@secretkeylabs/stacks-tools 0.2.0 → 0.3.0-6f23618

package/dist/queries/get-signer-stacked-amount.d.ts

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

package/dist/queries/get-signer-stacked-amount.js

@@ -0,0 +1,59 @@
+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 getSignerStackedAmount(args) {
+    let totalLocked = 0n;
+    const { identifier, ...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 (identifier.type === "address") {
+                if (signer.signer_address === identifier.signerAddress) {
+                    totalLocked = BigInt(signer.stacked_amount);
+                    found = true;
+                    break;
+                }
+            }
+            else {
+                if (signer.signing_key === identifier.signerPublicKey) {
+                    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: {
+                identifier,
+                cycle: args.cycleNumber,
+            },
+        });
+    }
+    return success(totalLocked);
+}
+//# sourceMappingURL=get-signer-stacked-amount.js.map

package/dist/queries/get-signer-stacked-amount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-signer-stacked-amount.js","sourceRoot":"","sources":["../../src/queries/get-signer-stacked-amount.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;AAgB1B;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,IAAU;IAEV,IAAI,WAAW,GAAG,EAAE,CAAC;IAErB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IAErC,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,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAClC,IAAI,MAAM,CAAC,cAAc,KAAK,UAAU,CAAC,aAAa,EAAE,CAAC;oBACvD,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;oBAC5C,KAAK,GAAG,IAAI,CAAC;oBACb,MAAM;gBACR,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,MAAM,CAAC,WAAW,KAAK,UAAU,CAAC,eAAe,EAAE,CAAC;oBACtD,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;oBAC5C,KAAK,GAAG,IAAI,CAAC;oBACb,MAAM;gBACR,CAAC;YACH,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,UAAU;gBACV,KAAK,EAAE,IAAI,CAAC,WAAW;aACxB;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC;AAC9B,CAAC"}

package/dist/queries/index.d.ts

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

package/dist/queries/index.js

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

package/dist/queries/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/queries/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAExE,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,sBAAsB;CACvB,CAAC"}

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

@@ -12,6 +12,7 @@ export declare const stacksApi: {
     proofOfTransfer: {
         cycle: typeof import("./proof-of-transfer/cycle.js").cycle;
         cycles: typeof import("./proof-of-transfer/cycles.js").cycles;
+        signerInCycle: typeof import("./proof-of-transfer/signer-in-cycle.js").signerInCycle;
         signersInCycle: typeof import("./proof-of-transfer/signers-in-cycle.js").signersInCycle;
         stackersForSignerInCycle: typeof import("./proof-of-transfer/stackers-for-signer-in-cycle.js").stackersForSignerInCycle;
     };

package/dist/stacks-api/proof-of-transfer/index.d.ts

@@ -1,10 +1,12 @@
 import { cycle } from "./cycle.js";
 import { cycles } from "./cycles.js";
+import { signerInCycle } from "./signer-in-cycle.js";
 import { signersInCycle } from "./signers-in-cycle.js";
 import { stackersForSignerInCycle } from "./stackers-for-signer-in-cycle.js";
 export declare const proofOfTransfer: {
     cycle: typeof cycle;
     cycles: typeof cycles;
+    signerInCycle: typeof signerInCycle;
     signersInCycle: typeof signersInCycle;
     stackersForSignerInCycle: typeof stackersForSignerInCycle;
 };

package/dist/stacks-api/proof-of-transfer/index.js

@@ -1,10 +1,12 @@
 import { cycle } from "./cycle.js";
 import { cycles } from "./cycles.js";
+import { signerInCycle } from "./signer-in-cycle.js";
 import { signersInCycle } from "./signers-in-cycle.js";
 import { stackersForSignerInCycle } from "./stackers-for-signer-in-cycle.js";
 export const proofOfTransfer = {
     cycle,
     cycles,
+    signerInCycle,
     signersInCycle,
     stackersForSignerInCycle,
 };

package/dist/stacks-api/proof-of-transfer/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stacks-api/proof-of-transfer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAE7E,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,KAAK;IACL,MAAM;IACN,cAAc;IACd,wBAAwB;CACzB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stacks-api/proof-of-transfer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAE7E,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,KAAK;IACL,MAAM;IACN,aAAa;IACb,cAAc;IACd,wBAAwB;CACzB,CAAC"}

package/dist/stacks-api/proof-of-transfer/signer-in-cycle.d.ts

@@ -0,0 +1,22 @@
+import { type Result } from "../../utils/safe.js";
+import type { ApiRequestOptions } from "../types.js";
+import * as v from "valibot";
+export type Args = {
+    /**
+     * The signers public key as a hex string, with or without a '0x' prefix.
+     */
+    signerPublicKey: string;
+    cycleId: number;
+} & ApiRequestOptions;
+export declare const signerInCycleResponseSchema: v.ObjectSchema<{
+    readonly signing_key: v.StringSchema<undefined>;
+    readonly signer_address: v.StringSchema<undefined>;
+    readonly weight: v.NumberSchema<undefined>;
+    readonly stacked_amount: v.StringSchema<undefined>;
+    readonly weight_percent: v.NumberSchema<undefined>;
+    readonly stacked_amount_percent: v.NumberSchema<undefined>;
+    readonly solo_stacker_count: v.NumberSchema<undefined>;
+    readonly pooled_stacker_count: v.NumberSchema<undefined>;
+}, undefined>;
+export type SignerInCycleResponse = v.InferOutput<typeof signerInCycleResponseSchema>;
+export declare function signerInCycle(args: Args): Promise<Result<SignerInCycleResponse>>;

package/dist/stacks-api/proof-of-transfer/signer-in-cycle.js

@@ -0,0 +1,57 @@
+import { error, safePromise, success } from "../../utils/safe.js";
+import * as v from "valibot";
+export const signerInCycleResponseSchema = v.object({
+    signing_key: v.string(),
+    signer_address: v.string(),
+    weight: v.number(),
+    stacked_amount: v.string(),
+    weight_percent: v.number(),
+    stacked_amount_percent: v.number(),
+    solo_stacker_count: v.number(),
+    pooled_stacker_count: v.number(),
+});
+export async function signerInCycle(args) {
+    const init = {};
+    if (args.apiKeyConfig) {
+        init.headers = {
+            [args.apiKeyConfig.header]: args.apiKeyConfig.key,
+        };
+    }
+    const signerPublicKey = args.signerPublicKey.startsWith("0x")
+        ? args.signerPublicKey
+        : `0x${args.signerPublicKey}`;
+    const endpoint = `${args.baseUrl}/extended/v2/pox/cycles/${args.cycleId}/signers/${signerPublicKey}`;
+    const res = await fetch(endpoint, init);
+    if (!res.ok) {
+        return error({
+            name: "FetchSignerInCycleError",
+            message: "Failed to fetch signer in cycle.",
+            data: {
+                status: res.status,
+                statusText: res.statusText,
+            },
+        });
+    }
+    const [jsonError, data] = await safePromise(res.json());
+    if (jsonError) {
+        return error({
+            name: "ParseBodyError",
+            message: "Failed to parse response body.",
+            data: {
+                signerPublicKey: args.signerPublicKey,
+                cycleId: args.cycleId,
+                jsonError,
+            },
+        });
+    }
+    const validationResult = v.safeParse(signerInCycleResponseSchema, data);
+    if (!validationResult.success) {
+        return error({
+            name: "ValidateDataError",
+            message: "Failed to validate response data.",
+            data: validationResult.issues,
+        });
+    }
+    return success(validationResult.output);
+}
+//# sourceMappingURL=signer-in-cycle.js.map

package/dist/stacks-api/proof-of-transfer/signer-in-cycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer-in-cycle.js","sourceRoot":"","sources":["../../../src/stacks-api/proof-of-transfer/signer-in-cycle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAe,MAAM,qBAAqB,CAAC;AAE/E,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAU7B,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE;IAClC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC9B,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE;CACjC,CAAC,CAAC;AAKH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,IAAU;IAEV,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;IACD,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC;QAC3D,CAAC,CAAC,IAAI,CAAC,eAAe;QACtB,CAAC,CAAC,KAAK,IAAI,CAAC,eAAe,EAAE,CAAC;IAChC,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,OAAO,2BAA2B,IAAI,CAAC,OAAO,YAAY,eAAe,EAAE,CAAC;IACrG,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,yBAAyB;YAC/B,OAAO,EAAE,kCAAkC;YAC3C,IAAI,EAAE;gBACJ,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,UAAU,EAAE,GAAG,CAAC,UAAU;aAC3B;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,gCAAgC;YACzC,IAAI,EAAE;gBACJ,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,SAAS;aACV;SACF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,gBAAgB,GAAG,CAAC,CAAC,SAAS,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;IACxE,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,mBAAmB;YACzB,OAAO,EAAE,mCAAmC;YAC5C,IAAI,EAAE,gBAAgB,CAAC,MAAM;SAC9B,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secretkeylabs/stacks-tools",
-  "version": "0.2.0",
+  "version": "0.3.0-6f23618",
   "type": "module",
   "files": [
     "dist"