npm - @stacks/blockchain-api-client - Versions diffs - 9.0.0-pox5.14 → 9.0.0-pox5.15 - Mend

@stacks/blockchain-api-client 9.0.0-pox5.14 → 9.0.0-pox5.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/lib/generated/schema.d.ts +84 -0
package/package.json +1 -1
package/src/generated/schema.d.ts +84 -0

package/lib/generated/schema.d.ts CHANGED Viewed

@@ -2159,6 +2159,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/extended/v3/staking/signers/{principal}/stakers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get staking signer stakers
+         * @description List the stakers that belong to a pox-5 signer, across both direct STX staking and BTC/sBTC bond staking. Each entry indicates which staking type(s) the staker participates in under this signer.
+         */
+        get: operations["get_staking_signer_stakers"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/extended/v3/transactions": {
         parameters: {
             query?: never;
@@ -39180,6 +39200,70 @@ export interface operations {
             };
         };
     };
+    get_staking_signer_stakers: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            staker: string;
+                            /**
+                             * @description The staking types this staker participates in under this signer: `stx` for direct pox-5 STX staking, `btc` for BTC/sBTC bond staking. A staker doing both has both entries.
+                             * @example [
+                             *       "stx"
+                             *     ]
+                             */
+                            types: ("stx" | "btc")[];
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
     get_transactions: {
         parameters: {
             query?: {

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "9.0.0-pox5.14",
+  "version": "9.0.0-pox5.15",
   "access": "public",
   "description": "Client for the Stacks Blockchain API",
   "homepage": "https://github.com/stx-labs/stacks-blockchain-api/tree/master/client#readme",

package/src/generated/schema.d.ts CHANGED Viewed

@@ -2159,6 +2159,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/extended/v3/staking/signers/{principal}/stakers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get staking signer stakers
+         * @description List the stakers that belong to a pox-5 signer, across both direct STX staking and BTC/sBTC bond staking. Each entry indicates which staking type(s) the staker participates in under this signer.
+         */
+        get: operations["get_staking_signer_stakers"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/extended/v3/transactions": {
         parameters: {
             query?: never;
@@ -39180,6 +39200,70 @@ export interface operations {
             };
         };
     };
+    get_staking_signer_stakers: {
+        parameters: {
+            query?: {
+                /** @description Number of results per page */
+                limit?: number;
+                /** @description Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                principal: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example 1 */
+                        total: number;
+                        /**
+                         * @description Number of results per page
+                         * @default 100
+                         */
+                        limit: number;
+                        cursor: {
+                            next: string | null;
+                            previous: string | null;
+                            current: string | null;
+                        };
+                        results: {
+                            staker: string;
+                            /**
+                             * @description The staking types this staker participates in under this signer: `stx` for direct pox-5 STX staking, `btc` for BTC/sBTC bond staking. A staker doing both has both entries.
+                             * @example [
+                             *       "stx"
+                             *     ]
+                             */
+                            types: ("stx" | "btc")[];
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        error: string;
+                        message?: string;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
     get_transactions: {
         parameters: {
             query?: {