@secretkeylabs/stacks-tools 0.8.0 → 0.9.0-3bdb7d7

package/dist/index.d.cts

@@ -55,18 +55,18 @@ declare function flatResults<T>(results: Array<Result$1<T>>): Result$1<Array<T>>
  */
 declare function safeExtractResponseBody(response: Response): Promise<unknown>;
 
-type Args$n = {
+type Args$o = {
     transactionId: string;
 } & ApiRequestOptions;
-type Response$8 = OperationResponse["get_raw_transaction_by_id"];
-declare function getRawTransaction(args: Args$n): Promise<Result$1<Response$8>>;
+type Response$9 = OperationResponse["get_raw_transaction_by_id"];
+declare function getRawTransaction(args: Args$o): Promise<Result$1<Response$9>>;
 
 declare const getRawTransaction$1_getRawTransaction: typeof getRawTransaction;
 declare namespace getRawTransaction$1 {
-  export { type Args$n as Args, type Response$8 as Response, getRawTransaction$1_getRawTransaction as getRawTransaction };
+  export { type Args$o as Args, type Response$9 as Response, getRawTransaction$1_getRawTransaction as getRawTransaction };
 }
 
-type Args$m = {
+type Args$n = {
     /**
      * Filter to only return transactions with this sender address.
      */
@@ -91,7 +91,7 @@ type Args$m = {
     order?: "asc" | "desc";
 } & ApiRequestOptions & ApiPaginationOptions;
 type MempoolTransactionsResponse = OperationResponse["/extended/v1/tx/mempool"];
-declare function mempoolTransactions(args: Args$m): Promise<Result$1<MempoolTransactionsResponse, SafeError<"FetchMempoolTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function mempoolTransactions(args: Args$n): Promise<Result$1<MempoolTransactionsResponse, SafeError<"FetchMempoolTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type mempoolTransactions$1_MempoolTransactionsResponse = MempoolTransactionsResponse;
 declare const mempoolTransactions$1_mempoolTransactions: typeof mempoolTransactions;
@@ -99,34 +99,34 @@ declare namespace mempoolTransactions$1 {
   export { type mempoolTransactions$1_MempoolTransactionsResponse as MempoolTransactionsResponse, mempoolTransactions$1_mempoolTransactions as mempoolTransactions };
 }
 
-type Args$l = {
+type Args$m = {
     transactionId: string;
 } & ApiRequestOptions;
-type Response$7 = OperationResponse["get_transaction_by_id"];
-declare function getTransaction(args: Args$l): Promise<Result$1<Response$7>>;
+type Response$8 = OperationResponse["get_transaction_by_id"];
+declare function getTransaction(args: Args$m): Promise<Result$1<Response$8>>;
 
 declare const getTransaction$1_getTransaction: typeof getTransaction;
 declare namespace getTransaction$1 {
   export { getTransaction$1_getTransaction as getTransaction };
 }
 
-type Args$k = {
+type Args$l = {
     address: string;
     transactionId: string;
 } & ApiRequestOptions & ApiPaginationOptions;
-type Response$6 = OperationResponse["/extended/v2/addresses/{address}/transactions/{tx_id}/events"];
-declare function eventsForAnAddressTransaction(args: Args$k): Promise<Result$1<Response$6>>;
+type Response$7 = OperationResponse["/extended/v2/addresses/{address}/transactions/{tx_id}/events"];
+declare function eventsForAnAddressTransaction(args: Args$l): Promise<Result$1<Response$7>>;
 
 declare const eventsForAnAddressTransaction$1_eventsForAnAddressTransaction: typeof eventsForAnAddressTransaction;
 declare namespace eventsForAnAddressTransaction$1 {
   export { eventsForAnAddressTransaction$1_eventsForAnAddressTransaction as eventsForAnAddressTransaction };
 }
 
-type Args$j = {
+type Args$k = {
     address: string;
 } & ApiRequestOptions & ApiPaginationOptions;
 type Result = OperationResponse["/extended/v2/addresses/{address}/transactions"];
-declare function addressTransactions(args: Args$j): Promise<Result$1<Result, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function addressTransactions(args: Args$k): Promise<Result$1<Result, SafeError<"FetchAddressTransactionsError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type addressTransactions$1_Result = Result;
 declare const addressTransactions$1_addressTransactions: typeof addressTransactions;
@@ -134,34 +134,34 @@ declare namespace addressTransactions$1 {
   export { type addressTransactions$1_Result as Result, addressTransactions$1_addressTransactions as addressTransactions };
 }
 
-type Args$i = {
+type Args$j = {
     poolPrincipal: string;
     afterBlock?: string | number | bigint;
     unanchored?: boolean;
     limit?: number;
     offset?: number;
 } & ApiRequestOptions & ApiPaginationOptions;
-type Response$5 = OperationResponse["get_pool_delegations"];
-declare function members(args: Args$i): Promise<Result$1<Response$5>>;
+type Response$6 = OperationResponse["get_pool_delegations"];
+declare function members(args: Args$j): Promise<Result$1<Response$6>>;
 
 declare const members$1_members: typeof members;
 declare namespace members$1 {
-  export { type Args$i as Args, type Response$5 as Response, members$1_members as members };
+  export { type Args$j as Args, type Response$6 as Response, members$1_members as members };
 }
 
-type Args$h = {
+type Args$i = {
     cycleNumber: string | number | bigint;
     signerPublicKey: string;
 } & ApiRequestOptions & ApiPaginationOptions;
-type Response$4 = OperationResponse["get_pox_cycle_signer_stackers"];
-declare function stackersForSignerInCycle(opts: Args$h): Promise<Result$1<Response$4, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError">>>;
+type Response$5 = OperationResponse["get_pox_cycle_signer_stackers"];
+declare function stackersForSignerInCycle(opts: Args$i): Promise<Result$1<Response$5, SafeError<"FetchStackersForSignerInCycleError" | "ParseBodyError">>>;
 
 declare const stackersForSignerInCycle$1_stackersForSignerInCycle: typeof stackersForSignerInCycle;
 declare namespace stackersForSignerInCycle$1 {
-  export { type Args$h as Args, type Response$4 as Response, stackersForSignerInCycle$1_stackersForSignerInCycle as stackersForSignerInCycle };
+  export { type Args$i as Args, type Response$5 as Response, stackersForSignerInCycle$1_stackersForSignerInCycle as stackersForSignerInCycle };
 }
 
-type Args$g = {
+type Args$h = {
     cycleNumber: number;
 } & ApiRequestOptions & ApiPaginationOptions;
 declare const signerSchema: v.ObjectSchema<{
@@ -202,7 +202,7 @@ declare const signersResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type SignersResponse = v.InferOutput<typeof signersResponseSchema>;
-declare function signersInCycle(args: Args$g): Promise<Result$1<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
+declare function signersInCycle(args: Args$h): Promise<Result$1<SignersResponse, SafeError<"FetchSignersError" | "ParseBodyError" | "ValidateDataError">>>;
 
 type signersInCycle$1_Signer = Signer;
 type signersInCycle$1_SignersResponse = SignersResponse;
@@ -210,10 +210,10 @@ declare const signersInCycle$1_signerSchema: typeof signerSchema;
 declare const signersInCycle$1_signersInCycle: typeof signersInCycle;
 declare const signersInCycle$1_signersResponseSchema: typeof signersResponseSchema;
 declare namespace signersInCycle$1 {
-  export { type Args$g as Args, type Results$1 as Results, type signersInCycle$1_Signer as Signer, type signersInCycle$1_SignersResponse as SignersResponse, resultsSchema$1 as resultsSchema, signersInCycle$1_signerSchema as signerSchema, signersInCycle$1_signersInCycle as signersInCycle, signersInCycle$1_signersResponseSchema as signersResponseSchema };
+  export { type Args$h as Args, type Results$1 as Results, type signersInCycle$1_Signer as Signer, type signersInCycle$1_SignersResponse as SignersResponse, resultsSchema$1 as resultsSchema, signersInCycle$1_signerSchema as signerSchema, signersInCycle$1_signersInCycle as signersInCycle, signersInCycle$1_signersResponseSchema as signersResponseSchema };
 }
 
-type Args$f = {
+type Args$g = {
     /**
      * The signers public key as a hex string, with or without a '0x' prefix.
      */
@@ -231,16 +231,16 @@ declare const signerInCycleResponseSchema: v.ObjectSchema<{
     readonly pooled_stacker_count: v.NumberSchema<undefined>;
 }, undefined>;
 type SignerInCycleResponse = v.InferOutput<typeof signerInCycleResponseSchema>;
-declare function signerInCycle(args: Args$f): Promise<Result$1<SignerInCycleResponse>>;
+declare function signerInCycle(args: Args$g): Promise<Result$1<SignerInCycleResponse>>;
 
 type signerInCycle$1_SignerInCycleResponse = SignerInCycleResponse;
 declare const signerInCycle$1_signerInCycle: typeof signerInCycle;
 declare const signerInCycle$1_signerInCycleResponseSchema: typeof signerInCycleResponseSchema;
 declare namespace signerInCycle$1 {
-  export { type Args$f as Args, type signerInCycle$1_SignerInCycleResponse as SignerInCycleResponse, signerInCycle$1_signerInCycle as signerInCycle, signerInCycle$1_signerInCycleResponseSchema as signerInCycleResponseSchema };
+  export { type Args$g as Args, type signerInCycle$1_SignerInCycleResponse as SignerInCycleResponse, signerInCycle$1_signerInCycle as signerInCycle, signerInCycle$1_signerInCycleResponseSchema as signerInCycleResponseSchema };
 }
 
-type Args$e = ApiRequestOptions & ApiPaginationOptions;
+type Args$f = ApiRequestOptions & ApiPaginationOptions;
 declare const cycleInfoSchema: v.ObjectSchema<{
     readonly block_height: v.NumberSchema<undefined>;
     readonly index_block_hash: v.StringSchema<undefined>;
@@ -273,7 +273,7 @@ declare const cyclesResponseSchema: v.ObjectSchema<{
     readonly total: v.NumberSchema<undefined>;
 }, undefined>;
 type CyclesResponse = v.InferOutput<typeof cyclesResponseSchema>;
-declare function cycles(args: Args$e): Promise<Result$1<CyclesResponse>>;
+declare function cycles(args: Args$f): Promise<Result$1<CyclesResponse>>;
 
 type cycles$1_CycleInfo = CycleInfo;
 type cycles$1_CyclesResponse = CyclesResponse;
@@ -283,13 +283,13 @@ declare const cycles$1_cycles: typeof cycles;
 declare const cycles$1_cyclesResponseSchema: typeof cyclesResponseSchema;
 declare const cycles$1_resultsSchema: typeof resultsSchema;
 declare namespace cycles$1 {
-  export { type Args$e as Args, type cycles$1_CycleInfo as CycleInfo, type cycles$1_CyclesResponse as CyclesResponse, type cycles$1_Results as Results, cycles$1_cycleInfoSchema as cycleInfoSchema, cycles$1_cycles as cycles, cycles$1_cyclesResponseSchema as cyclesResponseSchema, cycles$1_resultsSchema as resultsSchema };
+  export { type Args$f as Args, type cycles$1_CycleInfo as CycleInfo, type cycles$1_CyclesResponse as CyclesResponse, type cycles$1_Results as Results, cycles$1_cycleInfoSchema as cycleInfoSchema, cycles$1_cycles as cycles, cycles$1_cyclesResponseSchema as cyclesResponseSchema, cycles$1_resultsSchema as resultsSchema };
 }
 
-type Args$d = {
+type Args$e = {
     cycleNumber: number;
 } & ApiRequestOptions;
-declare const responseSchema$2: v.ObjectSchema<{
+declare const responseSchema$1: v.ObjectSchema<{
     readonly block_height: v.NumberSchema<undefined>;
     readonly index_block_hash: v.StringSchema<undefined>;
     readonly cycle_number: v.NumberSchema<undefined>;
@@ -297,12 +297,12 @@ declare const responseSchema$2: v.ObjectSchema<{
     readonly total_stacked_amount: v.StringSchema<undefined>;
     readonly total_signers: v.NumberSchema<undefined>;
 }, undefined>;
-type Response$3 = v.InferOutput<typeof responseSchema$2>;
-declare function cycle(opts: Args$d): Promise<Result$1<Response$3, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
+type Response$4 = v.InferOutput<typeof responseSchema$1>;
+declare function cycle(opts: Args$e): Promise<Result$1<Response$4, SafeError<"FetchCycleError" | "ParseBodyError" | "ValidateDataError">>>;
 
 declare const cycle$1_cycle: typeof cycle;
 declare namespace cycle$1 {
-  export { type Args$d as Args, type Response$3 as Response, cycle$1_cycle as cycle, responseSchema$2 as responseSchema };
+  export { type Args$e as Args, type Response$4 as Response, cycle$1_cycle as cycle, responseSchema$1 as responseSchema };
 }
 
 type FeePrioritiesResponse = {
@@ -364,47 +364,37 @@ declare namespace coreApi$1 {
   export { type coreApi$1_CoreApiResponse as CoreApiResponse, coreApi$1_coreApi as coreApi };
 }
 
-type Args$c = {
+type Args$d = {
     address: string;
     stacking?: boolean;
 } & ApiRequestOptions;
-declare function stx(opts: Args$c): Promise<Result$1<any>>;
+declare function stx(opts: Args$d): Promise<Result$1<any>>;
 
 declare const stx$1_stx: typeof stx;
 declare namespace stx$1 {
-  export { type Args$c as Args, stx$1_stx as stx };
+  export { type Args$d as Args, stx$1_stx as stx };
+}
+
+type Args$c = {
+    heightOrHash: string | number | bigint;
+} & ApiRequestOptions;
+type Response$3 = OperationResponse["get_burn_block"];
+declare function getBurnBlock(args: Args$c): Promise<Result$1<Response$3>>;
+
+declare const getBurnBlock$1_getBurnBlock: typeof getBurnBlock;
+declare namespace getBurnBlock$1 {
+  export { type Args$c as Args, type Response$3 as Response, getBurnBlock$1_getBurnBlock as getBurnBlock };
 }
 
 type Args$b = {
     heightOrHash: string | number;
 } & ApiRequestOptions;
-declare const responseSchema$1: v.ObjectSchema<{
-    readonly canonical: v.BooleanSchema<undefined>;
-    readonly height: v.NumberSchema<undefined>;
-    readonly hash: v.StringSchema<undefined>;
-    readonly block_time: v.NumberSchema<undefined>;
-    readonly block_time_iso: v.StringSchema<undefined>;
-    readonly index_block_hash: v.StringSchema<undefined>;
-    readonly parent_block_hash: v.StringSchema<undefined>;
-    readonly parent_index_block_hash: v.StringSchema<undefined>;
-    readonly burn_block_time: v.NumberSchema<undefined>;
-    readonly burn_block_time_iso: v.StringSchema<undefined>;
-    readonly burn_block_hash: v.StringSchema<undefined>;
-    readonly burn_block_height: v.NumberSchema<undefined>;
-    readonly miner_txid: v.StringSchema<undefined>;
-    readonly tx_count: v.NumberSchema<undefined>;
-    readonly execution_cost_read_count: v.NumberSchema<undefined>;
-    readonly execution_cost_read_length: v.NumberSchema<undefined>;
-    readonly execution_cost_runtime: v.NumberSchema<undefined>;
-    readonly execution_cost_write_count: v.NumberSchema<undefined>;
-    readonly execution_cost_write_length: v.NumberSchema<undefined>;
-}, undefined>;
-type Response$2 = v.InferOutput<typeof responseSchema$1>;
-declare function getBlock(opts: Args$b): Promise<Result$1<Response$2, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;
+type Response$2 = OperationResponse["get_block"];
+declare function getBlock(opts: Args$b): Promise<Result$1<Response$2>>;
 
 declare const getBlock$1_getBlock: typeof getBlock;
 declare namespace getBlock$1 {
-  export { type Args$b as Args, type Response$2 as Response, getBlock$1_getBlock as getBlock, responseSchema$1 as responseSchema };
+  export { type Args$b as Args, type Response$2 as Response, getBlock$1_getBlock as getBlock };
 }
 
 type Args$a = {
@@ -443,7 +433,7 @@ declare const accounts$1: {
     latestNonce: typeof latestNonce;
 };
 
-declare namespace index$f {
+declare namespace index$g {
   export { balances$1 as Balances, latestNonce$1 as LatestNonce, accounts$1 as accounts };
 }
 
@@ -451,9 +441,18 @@ declare const blocks: {
     getBlock: typeof getBlock;
 };
 
-declare const index$e_blocks: typeof blocks;
+declare const index$f_blocks: typeof blocks;
+declare namespace index$f {
+  export { getBlock$1 as GetBlock, index$f_blocks as blocks };
+}
+
+declare const burnBlocks: {
+    getBurnBlock: typeof getBurnBlock;
+};
+
+declare const index$e_burnBlocks: typeof burnBlocks;
 declare namespace index$e {
-  export { getBlock$1 as GetBlock, index$e_blocks as blocks };
+  export { getBurnBlock$1 as GetBurnBlock, index$e_burnBlocks as burnBlocks };
 }
 
 declare const faucets: {
@@ -525,6 +524,9 @@ declare const stacksApi: {
     blocks: {
         getBlock: typeof getBlock;
     };
+    burnBlocks: {
+        getBurnBlock: typeof getBurnBlock;
+    };
     faucets: {
         stx: typeof stx;
     };
@@ -555,7 +557,7 @@ declare const stacksApi: {
 
 declare const index$7_stacksApi: typeof stacksApi;
 declare namespace index$7 {
-  export { index$f as Accounts, index$e as Blocks, index$d as Faucets, index$c as Info, index$8 as Mempool, index$b as ProofOfTransfer, index$a as StackingPool, index$9 as Transactions, index$7_stacksApi as stacksApi };
+  export { index$g as Accounts, index$f as Blocks, index$e as BurnBlocks, index$d as Faucets, index$c as Info, index$8 as Mempool, index$b as ProofOfTransfer, index$a as StackingPool, index$9 as Transactions, index$7_stacksApi as stacksApi };
 }
 
 type Args$8 = {
@@ -792,22 +794,8 @@ type InfoResponse = {
     balance_proof: string;
     nonce_proof: string;
 };
-type InfoReturn = Promise<InfoResponse>;
-declare const info: (args: Args$4) => Promise<[null, unknown] | [{
-    readonly name: "InfoFetchError";
-    readonly message: "Failed to fetch info.";
-    readonly data: {
-        readonly init: RequestInit;
-        readonly status: number;
-        readonly statusText: string;
-        readonly endpoint: string;
-        readonly body: unknown;
-    };
-}, null] | [{
-    readonly name: "ParseBodyError";
-    readonly message: "Failed to parse response body as JSON.";
-    readonly data: SafeError<"SafeError", unknown>;
-}, null]>;
+type InfoReturn = Promise<Result$1<InfoResponse>>;
+declare const info: (args: Args$4) => InfoReturn;
 
 type info$1_InfoResponse = InfoResponse;
 type info$1_InfoReturn = InfoReturn;
@@ -837,21 +825,7 @@ declare namespace index$5 {
 }
 
 declare const accounts: {
-    info: (args: Args$4) => Promise<[null, unknown] | [{
-        readonly name: "InfoFetchError";
-        readonly message: "Failed to fetch info.";
-        readonly data: {
-            readonly init: RequestInit;
-            readonly status: number;
-            readonly statusText: string;
-            readonly endpoint: string;
-            readonly body: unknown;
-        };
-    }, null] | [{
-        readonly name: "ParseBodyError";
-        readonly message: "Failed to parse response body as JSON.";
-        readonly data: SafeError<"SafeError", unknown>;
-    }, null]>;
+    info: (args: Args$4) => InfoReturn;
 };
 
 declare const index$4_accounts: typeof accounts;
@@ -861,21 +835,7 @@ declare namespace index$4 {
 
 declare const stacksRpcApi: {
     accounts: {
-        info: (args: Args$4) => Promise<[null, unknown] | [{
-            readonly name: "InfoFetchError";
-            readonly message: "Failed to fetch info.";
-            readonly data: {
-                readonly init: RequestInit;
-                readonly status: number;
-                readonly statusText: string;
-                readonly endpoint: string;
-                readonly body: unknown;
-            };
-        }, null] | [{
-            readonly name: "ParseBodyError";
-            readonly message: "Failed to parse response body as JSON.";
-            readonly data: SafeError<"SafeError", unknown>;
-        }, null]>;
+        info: (args: Args$4) => InfoReturn;
     };
     pox: {
         poxDetails: typeof poxDetails;