@secondlayer/sdk 6.44.0 → 6.45.0

package/dist/index.d.ts

@@ -1166,6 +1166,7 @@ type IndexUsage = {
 type FtTransfer = {
 	cursor: string
 	block_height: number
+	block_time?: string | null
 	tx_id: string
 	tx_index: number
 	event_index: number
@@ -1176,13 +1177,25 @@ type FtTransfer = {
 	recipient: string
 	amount: string
 };
-type FtTransfersEnvelope = {
-	events: FtTransfer[]
+type FtTransfersEnvelope<TRow = FtTransfer> = {
+	events: TRow[]
 	next_cursor: string | null
 	tip: IndexTip
 	reorgs: IndexReorg[]
 };
+/** Transfer columns that survive any projection — the consume contract
+*  (`cursor`, `block_height`) plus the `event_type` discriminant. */
+type FtTransferAlwaysFields = "cursor" | "block_height" | "event_type";
+/** An ft-transfer row narrowed to the requested columns plus the always-present ones. */
+type FtTransferFields<F extends keyof FtTransfer & string> = Pick<FtTransfer, (F | FtTransferAlwaysFields) & keyof FtTransfer>;
 type FtTransfersListParams = {
+	/**
+	* Columns to return. The server projects the row, so an unrequested column
+	* is physically absent — and the narrowing overload on `list` makes reading
+	* one a compile error rather than `undefined` at runtime. Omitting
+	* `block_time` also lets the server skip the blocks join.
+	*/
+	fields?: readonly (keyof FtTransfer & string)[]
 	cursor?: string | null
 	fromCursor?: string | null
 	limit?: number
@@ -1199,6 +1212,7 @@ type FtTransfersWalkParams = Omit<FtTransfersListParams, "limit"> & {
 type NftTransfer = {
 	cursor: string
 	block_height: number
+	block_time?: string | null
 	tx_id: string
 	tx_index: number
 	event_index: number
@@ -1209,13 +1223,19 @@ type NftTransfer = {
 	recipient: string
 	value: string
 };
-type NftTransfersEnvelope = {
-	events: NftTransfer[]
+type NftTransfersEnvelope<TRow = NftTransfer> = {
+	events: TRow[]
 	next_cursor: string | null
 	tip: IndexTip
 	reorgs: IndexReorg[]
 };
+/** See {@link FtTransferAlwaysFields}. */
+type NftTransferAlwaysFields = "cursor" | "block_height" | "event_type";
+/** An nft-transfer row narrowed to the requested columns plus the always-present ones. */
+type NftTransferFields<F extends keyof NftTransfer & string> = Pick<NftTransfer, (F | NftTransferAlwaysFields) & keyof NftTransfer>;
 type NftTransfersListParams = {
+	/** Columns to return (see {@link FtTransfersListParams.fields}). */
+	fields?: readonly (keyof NftTransfer & string)[]
 	cursor?: string | null
 	fromCursor?: string | null
 	limit?: number
@@ -2125,14 +2145,44 @@ interface Pox5Resource {
 * no amount filtering and no asset-slug resolution on /v1/index/ft-transfers.
 */
 interface FtTransfersResource {
+	/** Narrowing overload for the callable shorthand — same wire path as
+	*  `list`, so it must narrow identically. */
+	<const F extends keyof FtTransfer & string>(params: FtTransfersListParams & {
+		fields: readonly F[]
+	}): Promise<FtTransfersEnvelope<FtTransferFields<F>>>;
 	(params?: FtTransfersListParams): Promise<FtTransfersEnvelope>;
+	/** Narrowing overload: `fields` shrinks the row type to exactly the
+	*  requested columns plus {@link FtTransferAlwaysFields}. */
+	list<const F extends keyof FtTransfer & string>(params: FtTransfersListParams & {
+		fields: readonly F[]
+	}): Promise<FtTransfersEnvelope<FtTransferFields<F>>>;
 	list(params?: FtTransfersListParams): Promise<FtTransfersEnvelope>;
+	/** Narrowing overload, matching `list`: `walk` forwards `fields` to the
+	*  wire, so without this the yielded rows are stripped while the type
+	*  still promises every column. */
+	walk<const F extends keyof FtTransfer & string>(params: FtTransfersWalkParams & {
+		fields: readonly F[]
+	}): AsyncIterable<FtTransferFields<F>>;
 	walk(params?: FtTransfersWalkParams): AsyncIterable<FtTransfer>;
 }
 /** `index.nftTransfers` — callable shorthand for `.list()` (see {@link FtTransfersResource}). */
 interface NftTransfersResource {
+	/** Narrowing overload for the callable shorthand — same wire path as
+	*  `list`, so it must narrow identically. */
+	<const F extends keyof NftTransfer & string>(params: NftTransfersListParams & {
+		fields: readonly F[]
+	}): Promise<NftTransfersEnvelope<NftTransferFields<F>>>;
 	(params?: NftTransfersListParams): Promise<NftTransfersEnvelope>;
+	/** Narrowing overload: `fields` shrinks the row type to exactly the
+	*  requested columns plus {@link NftTransferAlwaysFields}. */
+	list<const F extends keyof NftTransfer & string>(params: NftTransfersListParams & {
+		fields: readonly F[]
+	}): Promise<NftTransfersEnvelope<NftTransferFields<F>>>;
 	list(params?: NftTransfersListParams): Promise<NftTransfersEnvelope>;
+	/** Narrowing overload, matching `list` (see {@link FtTransfersResource}). */
+	walk<const F extends keyof NftTransfer & string>(params: NftTransfersWalkParams & {
+		fields: readonly F[]
+	}): AsyncIterable<NftTransferFields<F>>;
 	walk(params?: NftTransfersWalkParams): AsyncIterable<NftTransfer>;
 }
 /** `index.events` — callable shorthand for `.list()`; `eventType` is required. */

package/dist/index.js

@@ -1061,7 +1061,8 @@ class Index extends BaseClient {
       sender: params.sender,
       recipient: params.recipient,
       from_height: params.fromHeight,
-      to_height: params.toHeight
+      to_height: params.toHeight,
+      fields: params.fields?.join(",")
     })}`);
   }
   async listNftTransfers(params = {}) {
@@ -1074,7 +1075,8 @@ class Index extends BaseClient {
       sender: params.sender,
       recipient: params.recipient,
       from_height: params.fromHeight,
-      to_height: params.toHeight
+      to_height: params.toHeight,
+      fields: params.fields?.join(",")
     })}`);
   }
   async* keysetWalk(params, list, itemsOf) {
@@ -2884,5 +2886,5 @@ export {
   ApiError
 };
 
-//# debugId=2212082A9E39DB7664756E2164756E21
+//# debugId=798F8DCB6A6B9EBD64756E2164756E21
 //# sourceMappingURL=index.js.map