@integraledger/lcp/tvm

InterfacesCopy Anchor Link

TonCellCopy Anchor Link

A TON cell, as @ton/core's Cell gives one: its data bits, its references and its representation hash. The entry point's public types name this shape rather than the optional peer's class, and a Cell is one.

PropertiesCopy Anchor Link

MethodsCopy Anchor Link

hash()Copy Anchor Link

hash(level?): Uint8Array

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Uint8Array

---

TonTxCopy Anchor Link

A transaction as a TON Center v3 endpoint reports it. inBody is the inbound message body as a BoC.

PropertiesCopy Anchor Link

---

TvmChoiceCopy Anchor Link

PropertiesCopy Anchor Link

---

TvmReaderCopy Anchor Link

Bounded, read-only calls against one network's TON Center v3 endpoint. Every failure rejects with ReaderError.

PropertiesCopy Anchor Link

MethodsCopy Anchor Link

byHash()Copy Anchor Link

byHash(txHash): Promise<TonTx | null>

GET /api/v3/transactions?hash=…

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<TonTx | null>

byInBody()Copy Anchor Link

byInBody(bodyHash): Promise<readonly TonTx[]>

GET /api/v3/transactionsByMessage?body_hash=…&direction=in

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<readonly TonTx[]>

byInMessage()Copy Anchor Link

byInMessage(msgHash): Promise<readonly TonTx[]>

GET /api/v3/transactionsByMessage?msg_hash=…&direction=in

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<readonly TonTx[]>

headUtime()Copy Anchor Link

headUtime(): Promise<number>

GET /api/v3/masterchainInfo: the last indexed block's gen_utime.

ReturnsCopy Anchor Link

Promise<number>

---

TvmRefCopy Anchor Link

The read keys recorded at claim.

PropertiesCopy Anchor Link

---

TvmUnsignedCopy Anchor Link

PropertiesCopy Anchor Link

MethodsCopy Anchor Link

complete()Copy Anchor Link

complete(signature): Refusal | TvmPayment

Takes the 64-byte Ed25519 signature.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Refusal | TvmPayment

Type AliasesCopy Anchor Link

TvmNetworkCopy Anchor Link

TvmNetwork = `tvm:${number}`

tvm:<global_id>: tvm:-239 mainnet, tvm:-3 testnet.

---

TvmPaymentCopy Anchor Link

TvmPayment = X402Payment<{ asset: string; settlementBoc: string; }>

---

TvmStatusCopy Anchor Link

TvmStatus = { finality: "confirmed" | "finalized"; state: "settled"; } | { state: "pending"; why: "not-found" | "in-flight" | "not-final" | "unreadable"; } | { state: "failed"; why: "aborted" | "no-transfer" | "bounced" | "expired"; }

VariablesCopy Anchor Link

exactTvmCopy Anchor Link

const exactTvm: Readonly<{ advertise: (doc, h, link, offer, agreementUrl?) => Refusal | PaymentRequired; bound: (presented) => Promise<`0x${string}` | Refusal>; build: (c, h) => Promise<Refusal | TvmUnsigned>; carrier: "extra.forwardPayload"; claims: boolean; id: "x402/exact/tvm"; pattern: LcpPattern; read: (doc) => Refusal | X402Read; recover: (ref, reader) => Promise<`0x${string}` | Refusal>; reference: (presented) => Promise<Refusal | TvmRef>; status: (ref, reader) => Promise<TvmStatus>; tie: (accepts, request) => ["x402", { accepts: readonly PaymentRequirements[]; request: RequestCommitment; }]; txId: (tx) => string; unplaced: (option) => PaymentRequirements; }>

---

OPCopy Anchor Link

const OP: object

Type DeclarationCopy Anchor Link

FunctionsCopy Anchor Link

lcpComment()Copy Anchor Link

lcpComment(h): Refusal | TonCell

TEP-74's text comment: 32 zero bits, then the UTF-8 of the hash's LCP string. A value that is not a 32-byte hash is x402/payload-malformed.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Refusal | TonCell

---

pairingOf()Copy Anchor Link

pairingOf(option): "x402/exact/tvm" | undefined

This pairing's id for an option it can pay, or undefined.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

"x402/exact/tvm" | undefined

---

tvmCarrier()Copy Anchor Link

tvmCarrier(settlementBoc): Refusal | { h: `0x${string}`; jettonWallet: string; payload: TonCell; transferBodyHash: `0x${string}`; validUntil: number; }

Reads the signed request in a settlement BoC: an internal message whose body is a W5 internal_signed request with exactly one action_send_msg behind an empty list, carrying a Jetton transfer whose forward payload is a reference to a text comment holding an LCP string.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Refusal | { h: `0x${string}`; jettonWallet: string; payload: TonCell; transferBodyHash: `0x${string}`; validUntil: number; }

---

tvmRecover()Copy Anchor Link

tvmRecover(ref, reader): Promise<`0x${string}` | Refusal>

Recovers the hash from the payer Jetton wallet's transaction: the comment in its inbound Jetton transfer. One call.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<`0x${string}` | Refusal>

---

tvmStatus()Copy Anchor Link

tvmStatus(ref, reader): Promise<TvmStatus>

Finds the transfer by its body hash on the payer's Jetton wallet, then follows its internal_transfer to the payee's Jetton wallet. Settled when both executed without aborting, at the lower finality of the two. A transaction on any other account is ignored. A failed read, or a reader for another network, is pending.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<TvmStatus>

---

tvmTxId()Copy Anchor Link

tvmTxId(tx): string

A TON transaction hash in one spelling: lowercase hex without 0x (x402's TON scheme gives transaction as "Transaction hash (64-character hex string)"), whether it is given in hex, or in the base64 or base64url of its 32 bytes that TON Center answers. Any other string is returned unchanged.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

string