@lelantos-org/sdk / index / ChainAdapter

Interface: ChainAdapter

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:8

Adapters MUST be deterministic w.r.t. constructor inputs (no hidden global state).

Methods

blockNumber()?

optional blockNumber(): Promise<number>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:159

Current chain tip. Feeds SelectOpts.tipBlock, without which the selector's spend cooldown is inert. Names no address and no topic. Optional.

Returns

Promise<number>

---

cancelDelay()?

optional cancelDelay(): Promise<number>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:133

Blocks before cancelDeposit is allowed. Optional.

Returns

Promise<number>

---

cancelDeposit()?

optional cancelDeposit(id, inputs): Promise<{
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:119

MASP.cancelDeposit. On-chain digest check rejects tampered preimages. Optional.

Parameters

Parameter	Type
id	bigint
inputs	CancelDepositInputs

Returns

Promise<{ txHash: Hex32; }>

---

cancelDepositNative()?

optional cancelDepositNative(id, inputs): Promise<{
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:127

NativeAdapter.cancelNative — the only way to settle an adapter-owned escrow by refund, since the pool would return the coin to the adapter. No payer: the adapter supplies its own. Optional.

Parameters

Parameter	Type
id	bigint
inputs	Omit<CancelDepositInputs, "payer">

Returns

Promise<{ txHash: Hex32; }>

---

chainId()

chainId(): Promise<bigint>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:9

Returns

Promise<bigint>

---

fetchAsset()

fetchAsset(id): Promise<AssetEntry>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:20

Parameters

Parameter	Type
id	AssetId

Returns

Promise<AssetEntry>

---

fetchFeeBps()

fetchFeeBps(): Promise<bigint>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:22

0 disables fees.

Returns

Promise<bigint>

---

getEscrowed()?

optional getEscrowed(id): Promise<EscrowedDepositView | null>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:131

MASP.escrowed(id) — null if flushed/cancelled. Optional.

Parameters

Parameter	Type
id	bigint

Returns

Promise<EscrowedDepositView | null>

---

maspAddress()

maspAddress(): Promise<EvmAddress>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:13

Used as the Permit2 spender.

Returns

Promise<EvmAddress>

---

nativeAdapterAddress()?

optional nativeAdapterAddress(): EvmAddress | undefined;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:19

NativeAdapter address, or undefined where none is deployed. It is the payer a native deposit must name, so the deposit builder needs it before it builds the request. Optional.

Returns

EvmAddress | undefined

---

nativeBalance()?

optional nativeBalance(account): Promise<bigint>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:143

Wei. Optional.

Parameters

Parameter	Type
account	EvmAddress

Returns

Promise<bigint>

---

payerAddress()

payerAddress(): Promise<EvmAddress>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:11

Signer's eth address (== pi.payer for deposit).

Returns

Promise<EvmAddress>

---

permit2Address()?

optional permit2Address(): EvmAddress;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:149

Optional; adapters that don't use Permit2 omit.

Returns

EvmAddress

---

permit2Allowance()?

optional permit2Allowance(
   token, 
   owner, 
   spender
): Promise<{
  amount: TokenAmount;
  expiration: number;
  nonce: number;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:80

IAllowanceTransfer.allowance — cap, expiry, nonce. Optional.

Parameters

Parameter	Type
token	EvmAddress
owner	EvmAddress
spender	EvmAddress

Returns

Promise<{ amount: TokenAmount; expiration: number; nonce: number; }>

---

permit2Nonce()?

optional permit2Nonce(): Promise<bigint>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:138

Free slot in Permit2's unordered nonce bitmap. Optional; adapters returning a deterministic nonce can omit.

Returns

Promise<bigint>

---

permit2PermitAllowance()?

optional permit2PermitAllowance(args, onTxHash?): Promise<{
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:89

Submit pre-signed PermitSingle via IAllowanceTransfer.permit. Anyone can submit; relayer-gasless variants may override. Optional.

Parameters

Parameter	Type
args	{ owner: EvmAddress; permit: PermitSingle; signature: string; }
args.owner	EvmAddress
args.permit?	PermitSingle
args.signature?	string
onTxHash?	(hash) => void

Returns

Promise<{ txHash: Hex32; }>

---

permit2PermitAllowanceBatch()?

optional permit2PermitAllowanceBatch(args, onTxHash?): Promise<{
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:104

Submit a pre-signed PermitBatch via the permit overload taking an array — one tx establishes N token windows. Optional.

Parameters

Parameter	Type
args	{ owner: EvmAddress; permit: PermitBatch; signature: string; }
args.owner	EvmAddress
args.permit?	PermitBatch
args.signature?	string
onTxHash?	(hash) => void

Returns

Promise<{ txHash: Hex32; }>

---

signPermit2()

signPermit2(args): Promise<Permit2Sig>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:27

Sign Permit2 PermitWitnessTransferFrom witness-bound to piHash = keccak256(abi.encode(DepositRequest, aux)).

Parameters

Parameter	Type
args	Permit2SignArgs

Returns

Promise<Permit2Sig>

---

signPermit2Allowance()?

optional signPermit2Allowance(permit): Promise<{
  signature: string;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:97

Sign PermitSingle for AllowanceTransfer-mode deposits. Optional.

Parameters

Parameter	Type
permit	PermitSingle

Returns

Promise<{ signature: string; }>

---

signPermit2AllowanceBatch()?

optional signPermit2AllowanceBatch(permit): Promise<{
  signature: string;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:112

Sign one PermitBatch covering N tokens. Optional.

Parameters

Parameter	Type
permit	PermitBatch

Returns

Promise<{ signature: string; }>

---

submitDeposit()?

optional submitDeposit(args): Promise<{
  depositId: bigint;
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:32

MASP.deposit(d, sig, aux). Returns tx hash + deposit id from the DepositEscrowed log. Optional: relayer-broadcast adapters omit.

Parameters

Parameter	Type	Description
args	{ aux: AuxOutput; deposit: DepositRequest; feeAux: AuxOutput; onSent?: (txHash) => void; permit2: Permit2Sig; }	-
args.aux	AuxOutput	-
args.deposit	DepositRequest	-
args.feeAux	AuxOutput	The relayer fee note payload; a deposit mints two leaves.
args.onSent?	(txHash) => void	Fired after the wallet signs and the tx hash is known, before receipt-wait.
args.permit2	Permit2Sig	-

Returns

Promise<{ depositId: bigint; txHash: Hex32; }>

---

submitDepositAuthorized()?

optional submitDepositAuthorized(args): Promise<{
  depositId: bigint;
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:69

MASP.depositAuthorized. Pulls via Permit2 AllowanceTransfer against a previously-signed window; no per-deposit sig. Optional.

Parameters

Parameter	Type	Description
args	{ aux: AuxOutput; deposit: DepositRequest; feeAux: AuxOutput; onSent?: (txHash) => void; }	-
args.aux	AuxOutput	-
args.deposit	DepositRequest	-
args.feeAux	AuxOutput	The relayer fee note payload; a deposit mints two leaves.
args.onSent?	(txHash) => void	-

Returns

Promise<{ depositId: bigint; txHash: Hex32; }>

---

submitDepositNative()?

optional submitDepositNative(args): Promise<{
  depositId: bigint;
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:54

NativeAdapter.depositNative with msg.value = value. The pool is ERC-20 only, so the adapter wraps the coin, escrows it under its own name and returns the excess — deposit.payer must therefore be the adapter, not the sender. Asset id must be WETH-registered. Optional, and unavailable on a chain with no adapter deployed.

Parameters

Parameter	Type	Description
args	{ aux: AuxOutput; deposit: DepositRequest; feeAux: AuxOutput; onSent?: (txHash) => void; value: bigint; }	-
args.aux	AuxOutput	-
args.deposit	DepositRequest	-
args.feeAux	AuxOutput	The relayer fee note payload; a deposit mints two leaves.
args.onSent?	(txHash) => void	-
args.value	bigint	-

Returns

Promise<{ depositId: bigint; txHash: Hex32; }>

---

tokenAllowance()?

optional tokenAllowance(
   tokenAddr, 
   owner, 
   spender
): Promise<TokenAmount>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:144

Parameters

Parameter	Type
tokenAddr	EvmAddress
owner	EvmAddress
spender	EvmAddress

Returns

Promise<TokenAmount>

---

tokenApprove()?

optional tokenApprove(
   tokenAddr, 
   spender, 
   amount, 
   onTxHash?
): Promise<{
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:145

Parameters

Parameter	Type
tokenAddr	EvmAddress
spender	EvmAddress
amount	TokenAmount
onTxHash?	(hash) => void

Returns

Promise<{ txHash: Hex32; }>

---

tokenBalanceOf()?

optional tokenBalanceOf(tokenAddr, account): Promise<TokenAmount>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:141

Parameters

Parameter	Type
tokenAddr	EvmAddress
account	EvmAddress

Returns

Promise<TokenAmount>

---

tokenMeta()?

optional tokenMeta(tokenAddr): Promise<TokenMeta>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:140

Optional. CLIs/UIs feature-check before calling.

Parameters

Parameter	Type
tokenAddr	EvmAddress

Returns

Promise<TokenMeta>

---

waitTxReceipt()?

optional waitTxReceipt(txHash, confirmations?): Promise<{
  blockNumber: number;
  status: number;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:161

Returns block number + receipt status (1 = success, 0 = revert).

Parameters

Parameter	Type
txHash	Hex32
confirmations?	number

Returns

Promise<{ blockNumber: number; status: number; }>

---

wrapNative()?

optional wrapNative(wethAddr, value): Promise<{
  txHash: Hex32;
}>;

Defined in: @lelantos-org/sdk/dist/chain/port.d.ts:151

WETH9.deposit{value}. Optional.

Parameters

Parameter	Type
wethAddr	EvmAddress
value	bigint

Returns

Promise<{ txHash: Hex32; }>