DevelopersRead frame receipts
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

Read frame receipts

Distinguish inclusion from successful execution. Inspect individual frame results or wait until every returned frame has succeeded.

APIclient.waitForFrameReceipt({ hash, ...options })

Usage

TYPESCRIPT
receipts.ts
// One read: null means no receipt was returned yet.const current = await client.getFrameReceipt({ hash });// Poll for successful execution; throws if a frame reverts.const receipt = await client.waitForFrameReceipt({  hash,  expectedFrameCount: 2,  timeoutMs: 120_000,  pollingIntervalMs: 2_000,});

Examples use the configured client from Create a client.

Parameters

NameTypeDescription
hashHexThe transaction hash to inspect.
expectedFrameCountnumber?An optional check against the expected number of frames.
timeoutMsnumber?Maximum wait duration. Defaults to 120,000 milliseconds.
signalAbortSignal?Cancel waiting. This does not cancel the transaction.

Returns

getFrameReceipt: Promise<FrameReceipt | null>. waitForFrameReceipt: Promise<FrameReceipt>.

Behavior to know

  • A reverted frame raises FRAME_REVERTED and identifies failed frame indices.
  • A receipt is evidence of observed inclusion, not finality. A timeout is not proof of rejection.
NEXT UPInspect admission