SDK reference: @dynamoprotocol/sdk 4.3.3
GENERATED from the 4.3.3 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 4.3.3: 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 |
|---|---|
Account | type |
Accounts | class / constructor |
AllowanceCredential | type |
AllowanceCredentialPayload | type |
AllowanceVerifyOptions | type |
AllowanceVerifyResult | type |
AmendResult | type |
AmendSpec | type |
amount | function |
Amount | type |
Approval | type |
ApprovalRequiredError | class / constructor |
ApprovalState | type |
AssuranceLevel | type |
AuthorityChain | type |
AuthorityHead | type |
AuthorityRecord | type |
AuthorityRecordPayload | type |
BreachOutcome | type |
Budget | class / constructor |
BudgetSpec | type |
BudgetTree | type |
BudgetTreeStream | type |
CheckpointPendingError | class / constructor |
CheckpointRecord | type |
CheckpointWaitEvent | type |
childMandateHash | function |
ConsumeReceipt | type |
ConsumeRow | type |
Dynamo | class / constructor |
DynamoConfig | type |
DynamoError | class / constructor |
ErrorHeadroom | type |
ErrorInfo | type |
EvidenceExportSummary | type |
EvidenceSchemaOpt | type |
FieldUnavailableError | class / constructor |
FinalityState | type |
formatMicroUsd | function |
FreezeOptions | type |
FreezeResult | type |
FundingMode | type |
HaltError | class / constructor |
HaltReason | type |
HeadroomInfo | type |
HOP_INTENT_TYP | constant ("dynamo-hop-intent-v1") |
HOP_INTENT_V2_TYP | constant ("dynamo-hop-intent-v2") |
HopDelegation | type |
hopIntent | function |
HopIntent | type |
hopIntentHash | function |
hopIntentV2 | function |
HopIntentV2 | type |
hopNonce | function |
HopPayeeOffer | type |
HopSigner | type |
IdentityLink | type |
isValidRequestRef | function |
JsonValue | type |
MainSwitch | class / constructor |
MainSwitchState | type |
MainSwitchStatus | type |
Mandate | type |
MandateApproval | type |
MandateError | class / constructor |
MandateJson | type |
MandatePeriod | type |
MandateRefusalView | type |
MandateSpec | type |
MAX_OWNER_API_VERSION | constant ("1.11.0") |
microUsd | function |
newNonce | function |
NotFoundError | class / constructor |
NotYetImplementedError | class / constructor |
OFFER_DEFAULT_SECONDS | constant (3600) |
OfferAddressee | type |
offerScope | function |
OWNER_API_VERSION | constant ("1.1.0") |
parseMicroUsd | function |
PAYEE_OFFER_TYP | constant ("dynamo-payee-offer-v2") |
payeeOffer | function |
PayeeOffer | type |
payeeOfferHash | function |
PaymentAuthority | type |
PaymentAuthorityRecord | type |
ProofType | type |
Reservation | type |
resolveChildMandate | function |
SaleReceipt | type |
SDK_INTERFACE_VERSION | constant ("4.3.3") |
SdkConfigError | class / constructor |
SdkError | class / constructor |
Session | type |
SessionKey | class / constructor |
SessionStreamSummary | type |
SessionTotals | type |
SettlementView | type |
signHopIntent | function |
signPayeeOffer | function |
StateError | class / constructor |
StopResult | type |
Stream | class / constructor |
StreamSpec | type |
StreamTerms | type |
StreamTermsAcceptance | type |
TickReceipt | type |
units | function |
Units | type |
UnsupportedByServer | class / constructor |
usd | function |
VerificationError | class / constructor |
verifyAllowanceCredential | function |
voucherDigest | function |
VoucherDomainParams | type |
VoucherStruct | type |
voucherTypedData | function |
WireError | class / constructor |
x402 | namespace / object |
X402Error | class / constructor |
x402Stream | function |
X402WireStream | class / constructor |
x402 namespace members
| Export | Kind |
|---|---|
x402.AllowancePayloadSchema | zod schema |
x402.BatchChannels | class / constructor |
x402.BatchExtraSchema | zod schema |
x402.CDP_FACILITATOR_URL | constant ("https://api.cdp.coinbase.com/platform/v2/x402") |
x402.CdpAuthError | class / constructor |
x402.ChannelStateSchema | zod schema |
x402.DEFAULT_MAX_TIMEOUT_SECONDS | constant (900) |
x402.DEFAULT_MAX_WITHDRAW_DELAY_SECONDS | constant (604800) |
x402.ExactExtraSchema | zod schema |
x402.ExactPayloadSchema | zod schema |
x402.ExactV2PayloadSchema | zod schema |
x402.FileBatchChannels | class / constructor |
x402.FileX402KeyedStore | class / constructor |
x402.FileX402Sales | class / constructor |
x402.FileX402V2Pendings | class / constructor |
x402.HEADER_PAYMENT_REQUIRED | constant ("PAYMENT-REQUIRED") |
x402.HEADER_PAYMENT_RESPONSE | constant ("PAYMENT-RESPONSE") |
x402.HEADER_PAYMENT_SIGNATURE | constant ("PAYMENT-SIGNATURE") |
x402.HEADER_X_PAYMENT | constant ("X-PAYMENT") |
x402.HEADER_X_PAYMENT_RESPONSE | constant ("X-PAYMENT-RESPONSE") |
x402.MemoryX402KeyedStore | class / constructor |
x402.NETWORK_DYNAMO | constant ("dynamo-v1") |
x402.PAYMENT_HEADER | constant ("X-PAYMENT") |
x402.PAYMENT_RESPONSE_HEADER | constant ("X-PAYMENT-RESPONSE") |
x402.PERMIT2_ADDRESS | constant ("0x000000000022D473030F116dDEE9F6B43aC78BA3") |
x402.PaymentPayloadSchema | zod schema |
x402.PaymentRequiredBodySchema | zod schema |
x402.PaymentRequiredV1StandardSchema | zod schema |
x402.PaymentRequiredV2Schema | zod schema |
x402.PaymentRequirementsSchema | zod schema |
x402.PaymentRequirementsV1StandardSchema | zod schema |
x402.PaymentRequirementsV2Schema | zod schema |
x402.RECEIPT_V2_FIELDS | namespace / object |
x402.ReceiptSchema | zod schema |
x402.ReceiptV2Schema | zod schema |
x402.ResourceInfoSchema | zod schema |
x402.SCHEME_ALLOWANCE | constant ("dynamo-allowance") |
x402.SCHEME_EXACT | constant ("exact") |
x402.SCHEME_V2_BATCH | constant ("batch-settlement") |
x402.SCHEME_V2_EXACT | constant ("exact") |
x402.SCHEME_V2_UPTO | constant ("upto") |
x402.SettlementResponseV1StandardSchema | zod schema |
x402.SettlementResponseV2Schema | zod schema |
x402.UptoExtraSchema | zod schema |
x402.X402NetworkError | class / constructor |
x402.X402PendingSettlementError | class / constructor |
x402.X402Sales | class / constructor |
x402.X402Seller | class / constructor |
x402.X402SellerError | class / constructor |
x402.X402SellerRefs | class / constructor |
x402.X402StoreLockedError | class / constructor |
x402.X402V2Error | class / constructor |
x402.X402V2Pendings | class / constructor |
x402.X402_BATCH_SETTLEMENT | constant ("0x4020074e9dF2ce1deE5A9C1b5c3f541D02a10003") |
x402.X402_ERC3009_DEPOSIT_COLLECTOR | constant ("0x4020806089470a89826cB9fB1f4059150b550004") |
x402.X402_LOCAL_CHAIN_IDS | namespace / object |
x402.X402_MAINNET_CHAIN_IDS | namespace / object |
x402.X402_MAX_ACCEPTS | constant (64) |
x402.X402_MAX_HEADER_CHARS | constant (65536) |
x402.X402_TESTNET_CHAIN_IDS | namespace / object |
x402.X402_UPTO_PERMIT2_PROXY | constant ("0x4020A4f3b7b90ccA423B9fabCc0CE57C6C240002") |
x402.X402_V1_NETWORKS | namespace / object |
x402.X402_V2_VERSION | constant (2) |
x402.X402_VERSION | constant (1) |
x402.answerChallenge | function |
x402.assertBuyerBoundsV2 | function |
x402.assertX402Chain | function |
x402.batchChannelId | function |
x402.canonicalReceiptV2 | function |
x402.cdpFacilitator | function |
x402.cdpFacilitatorAuth | function |
x402.cdpJwt | function |
x402.chainSettlementResolver | function |
x402.decodeHeaderJson | function |
x402.decodePaymentHeader | function |
x402.encodeHeaderJson | function |
x402.encodePaymentHeader | function |
x402.evmChainId | function |
x402.issueChallenge | function |
x402.parseChallenge | function |
x402.parsePaymentRequiredV1Exact | function |
x402.parsePaymentRequiredV2 | function |
x402.parseReceiptV2 | function |
x402.parseSettlementResponseV2 | function |
x402.payV1Exact | function |
x402.payV2 | function |
x402.refundBatchChannelV2 | function |
x402.resolvePendingV2 | function |
x402.selectRequirementV2 | function |
x402.uptoBill | function |
x402.verifyAndConsumeV1 | function |
x402.verifyPayment | function |
x402.verifySaleReceipt | function |
x402.x402Fetch | function |
x402.x402FetchV1Exact | function |
x402.x402FetchV2 | function |
x402.x402StateDir | function |
x402.x402StateKey | function |