DevelopersSign locally
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

Sign locally

Delegate authorization to your signer while preserving the transaction you prepared. FramePay rejects changes to the signed envelope.

APIclient.signFrameTransaction({ transaction, signer })

Usage

TYPESCRIPT
sign.ts
import { privateKeyToFrameSigner } from '@framepay/sdk';import { generatePrivateKey } from 'viem/accounts';// A disposable local-devnet account. Fund its address before sending.const signer = privateKeyToFrameSigner(generatePrivateKey());// Prepare the transaction with sender: signer.address first.const signed = await client.signFrameTransaction({ transaction, signer });

Examples use the configured client from Create a client.

Parameters

NameTypeDescription
transactionFrameTxThe complete prepared transaction.
signerFrameSignerAn adapter implementing address and sign({ profile, transaction }).

Returns

Promise<FrameTx> — a signed copy of the transaction.

Behavior to know

  • The included local adapter uses SECP256K1. PQ authorization and browser-wallet adapters are future integrations.
  • Private keys should remain inside your signer. The playground generates its key in this browser tab and does not persist it.
NEXT UPSubmit to the sidecar