@secretkeylabs/stacks-tools 0.1.0-77af370

package/README.md

@@ -0,0 +1,17 @@
+# stacks-tools
+
+A collection of methods for calling the Stacks API and managing Stacks pools.
+
+## Quickstart
+
+Install dependencies with
+
+```shell
+bun install
+```
+
+and build the package with
+
+```shell
+bun run build
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { stacksApi } from "./stacks-api/index.js";
+export { queries } from "./queries/index.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { stacksApi } from "./stacks-api/index.js";
+export { queries } from "./queries/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/pox4-api/burn-height-to-reward-cycle.d.ts

@@ -0,0 +1,7 @@
+import type { ApiRequestOptions } from "../stacks-api/types.js";
+import { type Result } from "../utils/safe.js";
+type Args = {
+    burnHeight: number;
+} & ApiRequestOptions;
+export declare function burnHeightToRewardCycle(_args: Args): Promise<Result<number>>;
+export {};

package/dist/pox4-api/burn-height-to-reward-cycle.js

@@ -0,0 +1,6 @@
+import { success } from "../utils/safe.js";
+export async function burnHeightToRewardCycle(_args) {
+    // TODO
+    return success(0);
+}
+//# sourceMappingURL=burn-height-to-reward-cycle.js.map

package/dist/pox4-api/burn-height-to-reward-cycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"burn-height-to-reward-cycle.js","sourceRoot":"","sources":["../../src/pox4-api/burn-height-to-reward-cycle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAe,MAAM,kBAAkB,CAAC;AAMxD,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,KAAW;IAEX,OAAO;IACP,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC"}

package/dist/pox4-api/current-pox-reward-cycle.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/pox4-api/current-pox-reward-cycle.js

@@ -0,0 +1,3 @@
+export {};
+// TODO
+//# sourceMappingURL=current-pox-reward-cycle.js.map

package/dist/pox4-api/current-pox-reward-cycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"current-pox-reward-cycle.js","sourceRoot":"","sources":["../../src/pox4-api/current-pox-reward-cycle.ts"],"names":[],"mappings":";AAAA,OAAO"}

package/dist/pox4-api/get-stacker-info.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/pox4-api/get-stacker-info.js

@@ -0,0 +1,3 @@
+export {};
+// TODO
+//# sourceMappingURL=get-stacker-info.js.map

package/dist/pox4-api/get-stacker-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-stacker-info.js","sourceRoot":"","sources":["../../src/pox4-api/get-stacker-info.ts"],"names":[],"mappings":";AAAA,OAAO"}

package/dist/pox4-api/reward-cycle-to-burn-height.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/pox4-api/reward-cycle-to-burn-height.js

@@ -0,0 +1,3 @@
+export {};
+// TODO
+//# sourceMappingURL=reward-cycle-to-burn-height.js.map

package/dist/pox4-api/reward-cycle-to-burn-height.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reward-cycle-to-burn-height.js","sourceRoot":"","sources":["../../src/pox4-api/reward-cycle-to-burn-height.ts"],"names":[],"mappings":";AAAA,OAAO"}

package/dist/queries/get-signer-total-locked.d.ts

@@ -0,0 +1,10 @@
+import type { ApiRequestOptions } from "../stacks-api/types.js";
+import { type Result, type SafeError } from "../utils/safe.js";
+export type Args = {
+    cycleNumber: number;
+    signerAddress: string;
+} & ApiRequestOptions;
+/**
+ * Return the total locked amount for a signer in a PoX cycle.
+ */
+export declare function getSignerTotalLocked(args: Args): Promise<Result<bigint, SafeError<"SignerNotFound" | string>>>;

package/dist/queries/get-signer-total-locked.js

@@ -0,0 +1,49 @@
+import { signersInCycle } from "../stacks-api/proof-of-transfer/signers-in-cycle.js";
+import { safeCallRateLimitedApi } from "../utils/call-rate-limited-api.js";
+import { error as safeError, success, } from "../utils/safe.js";
+/**
+ * Return the total locked amount for a signer in a PoX cycle.
+ */
+export async function getSignerTotalLocked(args) {
+    let totalLocked = 0n;
+    const { signerAddress, ...rest } = args;
+    let hasMore = true;
+    let offset = 0;
+    let found = false;
+    const limit = 200;
+    while (hasMore && !found) {
+        const [error, data] = await safeCallRateLimitedApi(() => signersInCycle({
+            ...rest,
+            limit,
+        }));
+        if (error) {
+            return safeError({
+                name: "GetSignerTotalLockedError",
+                message: "Failed to get signer total locked.",
+                data: {
+                    error,
+                },
+            });
+        }
+        for (const signer of data.results) {
+            if (signer.signer_address === signerAddress) {
+                totalLocked = BigInt(signer.stacked_amount);
+                found = true;
+                break;
+            }
+        }
+        offset += limit + data.results.length;
+        hasMore = offset < data.total;
+    }
+    if (!found) {
+        return safeError({
+            name: "SignerNotFound",
+            message: "Signer not found.",
+            data: {
+                signerAddress,
+            },
+        });
+    }
+    return success(totalLocked);
+}
+//# sourceMappingURL=get-signer-total-locked.js.map

package/dist/queries/get-signer-total-locked.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-signer-total-locked.js","sourceRoot":"","sources":["../../src/queries/get-signer-total-locked.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qDAAqD,CAAC;AAErF,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EACL,KAAK,IAAI,SAAS,EAClB,OAAO,GAGR,MAAM,kBAAkB,CAAC;AAO1B;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAAU;IAEV,IAAI,WAAW,GAAG,EAAE,CAAC;IAErB,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IAExC,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,MAAM,KAAK,GAAG,GAAG,CAAC;IAClB,OAAO,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,CACtD,cAAc,CAAC;YACb,GAAG,IAAI;YACP,KAAK;SACN,CAAC,CACH,CAAC;QAEF,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,SAAS,CAAC;gBACf,IAAI,EAAE,2BAA2B;gBACjC,OAAO,EAAE,oCAAoC;gBAC7C,IAAI,EAAE;oBACJ,KAAK;iBACN;aACF,CAAC,CAAC;QACL,CAAC;QAED,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,IAAI,MAAM,CAAC,cAAc,KAAK,aAAa,EAAE,CAAC;gBAC5C,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;gBAC5C,KAAK,GAAG,IAAI,CAAC;gBACb,MAAM;YACR,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACtC,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;IAChC,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;YACf,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,mBAAmB;YAC5B,IAAI,EAAE;gBACJ,aAAa;aACd;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC;AAC9B,CAAC"}

package/dist/queries/index.d.ts

@@ -0,0 +1,4 @@
+import { getSignerTotalLocked } from "./get-signer-total-locked.js";
+export declare const queries: {
+    getSignerTotalLocked: typeof getSignerTotalLocked;
+};

package/dist/queries/index.js

@@ -0,0 +1,5 @@
+import { getSignerTotalLocked } from "./get-signer-total-locked.js";
+export const queries = {
+    getSignerTotalLocked,
+};
+//# sourceMappingURL=index.js.map

package/dist/queries/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/queries/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEpE,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,oBAAoB;CACrB,CAAC"}

package/dist/stacks-api/accounts/balances.d.ts

@@ -0,0 +1,34 @@
+import { type Result, type SafeError } from "../../utils/safe.js";
+import type { ApiRequestOptions } from "../types.js";
+import * as v from "valibot";
+export type Args = {
+    principal: string;
+    unanchored?: boolean;
+    untilBlock?: number;
+} & ApiRequestOptions;
+export declare const responseSchema: v.ObjectSchema<{
+    readonly stx: v.ObjectSchema<{
+        readonly balance: v.StringSchema<undefined>;
+        readonly total_sent: v.StringSchema<undefined>;
+        readonly total_received: v.StringSchema<undefined>;
+        readonly total_fees_sent: v.StringSchema<undefined>;
+        readonly total_miner_rewards_received: v.StringSchema<undefined>;
+        readonly lock_tx_id: v.StringSchema<undefined>;
+        readonly locked: v.StringSchema<undefined>;
+        readonly lock_height: v.NumberSchema<undefined>;
+        readonly burnchain_lock_height: v.NumberSchema<undefined>;
+        readonly burnchain_unlock_height: v.NumberSchema<undefined>;
+    }, undefined>;
+    readonly fungible_tokens: v.RecordSchema<v.StringSchema<undefined>, v.ObjectSchema<{
+        readonly balance: v.StringSchema<undefined>;
+        readonly total_sent: v.StringSchema<undefined>;
+        readonly total_received: v.StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly non_fungible_tokens: v.RecordSchema<v.StringSchema<undefined>, v.ObjectSchema<{
+        readonly count: v.StringSchema<undefined>;
+        readonly total_sent: v.StringSchema<undefined>;
+        readonly total_received: v.StringSchema<undefined>;
+    }, undefined>, undefined>;
+}, undefined>;
+export type Response = v.InferOutput<typeof responseSchema>;
+export declare function balances(opts: Args): Promise<Result<Response, SafeError<"FetchBalancesError" | "ParseBodyError" | "ValidateDataError">>>;

package/dist/stacks-api/accounts/balances.js

@@ -0,0 +1,70 @@
+import { error, safePromise, success, } from "../../utils/safe.js";
+import * as v from "valibot";
+export const responseSchema = v.object({
+    stx: v.object({
+        balance: v.string(),
+        total_sent: v.string(),
+        total_received: v.string(),
+        total_fees_sent: v.string(),
+        total_miner_rewards_received: v.string(),
+        lock_tx_id: v.string(),
+        locked: v.string(),
+        lock_height: v.number(),
+        burnchain_lock_height: v.number(),
+        burnchain_unlock_height: v.number(),
+    }),
+    fungible_tokens: v.record(v.string(), v.object({
+        balance: v.string(),
+        total_sent: v.string(),
+        total_received: v.string(),
+    })),
+    non_fungible_tokens: v.record(v.string(), v.object({
+        count: v.string(),
+        total_sent: v.string(),
+        total_received: v.string(),
+    })),
+});
+export async function balances(opts) {
+    const search = new URLSearchParams();
+    if (opts.unanchored)
+        search.append("unanchored", "true");
+    if (opts.untilBlock)
+        search.append("until_block", opts.untilBlock.toString());
+    const init = {};
+    if (opts.apiKeyConfig) {
+        init.headers = {
+            [opts.apiKeyConfig.header]: opts.apiKeyConfig.key,
+        };
+    }
+    const endpoint = `${opts.baseUrl}/extended/v1/address/${opts.principal}/balances?${search}`;
+    const res = await fetch(endpoint, init);
+    if (!res.ok) {
+        return error({
+            name: "FetchBalancesError",
+            message: "Failed to fetch balances.",
+            data: {
+                status: res.status,
+                statusText: res.statusText,
+                bodyParseResult: await safePromise(res.json()),
+            },
+        });
+    }
+    const [jsonError, data] = await safePromise(res.json());
+    if (jsonError) {
+        return error({
+            name: "ParseBodyError",
+            message: "Failed to parse response body as JSON.",
+            data: jsonError,
+        });
+    }
+    const validationResult = v.safeParse(responseSchema, data);
+    if (!validationResult.success) {
+        return error({
+            name: "ValidateDataError",
+            message: "Failed to validate data.",
+            data: validationResult,
+        });
+    }
+    return success(validationResult.output);
+}
+//# sourceMappingURL=balances.js.map

package/dist/stacks-api/accounts/balances.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"balances.js","sourceRoot":"","sources":["../../../src/stacks-api/accounts/balances.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,WAAW,EACX,OAAO,GAGR,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;QAC1B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;QAC3B,4BAA4B,EAAE,CAAC,CAAC,MAAM,EAAE;QACxC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE;QACjC,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE;KACpC,CAAC;IACF,eAAe,EAAE,CAAC,CAAC,MAAM,CACvB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;KAC3B,CAAC,CACH;IACD,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAC3B,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;KAC3B,CAAC,CACH;CACF,CAAC,CAAC;AAGH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,IAAU;IAOV,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,IAAI,IAAI,CAAC,UAAU;QAAE,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACzD,IAAI,IAAI,CAAC,UAAU;QAAE,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;IAE9E,MAAM,IAAI,GAAgB,EAAE,CAAC;IAC7B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG;YACb,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG;SAClD,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,OAAO,wBAAwB,IAAI,CAAC,SAAS,aAAa,MAAM,EAAE,CAAC;IAC5F,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAExC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,2BAA2B;YACpC,IAAI,EAAE;gBACJ,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,eAAe,EAAE,MAAM,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACxD,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,wCAAwC;YACjD,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,gBAAgB,GAAG,CAAC,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAC3D,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,mBAAmB;YACzB,OAAO,EAAE,0BAA0B;YACnC,IAAI,EAAE,gBAAgB;SACvB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC"}

package/dist/stacks-api/accounts/index.d.ts

@@ -0,0 +1,4 @@
+import { balances } from "./balances.js";
+export declare const accounts: {
+    balances: typeof balances;
+};

package/dist/stacks-api/accounts/index.js

@@ -0,0 +1,5 @@
+import { balances } from "./balances.js";
+export const accounts = {
+    balances,
+};
+//# sourceMappingURL=index.js.map

package/dist/stacks-api/accounts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stacks-api/accounts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,QAAQ;CACT,CAAC"}

package/dist/stacks-api/blocks/get-block.d.ts

@@ -0,0 +1,29 @@
+import { type Result, type SafeError } from "../../utils/safe.js";
+import { type ApiRequestOptions } from "../types.js";
+import * as v from "valibot";
+export type Args = {
+    heightOrHash: string | number;
+} & ApiRequestOptions;
+export declare const responseSchema: 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>;
+export type Response = v.InferOutput<typeof responseSchema>;
+export declare function getBlock(opts: Args): Promise<Result<Response, SafeError<"FetchBlockError" | "ParseBodyError" | "ValidateDataError">>>;

package/dist/stacks-api/blocks/get-block.js

@@ -0,0 +1,62 @@
+import { error, safePromise, success, } from "../../utils/safe.js";
+import {} from "../types.js";
+import * as v from "valibot";
+export const responseSchema = v.object({
+    canonical: v.boolean(),
+    height: v.number(),
+    hash: v.string(),
+    block_time: v.number(),
+    block_time_iso: v.string(),
+    index_block_hash: v.string(),
+    parent_block_hash: v.string(),
+    parent_index_block_hash: v.string(),
+    burn_block_time: v.number(),
+    burn_block_time_iso: v.string(),
+    burn_block_hash: v.string(),
+    burn_block_height: v.number(),
+    miner_txid: v.string(),
+    tx_count: v.number(),
+    execution_cost_read_count: v.number(),
+    execution_cost_read_length: v.number(),
+    execution_cost_runtime: v.number(),
+    execution_cost_write_count: v.number(),
+    execution_cost_write_length: v.number(),
+});
+export async function getBlock(opts) {
+    const init = {};
+    if (opts.apiKeyConfig) {
+        init.headers = {
+            [opts.apiKeyConfig.header]: opts.apiKeyConfig.key,
+        };
+    }
+    const res = await fetch(`${opts.baseUrl}/extended/v2/blocks/${opts.heightOrHash}`, init);
+    if (!res.ok) {
+        return error({
+            name: "FetchBlockError",
+            message: "Failed to fetch block.",
+            data: {
+                status: res.status,
+                statusText: res.statusText,
+                bodyParseResult: await safePromise(res.json()),
+            },
+        });
+    }
+    const [jsonError, data] = await safePromise(res.json());
+    if (jsonError) {
+        return error({
+            name: "ParseBodyError",
+            message: "Failed to parse body.",
+            data: jsonError,
+        });
+    }
+    const validationResult = v.safeParse(responseSchema, data);
+    if (!validationResult.success) {
+        return error({
+            name: "ValidateDataError",
+            message: "Failed to validate data.",
+            data: validationResult,
+        });
+    }
+    return success(validationResult.output);
+}
+//# sourceMappingURL=get-block.js.map

package/dist/stacks-api/blocks/get-block.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-block.js","sourceRoot":"","sources":["../../../src/stacks-api/blocks/get-block.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,WAAW,EACX,OAAO,GAGR,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAA0B,MAAM,aAAa,CAAC;AACrD,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAM7B,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE;IACnC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC/B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,yBAAyB,EAAE,CAAC,CAAC,MAAM,EAAE;IACrC,0BAA0B,EAAE,CAAC,CAAC,MAAM,EAAE;IACtC,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE;IAClC,0BAA0B,EAAE,CAAC,CAAC,MAAM,EAAE;IACtC,2BAA2B,EAAE,CAAC,CAAC,MAAM,EAAE;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,IAAU;IAOV,MAAM,IAAI,GAAgB,EAAE,CAAC;IAC7B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG;YACb,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG;SAClD,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,KAAK,CACrB,GAAG,IAAI,CAAC,OAAO,uBAAuB,IAAI,CAAC,YAAY,EAAE,EACzD,IAAI,CACL,CAAC;IAEF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,wBAAwB;YACjC,IAAI,EAAE;gBACJ,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,eAAe,EAAE,MAAM,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACxD,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,uBAAuB;YAChC,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,gBAAgB,GAAG,CAAC,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAC3D,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,mBAAmB;YACzB,OAAO,EAAE,0BAA0B;YACnC,IAAI,EAAE,gBAAgB;SACvB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC"}

package/dist/stacks-api/blocks/index.d.ts

@@ -0,0 +1,4 @@
+import { getBlock } from "./get-block.js";
+export declare const blocks: {
+    getBlock: typeof getBlock;
+};

package/dist/stacks-api/blocks/index.js

@@ -0,0 +1,5 @@
+import { getBlock } from "./get-block.js";
+export const blocks = {
+    getBlock,
+};
+//# sourceMappingURL=index.js.map

package/dist/stacks-api/blocks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stacks-api/blocks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,QAAQ;CACT,CAAC"}

package/dist/stacks-api/index.d.ts

@@ -0,0 +1,28 @@
+export declare const stacksApi: {
+    accounts: {
+        balances: typeof import("./accounts/balances.js").balances;
+    };
+    blocks: {
+        getBlock: typeof import("./blocks/get-block.js").getBlock;
+    };
+    info: {
+        coreApi: typeof import("./info/core-api.js").coreApi;
+        poxDetails: typeof import("./info/pox-details.js").poxDetails;
+    };
+    proofOfTransfer: {
+        cycle: typeof import("./proof-of-transfer/cycle.js").cycle;
+        cycles: typeof import("./proof-of-transfer/cycles.js").cycles;
+        signersInCycle: typeof import("./proof-of-transfer/signers-in-cycle.js").signersInCycle;
+        stackersForSignerInCycle: typeof import("./proof-of-transfer/stackers-for-signer-in-cycle.js").stackersForSignerInCycle;
+    };
+    smartContracts: {
+        readOnly: typeof import("./smart-contracts/read-only.js").readOnly;
+    };
+    stackingPool: {
+        members: typeof import("./stacking-pool/members.js").members;
+    };
+    transactions: {
+        addressTransactions: typeof import("./transactions/address-transactions.js").addressTransactions;
+        getTransaction: typeof import("./transactions/get-transaction.js").getTransaction;
+    };
+};

package/dist/stacks-api/index.js

@@ -0,0 +1,17 @@
+import { accounts } from "./accounts/index.js";
+import { blocks } from "./blocks/index.js";
+import { info } from "./info/index.js";
+import { proofOfTransfer } from "./proof-of-transfer/index.js";
+import { smartContracts } from "./smart-contracts/index.js";
+import { stackingPool } from "./stacking-pool/index.js";
+import { transactions } from "./transactions/index.js";
+export const stacksApi = {
+    accounts,
+    blocks,
+    info,
+    proofOfTransfer,
+    smartContracts,
+    stackingPool,
+    transactions,
+};
+//# sourceMappingURL=index.js.map

package/dist/stacks-api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/stacks-api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,QAAQ;IACR,MAAM;IACN,IAAI;IACJ,eAAe;IACf,cAAc;IACd,YAAY;IACZ,YAAY;CACb,CAAC"}

package/dist/stacks-api/info/core-api.d.ts

@@ -0,0 +1,21 @@
+import { type Result } from "../../utils/safe.js";
+import type { ApiRequestOptions } from "../types.js";
+import * as v from "valibot";
+declare const CoreApiResponseSchema: v.ObjectSchema<{
+    readonly peer_version: v.NumberSchema<undefined>;
+    readonly pox_consensus: v.StringSchema<undefined>;
+    readonly burn_block_height: v.NumberSchema<undefined>;
+    readonly stable_pox_consensus: v.StringSchema<undefined>;
+    readonly stable_burn_block_height: v.NumberSchema<undefined>;
+    readonly server_version: v.StringSchema<undefined>;
+    readonly network_id: v.NumberSchema<undefined>;
+    readonly parent_network_id: v.NumberSchema<undefined>;
+    readonly stacks_tip_height: v.NumberSchema<undefined>;
+    readonly stacks_tip: v.StringSchema<undefined>;
+    readonly stacks_tip_consensus_hash: v.StringSchema<undefined>;
+    readonly unanchored_tip: v.StringSchema<undefined>;
+    readonly exit_at_block_height: v.NumberSchema<undefined>;
+}, undefined>;
+export type CoreApiResponse = v.InferOutput<typeof CoreApiResponseSchema>;
+export declare function coreApi(apiOpts: ApiRequestOptions): Promise<Result<CoreApiResponse>>;
+export {};

package/dist/stacks-api/info/core-api.js

@@ -0,0 +1,55 @@
+import { error, safePromise, success } from "../../utils/safe.js";
+import * as v from "valibot";
+const CoreApiResponseSchema = v.object({
+    peer_version: v.number(),
+    pox_consensus: v.string(),
+    burn_block_height: v.number(),
+    stable_pox_consensus: v.string(),
+    stable_burn_block_height: v.number(),
+    server_version: v.string(),
+    network_id: v.number(),
+    parent_network_id: v.number(),
+    stacks_tip_height: v.number(),
+    stacks_tip: v.string(),
+    stacks_tip_consensus_hash: v.string(),
+    unanchored_tip: v.string(),
+    exit_at_block_height: v.number(),
+});
+export async function coreApi(apiOpts) {
+    const init = {};
+    if (apiOpts.apiKeyConfig) {
+        init.headers = {
+            [apiOpts.apiKeyConfig.header]: apiOpts.apiKeyConfig.key,
+        };
+    }
+    const res = await fetch(`${apiOpts.baseUrl}/v2/info`, init);
+    if (!res.ok) {
+        return error({
+            name: "FetchCoreApiError",
+            message: "Failed to fetch.",
+            data: {
+                status: res.status,
+                statusText: res.statusText,
+                bodyParseResult: await safePromise(res.json()),
+            },
+        });
+    }
+    const [parseBodyError, data] = await safePromise(res.json());
+    if (parseBodyError) {
+        return error({
+            name: "ParseBodyError",
+            message: "Failed to parse response body as JSON.",
+            data: parseBodyError,
+        });
+    }
+    const validationResult = v.safeParse(CoreApiResponseSchema, data);
+    if (!validationResult.success) {
+        return error({
+            name: "ValidateDataError",
+            message: "Failed to validate data.",
+            data: validationResult,
+        });
+    }
+    return success(validationResult.output);
+}
+//# sourceMappingURL=core-api.js.map

package/dist/stacks-api/info/core-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-api.js","sourceRoot":"","sources":["../../../src/stacks-api/info/core-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAe,MAAM,qBAAqB,CAAC;AAE/E,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE;IAChC,wBAAwB,EAAE,CAAC,CAAC,MAAM,EAAE;IACpC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,yBAAyB,EAAE,CAAC,CAAC,MAAM,EAAE;IACrC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE;CACjC,CAAC,CAAC;AAGH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,OAA0B;IAE1B,MAAM,IAAI,GAAgB,EAAE,CAAC;IAC7B,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG;YACb,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG;SACxD,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,UAAU,EAAE,IAAI,CAAC,CAAC;IAE5D,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,mBAAmB;YACzB,OAAO,EAAE,kBAAkB;YAC3B,IAAI,EAAE;gBACJ,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,eAAe,EAAE,MAAM,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7D,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,wCAAwC;YACjD,IAAI,EAAE,cAAc;SACrB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,gBAAgB,GAAG,CAAC,CAAC,SAAS,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;IAClE,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,mBAAmB;YACzB,OAAO,EAAE,0BAA0B;YACnC,IAAI,EAAE,gBAAgB;SACvB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC"}

package/dist/stacks-api/info/index.d.ts

@@ -0,0 +1,6 @@
+import { coreApi } from "./core-api.js";
+import { poxDetails } from "./pox-details.js";
+export declare const info: {
+    coreApi: typeof coreApi;
+    poxDetails: typeof poxDetails;
+};

package/dist/stacks-api/info/index.js

@@ -0,0 +1,7 @@
+import { coreApi } from "./core-api.js";
+import { poxDetails } from "./pox-details.js";
+export const info = {
+    coreApi,
+    poxDetails,
+};
+//# sourceMappingURL=index.js.map

package/dist/stacks-api/info/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stacks-api/info/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO;IACP,UAAU;CACX,CAAC"}

package/dist/stacks-api/info/pox-details.d.ts

@@ -0,0 +1,59 @@
+import { type Result } from "../../utils/safe.js";
+import type { ApiRequestOptions } from "../types.js";
+import * as v from "valibot";
+type Args = ApiRequestOptions;
+declare const poxDetailsResponseSchema: v.ObjectSchema<{
+    readonly contract_id: v.StringSchema<undefined>;
+    readonly pox_activation_threshold_ustx: v.NumberSchema<undefined>;
+    readonly first_burnchain_block_height: v.NumberSchema<undefined>;
+    readonly current_burnchain_block_height: v.NumberSchema<undefined>;
+    readonly prepare_phase_block_length: v.NumberSchema<undefined>;
+    readonly reward_phase_block_length: v.NumberSchema<undefined>;
+    readonly reward_slots: v.NumberSchema<undefined>;
+    readonly rejection_fraction: v.NullSchema<undefined>;
+    readonly total_liquid_supply_ustx: v.NumberSchema<undefined>;
+    readonly current_cycle: v.ObjectSchema<{
+        readonly id: v.NumberSchema<undefined>;
+        readonly min_threshold_ustx: v.NumberSchema<undefined>;
+        readonly stacked_ustx: v.NumberSchema<undefined>;
+        readonly is_pox_active: v.BooleanSchema<undefined>;
+    }, undefined>;
+    readonly next_cycle: v.ObjectSchema<{
+        readonly id: v.NumberSchema<undefined>;
+        readonly min_threshold_ustx: v.NumberSchema<undefined>;
+        readonly min_increment_ustx: v.NumberSchema<undefined>;
+        readonly stacked_ustx: v.NumberSchema<undefined>;
+        readonly prepare_phase_start_block_height: v.NumberSchema<undefined>;
+        readonly blocks_until_prepare_phase: v.NumberSchema<undefined>;
+        readonly reward_phase_start_block_height: v.NumberSchema<undefined>;
+        readonly blocks_until_reward_phase: v.NumberSchema<undefined>;
+        readonly ustx_until_pox_rejection: v.NullSchema<undefined>;
+    }, undefined>;
+    readonly epochs: v.ArraySchema<v.ObjectSchema<{
+        readonly epoch_id: v.StringSchema<undefined>;
+        readonly start_height: v.NumberSchema<undefined>;
+        readonly end_height: v.NumberSchema<undefined>;
+        readonly block_limit: v.ObjectSchema<{
+            readonly write_length: v.NumberSchema<undefined>;
+            readonly write_count: v.NumberSchema<undefined>;
+            readonly read_length: v.NumberSchema<undefined>;
+            readonly read_count: v.NumberSchema<undefined>;
+            readonly runtime: v.NumberSchema<undefined>;
+        }, undefined>;
+        readonly network_epoch: v.NumberSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly min_amount_ustx: v.NumberSchema<undefined>;
+    readonly prepare_cycle_length: v.NumberSchema<undefined>;
+    readonly reward_cycle_id: v.NumberSchema<undefined>;
+    readonly reward_cycle_length: v.NumberSchema<undefined>;
+    readonly rejection_votes_left_required: v.NullSchema<undefined>;
+    readonly next_reward_cycle_in: v.NumberSchema<undefined>;
+    readonly contract_versions: v.ArraySchema<v.ObjectSchema<{
+        readonly contract_id: v.StringSchema<undefined>;
+        readonly activation_burnchain_block_height: v.NumberSchema<undefined>;
+        readonly first_reward_cycle_id: v.NumberSchema<undefined>;
+    }, undefined>, undefined>;
+}, undefined>;
+type PoxDetailsResponse = v.InferOutput<typeof poxDetailsResponseSchema>;
+export declare function poxDetails(args: Args): Promise<Result<PoxDetailsResponse>>;
+export {};