canonical-message API

Source-derived exports, parameter and result types, public methods and source links.

This reference is generated from the checked-out TypeScript exports. Types and signatures describe the package contract; source presence does not establish deployment or service availability. Error expressions below are direct throws, not an exhaustive list of failures from dependencies.

Source module. See the reference index for package import boundaries and verification scope.

buildCrossChainPaymentIntentMessage

Cross-chain payment intent. This is intentionally separate from the legacy Solana-only Payment Intent format so existing Solana flows are not changed. Every destination-sensitive field is inside the user signature.

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 267.

buildCrossChainPaymentIntentMessage(params: { intentId: string; amountBaseUnits: bigint | string | number; destinationToken: string; recipientTin: string; feeBaseUnits: bigint | string | number; sender: string; nonce: string; expires: string | Date; destinationNetwork: string; destinationExecutor: string; settlementRouteId: string; }): string

Direct failure expressions:

new CanonicalMessageError("cross-chain intent fields must not be empty")
new CanonicalMessageError("Destination Executor must be a 20-byte EVM address")

buildPaymentIntentMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 211.

buildPaymentIntentMessage(params: { amountBaseUnits: bigint | string | number; tokenMintAddress: string; tokenDecimals: number; recipientTin: string; recipientDisplayName?: string; recipientDisplayNameSource?: "owner-provided" | "not provided"; recipientVerifiedCredentials?: readonly VerifiedRecipientCredential[]; feeBaseUnits: bigint | string | number; sender: string; nonce: string; expires: string | Date; }): string

Direct failure expressions:

new CanonicalMessageError("Token Mint is required")

buildTinCreationMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 322.

buildTinCreationMessage(params: { tin: string; displayName: string; privacy?: string; nonce: string; expires: string | Date; }): string

buildTinWalletBindingMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 338.

buildTinWalletBindingMessage(params: { tin: string; walletPublicKey: string; identityPublicKey: string; programId: string; issuedAt: string | Date; }): string

CanonicalMessageError

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 4.

new CanonicalMessageError(message: string): CanonicalMessageError

isCanonicalTsnMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 167.

isCanonicalTsnMessage(message: string): boolean

parseCrossChainPaymentIntentMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 301.

parseCrossChainPaymentIntentMessage(message: string): { intentId: string; amountBaseUnits: bigint; destinationToken: string; recipientTin: string; feeBaseUnits: bigint; sender: string; nonce: string; expires: Date; destinationNetwork: string; destinationExecutor: string; settlementRouteId: string; }

Direct failure expressions:

new CanonicalMessageError("Destination Executor must be a 20-byte EVM address")

parsePaymentIntentMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 241.

parsePaymentIntentMessage(message: string): { tokenMintAddress: string; tokenDecimals: number; amountBaseUnits: bigint; recipientTin: string; recipientDisplayName: string; recipientDisplayNameSource: string; recipientVerifiedCredentials: VerifiedRecipientCredential[]; feeBaseUnits: bigint; sender: string; nonce: string; expires: Date; }

Direct failure expressions:

new CanonicalMessageError("Token Decimals must be an integer from 0 through 18")

parseTinCreationMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 364.

parseTinCreationMessage(message: string): { tin: string; displayName: string; privacy: string; nonce: string; expires: Date; }

parseTinWalletBindingMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 354.

parseTinWalletBindingMessage(message: string): { tin: string; walletPublicKey: string; identityPublicKey: string; programId: string; issuedAt: Date; }

parseTokenAmountToBaseUnits

Convert a human token amount to integer base units without floating-point rounding.

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 17.

parseTokenAmountToBaseUnits(value: string | number, decimals?: number, options?: { allowZero?: boolean; }): bigint

Direct failure expressions:

new CanonicalMessageError("Token decimals must be an integer from 0 through 18")
new CanonicalMessageError(`Amount must be a plain decimal with at most ${decimals} fractional digits`)
new CanonicalMessageError(options.allowZero ? "Amount must not be negative" : "Amount must be positive")
new CanonicalMessageError("Amount is outside the u64 range")

TSN_CANONICAL_DOMAIN_DISPLAY

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 14.

string

TSN_CANONICAL_DOMAIN_HASH

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 11.

string

VerifiedRecipientCredential

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/canonical-message. Implementation, line 171.

export type VerifiedRecipientCredential = {
  credentialType: string;
  issuer: string;
  claims: Record<string, string>;
};