DevelopersCreate a client
DeFi appSwap, send sponsored transfers, and manage recurring buys and transaction rulesOverviewStart building with native frame transactionsQuickstartSet up the workspace and run a first transactionCreate a clientGive your existing viem client a native frame-transaction workflow. Keep your transport, chain configuration, and familiar public actions.Compose a transferChoose a recipient, draft limits, and who should pay for gas. FramePay generates the verification and execution frames for an EOA ETH transfer.Prepare a transactionBuild an unsigned frame transaction with explicit actions, gas limits, and fee bounds. The client checks the chain and resolves the ordinary account nonce.Sign locallyDelegate authorization to your signer while preserving the transaction you prepared. FramePay rejects changes to the signed envelope.Submit to the sidecarSend a signed frame transaction through the gateway’s standard alternative-mempool path. Get the expected transaction hash without silently retrying writes.Read frame receiptsDistinguish inclusion from successful execution. Inspect individual frame results or wait until every returned frame has succeeded.Inspect admissionRead the sidecar’s retained admission decision and rule checks. Find the stage that rejected a transaction without guessing from a generic RPC error.PlaygroundCreate an account and test the SDK on your local devnet
Search FramePay documentation esc to close
CONFIGURATION

Create a client

Give your existing viem client a native frame-transaction workflow. Keep your transport, chain configuration, and familiar public actions.

APIframeActions({ profile })

Usage

TYPESCRIPT
create-client.ts
import { createPublicClient, defineChain, http } from 'viem';import { frameActions, frameNetworks } from '@framepay/sdk';const network = frameNetworks.devnet; // selected FramePay RPCconst chain = defineChain({  id: network.chainId,  name: network.name,  nativeCurrency: { name: 'Test Ether', symbol: 'ETH', decimals: 18 },  rpcUrls: { default: { http: [network.rpcUrl] } },});const client = createPublicClient({  chain,  transport: http(network.rpcUrl, { retryCount: 0 }),}).extend(frameActions({ profile: 'ethrex-eip8141-tracer' }));

Examples use the configured client from Create a client.

Parameters

NameTypeDescription
profile'ethrex-eip8141-tracer'The explicitly supported workshop profile. Configure your chain with ID 1337.

Returns

Your viem client, extended with seven typed FramePay actions.

Behavior to know

  • createFrameClient({ chain, transport, profile }) is also available as a convenience factory.
  • The transport must point to the gateway sidecar. The gateway forwards chain reads and routes frame submissions.
  • frameNetworks.devnet, frameNetworks.local and frameNetworks.public identify distinct environments with the same chain ID (1337). Keep keys, nonces, paymasters and pending transactions separate. Chain ID alone does not prevent replay between these devnets.
  • The current sidecar follows the workshop’s PR #6 rules, which differ from later ERC-8421 revisions.
NEXT UPCompose a transfer