@dynamoprotocol/sdk 2.1.0GENERATED from the published 2.1.0 wire-client surface by
docs/tools/generate-sdk-reference.mjs(make docs-build). Do not edit byhand — edits are overwritten and drift fails the build. Curated guides live
The SDK public surface is a versioned artifact (rule 18): additive changes bump the minor version with a CHANGELOG entry; breaking changes are forbidden without a written deprecation note. This page documents SDK_INTERFACE_VERSION 2.1.0 — the thin wire client: it holds credentials, manages budgets and streams through your instance's versioned owner-api, and verifies what it receives; the engine and every enforcement decision live with the core it talks to.
@dynamoprotocol/sdk (single entry point)| Export | Kind |
|---|---|
AllowanceCredential | type |
AllowanceCredentialPayload | type |
AllowanceVerifyOptions | type |
AllowanceVerifyResult | type |
amount | function |
Amount | type |
Budget | class / constructor |
BudgetSpec | type |
CheckpointRecord | type |
ConsumeReceipt | type |
Dynamo | class / constructor |
DynamoConfig | type |
FinalityState | type |
formatMicroUsd | function |
FundingMode | type |
HaltError | class / constructor |
HaltReason | type |
HeadroomInfo | type |
isValidRequestRef | function |
microUsd | function |
newNonce | function |
NotFoundError | class / constructor |
NotYetImplementedError | class / constructor |
OWNER_API_VERSION | constant ("1.1.0") |
parseMicroUsd | function |
SDK_INTERFACE_VERSION | constant ("2.1.0") |
SdkConfigError | class / constructor |
SdkError | class / constructor |
Session | type |
SessionKey | class / constructor |
SessionStreamSummary | type |
SessionTotals | type |
SettlementView | type |
StateError | class / constructor |
Stream | class / constructor |
StreamSpec | type |
TickReceipt | type |
units | function |
Units | type |
usd | function |
VerificationError | class / constructor |
verifyAllowanceCredential | function |
voucherDigest | function |
VoucherDomainParams | type |
VoucherStruct | type |
voucherTypedData | function |
WireError | class / constructor |
x402 | namespace / object |
X402Error | class / constructor |
x402 namespace members| Export | Kind |
|---|---|
x402.AllowancePayloadSchema | zod schema |
x402.ExactPayloadSchema | zod schema |
x402.NETWORK_DYNAMO | constant ("dynamo-v1") |
x402.PAYMENT_HEADER | constant ("X-PAYMENT") |
x402.PAYMENT_RESPONSE_HEADER | constant ("X-PAYMENT-RESPONSE") |
x402.PaymentPayloadSchema | zod schema |
x402.PaymentRequiredBodySchema | zod schema |
x402.PaymentRequirementsSchema | zod schema |
x402.ReceiptSchema | zod schema |
x402.SCHEME_ALLOWANCE | constant ("dynamo-allowance") |
x402.SCHEME_EXACT | constant ("exact") |
x402.X402_VERSION | constant (1) |
x402.answerChallenge | function |
x402.decodePaymentHeader | function |
x402.encodePaymentHeader | function |
x402.issueChallenge | function |
x402.parseChallenge | function |
x402.verifyPayment | function |
x402.x402Fetch | function |