@alephium/web3 0.17.1 → 0.18.1

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

@@ -297,7 +297,12 @@ export interface CallContract {
     existingContracts?: string[];
     inputAssets?: TestInputAsset[];
 }
-export interface CallContractResult {
+export interface CallContractFailed {
+    error: string;
+    type: string;
+}
+export type CallContractResult = CallContractFailed | CallContractSucceeded;
+export interface CallContractSucceeded {
     returns: Val[];
     /** @format int32 */
     gasUsed: number;
@@ -305,6 +310,7 @@ export interface CallContractResult {
     txInputs: string[];
     txOutputs: Output[];
     events: ContractEventByTxId[];
+    type: string;
 }
 export interface ChainInfo {
     /** @format int32 */
@@ -938,7 +944,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 2.3.5
+ * @version 2.5.0
  * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -1577,7 +1583,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @summary Call contract
          * @request POST:/contracts/call-contract
          */
-        postContractsCallContract: (data: CallContract, params?: RequestParams) => Promise<CallContractResult>;
+        postContractsCallContract: (data: CallContract, params?: RequestParams) => Promise<CallContractFailed | CallContractSucceeded>;
         /**
          * No description
          *

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

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

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

@@ -20,6 +20,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeProvider = void 0;
 const types_1 = require("./types");
 const api_alephium_1 = require("./api-alephium");
+const contract_1 = require("../contract");
 const utils_1 = require("../utils");
 function initializeNodeApi(baseUrl, apiKey, customFetch) {
     const nodeApi = new api_alephium_1.Api({
@@ -44,24 +45,21 @@ class NodeProvider {
             const result = await this.contracts.postContractsMulticallContract({
                 calls: calls
             });
+            const callResults = result.results.map((r) => (0, contract_1.tryGetCallResult)(r));
             return {
-                symbol: result.results[0].returns[0].value,
-                name: result.results[1].returns[0].value,
-                decimals: Number(result.results[2].returns[0].value),
-                totalSupply: BigInt(result.results[3].returns[0].value)
+                symbol: callResults[0].returns[0].value,
+                name: callResults[1].returns[0].value,
+                decimals: Number(callResults[2].returns[0].value),
+                totalSupply: BigInt(callResults[3].returns[0].value)
             };
         };
         // Only use this when the token follows the non-fungile token interface, check `guessTokenType` first
         this.fetchNFTMetaData = async (tokenId) => {
             const address = (0, utils_1.addressFromTokenId)(tokenId);
             const group = (0, utils_1.groupOfAddress)(address);
-            const calls = Array.from([0, 1], (index) => ({ methodIndex: index, group: group, address: address }));
-            const result = await this.contracts.postContractsMulticallContract({
-                calls: calls
-            });
+            const result = await this.contracts.postContractsCallContract({ methodIndex: 0, group, address });
             return {
-                tokenUri: (0, utils_1.hexToString)(result.results[0].returns[0].value),
-                collectionAddress: (0, utils_1.addressFromContractId)(result.results[1].returns[0].value)
+                tokenUri: (0, utils_1.hexToString)((0, contract_1.tryGetCallResult)(result).returns[0].value)
             };
         };
         // Only use this when the contract follows the NFT collection interface, check `guessFollowsNFTCollectionStd` first
@@ -70,9 +68,10 @@ class NodeProvider {
             const group = (0, utils_1.groupOfAddress)(address);
             const calls = Array.from([0, 1], (index) => ({ methodIndex: index, group: group, address: address }));
             const result = await this.contracts.postContractsMulticallContract({ calls });
+            const callResults = result.results.map((r) => (0, contract_1.tryGetCallResult)(r));
             return {
-                collectionUri: (0, utils_1.hexToString)(result.results[0].returns[0].value),
-                totalSupply: BigInt(result.results[1].returns[0].value)
+                collectionUri: (0, utils_1.hexToString)(callResults[0].returns[0].value),
+                totalSupply: BigInt(callResults[1].returns[0].value)
             };
         };
         this.guessStdInterfaceId = async (tokenId) => {

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

@@ -42,7 +42,6 @@ export interface FungibleTokenMetaData {
     totalSupply: Number256;
 }
 export interface NFTMetaData {
-    collectionAddress: string;
     tokenUri: string;
 }
 export interface NFTCollectionMetaData {

package/dist/src/contract/contract.d.ts

@@ -307,4 +307,5 @@ export declare function multicallMethods<I extends ContractInstance, F extends F
 export declare function getContractEventsCurrentCount(contractAddress: Address): Promise<number>;
 export declare const getContractIdFromUnsignedTx: (nodeProvider: NodeProvider, unsignedTx: string) => Promise<HexString>;
 export declare const getTokenIdFromUnsignedTx: (nodeProvider: NodeProvider, unsignedTx: string) => Promise<HexString>;
+export declare function tryGetCallResult(result: node.CallContractResult): node.CallContractSucceeded;
 export {};

package/dist/src/contract/contract.js

@@ -43,7 +43,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTokenIdFromUnsignedTx = exports.getContractIdFromUnsignedTx = exports.getContractEventsCurrentCount = exports.multicallMethods = exports.callMethod = exports.subscribeContractEvents = exports.subscribeContractEvent = exports.decodeEvent = exports.subscribeContractDestroyedEvent = exports.subscribeContractCreatedEvent = exports.fetchContractState = exports.ContractInstance = exports.testMethod = exports.addStdIdToFields = exports.subscribeEventsFromContract = exports.decodeContractDestroyedEvent = exports.decodeContractCreatedEvent = exports.DestroyContractEventAddress = exports.CreateContractEventAddress = exports.ExecutableScript = exports.ContractFactory = exports.randomTxId = exports.toApiVals = exports.Script = exports.Contract = exports.Artifact = exports.Project = exports.ProjectArtifact = exports.DEFAULT_COMPILER_OPTIONS = exports.DEFAULT_NODE_COMPILER_OPTIONS = exports.StdIdFieldName = void 0;
+exports.tryGetCallResult = exports.getTokenIdFromUnsignedTx = exports.getContractIdFromUnsignedTx = exports.getContractEventsCurrentCount = exports.multicallMethods = exports.callMethod = exports.subscribeContractEvents = exports.subscribeContractEvent = exports.decodeEvent = exports.subscribeContractDestroyedEvent = exports.subscribeContractCreatedEvent = exports.fetchContractState = exports.ContractInstance = exports.testMethod = exports.addStdIdToFields = exports.subscribeEventsFromContract = exports.decodeContractDestroyedEvent = exports.decodeContractCreatedEvent = exports.DestroyContractEventAddress = exports.CreateContractEventAddress = exports.ExecutableScript = exports.ContractFactory = exports.randomTxId = exports.toApiVals = exports.Script = exports.Contract = exports.Artifact = exports.Project = exports.ProjectArtifact = exports.DEFAULT_COMPILER_OPTIONS = exports.DEFAULT_NODE_COMPILER_OPTIONS = exports.StdIdFieldName = void 0;
 const buffer_1 = require("buffer/");
 const fs_1 = __importDefault(require("fs"));
 const fs_2 = require("fs");
@@ -736,17 +736,18 @@ class Contract extends Artifact {
     }
     fromApiCallContractResult(result, txId, methodIndex, getContractByCodeHash) {
         const returnTypes = this.functions[`${methodIndex}`].returnTypes;
-        const rawReturn = (0, api_1.fromApiArray)(result.returns, returnTypes);
+        const callResult = tryGetCallResult(result);
+        const rawReturn = (0, api_1.fromApiArray)(callResult.returns, returnTypes);
         const returns = rawReturn.length === 0 ? null : rawReturn.length === 1 ? rawReturn[0] : rawReturn;
         const addressToCodeHash = new Map();
-        result.contracts.forEach((contract) => addressToCodeHash.set(contract.address, contract.codeHash));
+        callResult.contracts.forEach((contract) => addressToCodeHash.set(contract.address, contract.codeHash));
         return {
             returns: returns,
-            gasUsed: result.gasUsed,
-            contracts: result.contracts.map((state) => Contract.fromApiContractState(state, getContractByCodeHash)),
-            txInputs: result.txInputs,
-            txOutputs: result.txOutputs.map((output) => fromApiOutput(output)),
-            events: Contract.fromApiEvents(result.events, addressToCodeHash, txId, getContractByCodeHash)
+            gasUsed: callResult.gasUsed,
+            contracts: callResult.contracts.map((state) => Contract.fromApiContractState(state, getContractByCodeHash)),
+            txInputs: callResult.txInputs,
+            txOutputs: callResult.txOutputs.map((output) => fromApiOutput(output)),
+            events: Contract.fromApiEvents(callResult.events, addressToCodeHash, txId, getContractByCodeHash)
         };
     }
 }
@@ -1184,3 +1185,10 @@ const getContractIdFromUnsignedTx = async (nodeProvider, unsignedTx) => {
 exports.getContractIdFromUnsignedTx = getContractIdFromUnsignedTx;
 // This function only works in the simple case where a single non-subcontract is created in the tx
 exports.getTokenIdFromUnsignedTx = exports.getContractIdFromUnsignedTx;
+function tryGetCallResult(result) {
+    if (result.type === 'CallContractFailed') {
+        throw new Error(`Failed to call contract, error: ${result.error}`);
+    }
+    return result;
+}
+exports.tryGetCallResult = tryGetCallResult;

package/dist/src/utils/utils.js

@@ -233,6 +233,9 @@ function stringToHex(str) {
 }
 exports.stringToHex = stringToHex;
 function hexToString(str) {
+    if (!isHexString(str)) {
+        throw new Error(`Invalid hex string: ${str}`);
+    }
     return buffer_1.Buffer.from(str, 'hex').toString();
 }
 exports.hexToString = hexToString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.17.1",
+  "version": "0.18.1",
   "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.3.5",
+    "alephium_version": "2.5.0",
     "explorer_backend_version": "1.15.1"
   },
   "type": "commonjs",

package/src/api/api-alephium.ts

@@ -338,7 +338,14 @@ export interface CallContract {
   inputAssets?: TestInputAsset[]
 }
 
-export interface CallContractResult {
+export interface CallContractFailed {
+  error: string
+  type: string
+}
+
+export type CallContractResult = CallContractFailed | CallContractSucceeded
+
+export interface CallContractSucceeded {
   returns: Val[]
   /** @format int32 */
   gasUsed: number
@@ -346,6 +353,7 @@ export interface CallContractResult {
   txInputs: string[]
   txOutputs: Output[]
   events: ContractEventByTxId[]
+  type: string
 }
 
 export interface ChainInfo {
@@ -1228,7 +1236,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 2.3.5
+ * @version 2.5.0
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {

package/src/api/node-provider.ts

@@ -27,7 +27,7 @@ import {
   StdInterfaceIds
 } from './types'
 import { Api as NodeApi } from './api-alephium'
-import { HexString } from '../contract'
+import { HexString, tryGetCallResult } from '../contract'
 import { addressFromContractId, addressFromTokenId, groupOfAddress, hexToString } from '../utils'
 
 function initializeNodeApi(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): NodeApi<string> {
@@ -116,11 +116,12 @@ export class NodeProvider implements NodeProviderApis {
     const result = await this.contracts.postContractsMulticallContract({
       calls: calls
     })
+    const callResults = result.results.map((r) => tryGetCallResult(r))
     return {
-      symbol: result.results[0].returns[0].value as any as string,
-      name: result.results[1].returns[0].value as any as string,
-      decimals: Number(result.results[2].returns[0].value as any as string),
-      totalSupply: BigInt(result.results[3].returns[0].value as any as string)
+      symbol: callResults[0].returns[0].value as any as string,
+      name: callResults[1].returns[0].value as any as string,
+      decimals: Number(callResults[2].returns[0].value as any as string),
+      totalSupply: BigInt(callResults[3].returns[0].value as any as string)
     }
   }
 
@@ -128,13 +129,9 @@ export class NodeProvider implements NodeProviderApis {
   fetchNFTMetaData = async (tokenId: HexString): Promise<NFTMetaData> => {
     const address = addressFromTokenId(tokenId)
     const group = groupOfAddress(address)
-    const calls = Array.from([0, 1], (index) => ({ methodIndex: index, group: group, address: address }))
-    const result = await this.contracts.postContractsMulticallContract({
-      calls: calls
-    })
+    const result = await this.contracts.postContractsCallContract({ methodIndex: 0, group, address })
     return {
-      tokenUri: hexToString(result.results[0].returns[0].value as any as string),
-      collectionAddress: addressFromContractId(result.results[1].returns[0].value as any as string)
+      tokenUri: hexToString(tryGetCallResult(result).returns[0].value as any as string)
     }
   }
 
@@ -144,9 +141,10 @@ export class NodeProvider implements NodeProviderApis {
     const group = groupOfAddress(address)
     const calls = Array.from([0, 1], (index) => ({ methodIndex: index, group: group, address: address }))
     const result = await this.contracts.postContractsMulticallContract({ calls })
+    const callResults = result.results.map((r) => tryGetCallResult(r))
     return {
-      collectionUri: hexToString(result.results[0].returns[0].value as any as string),
-      totalSupply: BigInt(result.results[1].returns[0].value as any as string)
+      collectionUri: hexToString(callResults[0].returns[0].value as any as string),
+      totalSupply: BigInt(callResults[1].returns[0].value as any as string)
     }
   }
 

package/src/api/types.ts

@@ -284,7 +284,6 @@ export interface FungibleTokenMetaData {
 }
 
 export interface NFTMetaData {
-  collectionAddress: string
   tokenUri: string
 }
 

package/src/contract/contract.ts

@@ -1088,18 +1088,19 @@ export class Contract extends Artifact {
     getContractByCodeHash?: (codeHash: string) => Contract
   ): CallContractResult<unknown> {
     const returnTypes = this.functions[`${methodIndex}`].returnTypes
-    const rawReturn = fromApiArray(result.returns, returnTypes)
+    const callResult = tryGetCallResult(result)
+    const rawReturn = fromApiArray(callResult.returns, returnTypes)
     const returns = rawReturn.length === 0 ? null : rawReturn.length === 1 ? rawReturn[0] : rawReturn
 
     const addressToCodeHash = new Map<string, string>()
-    result.contracts.forEach((contract) => addressToCodeHash.set(contract.address, contract.codeHash))
+    callResult.contracts.forEach((contract) => addressToCodeHash.set(contract.address, contract.codeHash))
     return {
       returns: returns,
-      gasUsed: result.gasUsed,
-      contracts: result.contracts.map((state) => Contract.fromApiContractState(state, getContractByCodeHash)),
-      txInputs: result.txInputs,
-      txOutputs: result.txOutputs.map((output) => fromApiOutput(output)),
-      events: Contract.fromApiEvents(result.events, addressToCodeHash, txId, getContractByCodeHash)
+      gasUsed: callResult.gasUsed,
+      contracts: callResult.contracts.map((state) => Contract.fromApiContractState(state, getContractByCodeHash)),
+      txInputs: callResult.txInputs,
+      txOutputs: callResult.txOutputs.map((output) => fromApiOutput(output)),
+      events: Contract.fromApiEvents(callResult.events, addressToCodeHash, txId, getContractByCodeHash)
     }
   }
 }
@@ -1811,3 +1812,10 @@ export const getContractIdFromUnsignedTx = async (
 
 // This function only works in the simple case where a single non-subcontract is created in the tx
 export const getTokenIdFromUnsignedTx = getContractIdFromUnsignedTx
+
+export function tryGetCallResult(result: node.CallContractResult): node.CallContractSucceeded {
+  if (result.type === 'CallContractFailed') {
+    throw new Error(`Failed to call contract, error: ${(result as node.CallContractFailed).error}`)
+  }
+  return result as node.CallContractSucceeded
+}

package/src/utils/utils.ts

@@ -242,6 +242,9 @@ export function stringToHex(str: string): string {
 }
 
 export function hexToString(str: string): string {
+  if (!isHexString(str)) {
+    throw new Error(`Invalid hex string: ${str}`)
+  }
   return Buffer.from(str, 'hex').toString()
 }
 

package/std/nft_interface.ral

@@ -22,6 +22,4 @@ Interface INFT {
    //     }
    // }
    pub fn getTokenUri() -> ByteVec
-
-   pub fn getCollectionId() -> ByteVec
 }