SDK

npm install brickken-sdk

​

Why this surface

• One client, three APIs. Dapp, agentic, and RAMS live behind the same Brickken instance.
• Illegal combinations fail locally. The SDK derives the credential mode from what you pass and refuses combinations the API rejects, before a request leaves your process.
• Typed results, typed errors. Every write returns the same WriteResult shape, and every failure is one of fourteen error classes you can branch on.
• Your private key stays put. It signs x402 payments, client-signed transactions, and RAMS typed data in your process, and is never sent anywhere.

​

Two credentials, and they are alternatives

const bkn = new Brickken({ apiKey: 'key', signer })
await bkn.agent.register(input, { executionMode: 'brickken-relayed' })
// throws RelayedRequiresPaymentError, naming both fixes, with no network round trip

​

Every write is prepare → sign → send

const prepared = await bkn.agentToken.create({ chainId: '84532', name: 'Agent Token', symbol: 'AGT' })
prepared.txId                  // the prepared transaction id
prepared.transactions          // unsigned transactions
prepared.x402Requirements      // what sending will cost
prepared.sent                  // undefined: nothing was sent

const done = await bkn.agentToken.create(
  { chainId: '84532', name: 'Agent Token', symbol: 'AGT' },
  { execute: true, waitForReceipt: true },        // waitForReceipt needs rpcUrl
)
done.payment?.requirement.amount
done.deployedAddress                              // recovered from the receipt

​

Where to go next

​

Prerequisites the API does not expose

1. The wallet you pass as signerAddress must be whitelisted by Brickken before any prepare accepts it. Request it together with your API key.
2. An API key may only act on token symbols whose tokenizer email matches a newTokenization performed under that same key. Anything else raises UnauthorizedTokenSymbolError.