Skip to main content
Beta — BRC wallet only. Desktop / Mobile over BRC-100, not Connect or Wallet API.

Setup

Every call carries your origin so the wallet can show the user who is asking. See Local bridge to call the same methods over plain HTTP.

Connect

isAuthenticated never prompts, so use it to decide whether to show a connect button.

Read balance

getBalance is a HandCash convenience method:
For a portable version, total the funding outputs the wallet holds:

Send a payment

Build the recipient locking script with your Bitcoin library, then let the wallet fund, sign, and broadcast:
The user sees your description, the amount, and your app name. Keep descriptions specific — they are what the user is agreeing to.

Stage and sign an action

Use two steps when your app supplies its own unlocking script, such as spending an application contract:
Any input with unlockingScriptLength instead of unlockingScript produces a signableTransaction you must finish with signAction. The wallet never invents your contract’s unlock.

Abort a staged action

Abort or sign — never abort and then build a second transaction spending the same input.

Receive a payment

When another party hands your app a transaction in Atomic BEEF format:
The wallet validates the transaction before it accepts it. Do not mark a delivery complete until this call succeeds.

List history

Labels are how you find your own transactions later, so label every action your app creates.

Error handling

A timeout is not a failure — the wallet may finish an action after your request drops. Check listActions by label before retrying a payment. Every code, with its HTTP status, is listed in Permissions and scopes.

Next steps