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 by

hand: edits are overwritten and drift fails the build. Curated guides live

beside this page: budgets, streams,

session keys, holdback dial,

batch, subscribe.

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)

ExportKind
Accounttype
Accountsclass / constructor
AllowanceCredentialtype
AllowanceCredentialPayloadtype
AllowanceVerifyOptionstype
AllowanceVerifyResulttype
AmendResulttype
AmendSpectype
amountfunction
Amounttype
Approvaltype
ApprovalRequiredErrorclass / constructor
ApprovalStatetype
AssuranceLeveltype
AuthorityChaintype
AuthorityHeadtype
AuthorityRecordtype
AuthorityRecordPayloadtype
BreachOutcometype
Budgetclass / constructor
BudgetSpectype
BudgetTreetype
BudgetTreeStreamtype
CheckpointPendingErrorclass / constructor
CheckpointRecordtype
CheckpointWaitEventtype
childMandateHashfunction
ConsumeReceipttype
ConsumeRowtype
Dynamoclass / constructor
DynamoConfigtype
DynamoErrorclass / constructor
ErrorHeadroomtype
ErrorInfotype
EvidenceExportSummarytype
EvidenceSchemaOpttype
FieldUnavailableErrorclass / constructor
FinalityStatetype
formatMicroUsdfunction
FreezeOptionstype
FreezeResulttype
FundingModetype
HaltErrorclass / constructor
HaltReasontype
HeadroomInfotype
HOP_INTENT_TYPconstant ("dynamo-hop-intent-v1")
HOP_INTENT_V2_TYPconstant ("dynamo-hop-intent-v2")
HopDelegationtype
hopIntentfunction
HopIntenttype
hopIntentHashfunction
hopIntentV2function
HopIntentV2type
hopNoncefunction
HopPayeeOffertype
HopSignertype
IdentityLinktype
isValidRequestReffunction
JsonValuetype
MainSwitchclass / constructor
MainSwitchStatetype
MainSwitchStatustype
Mandatetype
MandateApprovaltype
MandateErrorclass / constructor
MandateJsontype
MandatePeriodtype
MandateRefusalViewtype
MandateSpectype
MAX_OWNER_API_VERSIONconstant ("1.11.0")
microUsdfunction
newNoncefunction
NotFoundErrorclass / constructor
NotYetImplementedErrorclass / constructor
OFFER_DEFAULT_SECONDSconstant (3600)
OfferAddresseetype
offerScopefunction
OWNER_API_VERSIONconstant ("1.1.0")
parseMicroUsdfunction
PAYEE_OFFER_TYPconstant ("dynamo-payee-offer-v2")
payeeOfferfunction
PayeeOffertype
payeeOfferHashfunction
PaymentAuthoritytype
PaymentAuthorityRecordtype
ProofTypetype
Reservationtype
resolveChildMandatefunction
SaleReceipttype
SDK_INTERFACE_VERSIONconstant ("4.3.3")
SdkConfigErrorclass / constructor
SdkErrorclass / constructor
Sessiontype
SessionKeyclass / constructor
SessionStreamSummarytype
SessionTotalstype
SettlementViewtype
signHopIntentfunction
signPayeeOfferfunction
StateErrorclass / constructor
StopResulttype
Streamclass / constructor
StreamSpectype
StreamTermstype
StreamTermsAcceptancetype
TickReceipttype
unitsfunction
Unitstype
UnsupportedByServerclass / constructor
usdfunction
VerificationErrorclass / constructor
verifyAllowanceCredentialfunction
voucherDigestfunction
VoucherDomainParamstype
VoucherStructtype
voucherTypedDatafunction
WireErrorclass / constructor
x402namespace / object
X402Errorclass / constructor
x402Streamfunction
X402WireStreamclass / constructor

x402 namespace members

ExportKind
x402.AllowancePayloadSchemazod schema
x402.BatchChannelsclass / constructor
x402.BatchExtraSchemazod schema
x402.CDP_FACILITATOR_URLconstant ("https://api.cdp.coinbase.com/platform/v2/x402")
x402.CdpAuthErrorclass / constructor
x402.ChannelStateSchemazod schema
x402.DEFAULT_MAX_TIMEOUT_SECONDSconstant (900)
x402.DEFAULT_MAX_WITHDRAW_DELAY_SECONDSconstant (604800)
x402.ExactExtraSchemazod schema
x402.ExactPayloadSchemazod schema
x402.ExactV2PayloadSchemazod schema
x402.FileBatchChannelsclass / constructor
x402.FileX402KeyedStoreclass / constructor
x402.FileX402Salesclass / constructor
x402.FileX402V2Pendingsclass / constructor
x402.HEADER_PAYMENT_REQUIREDconstant ("PAYMENT-REQUIRED")
x402.HEADER_PAYMENT_RESPONSEconstant ("PAYMENT-RESPONSE")
x402.HEADER_PAYMENT_SIGNATUREconstant ("PAYMENT-SIGNATURE")
x402.HEADER_X_PAYMENTconstant ("X-PAYMENT")
x402.HEADER_X_PAYMENT_RESPONSEconstant ("X-PAYMENT-RESPONSE")
x402.MemoryX402KeyedStoreclass / constructor
x402.NETWORK_DYNAMOconstant ("dynamo-v1")
x402.PAYMENT_HEADERconstant ("X-PAYMENT")
x402.PAYMENT_RESPONSE_HEADERconstant ("X-PAYMENT-RESPONSE")
x402.PERMIT2_ADDRESSconstant ("0x000000000022D473030F116dDEE9F6B43aC78BA3")
x402.PaymentPayloadSchemazod schema
x402.PaymentRequiredBodySchemazod schema
x402.PaymentRequiredV1StandardSchemazod schema
x402.PaymentRequiredV2Schemazod schema
x402.PaymentRequirementsSchemazod schema
x402.PaymentRequirementsV1StandardSchemazod schema
x402.PaymentRequirementsV2Schemazod schema
x402.RECEIPT_V2_FIELDSnamespace / object
x402.ReceiptSchemazod schema
x402.ReceiptV2Schemazod schema
x402.ResourceInfoSchemazod schema
x402.SCHEME_ALLOWANCEconstant ("dynamo-allowance")
x402.SCHEME_EXACTconstant ("exact")
x402.SCHEME_V2_BATCHconstant ("batch-settlement")
x402.SCHEME_V2_EXACTconstant ("exact")
x402.SCHEME_V2_UPTOconstant ("upto")
x402.SettlementResponseV1StandardSchemazod schema
x402.SettlementResponseV2Schemazod schema
x402.UptoExtraSchemazod schema
x402.X402NetworkErrorclass / constructor
x402.X402PendingSettlementErrorclass / constructor
x402.X402Salesclass / constructor
x402.X402Sellerclass / constructor
x402.X402SellerErrorclass / constructor
x402.X402SellerRefsclass / constructor
x402.X402StoreLockedErrorclass / constructor
x402.X402V2Errorclass / constructor
x402.X402V2Pendingsclass / constructor
x402.X402_BATCH_SETTLEMENTconstant ("0x4020074e9dF2ce1deE5A9C1b5c3f541D02a10003")
x402.X402_ERC3009_DEPOSIT_COLLECTORconstant ("0x4020806089470a89826cB9fB1f4059150b550004")
x402.X402_LOCAL_CHAIN_IDSnamespace / object
x402.X402_MAINNET_CHAIN_IDSnamespace / object
x402.X402_MAX_ACCEPTSconstant (64)
x402.X402_MAX_HEADER_CHARSconstant (65536)
x402.X402_TESTNET_CHAIN_IDSnamespace / object
x402.X402_UPTO_PERMIT2_PROXYconstant ("0x4020A4f3b7b90ccA423B9fabCc0CE57C6C240002")
x402.X402_V1_NETWORKSnamespace / object
x402.X402_V2_VERSIONconstant (2)
x402.X402_VERSIONconstant (1)
x402.answerChallengefunction
x402.assertBuyerBoundsV2function
x402.assertX402Chainfunction
x402.batchChannelIdfunction
x402.canonicalReceiptV2function
x402.cdpFacilitatorfunction
x402.cdpFacilitatorAuthfunction
x402.cdpJwtfunction
x402.chainSettlementResolverfunction
x402.decodeHeaderJsonfunction
x402.decodePaymentHeaderfunction
x402.encodeHeaderJsonfunction
x402.encodePaymentHeaderfunction
x402.evmChainIdfunction
x402.issueChallengefunction
x402.parseChallengefunction
x402.parsePaymentRequiredV1Exactfunction
x402.parsePaymentRequiredV2function
x402.parseReceiptV2function
x402.parseSettlementResponseV2function
x402.payV1Exactfunction
x402.payV2function
x402.refundBatchChannelV2function
x402.resolvePendingV2function
x402.selectRequirementV2function
x402.uptoBillfunction
x402.verifyAndConsumeV1function
x402.verifyPaymentfunction
x402.verifySaleReceiptfunction
x402.x402Fetchfunction
x402.x402FetchV1Exactfunction
x402.x402FetchV2function
x402.x402StateDirfunction
x402.x402StateKeyfunction