@alephium/web3 2.0.3 → 2.0.4

package/dist/src/api/api-explorer.d.ts

@@ -19,6 +19,7 @@ export interface AcceptedTransaction {
     inputSignatures?: string[];
     scriptSignatures?: string[];
     coinbase: boolean;
+    conflicted?: boolean;
     type: string;
 }
 /** AddressBalance */
@@ -104,6 +105,7 @@ export interface BlockEntry {
     parent?: string;
     mainChain: boolean;
     ghostUncles?: GhostUncle[];
+    conflictedTxs?: string[];
 }
 /** BlockEntryLite */
 export interface BlockEntryLite {
@@ -165,6 +167,8 @@ export interface ContractParent {
 export interface Event {
     /** @format block-hash */
     blockHash: string;
+    /** @format int64 */
+    timestamp: number;
     /** @format 32-byte-hash */
     txHash: string;
     /** @format address */
@@ -200,6 +204,10 @@ export interface FungibleTokenMetadata {
     /** @format uint256 */
     decimals: string;
 }
+/** GatewayTimeout */
+export interface GatewayTimeout {
+    detail: string;
+}
 /** GhostUncle */
 export interface GhostUncle {
     /** @format block-hash */
@@ -453,6 +461,7 @@ export interface Transaction {
     inputSignatures?: string[];
     scriptSignatures?: string[];
     coinbase: boolean;
+    conflicted?: boolean;
 }
 /** TransactionInfo */
 export interface TransactionInfo {
@@ -543,7 +552,10 @@ export declare enum Currencies {
     Rub = "rub",
     Try = "try",
     Cad = "cad",
-    Aud = "aud"
+    Aud = "aud",
+    Hkd = "hkd",
+    Thb = "thb",
+    Cny = "cny"
 }
 import 'cross-fetch/polyfill';
 export type QueryParamsType = Record<string | number, any>;
@@ -611,10 +623,11 @@ export declare class HttpClient<SecurityDataType = unknown> {
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
     blocks: {
         /**
-         * @description List latest blocks
+         * No description
          *
          * @tags Blocks
          * @name GetBlocks
+         * @summary List latest blocks
          * @request GET:/blocks
          */
         getBlocks: (query?: {
@@ -635,18 +648,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             reverse?: boolean;
         }, params?: RequestParams) => Promise<ListBlocks>;
         /**
-         * @description Get a block with hash
+         * No description
          *
          * @tags Blocks
          * @name GetBlocksBlockHash
+         * @summary Get a block with hash
          * @request GET:/blocks/{block_hash}
          */
         getBlocksBlockHash: (blockHash: string, params?: RequestParams) => Promise<BlockEntry>;
         /**
-         * @description Get block's transactions
+         * No description
          *
          * @tags Blocks
          * @name GetBlocksBlockHashTransactions
+         * @summary Get block's transactions
          * @request GET:/blocks/{block_hash}/transactions
          */
         getBlocksBlockHashTransactions: (blockHash: string, query?: {
@@ -667,28 +682,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     transactions: {
         /**
-         * @description Get a transaction with hash
+         * No description
          *
          * @tags Transactions
          * @name GetTransactionsTransactionHash
+         * @summary Get a transaction with hash
          * @request GET:/transactions/{transaction_hash}
          */
         getTransactionsTransactionHash: (transactionHash: string, params?: RequestParams) => Promise<AcceptedTransaction | PendingTransaction>;
     };
     addresses: {
         /**
-         * @description Get address information
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddress
+         * @summary Get address information
          * @request GET:/addresses/{address}
          */
         getAddressesAddress: (address: string, params?: RequestParams) => Promise<AddressInfo>;
         /**
-         * @description List transactions of a given address
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressTransactions
+         * @summary List transactions of a given address
          * @request GET:/addresses/{address}/transactions
          */
         getAddressesAddressTransactions: (address: string, query?: {
@@ -707,11 +725,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
-         * @description List transactions for given addresses
+         * No description
          *
          * @tags Addresses
          * @name PostAddressesTransactions
+         * @summary List transactions for given addresses
          * @request POST:/addresses/transactions
+         * @deprecated
          */
         postAddressesTransactions: (query?: {
             /**
@@ -741,10 +761,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, data?: string[], params?: RequestParams) => Promise<Transaction[]>;
         /**
-         * @description List transactions of a given address within a time-range
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressTimerangedTransactions
+         * @summary List transactions of a given address within a time-range
          * @request GET:/addresses/{address}/timeranged-transactions
          */
         getAddressesAddressTimerangedTransactions: (address: string, query: {
@@ -773,42 +794,47 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
-         * @description Get total transactions of a given address
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressTotalTransactions
+         * @summary Get total transactions of a given address
          * @request GET:/addresses/{address}/total-transactions
          */
         getAddressesAddressTotalTransactions: (address: string, params?: RequestParams) => Promise<number>;
         /**
-         * @description Get latest transaction information of a given address
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressLatestTransaction
+         * @summary Get latest transaction information of a given address
          * @request GET:/addresses/{address}/latest-transaction
          */
         getAddressesAddressLatestTransaction: (address: string, params?: RequestParams) => Promise<TransactionInfo>;
         /**
-         * @description List mempool transactions of a given address
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressMempoolTransactions
+         * @summary List mempool transactions of a given address
          * @request GET:/addresses/{address}/mempool/transactions
          */
         getAddressesAddressMempoolTransactions: (address: string, params?: RequestParams) => Promise<MempoolTransaction[]>;
         /**
-         * @description Get address balance
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressBalance
+         * @summary Get address balance
          * @request GET:/addresses/{address}/balance
          */
         getAddressesAddressBalance: (address: string, params?: RequestParams) => Promise<AddressBalance>;
         /**
-         * @description List address tokens
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressTokens
+         * @summary List address tokens
          * @request GET:/addresses/{address}/tokens
          * @deprecated
          */
@@ -828,10 +854,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<string[]>;
         /**
-         * @description List address tokens
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressTokensTokenIdTransactions
+         * @summary List address tokens
          * @request GET:/addresses/{address}/tokens/{token_id}/transactions
          */
         getAddressesAddressTokensTokenIdTransactions: (address: string, tokenId: string, query?: {
@@ -850,26 +877,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
-         * @description Get address balance of given token
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressTokensTokenIdBalance
+         * @summary Get address balance of given token
          * @request GET:/addresses/{address}/tokens/{token_id}/balance
          */
         getAddressesAddressTokensTokenIdBalance: (address: string, tokenId: string, params?: RequestParams) => Promise<AddressTokenBalance>;
         /**
-         * @description Get public key of p2pkh addresses, the address needs to have at least one input.
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressPublicKey
+         * @summary Use `/addresses/{address}/typed-public-key` instead
          * @request GET:/addresses/{address}/public-key
+         * @deprecated
          */
         getAddressesAddressPublicKey: (address: string, params?: RequestParams) => Promise<string>;
         /**
-         * @description Get address tokens with balance
+         * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressTokensBalance
+         * @summary Get address tokens with balance
          * @request GET:/addresses/{address}/tokens-balance
          */
         getAddressesAddressTokensBalance: (address: string, query?: {
@@ -888,10 +919,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<AddressTokenBalance[]>;
         /**
-         * @description Are the addresses used (at least 1 transaction)
+         * No description
          *
          * @tags Addresses, Addresses
          * @name PostAddressesUsed
+         * @summary Are the addresses used (at least 1 transaction)
          * @request POST:/addresses/used
          */
         postAddressesUsed: (data?: string[], params?: RequestParams) => Promise<boolean[]>;
@@ -914,33 +946,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             toTs: number;
         }, params?: RequestParams) => Promise<string>;
-        /**
-         * No description
-         *
-         * @tags Addresses
-         * @name GetAddressesAddressAmountHistoryDeprecated
-         * @request GET:/addresses/{address}/amount-history-DEPRECATED
-         * @deprecated
-         */
-        getAddressesAddressAmountHistoryDeprecated: (address: string, query: {
-            /**
-             * @format int64
-             * @min 0
-             */
-            fromTs: number;
-            /**
-             * @format int64
-             * @min 0
-             */
-            toTs: number;
-            'interval-type': IntervalType;
-        }, params?: RequestParams) => Promise<string>;
         /**
          * No description
          *
          * @tags Addresses
          * @name GetAddressesAddressAmountHistory
          * @request GET:/addresses/{address}/amount-history
+         * @deprecated
          */
         getAddressesAddressAmountHistory: (address: string, query: {
             /**
@@ -958,26 +970,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     infos: {
         /**
-         * @description Get explorer informations
+         * No description
          *
          * @tags Infos
          * @name GetInfos
+         * @summary Get explorer informations
          * @request GET:/infos
          */
         getInfos: (params?: RequestParams) => Promise<ExplorerInfo>;
         /**
-         * @description List latest height for each chain
+         * No description
          *
          * @tags Infos
          * @name GetInfosHeights
+         * @summary List latest height for each chain
          * @request GET:/infos/heights
          */
         getInfosHeights: (params?: RequestParams) => Promise<PerChainHeight[]>;
         /**
-         * @description Get token supply list
+         * No description
          *
          * @tags Infos
          * @name GetInfosSupply
+         * @summary Get token supply list
          * @request GET:/infos/supply
          */
         getInfosSupply: (query?: {
@@ -996,60 +1011,67 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<TokenSupply[]>;
         /**
-         * @description Get the ALPH total supply
+         * No description
          *
          * @tags Infos
          * @name GetInfosSupplyTotalAlph
+         * @summary Get the ALPH total supply
          * @request GET:/infos/supply/total-alph
          */
         getInfosSupplyTotalAlph: (params?: RequestParams) => Promise<number>;
         /**
-         * @description Get the ALPH circulating supply
+         * No description
          *
          * @tags Infos
          * @name GetInfosSupplyCirculatingAlph
+         * @summary Get the ALPH circulating supply
          * @request GET:/infos/supply/circulating-alph
          */
         getInfosSupplyCirculatingAlph: (params?: RequestParams) => Promise<number>;
         /**
-         * @description Get the ALPH reserved supply
+         * No description
          *
          * @tags Infos
          * @name GetInfosSupplyReservedAlph
+         * @summary Get the ALPH reserved supply
          * @request GET:/infos/supply/reserved-alph
          */
         getInfosSupplyReservedAlph: (params?: RequestParams) => Promise<number>;
         /**
-         * @description Get the ALPH locked supply
+         * No description
          *
          * @tags Infos
          * @name GetInfosSupplyLockedAlph
+         * @summary Get the ALPH locked supply
          * @request GET:/infos/supply/locked-alph
          */
         getInfosSupplyLockedAlph: (params?: RequestParams) => Promise<number>;
         /**
-         * @description Get the total number of transactions
+         * No description
          *
          * @tags Infos
          * @name GetInfosTotalTransactions
+         * @summary Get the total number of transactions
          * @request GET:/infos/total-transactions
          */
         getInfosTotalTransactions: (params?: RequestParams) => Promise<number>;
         /**
-         * @description Get the average block time for each chain
+         * No description
          *
          * @tags Infos
          * @name GetInfosAverageBlockTimes
+         * @summary Get the average block time for each chain
          * @request GET:/infos/average-block-times
          */
         getInfosAverageBlockTimes: (params?: RequestParams) => Promise<PerChainDuration[]>;
     };
     mempool: {
         /**
-         * @description list mempool transactions
+         * No description
          *
          * @tags Mempool
          * @name GetMempoolTransactions
+         * @summary list mempool transactions
          * @request GET:/mempool/transactions
          */
         getMempoolTransactions: (query?: {
@@ -1070,10 +1092,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     tokens: {
         /**
-         * @description List token information
+         * No description
          *
          * @tags Tokens
          * @name GetTokens
+         * @summary List token information
          * @request GET:/tokens
          */
         getTokens: (query?: {
@@ -1097,18 +1120,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             'interface-id'?: TokenStdInterfaceId | string;
         }, params?: RequestParams) => Promise<TokenInfo[]>;
         /**
-         * @description List given tokens information
+         * No description
          *
          * @tags Tokens
          * @name PostTokens
+         * @summary List given tokens information
          * @request POST:/tokens
          */
         postTokens: (data?: string[], params?: RequestParams) => Promise<TokenInfo[]>;
         /**
-         * @description List token transactions
+         * No description
          *
          * @tags Tokens
          * @name GetTokensTokenIdTransactions
+         * @summary List token transactions
          * @request GET:/tokens/{token_id}/transactions
          */
         getTokensTokenIdTransactions: (tokenId: string, query?: {
@@ -1127,10 +1152,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
-         * @description List token addresses
+         * No description
          *
          * @tags Tokens
          * @name GetTokensTokenIdAddresses
+         * @summary List token addresses
          * @request GET:/tokens/{token_id}/addresses
          */
         getTokensTokenIdAddresses: (tokenId: string, query?: {
@@ -1149,34 +1175,38 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<string[]>;
         /**
-         * @description Return metadata for the given fungible tokens, if metadata doesn't exist or token isn't a fungible, it won't be in the output list
+         * @description If metadata doesn't exist or token isn't a fungible, it won't be in the output list
          *
          * @tags Tokens
          * @name PostTokensFungibleMetadata
+         * @summary Return metadata for the given fungible tokens
          * @request POST:/tokens/fungible-metadata
          */
         postTokensFungibleMetadata: (data?: string[], params?: RequestParams) => Promise<FungibleTokenMetadata[]>;
         /**
-         * @description Return metadata for the given nft tokens, if metadata doesn't exist or token isn't a nft, it won't be in the output list
+         * @description If metadata doesn't exist or token isn't a nft, it won't be in the output list
          *
          * @tags Tokens
          * @name PostTokensNftMetadata
+         * @summary Return metadata for the given nft tokens
          * @request POST:/tokens/nft-metadata
          */
         postTokensNftMetadata: (data?: string[], params?: RequestParams) => Promise<NFTMetadata[]>;
         /**
-         * @description Return metadata for the given nft collection addresses, if metadata doesn't exist or address isn't a nft collection, it won't be in the output list
+         * @description If metadata doesn't exist or address isn't a nft collection, it won't be in the output list
          *
          * @tags Tokens
          * @name PostTokensNftCollectionMetadata
+         * @summary Return metadata for the given nft collection addresses
          * @request POST:/tokens/nft-collection-metadata
          */
         postTokensNftCollectionMetadata: (data?: string[], params?: RequestParams) => Promise<NFTCollectionMetadata[]>;
         /**
-         * @description Get a sorted list of top addresses by ALPH balance. Updates once per day.
+         * @description Updates once per day.
          *
          * @tags Tokens
          * @name GetTokensHoldersAlph
+         * @summary Get a sorted list of top addresses by ALPH balance
          * @request GET:/tokens/holders/alph
          */
         getTokensHoldersAlph: (query?: {
@@ -1195,10 +1225,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<HolderInfo[]>;
         /**
-         * @description Get a sorted list of top addresses by {token_id} balance. Updates once per day.
+         * @description Updates once per day.
          *
          * @tags Tokens
          * @name GetTokensHoldersTokenTokenId
+         * @summary Get a sorted list of top addresses by {token_id} balance. Updates once per day.
          * @request GET:/tokens/holders/token/{token_id}
          */
         getTokensHoldersTokenTokenId: (tokenId: string, query?: {
@@ -1284,21 +1315,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     contractEvents: {
         /**
-         * @description Get contract events by transaction id
+         * No description
          *
          * @tags Contract events
          * @name GetContractEventsTransactionIdTransactionId
+         * @summary Get contract events by transaction id
          * @request GET:/contract-events/transaction-id/{transaction_id}
          */
         getContractEventsTransactionIdTransactionId: (transactionId: string, params?: RequestParams) => Promise<Event[]>;
         /**
-         * @description Get contract events by contract address
+         * No description
          *
          * @tags Contract events
          * @name GetContractEventsContractAddressContractAddress
+         * @summary Get contract events by contract address
          * @request GET:/contract-events/contract-address/{contract_address}
          */
         getContractEventsContractAddressContractAddress: (contractAddress: string, query?: {
+            /** @format int32 */
+            event_index?: number;
             /**
              * Page number
              * @format int32
@@ -1314,13 +1349,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<Event[]>;
         /**
-         * @description Get contract events by contract and input addresses
+         * No description
          *
          * @tags Contract events
          * @name GetContractEventsContractAddressContractAddressInputAddressInputAddress
+         * @summary Get contract events by contract and input addresses
          * @request GET:/contract-events/contract-address/{contract_address}/input-address/{input_address}
          */
         getContractEventsContractAddressContractAddressInputAddressInputAddress: (contractAddress: string, inputAddress: string, query?: {
+            /** @format int32 */
+            event_index?: number;
             /**
              * Page number
              * @format int32
@@ -1338,26 +1376,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     contracts: {
         /**
-         * @description Get contract liveness
+         * No description
          *
          * @tags Contracts
          * @name GetContractsContractAddressCurrentLiveness
+         * @summary Get contract liveness
          * @request GET:/contracts/{contract_address}/current-liveness
          */
         getContractsContractAddressCurrentLiveness: (contractAddress: string, params?: RequestParams) => Promise<ContractLiveness>;
         /**
-         * @description Get contract parent address if exist
+         * No description
          *
          * @tags Contracts
          * @name GetContractsContractAddressParent
+         * @summary Get contract parent address if exist
          * @request GET:/contracts/{contract_address}/parent
          */
         getContractsContractAddressParent: (contractAddress: string, params?: RequestParams) => Promise<ContractParent>;
         /**
-         * @description Get sub contract addresses
+         * No description
          *
          * @tags Contracts
          * @name GetContractsContractAddressSubContracts
+         * @summary Get sub contract addresses
          * @request GET:/contracts/{contract_address}/sub-contracts
          */
         getContractsContractAddressSubContracts: (contractAddress: string, query?: {
@@ -1400,26 +1441,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     utils: {
         /**
-         * @description Perform a sanity check
+         * No description
          *
          * @tags Utils
          * @name PutUtilsSanityCheck
+         * @summary Perform a sanity check
          * @request PUT:/utils/sanity-check
          */
         putUtilsSanityCheck: (params?: RequestParams) => Promise<void>;
         /**
-         * @description Update global log level, accepted: TRACE, DEBUG, INFO, WARN, ERROR
+         * No description
          *
          * @tags Utils
          * @name PutUtilsUpdateGlobalLoglevel
+         * @summary Update global log level, accepted: TRACE, DEBUG, INFO, WARN, ERROR
          * @request PUT:/utils/update-global-loglevel
          */
         putUtilsUpdateGlobalLoglevel: (data: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR', params?: RequestParams) => Promise<void>;
         /**
-         * @description Update logback values
+         * No description
          *
          * @tags Utils
          * @name PutUtilsUpdateLogConfig
+         * @summary Update logback values
          * @request PUT:/utils/update-log-config
          */
         putUtilsUpdateLogConfig: (data?: LogbackValue[], params?: RequestParams) => Promise<void>;