@alephium/web3 2.0.3 → 2.0.4

package/dist/src/api/api-explorer.js

@@ -65,6 +65,9 @@ var Currencies;
     Currencies["Try"] = "try";
     Currencies["Cad"] = "cad";
     Currencies["Aud"] = "aud";
+    Currencies["Hkd"] = "hkd";
+    Currencies["Thb"] = "thb";
+    Currencies["Cny"] = "cny";
 })(Currencies = exports.Currencies || (exports.Currencies = {}));
 require("cross-fetch/polyfill");
 const utils_1 = require("./utils");
@@ -213,10 +216,11 @@ class Api extends HttpClient {
         super(...arguments);
         this.blocks = {
             /**
-             * @description List latest blocks
+             * No description
              *
              * @tags Blocks
              * @name GetBlocks
+             * @summary List latest blocks
              * @request GET:/blocks
              */
             getBlocks: (query, params = {}) => this.request({
@@ -227,10 +231,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -240,10 +245,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description Get block's transactions
+             * No description
              *
              * @tags Blocks
              * @name GetBlocksBlockHashTransactions
+             * @summary Get block's transactions
              * @request GET:/blocks/{block_hash}/transactions
              */
             getBlocksBlockHashTransactions: (blockHash, query, params = {}) => this.request({
@@ -256,10 +262,11 @@ class Api extends HttpClient {
         };
         this.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, params = {}) => this.request({
@@ -271,10 +278,11 @@ class Api extends HttpClient {
         };
         this.addresses = {
             /**
-             * @description Get address information
+             * No description
              *
              * @tags Addresses
              * @name GetAddressesAddress
+             * @summary Get address information
              * @request GET:/addresses/{address}
              */
             getAddressesAddress: (address, params = {}) => this.request({
@@ -284,10 +292,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, query, params = {}) => this.request({
@@ -298,11 +307,13 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, data, params = {}) => this.request({
                 path: `/addresses/transactions`,
@@ -314,10 +325,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, query, params = {}) => this.request({
@@ -328,10 +340,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -341,10 +354,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -354,10 +368,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -367,10 +382,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description Get address balance
+             * No description
              *
              * @tags Addresses
              * @name GetAddressesAddressBalance
+             * @summary Get address balance
              * @request GET:/addresses/{address}/balance
              */
             getAddressesAddressBalance: (address, params = {}) => this.request({
@@ -380,10 +396,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description List address tokens
+             * No description
              *
              * @tags Addresses
              * @name GetAddressesAddressTokens
+             * @summary List address tokens
              * @request GET:/addresses/{address}/tokens
              * @deprecated
              */
@@ -395,10 +412,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description List address tokens
+             * No description
              *
              * @tags Addresses
              * @name GetAddressesAddressTokensTokenIdTransactions
+             * @summary List address tokens
              * @request GET:/addresses/{address}/tokens/{token_id}/transactions
              */
             getAddressesAddressTokensTokenIdTransactions: (address, tokenId, query, params = {}) => this.request({
@@ -409,10 +427,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, tokenId, params = {}) => this.request({
@@ -422,11 +441,13 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
                 path: `/addresses/${address}/public-key`,
@@ -435,10 +456,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, query, params = {}) => this.request({
@@ -449,10 +471,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -477,27 +500,13 @@ class Api extends HttpClient {
                 format: 'text',
                 ...params
             }).then(utils_1.convertHttpResponse),
-            /**
-             * No description
-             *
-             * @tags Addresses
-             * @name GetAddressesAddressAmountHistoryDeprecated
-             * @request GET:/addresses/{address}/amount-history-DEPRECATED
-             * @deprecated
-             */
-            getAddressesAddressAmountHistoryDeprecated: (address, query, params = {}) => this.request({
-                path: `/addresses/${address}/amount-history-DEPRECATED`,
-                method: 'GET',
-                query: query,
-                format: 'json',
-                ...params
-            }).then(utils_1.convertHttpResponse),
             /**
              * No description
              *
              * @tags Addresses
              * @name GetAddressesAddressAmountHistory
              * @request GET:/addresses/{address}/amount-history
+             * @deprecated
              */
             getAddressesAddressAmountHistory: (address, query, params = {}) => this.request({
                 path: `/addresses/${address}/amount-history`,
@@ -509,10 +518,11 @@ class Api extends HttpClient {
         };
         this.infos = {
             /**
-             * @description Get explorer informations
+             * No description
              *
              * @tags Infos
              * @name GetInfos
+             * @summary Get explorer informations
              * @request GET:/infos
              */
             getInfos: (params = {}) => this.request({
@@ -522,10 +532,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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 = {}) => this.request({
@@ -535,10 +546,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description Get token supply list
+             * No description
              *
              * @tags Infos
              * @name GetInfosSupply
+             * @summary Get token supply list
              * @request GET:/infos/supply
              */
             getInfosSupply: (query, params = {}) => this.request({
@@ -549,10 +561,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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 = {}) => this.request({
@@ -562,10 +575,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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 = {}) => this.request({
@@ -575,10 +589,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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 = {}) => this.request({
@@ -588,10 +603,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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 = {}) => this.request({
@@ -601,10 +617,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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 = {}) => this.request({
@@ -614,10 +631,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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 = {}) => this.request({
@@ -629,10 +647,11 @@ class Api extends HttpClient {
         };
         this.mempool = {
             /**
-             * @description list mempool transactions
+             * No description
              *
              * @tags Mempool
              * @name GetMempoolTransactions
+             * @summary list mempool transactions
              * @request GET:/mempool/transactions
              */
             getMempoolTransactions: (query, params = {}) => this.request({
@@ -645,10 +664,11 @@ class Api extends HttpClient {
         };
         this.tokens = {
             /**
-             * @description List token information
+             * No description
              *
              * @tags Tokens
              * @name GetTokens
+             * @summary List token information
              * @request GET:/tokens
              */
             getTokens: (query, params = {}) => this.request({
@@ -659,10 +679,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description List given tokens information
+             * No description
              *
              * @tags Tokens
              * @name PostTokens
+             * @summary List given tokens information
              * @request POST:/tokens
              */
             postTokens: (data, params = {}) => this.request({
@@ -674,10 +695,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description List token transactions
+             * No description
              *
              * @tags Tokens
              * @name GetTokensTokenIdTransactions
+             * @summary List token transactions
              * @request GET:/tokens/{token_id}/transactions
              */
             getTokensTokenIdTransactions: (tokenId, query, params = {}) => this.request({
@@ -688,10 +710,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description List token addresses
+             * No description
              *
              * @tags Tokens
              * @name GetTokensTokenIdAddresses
+             * @summary List token addresses
              * @request GET:/tokens/{token_id}/addresses
              */
             getTokensTokenIdAddresses: (tokenId, query, params = {}) => this.request({
@@ -702,10 +725,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -717,10 +741,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -732,10 +757,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -747,10 +773,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -761,10 +788,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, query, params = {}) => this.request({
@@ -824,10 +852,11 @@ class Api extends HttpClient {
         };
         this.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, params = {}) => this.request({
@@ -837,10 +866,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, query, params = {}) => this.request({
@@ -851,10 +881,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, inputAddress, query, params = {}) => this.request({
@@ -867,10 +898,11 @@ class Api extends HttpClient {
         };
         this.contracts = {
             /**
-             * @description Get contract liveness
+             * No description
              *
              * @tags Contracts
              * @name GetContractsContractAddressCurrentLiveness
+             * @summary Get contract liveness
              * @request GET:/contracts/{contract_address}/current-liveness
              */
             getContractsContractAddressCurrentLiveness: (contractAddress, params = {}) => this.request({
@@ -880,10 +912,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -893,10 +926,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, query, params = {}) => this.request({
@@ -941,10 +975,11 @@ class Api extends HttpClient {
         };
         this.utils = {
             /**
-             * @description Perform a sanity check
+             * No description
              *
              * @tags Utils
              * @name PutUtilsSanityCheck
+             * @summary Perform a sanity check
              * @request PUT:/utils/sanity-check
              */
             putUtilsSanityCheck: (params = {}) => this.request({
@@ -953,10 +988,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @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, params = {}) => this.request({
@@ -966,10 +1002,11 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description Update logback values
+             * No description
              *
              * @tags Utils
              * @name PutUtilsUpdateLogConfig
+             * @summary Update logback values
              * @request PUT:/utils/update-log-config
              */
             putUtilsUpdateLogConfig: (data, params = {}) => this.request({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -34,7 +34,7 @@
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
     "alephium_version": "4.2.3",
-    "explorer_backend_version": "2.3.2"
+    "explorer_backend_version": "3.3.2"
   },
   "type": "commonjs",
   "dependencies": {