@alephium/web3 0.25.2 → 0.27.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/dist/src/utils/exchange.d.ts

@@ -1,7 +1,11 @@
 import { Transaction } from '../api/api-alephium';
 import { Address } from '../signer';
 export declare function validateExchangeAddress(address: string): void;
-export declare function isDepositALPHTransaction(tx: Transaction, exchangeAddress: string): boolean;
-export declare function isDepositTokenTransaction(tx: Transaction, exchangeAddress: string): boolean;
-export declare function getDepositAddress(tx: Transaction): Address;
+export declare function isSimpleALPHTransferTx(tx: Transaction): boolean;
+export declare function isSimpleTransferTokenTx(tx: Transaction): boolean;
+export declare function getALPHDepositInfo(tx: Transaction): {
+    targetAddress: Address;
+    depositAmount: bigint;
+};
+export declare function getSenderAddress(tx: Transaction): Address;
 export declare function getAddressFromUnlockScript(unlockScript: string): Address;

package/dist/src/utils/exchange.js

@@ -17,7 +17,7 @@ You should have received a copy of the GNU Lesser General Public License
 along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAddressFromUnlockScript = exports.getDepositAddress = exports.isDepositTokenTransaction = exports.isDepositALPHTransaction = exports.validateExchangeAddress = void 0;
+exports.getAddressFromUnlockScript = exports.getSenderAddress = exports.getALPHDepositInfo = exports.isSimpleTransferTokenTx = exports.isSimpleALPHTransferTx = exports.validateExchangeAddress = void 0;
 const __1 = require("..");
 function validateExchangeAddress(address) {
     let decoded;
@@ -38,19 +38,38 @@ function validateExchangeAddress(address) {
     }
 }
 exports.validateExchangeAddress = validateExchangeAddress;
-function isDepositALPHTransaction(tx, exchangeAddress) {
-    return isDepositTransaction(tx, exchangeAddress) && checkALPHOutput(tx);
+function isSimpleALPHTransferTx(tx) {
+    return isSimpleTransferTx(tx) && checkALPHOutput(tx);
 }
-exports.isDepositALPHTransaction = isDepositALPHTransaction;
-function isDepositTokenTransaction(tx, exchangeAddress) {
-    return isDepositTransaction(tx, exchangeAddress) && checkTokenOutput(tx, exchangeAddress);
+exports.isSimpleALPHTransferTx = isSimpleALPHTransferTx;
+function isSimpleTransferTokenTx(tx) {
+    const isTransferTx = isSimpleTransferTx(tx);
+    if (isTransferTx) {
+        const senderAddress = getSenderAddress(tx);
+        const targetAddress = tx.unsigned.fixedOutputs.find((o) => o.address !== senderAddress).address;
+        return checkTokenOutput(tx, targetAddress);
+    }
+    return false;
+}
+exports.isSimpleTransferTokenTx = isSimpleTransferTokenTx;
+// we assume that the tx is a simple transfer tx, i.e. isSimpleTransferALPHTx(tx) == true
+function getALPHDepositInfo(tx) {
+    const senderAddress = getSenderAddress(tx);
+    const targetAddress = tx.unsigned.fixedOutputs.find((o) => o.address !== senderAddress).address;
+    let depositAmount = 0n;
+    tx.unsigned.fixedOutputs.forEach((o) => {
+        if (o.address === targetAddress) {
+            depositAmount += BigInt(o.attoAlphAmount);
+        }
+    });
+    return { targetAddress, depositAmount };
 }
-exports.isDepositTokenTransaction = isDepositTokenTransaction;
-// we assume that the tx is deposit transaction
-function getDepositAddress(tx) {
+exports.getALPHDepositInfo = getALPHDepositInfo;
+// we assume that the tx is a simple transfer tx, i.e. isSimpleTransferALPHTx(tx) == true
+function getSenderAddress(tx) {
     return getAddressFromUnlockScript(tx.unsigned.inputs[0].unlockScript);
 }
-exports.getDepositAddress = getDepositAddress;
+exports.getSenderAddress = getSenderAddress;
 var UnlockScriptType;
 (function (UnlockScriptType) {
     UnlockScriptType[UnlockScriptType["P2PKH"] = 0] = "P2PKH";
@@ -81,50 +100,47 @@ function getAddressFromUnlockScript(unlockScript) {
     }
 }
 exports.getAddressFromUnlockScript = getAddressFromUnlockScript;
-function getFromAddress(tx) {
+function getSenderAddressAnyTx(tx) {
     try {
         const inputAddresses = tx.unsigned.inputs.map((i) => getAddressFromUnlockScript(i.unlockScript));
         // we have checked that the inputs is not empty
-        const from = inputAddresses[0];
-        return inputAddresses.slice(1).every((addr) => addr === from) ? from : undefined;
+        const sender = inputAddresses[0];
+        return inputAddresses.slice(1).every((addr) => addr === sender) ? sender : undefined;
     }
     catch (_) {
         return undefined;
     }
 }
-function checkOutputAddress(tx, from, to) {
-    let fromCount = 0;
-    let toCount = 0;
-    tx.unsigned.fixedOutputs.forEach((o) => {
-        if (o.address === from) {
-            fromCount += 1;
-        }
-        else if (o.address === to) {
-            toCount += 1;
-        }
-    });
-    const outputCount = tx.unsigned.fixedOutputs.length;
-    return toCount === 1 && fromCount === outputCount - 1;
-}
 function checkALPHOutput(tx) {
     const outputs = tx.unsigned.fixedOutputs;
     return outputs.every((o) => o.tokens.length === 0);
 }
 function checkTokenOutput(tx, to) {
     // we have checked the output address
-    const output = tx.unsigned.fixedOutputs.find((o) => o.address === to);
-    return output.attoAlphAmount === __1.DUST_AMOUNT.toString() && output.tokens.length === 1;
+    const outputs = tx.unsigned.fixedOutputs.filter((o) => o.address === to);
+    if (outputs[0].tokens.length === 0) {
+        return false;
+    }
+    const tokenId = outputs[0].tokens[0].id;
+    return outputs.every((o) => BigInt(o.attoAlphAmount) === __1.DUST_AMOUNT && o.tokens.length === 1 && o.tokens[0].id === tokenId);
 }
-function isDepositTransaction(tx, exchangeAddress) {
+function isSimpleTransferTx(tx) {
     if (tx.contractInputs.length !== 0 ||
         tx.generatedOutputs.length !== 0 ||
         tx.unsigned.inputs.length === 0 ||
         tx.unsigned.scriptOpt !== undefined) {
         return false;
     }
-    const from = getFromAddress(tx);
-    if (from === undefined || from === exchangeAddress) {
+    const sender = getSenderAddressAnyTx(tx);
+    if (sender === undefined) {
         return false;
     }
-    return checkOutputAddress(tx, from, exchangeAddress);
+    const outputAddresses = [];
+    tx.unsigned.fixedOutputs.forEach((o) => {
+        if (!outputAddresses.includes(o.address)) {
+            outputAddresses.push(o.address);
+        }
+    });
+    return ((outputAddresses.length === 1 && outputAddresses[0] !== sender) ||
+        (outputAddresses.length === 2 && outputAddresses.includes(sender)));
 }

package/dist/src/utils/index.d.ts

@@ -6,4 +6,4 @@ export * from './utils';
 export * from './subscription';
 export * from './sign';
 export * from './number';
-export { validateExchangeAddress, isDepositALPHTransaction, isDepositTokenTransaction, getDepositAddress } from './exchange';
+export { validateExchangeAddress, isSimpleALPHTransferTx, isSimpleTransferTokenTx, getSenderAddress, getALPHDepositInfo } from './exchange';

package/dist/src/utils/index.js

@@ -31,7 +31,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDepositAddress = exports.isDepositTokenTransaction = exports.isDepositALPHTransaction = exports.validateExchangeAddress = void 0;
+exports.getALPHDepositInfo = exports.getSenderAddress = exports.isSimpleTransferTokenTx = exports.isSimpleALPHTransferTx = exports.validateExchangeAddress = void 0;
 __exportStar(require("./webcrypto"), exports);
 __exportStar(require("./address"), exports);
 __exportStar(require("./bs58"), exports);
@@ -42,6 +42,7 @@ __exportStar(require("./sign"), exports);
 __exportStar(require("./number"), exports);
 var exchange_1 = require("./exchange");
 Object.defineProperty(exports, "validateExchangeAddress", { enumerable: true, get: function () { return exchange_1.validateExchangeAddress; } });
-Object.defineProperty(exports, "isDepositALPHTransaction", { enumerable: true, get: function () { return exchange_1.isDepositALPHTransaction; } });
-Object.defineProperty(exports, "isDepositTokenTransaction", { enumerable: true, get: function () { return exchange_1.isDepositTokenTransaction; } });
-Object.defineProperty(exports, "getDepositAddress", { enumerable: true, get: function () { return exchange_1.getDepositAddress; } });
+Object.defineProperty(exports, "isSimpleALPHTransferTx", { enumerable: true, get: function () { return exchange_1.isSimpleALPHTransferTx; } });
+Object.defineProperty(exports, "isSimpleTransferTokenTx", { enumerable: true, get: function () { return exchange_1.isSimpleTransferTokenTx; } });
+Object.defineProperty(exports, "getSenderAddress", { enumerable: true, get: function () { return exchange_1.getSenderAddress; } });
+Object.defineProperty(exports, "getALPHDepositInfo", { enumerable: true, get: function () { return exchange_1.getALPHDepositInfo; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.25.2",
+  "version": "0.27.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": {