@shapeshiftoss/unchained-client 9.0.3 → 9.2.0

package/dist/generated/avalanche/api.d.ts

@@ -0,0 +1,766 @@
+/**
+ * @shapeshiftoss/avalanche-api
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 7.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Configuration } from './configuration';
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from './base';
+/**
+ * Contains additional Avalanche specific info
+ * @export
+ * @interface AvalancheAccount
+ */
+export interface AvalancheAccount {
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheAccount
+     */
+    'balance': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheAccount
+     */
+    'unconfirmedBalance': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheAccount
+     */
+    'pubkey': string;
+    /**
+     *
+     * @type {number}
+     * @memberof AvalancheAccount
+     */
+    'nonce': number;
+    /**
+     *
+     * @type {Array<TokenBalance>}
+     * @memberof AvalancheAccount
+     */
+    'tokens': Array<TokenBalance>;
+}
+/**
+ * Contains info about an Avalanche transaction
+ * @export
+ * @interface AvalancheTx
+ */
+export interface AvalancheTx {
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'txid': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'blockHash'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AvalancheTx
+     */
+    'blockHeight': number;
+    /**
+     *
+     * @type {number}
+     * @memberof AvalancheTx
+     */
+    'timestamp': number;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'from': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'to': string;
+    /**
+     *
+     * @type {number}
+     * @memberof AvalancheTx
+     */
+    'confirmations': number;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'value': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'fee': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'gasLimit': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'gasUsed'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'gasPrice': string;
+    /**
+     *
+     * @type {number}
+     * @memberof AvalancheTx
+     */
+    'status': number;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTx
+     */
+    'inputData'?: string;
+    /**
+     *
+     * @type {Array<TokenTransfer>}
+     * @memberof AvalancheTx
+     */
+    'tokenTransfers'?: Array<TokenTransfer>;
+    /**
+     *
+     * @type {Array<InternalTx>}
+     * @memberof AvalancheTx
+     */
+    'internalTxs'?: Array<InternalTx>;
+}
+/**
+ * Contains info about Avalanche transaction history
+ * @export
+ * @interface AvalancheTxHistory
+ */
+export interface AvalancheTxHistory {
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTxHistory
+     */
+    'cursor'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AvalancheTxHistory
+     */
+    'pubkey': string;
+    /**
+     *
+     * @type {Array<AvalancheTx>}
+     * @memberof AvalancheTxHistory
+     */
+    'txs': Array<AvalancheTx>;
+}
+/**
+ * Contains info about a 400 Bad Request response
+ * @export
+ * @interface BadRequestError
+ */
+export interface BadRequestError {
+    /**
+     *
+     * @type {string}
+     * @memberof BadRequestError
+     */
+    'error': string;
+}
+/**
+ * Contains info about current recommended fees to use in a transaction
+ * @export
+ * @interface GasFees
+ */
+export interface GasFees {
+    /**
+     *
+     * @type {string}
+     * @memberof GasFees
+     */
+    'gasPrice': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GasFees
+     */
+    'maxFeePerGas': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GasFees
+     */
+    'maxPriorityFeePerGas': string;
+}
+/**
+ * Contains info about the running coinstack
+ * @export
+ * @interface Info
+ */
+export interface Info {
+    /**
+     *
+     * @type {string}
+     * @memberof Info
+     */
+    'network': string;
+}
+/**
+ * Contains info about a 500 Internal Server Error response
+ * @export
+ * @interface InternalServerError
+ */
+export interface InternalServerError {
+    /**
+     *
+     * @type {string}
+     * @memberof InternalServerError
+     */
+    'message': string;
+}
+/**
+ * Contains info about an Avalanche internal transaction
+ * @export
+ * @interface InternalTx
+ */
+export interface InternalTx {
+    /**
+     *
+     * @type {string}
+     * @memberof InternalTx
+     */
+    'from': string;
+    /**
+     *
+     * @type {string}
+     * @memberof InternalTx
+     */
+    'to': string;
+    /**
+     *
+     * @type {string}
+     * @memberof InternalTx
+     */
+    'value': string;
+}
+/**
+ * Contains the serialized raw transaction hex
+ * @export
+ * @interface SendTxBody
+ */
+export interface SendTxBody {
+    /**
+     *
+     * @type {string}
+     * @memberof SendTxBody
+     */
+    'hex': string;
+}
+/**
+ * Contains info about a token including balance for an address
+ * @export
+ * @interface TokenBalance
+ */
+export interface TokenBalance {
+    /**
+     *
+     * @type {string}
+     * @memberof TokenBalance
+     */
+    'contract': string;
+    /**
+     *
+     * @type {number}
+     * @memberof TokenBalance
+     */
+    'decimals': number;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenBalance
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenBalance
+     */
+    'symbol': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenBalance
+     */
+    'type': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenBalance
+     */
+    'balance': string;
+}
+/**
+ * Contains info about a token including transfer details
+ * @export
+ * @interface TokenTransfer
+ */
+export interface TokenTransfer {
+    /**
+     *
+     * @type {string}
+     * @memberof TokenTransfer
+     */
+    'contract': string;
+    /**
+     *
+     * @type {number}
+     * @memberof TokenTransfer
+     */
+    'decimals': number;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenTransfer
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenTransfer
+     */
+    'symbol': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenTransfer
+     */
+    'type': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenTransfer
+     */
+    'from': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenTransfer
+     */
+    'to': string;
+    /**
+     *
+     * @type {string}
+     * @memberof TokenTransfer
+     */
+    'value': string;
+}
+/**
+ * Contains info about a transaction
+ * @export
+ * @interface Tx
+ */
+export interface Tx {
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    'txid': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    'blockHash'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Tx
+     */
+    'blockHeight': number;
+    /**
+     *
+     * @type {number}
+     * @memberof Tx
+     */
+    'timestamp': number;
+}
+/**
+ * Contains info about a 422 Validation Error response
+ * @export
+ * @interface ValidationError
+ */
+export interface ValidationError {
+    /**
+     *
+     * @type {string}
+     * @memberof ValidationError
+     */
+    'message': ValidationErrorMessageEnum;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof ValidationError
+     */
+    'details': {
+        [key: string]: any;
+    };
+}
+export declare const ValidationErrorMessageEnum: {
+    readonly ValidationFailed: "Validation failed";
+};
+export declare type ValidationErrorMessageEnum = typeof ValidationErrorMessageEnum[keyof typeof ValidationErrorMessageEnum];
+/**
+ * V1Api - axios parameter creator
+ * @export
+ */
+export declare const V1ApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Get the estimated gas cost of a transaction
+     * @param {string} data input data
+     * @param {string} from from address
+     * @param {string} to to address
+     * @param {string} value transaction value in wei
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    estimateGas: (data: string, from: string, to: string, value: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get account details by address
+     * @param {string} pubkey account address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount: (pubkey: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the current recommended gas fees to use in a transaction  * For EIP-1559 transactions, use `maxFeePerGas` and `maxPriorityFeePerGas` * For Legacy transactions, use `gasPrice`
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGasFees: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get information about the running coinstack
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get transaction details
+     * @param {string} txid transaction hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransaction: (txid: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get transaction history by address
+     * @param {string} pubkey account address
+     * @param {string} [cursor] the cursor returned in previous query (base64 encoded json object with a \&#39;page\&#39; property)
+     * @param {number} [pageSize] page size (10 by default)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory: (pubkey: string, cursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Sends raw transaction to be broadcast to the node.
+     * @param {SendTxBody} sendTxBody serialized raw transaction hex
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx: (sendTxBody: SendTxBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * V1Api - functional programming interface
+ * @export
+ */
+export declare const V1ApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Get the estimated gas cost of a transaction
+     * @param {string} data input data
+     * @param {string} from from address
+     * @param {string} to to address
+     * @param {string} value transaction value in wei
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    estimateGas(data: string, from: string, to: string, value: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<string>>;
+    /**
+     * Get account details by address
+     * @param {string} pubkey account address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount(pubkey: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<AvalancheAccount>>;
+    /**
+     * Get the current recommended gas fees to use in a transaction  * For EIP-1559 transactions, use `maxFeePerGas` and `maxPriorityFeePerGas` * For Legacy transactions, use `gasPrice`
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGasFees(options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GasFees>>;
+    /**
+     * Get information about the running coinstack
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfo(options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Info>>;
+    /**
+     * Get transaction details
+     * @param {string} txid transaction hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransaction(txid: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<AvalancheTx>>;
+    /**
+     * Get transaction history by address
+     * @param {string} pubkey account address
+     * @param {string} [cursor] the cursor returned in previous query (base64 encoded json object with a \&#39;page\&#39; property)
+     * @param {number} [pageSize] page size (10 by default)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory(pubkey: string, cursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<AvalancheTxHistory>>;
+    /**
+     * Sends raw transaction to be broadcast to the node.
+     * @param {SendTxBody} sendTxBody serialized raw transaction hex
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx(sendTxBody: SendTxBody, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<string>>;
+};
+/**
+ * V1Api - factory interface
+ * @export
+ */
+export declare const V1ApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Get the estimated gas cost of a transaction
+     * @param {string} data input data
+     * @param {string} from from address
+     * @param {string} to to address
+     * @param {string} value transaction value in wei
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    estimateGas(data: string, from: string, to: string, value: string, options?: any): AxiosPromise<string>;
+    /**
+     * Get account details by address
+     * @param {string} pubkey account address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount(pubkey: string, options?: any): AxiosPromise<AvalancheAccount>;
+    /**
+     * Get the current recommended gas fees to use in a transaction  * For EIP-1559 transactions, use `maxFeePerGas` and `maxPriorityFeePerGas` * For Legacy transactions, use `gasPrice`
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGasFees(options?: any): AxiosPromise<GasFees>;
+    /**
+     * Get information about the running coinstack
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfo(options?: any): AxiosPromise<Info>;
+    /**
+     * Get transaction details
+     * @param {string} txid transaction hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransaction(txid: string, options?: any): AxiosPromise<AvalancheTx>;
+    /**
+     * Get transaction history by address
+     * @param {string} pubkey account address
+     * @param {string} [cursor] the cursor returned in previous query (base64 encoded json object with a \&#39;page\&#39; property)
+     * @param {number} [pageSize] page size (10 by default)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory(pubkey: string, cursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<AvalancheTxHistory>;
+    /**
+     * Sends raw transaction to be broadcast to the node.
+     * @param {SendTxBody} sendTxBody serialized raw transaction hex
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx(sendTxBody: SendTxBody, options?: any): AxiosPromise<string>;
+};
+/**
+ * Request parameters for estimateGas operation in V1Api.
+ * @export
+ * @interface V1ApiEstimateGasRequest
+ */
+export interface V1ApiEstimateGasRequest {
+    /**
+     * input data
+     * @type {string}
+     * @memberof V1ApiEstimateGas
+     */
+    readonly data: string;
+    /**
+     * from address
+     * @type {string}
+     * @memberof V1ApiEstimateGas
+     */
+    readonly from: string;
+    /**
+     * to address
+     * @type {string}
+     * @memberof V1ApiEstimateGas
+     */
+    readonly to: string;
+    /**
+     * transaction value in wei
+     * @type {string}
+     * @memberof V1ApiEstimateGas
+     */
+    readonly value: string;
+}
+/**
+ * Request parameters for getAccount operation in V1Api.
+ * @export
+ * @interface V1ApiGetAccountRequest
+ */
+export interface V1ApiGetAccountRequest {
+    /**
+     * account address
+     * @type {string}
+     * @memberof V1ApiGetAccount
+     */
+    readonly pubkey: string;
+}
+/**
+ * Request parameters for getTransaction operation in V1Api.
+ * @export
+ * @interface V1ApiGetTransactionRequest
+ */
+export interface V1ApiGetTransactionRequest {
+    /**
+     * transaction hash
+     * @type {string}
+     * @memberof V1ApiGetTransaction
+     */
+    readonly txid: string;
+}
+/**
+ * Request parameters for getTxHistory operation in V1Api.
+ * @export
+ * @interface V1ApiGetTxHistoryRequest
+ */
+export interface V1ApiGetTxHistoryRequest {
+    /**
+     * account address
+     * @type {string}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly pubkey: string;
+    /**
+     * the cursor returned in previous query (base64 encoded json object with a \&#39;page\&#39; property)
+     * @type {string}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly cursor?: string;
+    /**
+     * page size (10 by default)
+     * @type {number}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for sendTx operation in V1Api.
+ * @export
+ * @interface V1ApiSendTxRequest
+ */
+export interface V1ApiSendTxRequest {
+    /**
+     * serialized raw transaction hex
+     * @type {SendTxBody}
+     * @memberof V1ApiSendTx
+     */
+    readonly sendTxBody: SendTxBody;
+}
+/**
+ * V1Api - object-oriented interface
+ * @export
+ * @class V1Api
+ * @extends {BaseAPI}
+ */
+export declare class V1Api extends BaseAPI {
+    /**
+     * Get the estimated gas cost of a transaction
+     * @param {V1ApiEstimateGasRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    estimateGas(requestParameters: V1ApiEstimateGasRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
+    /**
+     * Get account details by address
+     * @param {V1ApiGetAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getAccount(requestParameters: V1ApiGetAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AvalancheAccount, any>>;
+    /**
+     * Get the current recommended gas fees to use in a transaction  * For EIP-1559 transactions, use `maxFeePerGas` and `maxPriorityFeePerGas` * For Legacy transactions, use `gasPrice`
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getGasFees(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GasFees, any>>;
+    /**
+     * Get information about the running coinstack
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Info, any>>;
+    /**
+     * Get transaction details
+     * @param {V1ApiGetTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getTransaction(requestParameters: V1ApiGetTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AvalancheTx, any>>;
+    /**
+     * Get transaction history by address
+     * @param {V1ApiGetTxHistoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getTxHistory(requestParameters: V1ApiGetTxHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AvalancheTxHistory, any>>;
+    /**
+     * Sends raw transaction to be broadcast to the node.
+     * @param {V1ApiSendTxRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    sendTx(requestParameters: V1ApiSendTxRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
+}