cross-chain 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.

assertVerifiedDestinationLiquidity

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 140.

assertVerifiedDestinationLiquidity(route: DestinationLiquidityRoute, observation: VerifiedDestinationLiquidity, requestedAmount: bigint, nowSeconds?: bigint): void

Direct failure expressions:

new Error("destination route is disabled")
new Error("liquidity observation route mismatch")
new Error("invalid destination payout vault")
new Error("invalid destination settlement token")
new Error("verified destination liquidity is insufficient")
new Error("verified destination liquidity has expired")

AttestationStatus

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 14.

export type AttestationStatus =
  | "not_requested"
  | "queued"
  | "anchored"
  | "verified"
  | "failed";

ATTESTCOIN_BLOCK_PROVER_PRECOMPILE

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 5.

"0x0000000000000000000000000000000000000FD2"

createTinExitReplayKey

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 105.

createTinExitReplayKey(input: Pick<TinExitAttestationInput, "sealedTipHeadHash" | "amount" | "tinHash" | "exitCommitment">): string

CREDITCOIN_SETTLEMENT_NETWORK

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 21.

"creditcoin-testnet"

CreditcoinDestination

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 69.

CreditcoinDestination.network

Source, line 70.

network: "creditcoin-testnet"

CreditcoinDestination.address

Source, line 71.

address: `0x${string}`

CreditcoinDestination.token

Source, line 72.

token: string

CreditcoinLiquidityState

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 186.

CreditcoinLiquidityState.availableAmount

Source, line 187.

availableAmount: bigint

CreditcoinLiquidityState.sourceBlock

Source, line 188.

sourceBlock: bigint

CreditcoinLiquidityState.observedAt

Source, line 189.

observedAt: bigint

CreditcoinLiquidityState.validUntil

Source, line 190.

validUntil: bigint

CreditcoinLiquidityState.nonce

Source, line 191.

nonce: bigint

CreditcoinLiquidityState.queryId

Source, line 192.

queryId: `0x${string}`

CreditcoinLiquidityState.isFresh

Source, line 193.

isFresh: boolean

CreditcoinPayoutAuthorization

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 36.

CreditcoinPayoutAuthorization.settlementId

Source, line 37.

settlementId: string

CreditcoinPayoutAuthorization.sealedTipHeadHash

Source, line 38.

sealedTipHeadHash: string

CreditcoinPayoutAuthorization.tinHash

Source, line 39.

tinHash: string

CreditcoinPayoutAuthorization.exitCommitment

Source, line 40.

exitCommitment: string

CreditcoinPayoutAuthorization.destinationNetwork

Source, line 41.

destinationNetwork: "creditcoin-testnet"

CreditcoinPayoutAuthorization.recipient

Source, line 42.

recipient: `0x${string}`

CreditcoinPayoutAuthorization.amount

Source, line 43.

amount: bigint

CreditcoinPayoutAuthorization.nonce

Source, line 44.

nonce: bigint

CreditcoinPayoutAuthorization.deadline

Source, line 45.

deadline: bigint

CreditcoinPayoutAuthorization.merchantOverride

Source, line 46.

merchantOverride: boolean

CreditcoinRouteClient

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 250.

new CreditcoinRouteClient(config: CreditcoinRouteClientConfig): CreditcoinRouteClient

CreditcoinRouteClient.readRoute

Source, line 279.

readRoute(): Promise<CreditcoinRouteState>

CreditcoinRouteClient.readLiquidity

Source, line 305.

readLiquidity(): Promise<CreditcoinLiquidityState>

CreditcoinRouteClient.readEvidence

Source, line 319.

readEvidence(): Promise<CreditcoinRouteEvidence>

Direct failure expressions:

new Error(`Creditcoin RPC HTTP ${response.status}`)
new Error(body.error?.message ?? "Creditcoin RPC returned no result")
new Error(`expected Creditcoin chain ${this.config.expectedChainId}, received ${chainId}`)

CreditcoinRouteClientConfig

Live Creditcoin route evidence for terminal runners and the TSN test UI.

The Node may mirror route identity for fast admission, but this client reads the route registry and liquidity observation directly from Creditcoin. It never accepts a token or executor address as runtime authority from UI data.

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 163.

CreditcoinRouteClientConfig.rpcUrl

Source, line 164.

rpcUrl: string

CreditcoinRouteClientConfig.registry

Source, line 165.

registry: `0x${string}`

CreditcoinRouteClientConfig.routeId

Source, line 166.

routeId: `0x${string}`

CreditcoinRouteClientConfig.expectedChainId

Source, line 167.

expectedChainId: bigint | undefined

CreditcoinRouteClientConfig.explorerBaseUrl

Source, line 168.

explorerBaseUrl: string | undefined

CreditcoinRouteEvidence

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 196.

CreditcoinRouteEvidence.status

Source, line 197.

status: "ready" | "blocked"

CreditcoinRouteEvidence.route

Source, line 198.

route: CreditcoinRouteState

CreditcoinRouteEvidence.liquidity

Source, line 199.

liquidity: CreditcoinLiquidityState

CreditcoinRouteEvidence.logs

Source, line 200.

logs: string[]

CreditcoinRouteEvidence.explorerLinks

Source, line 201.

explorerLinks: { registry: string; token: string; vault: string; }

CreditcoinRouteEvidence.failure

Source, line 202.

failure: string | undefined

CreditcoinRouteState

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 171.

CreditcoinRouteState.chainId

Source, line 172.

chainId: bigint

CreditcoinRouteState.routeId

Source, line 173.

routeId: `0x${string}`

CreditcoinRouteState.enabled

Source, line 174.

enabled: boolean

CreditcoinRouteState.payoutVault

Source, line 175.

payoutVault: `0x${string}`

CreditcoinRouteState.settlementToken

Source, line 176.

settlementToken: `0x${string}`

CreditcoinRouteState.destinationNetwork

Source, line 177.

destinationNetwork: `0x${string}`

CreditcoinRouteState.destinationChainId

Source, line 178.

destinationChainId: bigint

CreditcoinRouteState.destinationExecutor

Source, line 179.

destinationExecutor: `0x${string}`

CreditcoinRouteState.outbox

Source, line 180.

outbox: `0x${string}`

CreditcoinRouteState.tokenName

Source, line 181.

tokenName: string | undefined

CreditcoinRouteState.tokenSymbol

Source, line 182.

tokenSymbol: string | undefined

CreditcoinRouteState.tokenDecimals

Source, line 183.

tokenDecimals: number | undefined

CrossChainNetwork

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 8.

export type CrossChainNetwork =
  | "solana-devnet"
  | "creditcoin-testnet"
  | "base-sepolia"
  | "ethereum-sepolia";

CrossChainRecipient

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 23.

export type CrossChainRecipient =
  | { kind: "tin"; tinHash: `0x${string}` }
  | { kind: "wallet"; address: `0x${string}` };

CrossChainUiSnapshot

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 365.

CrossChainUiSnapshot.status

Source, line 366.

status: "ready" | "blocked"

CrossChainUiSnapshot.logs

Source, line 367.

logs: string[]

CrossChainUiSnapshot.nodeRoutes

Source, line 368.

nodeRoutes: unknown[]

CrossChainUiSnapshot.creditcoin

Source, line 369.

creditcoin: CreditcoinRouteEvidence

DestinationLiquidityRoute

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 121.

DestinationLiquidityRoute.routeId

Source, line 122.

routeId: `0x${string}`

DestinationLiquidityRoute.network

Source, line 123.

network: VerifiedDestinationEvm

DestinationLiquidityRoute.sourceChainKey

Source, line 124.

sourceChainKey: bigint

DestinationLiquidityRoute.sourceLiquidityEmitter

Source, line 125.

sourceLiquidityEmitter: `0x${string}`

DestinationLiquidityRoute.payoutVault

Source, line 126.

payoutVault: `0x${string}`

DestinationLiquidityRoute.settlementToken

Source, line 127.

settlementToken: `0x${string}`

DestinationLiquidityRoute.enabled

Source, line 128.

enabled: boolean

loadCrossChainUiSnapshot

One UI-facing preflight that mirrors the terminal order: Node route gate first, then live Creditcoin registry/liquidity evidence.

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 376.

loadCrossChainUiSnapshot(input: { nodeUrl: string; route: CreditcoinRouteClientConfig; }): Promise<CrossChainUiSnapshot>

Direct failure expressions:

new Error(`Node route gate HTTP ${response.status}`)

TinExitAttestationInput

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 75.

TinExitAttestationInput.settlementId

Source, line 76.

settlementId: string

TinExitAttestationInput.sourceNetwork

Source, line 77.

sourceNetwork: "solana-devnet"

TinExitAttestationInput.destinationNetwork

Source, line 78.

destinationNetwork: "creditcoin-testnet"

TinExitAttestationInput.sealedTipHeadHash

Source, line 79.

sealedTipHeadHash: string

TinExitAttestationInput.amount

Source, line 80.

amount: bigint

TinExitAttestationInput.tinHash

Source, line 81.

tinHash: string

TinExitAttestationInput.exitCommitment

Source, line 82.

exitCommitment: string

TinExitAttestationReceipt

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 85.

TinExitAttestationReceipt.status

Source, line 86.

status: AttestationStatus

TinExitAttestationReceipt.settlementId

Source, line 87.

settlementId: string

TinExitAttestationReceipt.destinationNetwork

Source, line 88.

destinationNetwork: "creditcoin-testnet"

TinExitAttestationReceipt.creditcoinTransaction

Source, line 89.

creditcoinTransaction: string | undefined

TinExitAttestationReceipt.sourceAnchorTransaction

Source, line 90.

sourceAnchorTransaction: string | undefined

TsnCrossChainClient

Application-facing TSN cross-chain façade.

This class coordinates calls to the existing Node and registry reader. It deliberately does not sign Solana transactions, submit EVM transactions, generate Attestcoin proofs, or choose an executor. Those responsibilities remain with the Solana programs, Node, Attestcoin contracts, and Crankers.

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 408.

new TsnCrossChainClient(input: { nodeUrl: string; route: CreditcoinRouteClientConfig; apiKey?: string | null; fetchImpl?: typeof fetch; }): TsnCrossChainClient

TsnCrossChainClient.getSettlementNetworks

Returns only routes admitted by the running Node gate.

Source, line 431.

getSettlementNetworks(): Promise<unknown>

TsnCrossChainClient.preflight

Runs the same Node-gate then Creditcoin-registry preflight used by the UI.

Source, line 436.

preflight(): Promise<CrossChainUiSnapshot>

TsnCrossChainClient.submitDebitIntent

Submits an already signed TSN debit intent to the Node.

Source, line 444.

submitDebitIntent(request: CreateIntentRequest): Promise<TsnMempoolIntent>

TsnCrossChainClient.readCreditcoinEvidence

Reads live Creditcoin route and liquidity evidence without submitting a transaction.

Source, line 455.

readCreditcoinEvidence(): Promise<CreditcoinRouteEvidence>

TsnCrossChainClient.createCrankerHandoff

Produces the exact handoff object a Cranker may submit. The SDK never broadcasts it; a Cranker must enforce its own network and signer policy.

Source, line 463.

createCrankerHandoff(input: { authorization: CreditcoinPayoutAuthorization; signature: string; }): { network: typeof CREDITCOIN_SETTLEMENT_NETWORK; authorization: CreditcoinPayoutAuthorization; signature: string; }

Direct failure expressions:

new Error("cross-chain debit intent must target an enabled TSN destination")
new Error("cross-chain debit intent requires registry-bound executor, token, and route ID")

validateCreditcoinDestination

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 93.

validateCreditcoinDestination(destination: CreditcoinDestination): CreditcoinDestination

Direct failure expressions:

new Error("Creditcoin destination must be a 20-byte EVM address")
new Error("Creditcoin destination token is required")

validateCreditcoinPayoutAuthorization

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 49.

validateCreditcoinPayoutAuthorization(authorization: CreditcoinPayoutAuthorization): CreditcoinPayoutAuthorization

Direct failure expressions:

new Error("Creditcoin payout recipient must be a 20-byte EVM address")
new Error(`${field} must be a bytes32 value`)
new Error("only the Creditcoin settlement rail is enabled")
new Error("payout amount and deadline must be positive")

validateCrossChainRecipient

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 27.

validateCrossChainRecipient(recipient: CrossChainRecipient): CrossChainRecipient

VerifiedDestinationEvm

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 119.

export type VerifiedDestinationEvm = "base" | "ethereum";

VerifiedDestinationLiquidity

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/cross-chain. Implementation, line 131.

VerifiedDestinationLiquidity.routeId

Source, line 132.

routeId: `0x${string}`

VerifiedDestinationLiquidity.queryId

Source, line 133.

queryId: `0x${string}`

VerifiedDestinationLiquidity.availableAmount

Source, line 134.

availableAmount: bigint

VerifiedDestinationLiquidity.sourceBlock

Source, line 135.

sourceBlock: bigint

VerifiedDestinationLiquidity.validUntil

Source, line 136.

validUntil: bigint

VerifiedDestinationLiquidity.nonce

Source, line 137.

nonce: bigint