@avalabs/glacier-sdk 2.8.0-alpha.6 → 2.8.0-alpha.60

package/dist/index.d.ts

@@ -1,3 +1,491 @@
-export * from './src/generated/models';
-export * from './src/glacierClient';
-//# sourceMappingURL=index.d.ts.map
+import { HttpOptions } from '@avalabs/utils-sdk';
+
+declare enum CurrencyCode {
+    Usd = "usd",
+    Eur = "eur",
+    Aud = "aud",
+    Cad = "cad",
+    Chf = "chf",
+    Clp = "clp",
+    Czk = "czk",
+    Dkk = "dkk",
+    Gbp = "gbp",
+    Hkd = "hkd",
+    Huf = "huf"
+}
+interface Money {
+    /**
+     * ISO 4217 currency code.
+     * @example usd
+     */
+    currencyCode: CurrencyCode;
+    /**
+     * Monetary value in base 10 decimals.
+     * @example 42.42
+     */
+    value: number;
+}
+interface NativeTokenBalance {
+    name: string;
+    symbol: string;
+    decimals: number;
+    logoUri?: string;
+    chainId: string;
+    price?: Money;
+    balance: string;
+    balanceValue?: Money;
+}
+interface NativeBalance {
+    nativeTokenBalance: NativeTokenBalance;
+}
+interface Erc20TokenBalance {
+    /** @example 0x71C7656EC7ab88b098defB751B7401B5f6d8976F */
+    address: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+    logoUri?: string;
+    price?: Money;
+    chainId: string;
+    balance: string;
+    balanceValue?: Money;
+}
+interface Erc20Balances {
+    /** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
+    nextPageToken?: string;
+    erc20TokenBalances: Erc20TokenBalance[];
+}
+declare enum Erc721MetadataStatus {
+    UNKNOWN = "UNKNOWN",
+    MISSING_TOKEN = "MISSING_TOKEN",
+    INVALID_TOKEN_URI = "INVALID_TOKEN_URI",
+    INVALID_TOKEN_URI_SCHEME = "INVALID_TOKEN_URI_SCHEME",
+    UNREACHABLE_TOKEN_URI = "UNREACHABLE_TOKEN_URI",
+    THROTTLED_TOKEN_URI = "THROTTLED_TOKEN_URI",
+    METADATA_CONTENT_TOO_LARGE = "METADATA_CONTENT_TOO_LARGE",
+    INVALID_METADATA = "INVALID_METADATA",
+    INVALID_METADATA_JSON = "INVALID_METADATA_JSON",
+    INDEXED = "INDEXED",
+    UNINDEXED = "UNINDEXED"
+}
+interface Erc721Metadata {
+    /**
+     * The metadata indexing status of the nft.
+     * @example indexed
+     */
+    indexStatus: Erc721MetadataStatus;
+    metadataLastUpdatedTimestamp?: number;
+    name?: string;
+    symbol?: string;
+    imageUri?: string;
+    description?: string;
+    animationUri?: string;
+    externalUrl?: string;
+    background?: string;
+    attributes?: string;
+}
+interface Erc721TokenBalance {
+    /** @example 0x71C7656EC7ab88b098defB751B7401B5f6d8976F */
+    address: string;
+    name: string;
+    symbol: string;
+    tokenId: string;
+    tokenUri: string;
+    metadata: Erc721Metadata;
+    chainId: string;
+}
+interface Erc721Balances {
+    /** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
+    nextPageToken?: string;
+    erc721TokenBalances: Erc721TokenBalance[];
+}
+interface Block {
+    /**
+     * The block number on the chain.
+     * @example 339
+     */
+    blockNumber: string;
+    /**
+     * The block finality timestamp.
+     * @example 1648672486
+     */
+    blockTimestamp: number;
+    /**
+     * The block hash identifier.
+     * @example 0x17533aeb5193378b9ff441d61728e7a2ebaf10f61fd5310759451627dfca2e7c
+     */
+    blockHash: string;
+    /** The number of transactions in the block. */
+    txCount: number;
+    /** The base gas fee for a transaction to be included in the block. */
+    baseFee: string;
+    /** The gas used for transactions in the block. */
+    gasUsed: string;
+    /** The total gas limit set for transactions in the block. */
+    gasLimit: string;
+    gasCost: string;
+    /** The hash of the parent block. */
+    parentHash: string;
+    /** The amount of fees spent/burned for transactions in the block. */
+    feesSpent: string;
+    /** The cumulative number of transactions for the chain including this block. */
+    cumulativeTransactions: string;
+}
+interface ListBlocks {
+    /** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
+    nextPageToken?: string;
+    blocks: Block[];
+}
+interface ListTransfers {
+    /** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
+    nextPageToken?: string;
+    transfers: Erc20Transfer[] | Erc721Transfer[];
+}
+interface RichAddress {
+    name?: string;
+    symbol?: string;
+    decimals?: number;
+    logoUri?: string;
+    /** @example 0x71C7656EC7ab88b098defB751B7401B5f6d8976F */
+    address: string;
+}
+interface Method {
+    /**
+     * The contract method hash identifier.
+     * @example 0xa9059cbb
+     */
+    methodHash: string;
+    /**
+     * The contract method name including parameter types.
+     * @example transfer(address,uint256)
+     */
+    methodName?: string;
+}
+interface NativeTransaction {
+    /**
+     * The block number on the chain.
+     * @example 339
+     */
+    blockNumber: string;
+    /**
+     * The block finality timestamp.
+     * @example 1648672486
+     */
+    blockTimestamp: number;
+    /**
+     * The block hash identifier.
+     * @example 0x17533aeb5193378b9ff441d61728e7a2ebaf10f61fd5310759451627dfca2e7c
+     */
+    blockHash: string;
+    /**
+     * The index at which the transaction occured in the block (0-indexed).
+     * @example 0
+     */
+    blockIndex: number;
+    /**
+     * The transaction hash identifier.
+     * @example 0x3e9303f81be00b4af28515dab7b914bf3dbff209ea10e7071fa24d4af0a112d4
+     */
+    txHash: string;
+    /**
+     * The transaction status, which is either 0 (failed) or 1 (successful).
+     * @example 1
+     */
+    txStatus: string;
+    /**
+     * The transaction type.
+     * @example 1
+     */
+    txType: number;
+    /**
+     * The gas limit set for the transaction.
+     * @example 51373
+     */
+    gasLimit: string;
+    /**
+     * The amount of gas used.
+     * @example 51373
+     */
+    gasUsed: string;
+    /**
+     * The gas price denominated by the number of decimals of the native token.
+     * @example 470000000000
+     */
+    gasPrice: string;
+    /**
+     * The nonce used by the sender of the transaction.
+     * @example 1
+     */
+    nonce: string;
+    from: RichAddress;
+    to: RichAddress;
+    method?: Method;
+    /** @example 10000000000000000000 */
+    value: string;
+}
+interface Erc20Token {
+    /** @example 0x71C7656EC7ab88b098defB751B7401B5f6d8976F */
+    address: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+    logoUri?: string;
+    price?: Money;
+}
+interface Erc20TransferDetails {
+    from: RichAddress;
+    to: RichAddress;
+    erc20Token: Erc20Token;
+    /** @example 10000000000000000000 */
+    value: string;
+}
+interface Erc721Token {
+    /** @example 0x71C7656EC7ab88b098defB751B7401B5f6d8976F */
+    address: string;
+    name: string;
+    symbol: string;
+    tokenId: string;
+    tokenUri: string;
+    metadata: Erc721Metadata;
+}
+interface Erc721TransferDetails {
+    from: RichAddress;
+    to: RichAddress;
+    erc721Token: Erc721Token;
+}
+declare enum InternalTransactionOpCall {
+    UNKNOWN = "UNKNOWN",
+    CALL = "CALL",
+    CREATE = "CREATE",
+    CREATE2 = "CREATE2",
+    CALLCODE = "CALLCODE",
+    DELEGATECALL = "DELEGATECALL",
+    STATICCALL = "STATICCALL"
+}
+interface InternalTransactionDetails {
+    from: RichAddress;
+    to: RichAddress;
+    internalTxType: InternalTransactionOpCall;
+    /** @example 10000000000000000000 */
+    value: string;
+    isReverted: boolean;
+}
+interface TransactionDetails {
+    nativeTransaction: NativeTransaction;
+    erc20Transfers?: Erc20TransferDetails[];
+    erc721Transfers?: Erc721TransferDetails[];
+    internalTransactions?: InternalTransactionDetails[];
+}
+interface ListTransactionDetails {
+    /** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
+    nextPageToken?: string;
+    transactions: TransactionDetails[];
+}
+interface ListNativeTransactions {
+    /** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
+    nextPageToken?: string;
+    transactions: NativeTransaction[];
+}
+interface Erc20Transfer {
+    /**
+     * The block number on the chain.
+     * @example 339
+     */
+    blockNumber: string;
+    /**
+     * The block finality timestamp.
+     * @example 1648672486
+     */
+    blockTimestamp: number;
+    /**
+     * The transaction hash identifier.
+     * @example 0x3e9303f81be00b4af28515dab7b914bf3dbff209ea10e7071fa24d4af0a112d4
+     */
+    txHash: string;
+    from: RichAddress;
+    to: RichAddress;
+    erc20Token: Erc20Token;
+    /** @example 10000000000000000000 */
+    value: string;
+}
+interface ListErc20Transactions {
+    /** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
+    nextPageToken?: string;
+    transactions: Erc20Transfer[];
+}
+interface Erc721Transfer {
+    /**
+     * The block number on the chain.
+     * @example 339
+     */
+    blockNumber: string;
+    /**
+     * The block finality timestamp.
+     * @example 1648672486
+     */
+    blockTimestamp: number;
+    /**
+     * The transaction hash identifier.
+     * @example 0x3e9303f81be00b4af28515dab7b914bf3dbff209ea10e7071fa24d4af0a112d4
+     */
+    txHash: string;
+    from: RichAddress;
+    to: RichAddress;
+    erc721Token: Erc721Token;
+}
+interface ListErc721Transactions {
+    /** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
+    nextPageToken?: string;
+    transactions: Erc721Transfer[];
+}
+interface NetworkToken {
+    name: string;
+    symbol: string;
+    decimals: number;
+    logoUri?: string;
+    description?: string;
+}
+interface NetworkTokenDetails {
+    networkToken: NetworkToken;
+    currentPrice?: Money;
+    historicalPrice?: Money;
+}
+interface FullTransactionDetails {
+    nativeTransaction: NativeTransaction;
+    erc20Transfers?: Erc20TransferDetails[];
+    erc721Transfers?: Erc721TransferDetails[];
+    internalTransactions?: InternalTransactionDetails[];
+    networkTokenDetails: NetworkTokenDetails;
+}
+declare enum VmName {
+    EVM = "EVM",
+    BITCOIN = "BITCOIN",
+    ETHEREUM = "ETHEREUM"
+}
+interface UtilityAddresses {
+    multicall?: string;
+}
+interface ChainInfo {
+    chainId: string;
+    chainName: string;
+    description: string;
+    platformChainId?: string;
+    subnetId?: string;
+    vmId?: string;
+    vmName: VmName;
+    explorerUrl?: string;
+    rpcUrl: string;
+    wsUrl?: string;
+    isTestnet: boolean;
+    utilityAddresses?: UtilityAddresses;
+    networkToken: NetworkToken;
+    chainLogoUri?: string;
+}
+interface Chains {
+    chains: ChainInfo[];
+}
+
+interface HealthStatusCheck {
+    status?: string;
+    info?: Record<string, {
+        status?: string;
+    }>;
+    error?: Record<string, {
+        status?: string;
+    }>;
+    details?: Record<string, {
+        status?: string;
+    }>;
+}
+
+declare class GlacierClient {
+    private baseUrl;
+    private version;
+    private httpOptions?;
+    private httpClient;
+    constructor(baseUrl: string, version?: string, httpOptions?: HttpOptions | undefined);
+    /**
+     *
+     * @name HealthCheck
+     * @summary Get the health of the service.
+     * @request GET:/${version}/health-check
+     * @response `200` `{ status?: string, info?: Record<string, { status?: string }>, error?: Record<string, { status?: string }>, details?: Record<string, { status?: string }> }` The Health Check is successful
+     * @response `503` `{ status?: string, info?: Record<string, { status?: string }>, error?: Record<string, { status?: string }>, details?: Record<string, { status?: string }> }` The Health Check is not successful
+     */
+    healthCheck(params?: Record<string, any>, customOptions?: HttpOptions): Promise<HealthStatusCheck>;
+    /**
+     * No description
+     *
+     * @name GetNativeBalance
+     * @summary Get native token balance of a wallet address for a given chain.
+     * @request GET:/v1/chains/{chainId}/addresses/{address}/balances:getNative
+     * @response `200` `NativeBalanceDto`
+     */
+    getNativeBalance(chainId: string, address: string, query?: {
+        currency?: CurrencyCode;
+    }, params?: Record<string, any>, customOptions?: HttpOptions): Promise<NativeBalance>;
+    /**
+     *
+     * @name ListErc20Balances
+     * @summary Get erc-20 token balances of a wallet address for a given chain.
+     * @request GET:/v1/chains/{chainId}/addresses/{address}/balances:listErc20
+     * @response `200` `Erc20BalancesDto`
+     */
+    listErc20Balances(chainId: string, address: string, query?: {
+        pageSize?: number;
+        pageToken?: string;
+        currency?: CurrencyCode;
+    }, params?: Record<string, any>, customOptions?: HttpOptions): Promise<Erc20Balances>;
+    /**
+     * No description
+     *
+     * @name ListErc721Balances
+     * @summary Get erc-721 token balances of a wallet address for a given chain.
+     * @request GET:/v1/chains/{chainId}/addresses/{address}/balances:listErc721
+     * @response `200` `Erc721BalancesDto`
+     */
+    listErc721Balances(chainId: string, address: string, query?: {
+        pageSize?: number;
+        pageToken?: string;
+        currency?: CurrencyCode;
+    }, params?: Record<string, any>, customOptions?: HttpOptions): Promise<Erc721Balances>;
+    /**
+     * @description Gets a list of transactions where the given wallet address had an on-chain interaction for a given chain. The erc20 transfers, erc721 transfers, and internal transactions returned as part of the native transactions are only those where the address had an interaction. Therefore the transactions returned from this list may not be complete representations of the on-chain data. For a complete view of a transaction use the `/chains/:chainId/transactions/:txHash` endpoint.
+     *
+     * @name ListTransactions
+     * @summary Gets a list of transactions for a wallet address and chain.
+     * @request GET:/v1/chains/{chainId}/addresses/{address}/transactions
+     * @response `200` `ListTransactionDetailsDto`
+     */
+    listTransactions(chainId: string, address: string, query?: {
+        pageSize?: number;
+        pageToken?: string;
+    }, params?: Record<string, any>, customOptions?: HttpOptions): Promise<ListTransactionDetails>;
+    /**
+     *
+     * @name GetTransaction
+     * @summary Gets the details of a single transaction.
+     * @request GET:/v1/chains/{chainId}/transactions/{txHash}
+     * @response `200` `TransactionDetailsDto`
+     */
+    getTransaction(chainId: string, txHash: string, params?: Record<string, any>, customOptions?: HttpOptions): Promise<TransactionDetails>;
+    /**
+     *
+     * @name SupportedChains
+     * @summary Gets the list of chains supported by the api.
+     * @request GET:/v1/chains
+     * @response `200` `ChainsDto`
+     */
+    supportedChains(params?: Record<string, any>, customOptions?: HttpOptions): Promise<Chains>;
+    /**
+     * No description
+     *
+     * @name GetChainInfo
+     * @summary Gets chain information by chain id.
+     * @request GET:/v1/chains/{chainId}
+     * @response `200` `ChainInfoDto`
+     */
+    getChainInfo(chainId: string, params?: Record<string, any>, customOptions?: HttpOptions): Promise<ChainInfo>;
+}
+
+export { Block, ChainInfo, Chains, CurrencyCode, Erc20Balances, Erc20Token, Erc20TokenBalance, Erc20Transfer, Erc20TransferDetails, Erc721Balances, Erc721Metadata, Erc721MetadataStatus, Erc721Token, Erc721TokenBalance, Erc721Transfer, Erc721TransferDetails, FullTransactionDetails, GlacierClient, InternalTransactionDetails, InternalTransactionOpCall, ListBlocks, ListErc20Transactions, ListErc721Transactions, ListNativeTransactions, ListTransactionDetails, ListTransfers, Method, Money, NativeBalance, NativeTokenBalance, NativeTransaction, NetworkToken, NetworkTokenDetails, RichAddress, TransactionDetails, UtilityAddresses, VmName };