@alephium/web3 0.21.1 → 0.22.0

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

@@ -963,7 +963,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 2.5.3
+ * @version 2.5.5
  * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -1347,6 +1347,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/blockflow/is-block-in-main-chain
          */
         getBlockflowIsBlockInMainChain: (query: {
+            /** @format block-hash */
             blockHash: string;
         }, params?: RequestParams) => Promise<boolean>;
         /**
@@ -1480,6 +1481,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/transactions/status
          */
         getTransactionsStatus: (query: {
+            /** @format 32-byte-hash */
             txId: string;
             /** @format int32 */
             fromGroup?: number;
@@ -1515,6 +1517,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/mempool/transactions/rebroadcast
          */
         putMempoolTransactionsRebroadcast: (query: {
+            /** @format 32-byte-hash */
             txId: string;
         }, params?: RequestParams) => Promise<void>;
         /**

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

@@ -151,7 +151,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Alephium API
- * @version 2.5.3
+ * @version 2.5.5
  * @baseUrl ../
  */
 class Api extends HttpClient {

package/dist/src/api/node-provider.js

@@ -57,10 +57,46 @@ class NodeProvider {
         this.fetchNFTMetaData = async (tokenId) => {
             const address = (0, utils_1.addressFromTokenId)(tokenId);
             const group = (0, utils_1.groupOfAddress)(address);
-            const result = await this.contracts.postContractsCallContract({ methodIndex: 0, group, address });
-            return {
-                tokenUri: (0, utils_1.hexToString)((0, contract_1.tryGetCallResult)(result).returns[0].value)
-            };
+            const calls = Array.from([0, 1], (index) => ({ methodIndex: index, group: group, address: address }));
+            const result = await this.contracts.postContractsMulticallContract({
+                calls: calls
+            });
+            const tokenUri = (0, utils_1.hexToString)((0, contract_1.tryGetCallResult)(result.results[0]).returns[0].value);
+            const collectionIndexResult = result.results[1];
+            if (collectionIndexResult.type === 'CallContractSucceeded') {
+                const successfulCollectionIndexResult = result.results[1];
+                const contractIdReturnResult = successfulCollectionIndexResult.returns[0];
+                if (contractIdReturnResult === undefined) {
+                    throw new Error('Deprecated NFT contract');
+                }
+                const collectionId = successfulCollectionIndexResult.returns[0].value;
+                if (collectionId === undefined || !(0, utils_1.isHexString)(collectionId) || collectionId.length !== 64) {
+                    throw new Error('Deprecated NFT contract');
+                }
+                const nftIndexReturnResult = successfulCollectionIndexResult.returns[1];
+                if (nftIndexReturnResult === undefined) {
+                    throw new Error('Deprecated NFT contract');
+                }
+                const nftIndex = (0, utils_1.toNonNegativeBigInt)(nftIndexReturnResult.value);
+                if (nftIndex === undefined) {
+                    throw new Error('Deprecated NFT contract');
+                }
+                // If there are more return values, it is also a deprecated NFT contract
+                const thirdResult = successfulCollectionIndexResult.returns[2];
+                if (thirdResult !== undefined) {
+                    throw new Error('Deprecated NFT contract');
+                }
+                return { tokenUri, collectionId, nftIndex };
+            }
+            else {
+                const failedCollectionIndexResult = result.results[1];
+                if (failedCollectionIndexResult.error.startsWith('VM execution error: InvalidMethodIndex')) {
+                    throw new Error('Deprecated NFT contract');
+                }
+                else {
+                    throw new Error(`Failed to call contract, error: ${failedCollectionIndexResult.error}`);
+                }
+            }
         };
         // Only use this when the contract follows the NFT collection interface, check `guessFollowsNFTCollectionStd` first
         this.fetchNFTCollectionMetaData = async (contractId) => {

package/dist/src/api/types.d.ts

@@ -44,6 +44,8 @@ export interface FungibleTokenMetaData {
     totalSupply: Number256;
 }
 export interface NFTMetaData {
+    collectionId: string;
+    nftIndex: Number256;
     tokenUri: string;
 }
 export interface NFTCollectionMetaData {

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

@@ -12,6 +12,7 @@ export declare function encodeHexSignature(rHex: string, sHex: string): string;
 export declare function signatureDecode(ec: EC, signature: string): SignatureInput;
 export declare function xorByte(intValue: number): number;
 export declare function isHexString(input: string): boolean;
+export declare function toNonNegativeBigInt(input: string): bigint | undefined;
 export declare function groupOfAddress(address: string): number;
 export declare function contractIdFromAddress(address: string): Uint8Array;
 export declare function tokenIdFromAddress(address: string): Uint8Array;

package/dist/src/utils/utils.js

@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertType = exports.sleep = exports.hexToString = exports.stringToHex = exports.blockChainIndex = exports.subContractId = exports.contractIdFromTx = exports.addressFromTokenId = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.groupOfPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.isHexString = exports.xorByte = exports.signatureDecode = exports.encodeHexSignature = exports.encodeSignature = exports.networkIds = void 0;
+exports.assertType = exports.sleep = exports.hexToString = exports.stringToHex = exports.blockChainIndex = exports.subContractId = exports.contractIdFromTx = exports.addressFromTokenId = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.groupOfPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.toNonNegativeBigInt = exports.isHexString = exports.xorByte = exports.signatureDecode = exports.encodeHexSignature = exports.encodeSignature = exports.networkIds = void 0;
 const elliptic_1 = require("elliptic");
 const bn_js_1 = __importDefault(require("bn.js"));
 const blakejs_1 = __importDefault(require("blakejs"));
@@ -72,6 +72,16 @@ function isHexString(input) {
     return input.length % 2 === 0 && /^[0-9a-fA-F]*$/.test(input);
 }
 exports.isHexString = isHexString;
+function toNonNegativeBigInt(input) {
+    try {
+        const bigIntValue = BigInt(input);
+        return bigIntValue < 0n ? undefined : bigIntValue;
+    }
+    catch {
+        return undefined;
+    }
+}
+exports.toNonNegativeBigInt = toNonNegativeBigInt;
 var AddressType;
 (function (AddressType) {
     AddressType[AddressType["P2PKH"] = 0] = "P2PKH";

package/package.json

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

package/src/api/api-alephium.ts

@@ -1256,7 +1256,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 2.5.3
+ * @version 2.5.5
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -1955,6 +1955,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      */
     getBlockflowIsBlockInMainChain: (
       query: {
+        /** @format block-hash */
         blockHash: string
       },
       params: RequestParams = {}
@@ -2209,6 +2210,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      */
     getTransactionsStatus: (
       query: {
+        /** @format 32-byte-hash */
         txId: string
         /** @format int32 */
         fromGroup?: number
@@ -2270,6 +2272,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      */
     putMempoolTransactionsRebroadcast: (
       query: {
+        /** @format 32-byte-hash */
         txId: string
       },
       params: RequestParams = {}

package/src/api/node-provider.ts

@@ -26,9 +26,16 @@ import {
   NFTCollectionMetaData,
   StdInterfaceIds
 } from './types'
-import { Api as NodeApi } from './api-alephium'
+import { Api as NodeApi, CallContractFailed, CallContractSucceeded } from './api-alephium'
 import { HexString, tryGetCallResult } from '../contract'
-import { addressFromContractId, addressFromTokenId, groupOfAddress, hexToString } from '../utils'
+import {
+  addressFromContractId,
+  addressFromTokenId,
+  groupOfAddress,
+  hexToString,
+  isHexString,
+  toNonNegativeBigInt
+} from '../utils'
 
 function initializeNodeApi(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): NodeApi<string> {
   const nodeApi = new NodeApi<string>({
@@ -129,9 +136,46 @@ export class NodeProvider implements NodeProviderApis {
   fetchNFTMetaData = async (tokenId: HexString): Promise<NFTMetaData> => {
     const address = addressFromTokenId(tokenId)
     const group = groupOfAddress(address)
-    const result = await this.contracts.postContractsCallContract({ methodIndex: 0, group, address })
-    return {
-      tokenUri: hexToString(tryGetCallResult(result).returns[0].value as any as string)
+    const calls = Array.from([0, 1], (index) => ({ methodIndex: index, group: group, address: address }))
+    const result = await this.contracts.postContractsMulticallContract({
+      calls: calls
+    })
+    const tokenUri = hexToString(tryGetCallResult(result.results[0]).returns[0].value as any as string)
+    const collectionIndexResult = result.results[1]
+    if (collectionIndexResult.type === 'CallContractSucceeded') {
+      const successfulCollectionIndexResult = result.results[1] as CallContractSucceeded
+      const contractIdReturnResult = successfulCollectionIndexResult.returns[0]
+      if (contractIdReturnResult === undefined) {
+        throw new Error('Deprecated NFT contract')
+      }
+      const collectionId = successfulCollectionIndexResult.returns[0].value as any as string
+      if (collectionId === undefined || !isHexString(collectionId) || collectionId.length !== 64) {
+        throw new Error('Deprecated NFT contract')
+      }
+
+      const nftIndexReturnResult = successfulCollectionIndexResult.returns[1]
+      if (nftIndexReturnResult === undefined) {
+        throw new Error('Deprecated NFT contract')
+      }
+      const nftIndex = toNonNegativeBigInt(nftIndexReturnResult.value as any as string)
+      if (nftIndex === undefined) {
+        throw new Error('Deprecated NFT contract')
+      }
+
+      // If there are more return values, it is also a deprecated NFT contract
+      const thirdResult = successfulCollectionIndexResult.returns[2]
+      if (thirdResult !== undefined) {
+        throw new Error('Deprecated NFT contract')
+      }
+
+      return { tokenUri, collectionId, nftIndex }
+    } else {
+      const failedCollectionIndexResult = result.results[1] as CallContractFailed
+      if (failedCollectionIndexResult.error.startsWith('VM execution error: InvalidMethodIndex')) {
+        throw new Error('Deprecated NFT contract')
+      } else {
+        throw new Error(`Failed to call contract, error: ${failedCollectionIndexResult.error}`)
+      }
     }
   }
 

package/src/api/types.ts

@@ -298,6 +298,8 @@ export interface FungibleTokenMetaData {
 }
 
 export interface NFTMetaData {
+  collectionId: string
+  nftIndex: Number256
   tokenUri: string
 }
 

package/src/utils/utils.ts

@@ -75,6 +75,15 @@ export function isHexString(input: string): boolean {
   return input.length % 2 === 0 && /^[0-9a-fA-F]*$/.test(input)
 }
 
+export function toNonNegativeBigInt(input: string): bigint | undefined {
+  try {
+    const bigIntValue = BigInt(input)
+    return bigIntValue < 0n ? undefined : bigIntValue
+  } catch {
+    return undefined
+  }
+}
+
 enum AddressType {
   P2PKH = 0x00,
   P2MPKH = 0x01,

package/std/nft_collection_interface.ral

@@ -26,4 +26,7 @@ Interface INFTCollection {
    pub fn totalSupply() -> U256
 
    pub fn nftByIndex(index: U256) -> INFT
+
+   // Validates that the NFT is part of the collection, otherwise throws exception.
+   pub fn validateNFT(nftId: ByteVec, nftIndex: U256) -> ()
 }

package/std/nft_interface.ral

@@ -22,4 +22,7 @@ Interface INFT {
    //     }
    // }
    pub fn getTokenUri() -> ByteVec
+
+   // Returns collection id and index of the NFT in the collection.
+   pub fn getCollectionIndex() -> (ByteVec, U256)
 }