SDK · proposed target surface · 2026-09-16

Shuttle SDK

Wallet creation, signing, transfers, policies and signed events — one business contract across TypeScript, React, Python and Go. Compiled losslessly from 25 canonical source documents.

Status and source boundary

Proposed SDK surface for product review, compiled losslessly from the 25 canonical source documents. It is not an installable library, accepted implementation specification, or production-readiness claim.

Start here#

SDK model & stories The wallet and ownership model, the durable operation contract, the signed event contract and the language bindings. Read this first — every method page assumes it. createWallet One network-scoped signing identity in an explicitly chosen embedded or server control mode. getOperation Every mutation is durable and recoverable by its request identity. This is how you resolve an unknown outcome — never by retrying.

Wallet lifecycle#

createWalletCreate one network-scoped signing identity in an explicit control mode.getWalletRead one safe wallet projection with authority and policy assignments.getWalletsList the wallets visible to the caller's scope.updateWalletApply an explicit change set: name, rights and policy assignments.

Signing#

signTransactionProduce a signature over exact transaction material without broadcasting.signMessageSign an exact message payload under wallet authority.signTypedDataSign structured typed data bound to its exact domain and payload.

Transfers & balances#

sendTransactionSend assets; ethSendTransaction is the EVM compatibility alias.getSendTransactionStatusChain-specific send detail, only when you need it.getWalletAddressBalancesRead exact raw balances for a wallet address.

Custody & recovery#

importWalletBring existing key material in through an authorized secure flow.exportWalletDisclose key material once, to an authorized secure recipient.recoverWalletAccessRestore access without silently changing control mode or authority.

Policies & authority#

createPolicyDefine a rule set and its agreement lifecycle.updatePolicyChange a policy through an explicit, ordered change set.

Events & operations#

watchWalletSigned deposit and transfer lifecycle events with checkpointing.getOperationRecover any durable operation by its request identity.

Catalogs#

Authentication & sessionsPasskey, OTP, social and external-wallet flows, sessions and profiles.UsersEight core methods, four tag methods, eleven credential methods.OrganizationsHierarchy, security and invitation methods.Application configurationThe verified bootstrap helper and what does not exist.ApprovalsGet, list, approve and reject — without duplicating action creation.PoliciesAll nine verified policy methods with nested rule expressions.TransactionsPrimary, compatibility, history and supporting transaction methods.

Conventions#

Every method page follows the same shape, so you can scan for the part you need.

Section	What it answers
Status	How much of this is verified source fact versus proposed design.
Business action	The one thing the call does, in business terms.
Proposed call	Signature in TypeScript, Python and Go, plus required input.
Result	What comes back, and what is deliberately never returned.
Authorization and effects	Who may authorize, and exactly what changes on success.
Acceptance	Positive and negative criteria the implementation must meet.

Code blocks with language tabs remember your choice: pick Go once and every block on every page follows. Press ⌘K or / to search.

Naming across runtimes

One shared business contract, one set of stable JSON field names, native naming per language: requestId in TypeScript, request_id in Python, RequestID in Go — all encoding to request_id on the wire. Exact monetary quantities are canonical unsigned base-10 JSON strings; the codec rejects JavaScript number, floating point, signs, fractions, exponent notation and non-canonical leading zeroes.