@secondlayer/sdk 6.27.2 → 6.28.1

package/dist/index.d.ts

@@ -1450,6 +1450,9 @@ type IndexSbtcWithdrawal = {
 	recipient_btc_version: number | null
 	recipient_btc_hashbytes: string | null
 	sweep_txid: string | null
+	/** BTC L1 settlement of the committed sweep: true once confirmed, false while
+	*  pending, null when there is no sweep yet (REQUESTED). */
+	settlement_confirmed: boolean | null
 	requested_at?: string | null
 	resolved_at?: string | null
 };
@@ -1478,6 +1481,10 @@ type IndexSbtcWithdrawalDetail = {
 		sweep_txid: string | null
 		btc_confirmations: number | null
 		settlement_confirmed: boolean | null
+		/** Confirming Bitcoin block height; null until the sweep confirms. */
+		btc_block_height: number | null
+		/** ISO timestamp the sweep first crossed the confirmation threshold. */
+		confirmed_at: string | null
 	}
 	finalized: boolean
 };
@@ -1579,6 +1586,9 @@ type SbtcWithdrawalsListParams = {
 	status?: SbtcWithdrawalStatus
 	sender?: string
 	requestId?: number
+	/** Filter by BTC L1 settlement: true → only confirmed sweeps; false → not
+	*  yet confirmed (pending or no sweep). */
+	settlementConfirmed?: boolean
 	fromHeight?: number
 	toHeight?: number
 };
@@ -1791,6 +1801,12 @@ declare class Index extends BaseClient {
 	readonly pox: PoxResource;
 	private listFtTransfers;
 	private listNftTransfers;
+	/** Shared keyset-pagination loop for every `walk*` feed: seed the cursor from
+	*  `cursor`/`fromCursor` (and `fromHeight` 0 on the first page), then page until
+	*  the cursor stops advancing or a short page signals the tail. `list` merges the
+	*  resource's filter params; `itemsOf` selects the envelope's item array. PoX
+	*  cycles use a numeric cursor and are walked separately. */
+	private keysetWalk;
 	private walkFtTransfers;
 	private walkNftTransfers;
 	private listEvents;

package/dist/index.js

@@ -835,55 +835,36 @@ class Index extends BaseClient {
       to_height: params.toHeight
     })}`);
   }
-  async* walkFtTransfers(params = {}) {
+  async* keysetWalk(params, list, itemsOf) {
     const batchSize = params.batchSize ?? 200;
     let cursor = params.cursor ?? params.fromCursor ?? null;
     let firstPage = true;
     while (!params.signal?.aborted) {
-      const envelope = await this.listFtTransfers({
-        ...params,
+      const envelope = await list({
         limit: batchSize,
         cursor: firstPage ? params.cursor : cursor,
         fromCursor: firstPage ? params.fromCursor : undefined,
         fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
       });
-      for (const event of envelope.events) {
+      const items = itemsOf(envelope);
+      for (const item of items) {
         if (params.signal?.aborted)
           return;
-        yield event;
+        yield item;
       }
       const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.events.length < batchSize) {
+      if (!nextCursor || nextCursor === cursor || items.length < batchSize) {
         return;
       }
       cursor = nextCursor;
       firstPage = false;
     }
   }
-  async* walkNftTransfers(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listNftTransfers({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const event of envelope.events) {
-        if (params.signal?.aborted)
-          return;
-        yield event;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.events.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkFtTransfers(params = {}) {
+    return this.keysetWalk(params, (page) => this.listFtTransfers({ ...params, ...page }), (e) => e.events);
+  }
+  walkNftTransfers(params = {}) {
+    return this.keysetWalk(params, (page) => this.listNftTransfers({ ...params, ...page }), (e) => e.events);
   }
   async listEvents(params) {
     return this.request("GET", `/v1/index/events${buildQuery({
@@ -901,30 +882,8 @@ class Index extends BaseClient {
       tx_context: params.txContext ? "true" : undefined
     })}`);
   }
-  async* walkEvents(params) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listEvents({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const event of envelope.events) {
-        if (params.signal?.aborted)
-          return;
-        yield event;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.events.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkEvents(params) {
+    return this.keysetWalk(params, (page) => this.listEvents({ ...params, ...page }), (e) => e.events);
   }
   async listContractCalls(params = {}) {
     return this.request("GET", `/v1/index/contract-calls${buildQuery({
@@ -939,30 +898,8 @@ class Index extends BaseClient {
       trait: params.trait
     })}`);
   }
-  async* walkContractCalls(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listContractCalls({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const call of envelope.contract_calls) {
-        if (params.signal?.aborted)
-          return;
-        yield call;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.contract_calls.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkContractCalls(params = {}) {
+    return this.keysetWalk(params, (page) => this.listContractCalls({ ...params, ...page }), (e) => e.contract_calls);
   }
   async listCanonical(params = {}) {
     return this.request("GET", `/v1/index/canonical${buildQuery({
@@ -973,30 +910,8 @@ class Index extends BaseClient {
       to_height: params.toHeight
     })}`);
   }
-  async* walkCanonical(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listCanonical({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const block of envelope.canonical) {
-        if (params.signal?.aborted)
-          return;
-        yield block;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.canonical.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkCanonical(params = {}) {
+    return this.keysetWalk(params, (page) => this.listCanonical({ ...params, ...page }), (e) => e.canonical);
   }
   async listBlocks(params = {}) {
     return this.request("GET", `/v1/index/blocks${buildQuery({
@@ -1010,30 +925,8 @@ class Index extends BaseClient {
   async getBlock(ref) {
     return this.requestOrNull("GET", `/v1/index/blocks/${encodeURIComponent(String(ref))}`);
   }
-  async* walkBlocks(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listBlocks({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const block of envelope.blocks) {
-        if (params.signal?.aborted)
-          return;
-        yield block;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.blocks.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkBlocks(params = {}) {
+    return this.keysetWalk(params, (page) => this.listBlocks({ ...params, ...page }), (e) => e.blocks);
   }
   async listTransactions(params = {}) {
     return this.request("GET", `/v1/index/transactions${buildQuery({
@@ -1053,30 +946,8 @@ class Index extends BaseClient {
   async getTransactionProof(txId) {
     return this.requestOrNull("GET", `/v1/index/transactions/${encodeURIComponent(txId)}/proof`);
   }
-  async* walkTransactions(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listTransactions({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const tx of envelope.transactions) {
-        if (params.signal?.aborted)
-          return;
-        yield tx;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.transactions.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkTransactions(params = {}) {
+    return this.keysetWalk(params, (page) => this.listTransactions({ ...params, ...page }), (e) => e.transactions);
   }
   async listStacking(params = {}) {
     return this.request("GET", `/v1/index/stacking${buildQuery({
@@ -1090,30 +961,8 @@ class Index extends BaseClient {
       to_height: params.toHeight
     })}`);
   }
-  async* walkStacking(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listStacking({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const action of envelope.stacking) {
-        if (params.signal?.aborted)
-          return;
-        yield action;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.stacking.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkStacking(params = {}) {
+    return this.keysetWalk(params, (page) => this.listStacking({ ...params, ...page }), (e) => e.stacking);
   }
   async listMempool(params = {}) {
     return this.request("GET", `/v1/index/mempool${buildQuery({
@@ -1128,29 +977,8 @@ class Index extends BaseClient {
   async getMempoolTx(txId) {
     return this.requestOrNull("GET", `/v1/index/mempool/${encodeURIComponent(txId)}`);
   }
-  async* walkMempool(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listMempool({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined
-      });
-      for (const tx of envelope.mempool) {
-        if (params.signal?.aborted)
-          return;
-        yield tx;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.mempool.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkMempool(params = {}) {
+    return this.keysetWalk(params, (page) => this.listMempool({ ...params, ...page }), (e) => e.mempool);
   }
   async listSbtcDeposits(params = {}) {
     return this.request("GET", `/v1/index/sbtc/deposits${buildQuery({
@@ -1164,30 +992,8 @@ class Index extends BaseClient {
       to_height: params.toHeight
     })}`);
   }
-  async* walkSbtcDeposits(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listSbtcDeposits({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const deposit of envelope.deposits) {
-        if (params.signal?.aborted)
-          return;
-        yield deposit;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.deposits.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkSbtcDeposits(params = {}) {
+    return this.keysetWalk(params, (page) => this.listSbtcDeposits({ ...params, ...page }), (e) => e.deposits);
   }
   async getSbtcDeposit(bitcoinTxid) {
     return this.requestOrNull("GET", `/v1/index/sbtc/deposits/${encodeURIComponent(bitcoinTxid)}`);
@@ -1201,34 +1007,13 @@ class Index extends BaseClient {
       status: params.status,
       sender: params.sender,
       request_id: params.requestId,
+      settlement_confirmed: params.settlementConfirmed,
       from_height: params.fromHeight,
       to_height: params.toHeight
     })}`);
   }
-  async* walkSbtcWithdrawals(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listSbtcWithdrawals({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const withdrawal of envelope.withdrawals) {
-        if (params.signal?.aborted)
-          return;
-        yield withdrawal;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.withdrawals.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkSbtcWithdrawals(params = {}) {
+    return this.keysetWalk(params, (page) => this.listSbtcWithdrawals({ ...params, ...page }), (e) => e.withdrawals);
   }
   async getSbtcWithdrawal(requestId) {
     return this.requestOrNull("GET", `/v1/index/sbtc/withdrawals/${requestId}`);
@@ -1247,30 +1032,8 @@ class Index extends BaseClient {
       to_height: params.toHeight
     })}`);
   }
-  async* walkSbtcEvents(params = {}) {
-    const batchSize = params.batchSize ?? 200;
-    let cursor = params.cursor ?? params.fromCursor ?? null;
-    let firstPage = true;
-    while (!params.signal?.aborted) {
-      const envelope = await this.listSbtcEvents({
-        ...params,
-        limit: batchSize,
-        cursor: firstPage ? params.cursor : cursor,
-        fromCursor: firstPage ? params.fromCursor : undefined,
-        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
-      });
-      for (const event of envelope.events) {
-        if (params.signal?.aborted)
-          return;
-        yield event;
-      }
-      const nextCursor = envelope.next_cursor;
-      if (!nextCursor || nextCursor === cursor || envelope.events.length < batchSize) {
-        return;
-      }
-      cursor = nextCursor;
-      firstPage = false;
-    }
+  walkSbtcEvents(params = {}) {
+    return this.keysetWalk(params, (page) => this.listSbtcEvents({ ...params, ...page }), (e) => e.events);
   }
   async getSbtcSummary() {
     return this.request("GET", "/v1/index/sbtc/summary");
@@ -2634,5 +2397,5 @@ export {
   ApiError
 };
 
-//# debugId=CD88F21B10F170CE64756E2164756E21
+//# debugId=A8092EB602106E7964756E2164756E21
 //# sourceMappingURL=index.js.map