@secretkeylabs/stacks-tools 0.2.0-b1b31e3 → 0.3.0-9b21b7a

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/package.json

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