@wallaby-cash/custodial
v0.3.0
Published
Node-only SDK for the pooled_custodial wallet type. Runs alongside an integrator-owned DB; the master key is supplied fresh on every operation and is never held by any long-lived object.
Readme
@wallaby-cash/custodial
Node-only SDK for the pooled_custodial wallet type. Runs alongside an integrator-owned DB.
See GUIDE.md for usage and docs-architecture/custodial-sdk-architecture.md (in
sdk-monorepo) for the full design.
- Use
bunfor tooling (build/test), same as the rest ofsdk-monorepo/packages/*. - Uses
tsyringefor DI, same pattern asserver-sdk. - The master key is supplied fresh on every
client.auth.signUp/signIncall and is never held by any long-lived object — not a constructor argument, not a field onclient.auth, not part ofclient.update(...). - Error handling goes through
WallabyError(@wallaby-cash/utilities):contextisModuleName::FunctionName(e.g.AuthService::signIn).errorCodeis required for every thrown error.- if
onErroris configured on the client,WallabyErrortriggers it — this is how integrator-side telemetry/error logging gets wired up.
Scope (Phase 1)
Master-key-based sign-up/sign-in against the NCW Wallets Service auth endpoints, plus the
storage/cipher plumbing they depend on. pooled_custodial wallet creation
(WalletService.createPooledWallet) and the transaction-signing mechanism are Phase 2.
