DevelopersPrepare a transaction
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
TRANSACTION LIFECYCLE

Prepare a transaction

Build an unsigned frame transaction with explicit actions, gas limits, and fee bounds. The client checks the chain and resolves the ordinary account nonce.

APIclient.prepareFrameTransaction(parameters)

Usage

TYPESCRIPT
prepare.ts
import { frame, getProfile } from '@framepay/sdk';const profile = getProfile('ethrex-eip8141-tracer');const transaction = await client.prepareFrameTransaction({  sender: signer.address,  maxFeePerGas: 2_000_000_000n,  frames: [    frame(profile, 'VERIFY', {      scope: 'EXECUTION_AND_PAYMENT', execution: 30_000n,    }),    frame(profile, 'SENDER', {      target: recipient, value: 1_000_000_000n,      execution: 50_000n, state: 200_000n,    }),  ],});

Examples use the configured client from Create a client.

Parameters

NameTypeDescription
senderAddressThe account authorizing the transaction.
framesFrame[]Ordered frames with explicit execution and state gas limits.
maxFeePerGasbigintMaximum gas price, in wei.
nonceSeqbigint?Read from the chain for ordinary nonces when omitted. Required for nonzero nonce keys.
nonceKeysbigint[]?Defaults to [0n]. Keyed nonce allocation is managed by the caller.
recentRootReferencesRecentRootReference[]?Optional references included in the signed envelope.

Returns

Promise<FrameTx> — an unsigned transaction envelope.

Behavior to know

  • Preparation is not admission simulation. Gas values in this example come from the workshop preset.
  • A nonce read is not a reservation. Serialize ordinary-nonce sends from the same account.
NEXT UPSign locally