@alephium/web3 0.25.1 → 0.26.0

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

@@ -114,6 +114,14 @@ export interface ExplorerInfo {
     /** @format int64 */
     lastFinalizedInputTime: number;
 }
+export interface FungibleTokenMetadata {
+    /** @format 32-byte-hash */
+    id: string;
+    symbol: string;
+    name: string;
+    /** @format uint256 */
+    decimals: string;
+}
 export interface Hashrate {
     /** @format int64 */
     timestamp: number;
@@ -164,6 +172,20 @@ export interface MempoolTransaction {
     /** @format int64 */
     lastSeen: number;
 }
+export interface NFTCollectionMetadata {
+    /** @format address */
+    address: string;
+    collectionUri: string;
+}
+export interface NFTMetadata {
+    /** @format 32-byte-hash */
+    id: string;
+    tokenUri: string;
+    /** @format 32-byte-hash */
+    collectionId: string;
+    /** @format uint256 */
+    nftIndex: string;
+}
 export interface NotFound {
     detail: string;
     resource: string;
@@ -243,6 +265,17 @@ export interface Token {
     /** @format uint256 */
     amount: string;
 }
+export interface TokenInfo {
+    /** @format 32-byte-hash */
+    token: string;
+    /** Raw interface id, e.g. 0001 */
+    stdInterfaceId?: TokenStdInterfaceId | string;
+}
+export declare enum TokenStdInterfaceId {
+    Fungible = "fungible",
+    NonFungible = "non-fungible",
+    NonStandard = "non-standard"
+}
 export interface TokenSupply {
     /** @format int64 */
     timestamp: number;
@@ -306,6 +339,12 @@ export interface ValU256 {
     value: string;
     type: string;
 }
+export declare enum MaxSizeTokens {
+    Value80 = 80
+}
+export declare enum MaxSizeAddresses {
+    Value80 = 80
+}
 import 'cross-fetch/polyfill';
 export type QueryParamsType = Record<string | number, any>;
 export type ResponseFormat = keyof Omit<Body, 'body' | 'bodyUsed'>;
@@ -536,6 +575,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @tags Addresses
          * @name GetAddressesAddressTokens
          * @request GET:/addresses/{address}/tokens
+         * @deprecated
          */
         getAddressesAddressTokens: (address: string, query?: {
             /**
@@ -751,7 +791,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
     };
     tokens: {
         /**
-         * @description List tokens
+         * @description List token information
          *
          * @tags Tokens
          * @name GetTokens
@@ -768,7 +808,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              * @format int32
              */
             limit?: number;
-        }, params?: RequestParams) => Promise<string[]>;
+            /**
+             * fungible, non-fungible, non-standard or any interface id in hex-string format, e.g: 0001
+             * @format string
+             */
+            'interface-id'?: TokenStdInterfaceId | string;
+        }, params?: RequestParams) => Promise<TokenInfo[]>;
+        /**
+         * @description list given tokens information
+         *
+         * @tags Tokens
+         * @name PostTokens
+         * @request POST:/tokens
+         */
+        postTokens: (data?: string[], params?: RequestParams) => Promise<TokenInfo[]>;
         /**
          * @description List token transactions
          *
@@ -788,6 +841,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             limit?: number;
         }, params?: RequestParams) => Promise<Transaction[]>;
+        /**
+         * @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
+         *
+         * @tags Tokens
+         * @name PostTokensFungibleMetadata
+         * @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
+         *
+         * @tags Tokens
+         * @name PostTokensNftMetadata
+         * @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
+         *
+         * @tags Tokens
+         * @name PostTokensNftCollectionMetadata
+         * @request POST:/tokens/nft-collection-metadata
+         */
+        postTokensNftCollectionMetadata: (data?: string[], params?: RequestParams) => Promise<NFTCollectionMetadata[]>;
     };
     charts: {
         /**
@@ -907,18 +984,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @description Get contract parent address if exist
          *
          * @tags Contracts
-         * @name GetContractsContractParent
-         * @request GET:/contracts/{contract}/parent
+         * @name GetContractsContractAddressParent
+         * @request GET:/contracts/{contract_address}/parent
          */
-        getContractsContractParent: (contract: string, params?: RequestParams) => Promise<ContractParent>;
+        getContractsContractAddressParent: (contractAddress: string, params?: RequestParams) => Promise<ContractParent>;
         /**
          * @description Get sub contract addresses
          *
          * @tags Contracts
-         * @name GetContractsContractSubContracts
-         * @request GET:/contracts/{contract}/sub-contracts
+         * @name GetContractsContractAddressSubContracts
+         * @request GET:/contracts/{contract_address}/sub-contracts
          */
-        getContractsContractSubContracts: (contract: string, query?: {
+        getContractsContractAddressSubContracts: (contractAddress: string, query?: {
             /**
              * Page number
              * @format int32

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

@@ -10,12 +10,26 @@
  * ---------------------------------------------------------------
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Api = exports.HttpClient = exports.ContentType = exports.IntervalType = void 0;
+exports.Api = exports.HttpClient = exports.ContentType = exports.MaxSizeAddresses = exports.MaxSizeTokens = exports.TokenStdInterfaceId = exports.IntervalType = void 0;
 var IntervalType;
 (function (IntervalType) {
     IntervalType["Daily"] = "daily";
     IntervalType["Hourly"] = "hourly";
 })(IntervalType = exports.IntervalType || (exports.IntervalType = {}));
+var TokenStdInterfaceId;
+(function (TokenStdInterfaceId) {
+    TokenStdInterfaceId["Fungible"] = "fungible";
+    TokenStdInterfaceId["NonFungible"] = "non-fungible";
+    TokenStdInterfaceId["NonStandard"] = "non-standard";
+})(TokenStdInterfaceId = exports.TokenStdInterfaceId || (exports.TokenStdInterfaceId = {}));
+var MaxSizeTokens;
+(function (MaxSizeTokens) {
+    MaxSizeTokens[MaxSizeTokens["Value80"] = 80] = "Value80";
+})(MaxSizeTokens = exports.MaxSizeTokens || (exports.MaxSizeTokens = {}));
+var MaxSizeAddresses;
+(function (MaxSizeAddresses) {
+    MaxSizeAddresses[MaxSizeAddresses["Value80"] = 80] = "Value80";
+})(MaxSizeAddresses = exports.MaxSizeAddresses || (exports.MaxSizeAddresses = {}));
 require("cross-fetch/polyfill");
 const utils_1 = require("./utils");
 var ContentType;
@@ -322,6 +336,7 @@ class Api extends HttpClient {
              * @tags Addresses
              * @name GetAddressesAddressTokens
              * @request GET:/addresses/{address}/tokens
+             * @deprecated
              */
             getAddressesAddressTokens: (address, query, params = {}) => this.request({
                 path: `/addresses/${address}/tokens`,
@@ -553,7 +568,7 @@ class Api extends HttpClient {
         };
         this.tokens = {
             /**
-             * @description List tokens
+             * @description List token information
              *
              * @tags Tokens
              * @name GetTokens
@@ -566,6 +581,21 @@ class Api extends HttpClient {
                 format: 'json',
                 ...params
             }).then(utils_1.convertHttpResponse),
+            /**
+             * @description list given tokens information
+             *
+             * @tags Tokens
+             * @name PostTokens
+             * @request POST:/tokens
+             */
+            postTokens: (data, params = {}) => this.request({
+                path: `/tokens`,
+                method: 'POST',
+                body: data,
+                type: ContentType.Json,
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse),
             /**
              * @description List token transactions
              *
@@ -579,6 +609,51 @@ class Api extends HttpClient {
                 query: query,
                 format: 'json',
                 ...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
+             *
+             * @tags Tokens
+             * @name PostTokensFungibleMetadata
+             * @request POST:/tokens/fungible-metadata
+             */
+            postTokensFungibleMetadata: (data, params = {}) => this.request({
+                path: `/tokens/fungible-metadata`,
+                method: 'POST',
+                body: data,
+                type: ContentType.Json,
+                format: 'json',
+                ...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
+             *
+             * @tags Tokens
+             * @name PostTokensNftMetadata
+             * @request POST:/tokens/nft-metadata
+             */
+            postTokensNftMetadata: (data, params = {}) => this.request({
+                path: `/tokens/nft-metadata`,
+                method: 'POST',
+                body: data,
+                type: ContentType.Json,
+                format: 'json',
+                ...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
+             *
+             * @tags Tokens
+             * @name PostTokensNftCollectionMetadata
+             * @request POST:/tokens/nft-collection-metadata
+             */
+            postTokensNftCollectionMetadata: (data, params = {}) => this.request({
+                path: `/tokens/nft-collection-metadata`,
+                method: 'POST',
+                body: data,
+                type: ContentType.Json,
+                format: 'json',
+                ...params
             }).then(utils_1.convertHttpResponse)
         };
         this.charts = {
@@ -676,11 +751,11 @@ class Api extends HttpClient {
              * @description Get contract parent address if exist
              *
              * @tags Contracts
-             * @name GetContractsContractParent
-             * @request GET:/contracts/{contract}/parent
+             * @name GetContractsContractAddressParent
+             * @request GET:/contracts/{contract_address}/parent
              */
-            getContractsContractParent: (contract, params = {}) => this.request({
-                path: `/contracts/${contract}/parent`,
+            getContractsContractAddressParent: (contractAddress, params = {}) => this.request({
+                path: `/contracts/${contractAddress}/parent`,
                 method: 'GET',
                 format: 'json',
                 ...params
@@ -689,11 +764,11 @@ class Api extends HttpClient {
              * @description Get sub contract addresses
              *
              * @tags Contracts
-             * @name GetContractsContractSubContracts
-             * @request GET:/contracts/{contract}/sub-contracts
+             * @name GetContractsContractAddressSubContracts
+             * @request GET:/contracts/{contract_address}/sub-contracts
              */
-            getContractsContractSubContracts: (contract, query, params = {}) => this.request({
-                path: `/contracts/${contract}/sub-contracts`,
+            getContractsContractAddressSubContracts: (contractAddress, query, params = {}) => this.request({
+                path: `/contracts/${contractAddress}/sub-contracts`,
                 method: 'GET',
                 query: query,
                 format: 'json',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.25.1",
+  "version": "0.26.0",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -28,7 +28,7 @@
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
     "alephium_version": "2.5.5",
-    "explorer_backend_version": "1.15.1"
+    "explorer_backend_version": "1.16.0"
   },
   "type": "commonjs",
   "dependencies": {

package/src/api/api-explorer.ts

@@ -136,6 +136,15 @@ export interface ExplorerInfo {
   lastFinalizedInputTime: number
 }
 
+export interface FungibleTokenMetadata {
+  /** @format 32-byte-hash */
+  id: string
+  symbol: string
+  name: string
+  /** @format uint256 */
+  decimals: string
+}
+
 export interface Hashrate {
   /** @format int64 */
   timestamp: number
@@ -193,6 +202,22 @@ export interface MempoolTransaction {
   lastSeen: number
 }
 
+export interface NFTCollectionMetadata {
+  /** @format address */
+  address: string
+  collectionUri: string
+}
+
+export interface NFTMetadata {
+  /** @format 32-byte-hash */
+  id: string
+  tokenUri: string
+  /** @format 32-byte-hash */
+  collectionId: string
+  /** @format uint256 */
+  nftIndex: string
+}
+
 export interface NotFound {
   detail: string
   resource: string
@@ -284,6 +309,19 @@ export interface Token {
   amount: string
 }
 
+export interface TokenInfo {
+  /** @format 32-byte-hash */
+  token: string
+  /** Raw interface id, e.g. 0001 */
+  stdInterfaceId?: TokenStdInterfaceId | string
+}
+
+export enum TokenStdInterfaceId {
+  Fungible = 'fungible',
+  NonFungible = 'non-fungible',
+  NonStandard = 'non-standard'
+}
+
 export interface TokenSupply {
   /** @format int64 */
   timestamp: number
@@ -358,6 +396,14 @@ export interface ValU256 {
   type: string
 }
 
+export enum MaxSizeTokens {
+  Value80 = 80
+}
+
+export enum MaxSizeAddresses {
+  Value80 = 80
+}
+
 import 'cross-fetch/polyfill'
 import { convertHttpResponse } from './utils'
 
@@ -845,6 +891,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @tags Addresses
      * @name GetAddressesAddressTokens
      * @request GET:/addresses/{address}/tokens
+     * @deprecated
      */
     getAddressesAddressTokens: (
       address: string,
@@ -1223,7 +1270,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
   }
   tokens = {
     /**
-     * @description List tokens
+     * @description List token information
      *
      * @tags Tokens
      * @name GetTokens
@@ -1241,10 +1288,15 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
          * @format int32
          */
         limit?: number
+        /**
+         * fungible, non-fungible, non-standard or any interface id in hex-string format, e.g: 0001
+         * @format string
+         */
+        'interface-id'?: TokenStdInterfaceId | string
       },
       params: RequestParams = {}
     ) =>
-      this.request<string[], BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+      this.request<TokenInfo[], BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
         path: `/tokens`,
         method: 'GET',
         query: query,
@@ -1252,6 +1304,23 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(convertHttpResponse),
 
+    /**
+     * @description list given tokens information
+     *
+     * @tags Tokens
+     * @name PostTokens
+     * @request POST:/tokens
+     */
+    postTokens: (data?: string[], params: RequestParams = {}) =>
+      this.request<TokenInfo[], BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/tokens`,
+        method: 'POST',
+        body: data,
+        type: ContentType.Json,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
     /**
      * @description List token transactions
      *
@@ -1281,6 +1350,63 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         query: query,
         format: 'json',
         ...params
+      }).then(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
+     *
+     * @tags Tokens
+     * @name PostTokensFungibleMetadata
+     * @request POST:/tokens/fungible-metadata
+     */
+    postTokensFungibleMetadata: (data?: string[], params: RequestParams = {}) =>
+      this.request<
+        FungibleTokenMetadata[],
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/tokens/fungible-metadata`,
+        method: 'POST',
+        body: data,
+        type: ContentType.Json,
+        format: 'json',
+        ...params
+      }).then(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
+     *
+     * @tags Tokens
+     * @name PostTokensNftMetadata
+     * @request POST:/tokens/nft-metadata
+     */
+    postTokensNftMetadata: (data?: string[], params: RequestParams = {}) =>
+      this.request<NFTMetadata[], BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/tokens/nft-metadata`,
+        method: 'POST',
+        body: data,
+        type: ContentType.Json,
+        format: 'json',
+        ...params
+      }).then(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
+     *
+     * @tags Tokens
+     * @name PostTokensNftCollectionMetadata
+     * @request POST:/tokens/nft-collection-metadata
+     */
+    postTokensNftCollectionMetadata: (data?: string[], params: RequestParams = {}) =>
+      this.request<
+        NFTCollectionMetadata[],
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/tokens/nft-collection-metadata`,
+        method: 'POST',
+        body: data,
+        type: ContentType.Json,
+        format: 'json',
+        ...params
       }).then(convertHttpResponse)
   }
   charts = {
@@ -1467,12 +1593,12 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @description Get contract parent address if exist
      *
      * @tags Contracts
-     * @name GetContractsContractParent
-     * @request GET:/contracts/{contract}/parent
+     * @name GetContractsContractAddressParent
+     * @request GET:/contracts/{contract_address}/parent
      */
-    getContractsContractParent: (contract: string, params: RequestParams = {}) =>
+    getContractsContractAddressParent: (contractAddress: string, params: RequestParams = {}) =>
       this.request<ContractParent, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
-        path: `/contracts/${contract}/parent`,
+        path: `/contracts/${contractAddress}/parent`,
         method: 'GET',
         format: 'json',
         ...params
@@ -1482,11 +1608,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @description Get sub contract addresses
      *
      * @tags Contracts
-     * @name GetContractsContractSubContracts
-     * @request GET:/contracts/{contract}/sub-contracts
+     * @name GetContractsContractAddressSubContracts
+     * @request GET:/contracts/{contract_address}/sub-contracts
      */
-    getContractsContractSubContracts: (
-      contract: string,
+    getContractsContractAddressSubContracts: (
+      contractAddress: string,
       query?: {
         /**
          * Page number
@@ -1502,7 +1628,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       params: RequestParams = {}
     ) =>
       this.request<SubContracts, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
-        path: `/contracts/${contract}/sub-contracts`,
+        path: `/contracts/${contractAddress}/sub-contracts`,
         method: 'GET',
         query: query,
         format: 'json',