@stacks/blockchain-api-client 7.13.2 → 8.0.0-beta.2

package/src/generated/models/RosettaOperation.ts

@@ -1,135 +0,0 @@
-/* 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 {
-    RosettaAccount,
-    RosettaAccountFromJSON,
-    RosettaAccountFromJSONTyped,
-    RosettaAccountToJSON,
-    RosettaAmount,
-    RosettaAmountFromJSON,
-    RosettaAmountFromJSONTyped,
-    RosettaAmountToJSON,
-    RosettaCoinChange,
-    RosettaCoinChangeFromJSON,
-    RosettaCoinChangeFromJSONTyped,
-    RosettaCoinChangeToJSON,
-    RosettaOperationIdentifier,
-    RosettaOperationIdentifierFromJSON,
-    RosettaOperationIdentifierFromJSONTyped,
-    RosettaOperationIdentifierToJSON,
-    RosettaRelatedOperation,
-    RosettaRelatedOperationFromJSON,
-    RosettaRelatedOperationFromJSONTyped,
-    RosettaRelatedOperationToJSON,
-} from './';
-
-/**
- * Operations contain all balance-changing information within a transaction. They are always one-sided (only affect 1 AccountIdentifier) and can succeed or fail independently from a Transaction.
- * @export
- * @interface RosettaOperation
- */
-export interface RosettaOperation {
-    /**
-     * 
-     * @type {RosettaOperationIdentifier}
-     * @memberof RosettaOperation
-     */
-    operation_identifier: RosettaOperationIdentifier;
-    /**
-     * Restrict referenced related_operations to identifier indexes < the current operation_identifier.index. This ensures there exists a clear DAG-structure of relations. Since operations are one-sided, one could imagine relating operations in a single transfer or linking operations in a call tree.
-     * @type {Array<RosettaRelatedOperation>}
-     * @memberof RosettaOperation
-     */
-    related_operations?: Array<RosettaRelatedOperation>;
-    /**
-     * The network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkStatus. This can be very useful to downstream consumers that parse all block data.
-     * @type {string}
-     * @memberof RosettaOperation
-     */
-    type: string;
-    /**
-     * The network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply. Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation.
-     * @type {string}
-     * @memberof RosettaOperation
-     */
-    status?: string;
-    /**
-     * 
-     * @type {RosettaAccount}
-     * @memberof RosettaOperation
-     */
-    account?: RosettaAccount;
-    /**
-     * 
-     * @type {RosettaAmount}
-     * @memberof RosettaOperation
-     */
-    amount?: RosettaAmount;
-    /**
-     * 
-     * @type {RosettaCoinChange}
-     * @memberof RosettaOperation
-     */
-    coin_change?: RosettaCoinChange;
-    /**
-     * Operations Meta Data
-     * @type {object}
-     * @memberof RosettaOperation
-     */
-    metadata?: object;
-}
-
-export function RosettaOperationFromJSON(json: any): RosettaOperation {
-    return RosettaOperationFromJSONTyped(json, false);
-}
-
-export function RosettaOperationFromJSONTyped(json: any, ignoreDiscriminator: boolean): RosettaOperation {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'operation_identifier': RosettaOperationIdentifierFromJSON(json['operation_identifier']),
-        'related_operations': !exists(json, 'related_operations') ? undefined : ((json['related_operations'] as Array<any>).map(RosettaRelatedOperationFromJSON)),
-        'type': json['type'],
-        'status': !exists(json, 'status') ? undefined : json['status'],
-        'account': !exists(json, 'account') ? undefined : RosettaAccountFromJSON(json['account']),
-        'amount': !exists(json, 'amount') ? undefined : RosettaAmountFromJSON(json['amount']),
-        'coin_change': !exists(json, 'coin_change') ? undefined : RosettaCoinChangeFromJSON(json['coin_change']),
-        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
-    };
-}
-
-export function RosettaOperationToJSON(value?: RosettaOperation | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'operation_identifier': RosettaOperationIdentifierToJSON(value.operation_identifier),
-        'related_operations': value.related_operations === undefined ? undefined : ((value.related_operations as Array<any>).map(RosettaRelatedOperationToJSON)),
-        'type': value.type,
-        'status': value.status,
-        'account': RosettaAccountToJSON(value.account),
-        'amount': RosettaAmountToJSON(value.amount),
-        'coin_change': RosettaCoinChangeToJSON(value.coin_change),
-        'metadata': value.metadata,
-    };
-}
-

package/src/generated/models/RosettaOperationIdentifier.ts

@@ -1,64 +0,0 @@
-/* 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';
-/**
- * The operation_identifier uniquely identifies an operation within a transaction.
- * @export
- * @interface RosettaOperationIdentifier
- */
-export interface RosettaOperationIdentifier {
-    /**
-     * The operation index is used to ensure each operation has a unique identifier within a transaction. This index is only relative to the transaction and NOT GLOBAL. The operations in each transaction should start from index 0. To clarify, there may not be any notion of an operation index in the blockchain being described.
-     * @type {number}
-     * @memberof RosettaOperationIdentifier
-     */
-    index: number;
-    /**
-     * Some blockchains specify an operation index that is essential for client use. For example, Bitcoin uses a network_index to identify which UTXO was used in a transaction. network_index should not be populated if there is no notion of an operation index in a blockchain (typically most account-based blockchains).
-     * @type {number}
-     * @memberof RosettaOperationIdentifier
-     */
-    network_index?: number;
-}
-
-export function RosettaOperationIdentifierFromJSON(json: any): RosettaOperationIdentifier {
-    return RosettaOperationIdentifierFromJSONTyped(json, false);
-}
-
-export function RosettaOperationIdentifierFromJSONTyped(json: any, ignoreDiscriminator: boolean): RosettaOperationIdentifier {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'index': json['index'],
-        'network_index': !exists(json, 'network_index') ? undefined : json['network_index'],
-    };
-}
-
-export function RosettaOperationIdentifierToJSON(value?: RosettaOperationIdentifier | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'index': value.index,
-        'network_index': value.network_index,
-    };
-}
-

package/src/generated/models/RosettaOperationStatus.ts

@@ -1,64 +0,0 @@
-/* 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';
-/**
- * OperationStatus is utilized to indicate which Operation status are considered successful.
- * @export
- * @interface RosettaOperationStatus
- */
-export interface RosettaOperationStatus {
-    /**
-     * The status is the network-specific status of the operation.
-     * @type {string}
-     * @memberof RosettaOperationStatus
-     */
-    status: string;
-    /**
-     * An Operation is considered successful if the Operation.Amount should affect the Operation.Account. Some blockchains (like Bitcoin) only include successful operations in blocks but other blockchains (like Ethereum) include unsuccessful operations that incur a fee. To reconcile the computed balance from the stream of Operations, it is critical to understand which Operation.Status indicate an Operation is successful and should affect an Account.
-     * @type {boolean}
-     * @memberof RosettaOperationStatus
-     */
-    successful: boolean;
-}
-
-export function RosettaOperationStatusFromJSON(json: any): RosettaOperationStatus {
-    return RosettaOperationStatusFromJSONTyped(json, false);
-}
-
-export function RosettaOperationStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): RosettaOperationStatus {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'status': json['status'],
-        'successful': json['successful'],
-    };
-}
-
-export function RosettaOperationStatusToJSON(value?: RosettaOperationStatus | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'status': value.status,
-        'successful': value.successful,
-    };
-}
-

package/src/generated/models/RosettaOptions.ts

@@ -1,256 +0,0 @@
-/* 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';
-/**
- * The options that will be sent directly to /construction/metadata by the caller.
- * @export
- * @interface RosettaOptions
- */
-export interface RosettaOptions {
-    /**
-     * sender's address 
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    sender_address?: string;
-    /**
-     * Type of operation e.g transfer
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    type?: string;
-    /**
-     * This value indicates the state of the operations
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    status?: string;
-    /**
-     * Recipient's address
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    token_transfer_recipient_address?: string;
-    /**
-     * Amount to be transfered.
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    amount?: string;
-    /**
-     * Currency symbol e.g STX
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    symbol?: string;
-    /**
-     * Number of decimal places
-     * @type {number}
-     * @memberof RosettaOptions
-     */
-    decimals?: number;
-    /**
-     * Maximum price a user is willing to pay.
-     * @type {number}
-     * @memberof RosettaOptions
-     */
-    gas_limit?: number;
-    /**
-     * Cost necessary to perform a transaction on the network
-     * @type {number}
-     * @memberof RosettaOptions
-     */
-    gas_price?: number;
-    /**
-     *  A suggested fee multiplier to indicate that the suggested fee should be scaled. This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency.
-     * @type {number}
-     * @memberof RosettaOptions
-     */
-    suggested_fee_multiplier?: number;
-    /**
-     * Maximum fee user is willing to pay
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    max_fee?: string;
-    /**
-     * Fee for this transaction
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    fee?: string;
-    /**
-     * Transaction approximative size (used to calculate total fee).
-     * @type {number}
-     * @memberof RosettaOptions
-     */
-    size?: number;
-    /**
-     * STX token transfer memo.
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    memo?: string;
-    /**
-     * Number of cycles when stacking.
-     * @type {number}
-     * @memberof RosettaOptions
-     */
-    number_of_cycles?: number;
-    /**
-     * Address of the contract to call.
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    contract_address?: string;
-    /**
-     * Name of the contract to call.
-     * @type {string}
-     * @memberof RosettaOptions
-     */
-    contract_name?: string;
-    /**
-     * Set the burnchain (BTC) block for stacking lock to start.
-     * @type {number}
-     * @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}
-     * @memberof RosettaOptions
-     */
-    delegate_to?: string;
-    /**
-     * The reward address for stacking transaction. It should be a valid Bitcoin address
-     * @type {string}
-     * @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 {
-    return RosettaOptionsFromJSONTyped(json, false);
-}
-
-export function RosettaOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RosettaOptions {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'sender_address': !exists(json, 'sender_address') ? undefined : json['sender_address'],
-        'type': !exists(json, 'type') ? undefined : json['type'],
-        'status': !exists(json, 'status') ? undefined : json['status'],
-        'token_transfer_recipient_address': !exists(json, 'token_transfer_recipient_address') ? undefined : json['token_transfer_recipient_address'],
-        'amount': !exists(json, 'amount') ? undefined : json['amount'],
-        'symbol': !exists(json, 'symbol') ? undefined : json['symbol'],
-        'decimals': !exists(json, 'decimals') ? undefined : json['decimals'],
-        'gas_limit': !exists(json, 'gas_limit') ? undefined : json['gas_limit'],
-        'gas_price': !exists(json, 'gas_price') ? undefined : json['gas_price'],
-        'suggested_fee_multiplier': !exists(json, 'suggested_fee_multiplier') ? undefined : json['suggested_fee_multiplier'],
-        'max_fee': !exists(json, 'max_fee') ? undefined : json['max_fee'],
-        'fee': !exists(json, 'fee') ? undefined : json['fee'],
-        'size': !exists(json, 'size') ? undefined : json['size'],
-        'memo': !exists(json, 'memo') ? undefined : json['memo'],
-        'number_of_cycles': !exists(json, 'number_of_cycles') ? undefined : json['number_of_cycles'],
-        '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'],
-    };
-}
-
-export function RosettaOptionsToJSON(value?: RosettaOptions | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'sender_address': value.sender_address,
-        'type': value.type,
-        'status': value.status,
-        'token_transfer_recipient_address': value.token_transfer_recipient_address,
-        'amount': value.amount,
-        'symbol': value.symbol,
-        'decimals': value.decimals,
-        'gas_limit': value.gas_limit,
-        'gas_price': value.gas_price,
-        'suggested_fee_multiplier': value.suggested_fee_multiplier,
-        'max_fee': value.max_fee,
-        'fee': value.fee,
-        'size': value.size,
-        'memo': value.memo,
-        'number_of_cycles': value.number_of_cycles,
-        '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/RosettaOptionsRequest.ts

@@ -1,71 +0,0 @@
-/* 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 {
-    NetworkIdentifier,
-    NetworkIdentifierFromJSON,
-    NetworkIdentifierFromJSONTyped,
-    NetworkIdentifierToJSON,
-} from './';
-
-/**
- * This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network.
- * @export
- * @interface RosettaOptionsRequest
- */
-export interface RosettaOptionsRequest {
-    /**
-     * 
-     * @type {NetworkIdentifier}
-     * @memberof RosettaOptionsRequest
-     */
-    network_identifier: NetworkIdentifier;
-    /**
-     * 
-     * @type {object}
-     * @memberof RosettaOptionsRequest
-     */
-    metadata?: object;
-}
-
-export function RosettaOptionsRequestFromJSON(json: any): RosettaOptionsRequest {
-    return RosettaOptionsRequestFromJSONTyped(json, false);
-}
-
-export function RosettaOptionsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RosettaOptionsRequest {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'network_identifier': NetworkIdentifierFromJSON(json['network_identifier']),
-        'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
-    };
-}
-
-export function RosettaOptionsRequestToJSON(value?: RosettaOptionsRequest | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'network_identifier': NetworkIdentifierToJSON(value.network_identifier),
-        'metadata': value.metadata,
-    };
-}
-

package/src/generated/models/RosettaParentBlockIdentifier.ts

@@ -1,64 +0,0 @@
-/* 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';
-/**
- * The block_identifier uniquely identifies a block in a particular network.
- * @export
- * @interface RosettaParentBlockIdentifier
- */
-export interface RosettaParentBlockIdentifier {
-    /**
-     * This is also known as the block height.
-     * @type {number}
-     * @memberof RosettaParentBlockIdentifier
-     */
-    index: number;
-    /**
-     * Block hash
-     * @type {string}
-     * @memberof RosettaParentBlockIdentifier
-     */
-    hash: string;
-}
-
-export function RosettaParentBlockIdentifierFromJSON(json: any): RosettaParentBlockIdentifier {
-    return RosettaParentBlockIdentifierFromJSONTyped(json, false);
-}
-
-export function RosettaParentBlockIdentifierFromJSONTyped(json: any, ignoreDiscriminator: boolean): RosettaParentBlockIdentifier {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'index': json['index'],
-        'hash': json['hash'],
-    };
-}
-
-export function RosettaParentBlockIdentifierToJSON(value?: RosettaParentBlockIdentifier | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'index': value.index,
-        'hash': value.hash,
-    };
-}
-