@stacks/blockchain-api-client 7.9.1 → 7.10.0-beta.2

package/src/generated/models/PoxCycleSignerStackersListResponse.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    PoxStacker,
+    PoxStackerFromJSON,
+    PoxStackerFromJSONTyped,
+    PoxStackerToJSON,
+} from './';
+
+/**
+ * GET request that returns stackers for a signer in a PoX cycle
+ * @export
+ * @interface PoxCycleSignerStackersListResponse
+ */
+export interface PoxCycleSignerStackersListResponse {
+    /**
+     * The number of stackers to return
+     * @type {number}
+     * @memberof PoxCycleSignerStackersListResponse
+     */
+    limit: number;
+    /**
+     * The number to stackers to skip (starting at `0`)
+     * @type {number}
+     * @memberof PoxCycleSignerStackersListResponse
+     */
+    offset: number;
+    /**
+     * The total number of stackers
+     * @type {number}
+     * @memberof PoxCycleSignerStackersListResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {Array<PoxStacker>}
+     * @memberof PoxCycleSignerStackersListResponse
+     */
+    results: Array<PoxStacker>;
+}
+
+export function PoxCycleSignerStackersListResponseFromJSON(json: any): PoxCycleSignerStackersListResponse {
+    return PoxCycleSignerStackersListResponseFromJSONTyped(json, false);
+}
+
+export function PoxCycleSignerStackersListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PoxCycleSignerStackersListResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'],
+        'offset': json['offset'],
+        'total': json['total'],
+        'results': ((json['results'] as Array<any>).map(PoxStackerFromJSON)),
+    };
+}
+
+export function PoxCycleSignerStackersListResponseToJSON(value?: PoxCycleSignerStackersListResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'limit': value.limit,
+        'offset': value.offset,
+        'total': value.total,
+        'results': ((value.results as Array<any>).map(PoxStackerToJSON)),
+    };
+}
+

package/src/generated/models/PoxCycleSignersListResponse.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    PoxSigner,
+    PoxSignerFromJSON,
+    PoxSignerFromJSONTyped,
+    PoxSignerToJSON,
+} from './';
+
+/**
+ * GET request that returns signers for a PoX cycle
+ * @export
+ * @interface PoxCycleSignersListResponse
+ */
+export interface PoxCycleSignersListResponse {
+    /**
+     * The number of signers to return
+     * @type {number}
+     * @memberof PoxCycleSignersListResponse
+     */
+    limit: number;
+    /**
+     * The number to signers to skip (starting at `0`)
+     * @type {number}
+     * @memberof PoxCycleSignersListResponse
+     */
+    offset: number;
+    /**
+     * The total number of signers
+     * @type {number}
+     * @memberof PoxCycleSignersListResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {Array<PoxSigner>}
+     * @memberof PoxCycleSignersListResponse
+     */
+    results: Array<PoxSigner>;
+}
+
+export function PoxCycleSignersListResponseFromJSON(json: any): PoxCycleSignersListResponse {
+    return PoxCycleSignersListResponseFromJSONTyped(json, false);
+}
+
+export function PoxCycleSignersListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PoxCycleSignersListResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'],
+        'offset': json['offset'],
+        'total': json['total'],
+        'results': ((json['results'] as Array<any>).map(PoxSignerFromJSON)),
+    };
+}
+
+export function PoxCycleSignersListResponseToJSON(value?: PoxCycleSignersListResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'limit': value.limit,
+        'offset': value.offset,
+        'total': value.total,
+        'results': ((value.results as Array<any>).map(PoxSignerToJSON)),
+    };
+}
+

package/src/generated/models/PoxSigner.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PoxSigner
+ */
+export interface PoxSigner {
+    /**
+     * 
+     * @type {string}
+     * @memberof PoxSigner
+     */
+    signing_key: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PoxSigner
+     */
+    weight: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PoxSigner
+     */
+    stacked_amount: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PoxSigner
+     */
+    weight_percent: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PoxSigner
+     */
+    stacked_amount_percent: number;
+}
+
+export function PoxSignerFromJSON(json: any): PoxSigner {
+    return PoxSignerFromJSONTyped(json, false);
+}
+
+export function PoxSignerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PoxSigner {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'signing_key': json['signing_key'],
+        'weight': json['weight'],
+        'stacked_amount': json['stacked_amount'],
+        'weight_percent': json['weight_percent'],
+        'stacked_amount_percent': json['stacked_amount_percent'],
+    };
+}
+
+export function PoxSignerToJSON(value?: PoxSigner | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'signing_key': value.signing_key,
+        'weight': value.weight,
+        'stacked_amount': value.stacked_amount,
+        'weight_percent': value.weight_percent,
+        'stacked_amount_percent': value.stacked_amount_percent,
+    };
+}
+

package/src/generated/models/PoxStacker.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PoxStacker
+ */
+export interface PoxStacker {
+    /**
+     * 
+     * @type {string}
+     * @memberof PoxStacker
+     */
+    stacker_address: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PoxStacker
+     */
+    stacked_amount: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PoxStacker
+     */
+    pox_address: string;
+}
+
+export function PoxStackerFromJSON(json: any): PoxStacker {
+    return PoxStackerFromJSONTyped(json, false);
+}
+
+export function PoxStackerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PoxStacker {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'stacker_address': json['stacker_address'],
+        'stacked_amount': json['stacked_amount'],
+        'pox_address': json['pox_address'],
+    };
+}
+
+export function PoxStackerToJSON(value?: PoxStacker | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'stacker_address': value.stacker_address,
+        'stacked_amount': value.stacked_amount,
+        'pox_address': value.pox_address,
+    };
+}
+

package/src/generated/models/RosettaOptions.ts

@@ -127,6 +127,12 @@ export interface RosettaOptions {
      * @memberof RosettaOptions
      */
     burn_block_height?: number;
+    /**
+     * The reward cycle ID for stacking transaction.
+     * @type {number}
+     * @memberof RosettaOptions
+     */
+    reward_cycle_id?: number;
     /**
      * Delegator address for when calling `delegate-stacking`.
      * @type {string}
@@ -139,6 +145,36 @@ export interface RosettaOptions {
      * @memberof RosettaOptions
      */
     pox_addr?: string;
+    /**
+     * The hex-encoded signer key (buff 33) for PoX.
+     * @type {string}
+     * @memberof RosettaOptions
+     */
+    signer_key?: string;
+    /**
+     * The hex-encoded signer private key for PoX. Specify either this or `signer_signature`, otherwise the PoX transaction requires allow-listing from the signer.
+     * @type {string}
+     * @memberof RosettaOptions
+     */
+    signer_private_key?: string;
+    /**
+     * The hex-encoded signer signature for PoX. Specify either this or `signer_private_key`, otherwise the PoX transaction requires allow-listing from the signer.
+     * @type {string}
+     * @memberof RosettaOptions
+     */
+    signer_signature?: string;
+    /**
+     * The maximum amount of STX to stack for PoX. If not specified, the `amount` will be used as the `max-amount` for the PoX transaction.
+     * @type {string}
+     * @memberof RosettaOptions
+     */
+    pox_max_amount?: string;
+    /**
+     * The auth ID for the PoX transaction. If not specified, a random value will be generated.
+     * @type {string}
+     * @memberof RosettaOptions
+     */
+    pox_auth_id?: string;
 }
 
 export function RosettaOptionsFromJSON(json: any): RosettaOptions {
@@ -169,8 +205,14 @@ export function RosettaOptionsFromJSONTyped(json: any, ignoreDiscriminator: bool
         'contract_address': !exists(json, 'contract_address') ? undefined : json['contract_address'],
         'contract_name': !exists(json, 'contract_name') ? undefined : json['contract_name'],
         'burn_block_height': !exists(json, 'burn_block_height') ? undefined : json['burn_block_height'],
+        'reward_cycle_id': !exists(json, 'reward_cycle_id') ? undefined : json['reward_cycle_id'],
         'delegate_to': !exists(json, 'delegate_to') ? undefined : json['delegate_to'],
         'pox_addr': !exists(json, 'pox_addr') ? undefined : json['pox_addr'],
+        'signer_key': !exists(json, 'signer_key') ? undefined : json['signer_key'],
+        'signer_private_key': !exists(json, 'signer_private_key') ? undefined : json['signer_private_key'],
+        'signer_signature': !exists(json, 'signer_signature') ? undefined : json['signer_signature'],
+        'pox_max_amount': !exists(json, 'pox_max_amount') ? undefined : json['pox_max_amount'],
+        'pox_auth_id': !exists(json, 'pox_auth_id') ? undefined : json['pox_auth_id'],
     };
 }
 
@@ -201,8 +243,14 @@ export function RosettaOptionsToJSON(value?: RosettaOptions | null): any {
         'contract_address': value.contract_address,
         'contract_name': value.contract_name,
         'burn_block_height': value.burn_block_height,
+        'reward_cycle_id': value.reward_cycle_id,
         'delegate_to': value.delegate_to,
         'pox_addr': value.pox_addr,
+        'signer_key': value.signer_key,
+        'signer_private_key': value.signer_private_key,
+        'signer_signature': value.signer_signature,
+        'pox_max_amount': value.pox_max_amount,
+        'pox_auth_id': value.pox_auth_id,
     };
 }
 

package/src/generated/models/index.ts

@@ -72,6 +72,12 @@ export * from './OtherTransactionIdentifier';
 export * from './PoolDelegation';
 export * from './PoolDelegationsResponse';
 export * from './PostCoreNodeTransactionsError';
+export * from './PoxCycle';
+export * from './PoxCycleListResponse';
+export * from './PoxCycleSignerStackersListResponse';
+export * from './PoxCycleSignersListResponse';
+export * from './PoxSigner';
+export * from './PoxStacker';
 export * from './ReadOnlyFunctionArgs';
 export * from './ReadOnlyFunctionSuccessResponse';
 export * from './RosettaAccount';