API Reference

#Detection

All exported from @joeywallet/wallet-sdk. Detection only reads the page; it never messages the extension.

#getJoey(): Joey | null

Returns the Joey client, or null if the extension isn't present. Synchronous, never throws, and returns the same client object each time.

#isJoeyAvailable(): boolean

true when getJoey() would return a client.

#requireJoey(): Joey

Like getJoey(), but throws JoeyRpcError 4900 instead of returning null.

#waitForJoey(options?): Promise<Joey>

interface WaitForJoeyOptions {
  timeoutMs?: number // default 3000
  signal?: AbortSignal
}

Resolves immediately if Joey is present; otherwise waits for the extension to announce itself. It rejects with 4900 if the timeout passes (or on the server), and with -32603 if signal aborts.

#Other detection helpers

#The Joey client

Returned by getJoey(), waitForJoey() and requireJoey(). Every async method resolves with its result or rejects with a JoeyRpcError.

#Properties

#connect(params?)

interface ConnectParams { chain?: JoeyChain; silent?: boolean; name?: string; icon?: string }
interface ConnectResult { accounts: JoeyAccount[]; chain: JoeyChain | null; networkId: number | null }
interface JoeyAccount { address: string; publicKey?: string; label?: string }

• Already approved: returns the existing grant immediately, without a prompt.
• silent: true: never prompts. Returns { accounts: [] } if your site isn't approved, and works while Joey is locked.
• Otherwise: opens the approval window, where the user chooses which accounts to share. If Joey is locked, the request waits behind the unlock screen.
• name (up to 128 characters) and icon (an https: or data:image/ URL) are validated, but the approval screen shows your site's verified origin rather than these values.
• Errors: 4001 rejected or expired; -32602 invalid params; -32005 rate limited.

#disconnect(): Promise<void>

Revokes your site's grant and withdraws its pending requests. Other tabs and frames of your origin receive a disconnect event.

#getAccounts(): Promise<string[]>

Granted addresses, or [] if your site isn't connected. Never throws for an unconnected site.

#getNetwork(): Promise<JoeyNetwork>

interface JoeyNetwork { chain: JoeyChain; networkId: number; name: string } // 'Mainnet' | 'Testnet' | 'Devnet'

Requires a connected site; otherwise rejects with 4100.

#signTransaction(params)

Signs without submitting.

interface SignTransactionParams<TTx> {
  tx_json: TTx
  account?: string    // which granted address signs; defaults to the first
  chain?: JoeyChain   // refuse with 4901 if Joey is on another network
  autofill?: boolean  // default true: fills Fee, Sequence, LastLedgerSequence
}
interface SignTransactionResult { tx_json: Record<string, unknown>; tx_blob: string; hash: string }

The returned tx_json is decoded from the signed blob, so it includes the filled fields, SigningPubKey and TxnSignature.

#signAndSubmitTransaction(params)

Same parameters as signTransaction. One approval covers signing and submitting.

interface SignAndSubmitTransactionResult extends SignTransactionResult {
  engine_result?: string         // preliminary, e.g. 'tesSUCCESS'
  engine_result_message?: string
  batch?: BatchSubmitOutcome     // present for XLS-56 Batch transactions (0.5.0+)
}

#signTransactionFor(params)

Adds one multisignature for a granted account.

interface SignTransactionForParams<TTx> {
  tx_signer: string // a granted address; otherwise 4100
  tx_json: TTx      // Account is the multisigned account
  account?: string
  chain?: JoeyChain
}

This method never autofills: set Fee, Sequence and LastLedgerSequence yourself so every signer signs identical bytes. The multisign fee is base fee × (1 + number of signatures).

#signTransactionBulk(params)

Signs, and optionally submits, up to 32 transactions with one approval.

interface SignTransactionBulkParams<TTx> {
  tx_list: Array<{ tx_json: TTx }> // at most 32 (MAX_BULK_TRANSACTIONS)
  submit: boolean                  // required
  autofill?: boolean
  account?: string
  chain?: JoeyChain
}
// resolves with SignAndSubmitTransactionResult[]

Bulk submission is not atomic. See Batch and bulk for ordering and partial failures.

#signIn(params?)

Proves the user controls an address. See Sign-in.

#on(event, listener) and off(event, listener)

Subscribe to connect, disconnect, accountsChanged and networkChanged. on() returns an unsubscribe function. See Events.

#request({ method, params })

A low-level escape hatch for wallet methods newer than your SDK version. Errors are still JoeyRpcError.

#Method summary

#Constants

JOEY_DAPP_FORBIDDEN_TRANSACTION_TYPES is deprecated and empty. Don't use it to decide what Joey will sign; handle the wallet's error instead.

#Helpers

#Low-level helpers

Most apps don't need these; the Joey client uses them internally.

#Types

The package exports types for everything above:

• Transactions: TransactionLike, AnyTransaction, Amount, IssuedCurrencyAmount, MPTAmount, Memo, Signer, Path, PathStep
• Connection and network: ConnectParams, ConnectResult, JoeyAccount, JoeyChain, JoeyNetwork, JoeyCapability
• Signing: SigningContextParams, SignTransactionParams, SignTransactionResult, SignAndSubmitTransactionResult, SignTransactionForParams, SignTransactionBulkParams, SignTransactionBulkFailure, BulkEntryResult, BulkEntryStatus
• Batch: BatchTransaction, BatchInnerTransaction, BatchSigner, BatchSubmitOutcome
• Sign-in: SignInParams, SignInMode, SignInResult, Caip122SignInResult, ChallengeSignInResult
• Events: JoeyEventMap, JoeyEventName, JoeyEventListener
• Provider and errors: JoeyInjectedProvider, JoeyRequestArguments, JoeyRpcMethod, JoeyProviderEventName, JoeyErrorCode
• React and vanilla: JoeyProviderProps, JoeyContextValue, UseJoeyMutationOptions, UseJoeyMutationResult, CreateJoeySessionOptions, JoeySessionState, BindConnectButtonOptions
• Mutation state: MutationState, MutationStatus, MutationAction