@lelantos-org/sdk / services / RelayerClient

Class: RelayerClient

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:9

HTTP client for the relayer wire protocol. A relayer service implementing the protocol must match these shapes.

Constructors

Constructor

new RelayerClient(baseUrl, opts?): RelayerClient;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:11

Parameters

Parameter	Type
baseUrl	string
opts?	HttpClientOptions

Returns

RelayerClient

Methods

estimateDeposit()

estimateDeposit(chainId): Promise<EstimateResponse>;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:42

What the relayer charges to flush a deposit: a deposit is not relayed at submit time, so this recovers the cost of the flushBatch the relayer later proves and broadcasts.

Parameters

Parameter	Type
chainId	number | bigint

Returns

Promise<EstimateResponse>

---

estimateGeneric()

estimateGeneric(chainId, minGas): Promise<EstimateResponse>;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:36

What the relayer charges for a GenericCallWrapper execution whose call leg is forwarded minGas: the wrapper's own gas plus that floor.

Parameters

Parameter	Type
chainId	number | bigint
minGas	bigint

Returns

Promise<EstimateResponse>

---

estimateSpend()

estimateSpend(chainId, kind): Promise<EstimateResponse>;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:30

What this relayer charges to relay a spend of kind.

A function of (chainId, kind) alone. It takes neither a payload nor a proof, so an estimate for a spend the user may never send reveals no nullifiers.

The quote is advisory: it is not signed, and the relayer re-derives the requirement when the spend arrives. Pay at least RelayerFeeQuote.circuitAmount; the relayer's graceBps absorbs drift in between.

Parameters

Parameter	Type
chainId	number | bigint
kind	SpendKind

Returns

Promise<EstimateResponse>

---

estimateSwap()

estimateSwap(chainId): Promise<EstimateResponse>;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:31

Parameters

Parameter	Type
chainId	number | bigint

Returns

Promise<EstimateResponse>

---

getChains()

getChains(): Promise<ChainsResponse>;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:18

The chain registry a client boots from: ids, contract addresses, the asset table, and the shielded fee terms where a relayer charges one. Carries no per-user data, so it is cacheable and identical for every caller.

Returns

Promise<ChainsResponse>

---

submitGeneric()

submitGeneric(payload): Promise<RelayerSubmitResponse>;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:45

Parameters

Parameter	Type
payload	SubmitGenericPayload

Returns

Promise<RelayerSubmitResponse>

---

submitSwap()

submitSwap(payload): Promise<RelayerSubmitResponse>;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:44

Parameters

Parameter	Type
payload	SubmitSwapPayload

Returns

Promise<RelayerSubmitResponse>

---

submitTransact()

submitTransact(payload): Promise<RelayerSubmitResponse>;

Defined in: @lelantos-org/sdk/dist/services/relayer/client.d.ts:43

Parameters

Parameter	Type
payload	SubmitTransactPayload

Returns

Promise<RelayerSubmitResponse>