@lelantos-org/sdk / services / DepositStream

Class: DepositStream

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:73

Subscription to one chain's deposit events.

The source opens on construction and stays open: the relayer heartbeats to hold it through proxies, and the browser reconnects across transient drops. Call close when the wallet goes away.

const stream = new DepositStream(relayerUrl, 31337n);
const wait = await stream.awaitFlush(depositId, { signal });
if (wait.kind === "flushed") console.log(wait.txHash);

Indexable

[key: number]: () => void

Constructors

Constructor

new DepositStream(
   baseUrl, 
   chainId, 
   opts?
): DepositStream;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:84

Parameters

Parameter	Type
baseUrl	string
chainId	bigint
opts?	DepositStreamOptions

Returns

DepositStream

Accessors

isClosed

Get Signature

get isClosed(): boolean;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:86

True once the feed can no longer deliver events.

Returns

boolean

Methods

awaitFlush()

awaitFlush(depositId, opts?): Promise<FlushWait>;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:100

Wait for depositId to be flushed.

Buffered events are matched first, so a relayer that flushed before this call is still observed. Never rejects; see FlushWait.

Parameters

Parameter	Type
depositId	bigint
opts?	{ signal?: AbortSignal; }
opts.signal?	AbortSignal

Returns

Promise<FlushWait>

---

close()

close(): void;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:104

Release the source. Pending waiters settle as closed.

Returns

void

---

subscribe()

subscribe(listener): () => void;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:93

Observe every event from now on. Returns an unsubscribe function.

A no-op once closed: the listener set is already cleared, so a listener added then could never fire.

Parameters

Parameter	Type
listener	(ev) => void

Returns

() => void