@alephium/web3 0.6.6 → 0.7.0

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

@@ -541,6 +541,12 @@ export interface MinerAddressesInfo {
     addresses: AddressInfo[];
 }
 export declare type MisbehaviorAction = Ban | Unban;
+export interface MultipleCallContract {
+    calls: CallContract[];
+}
+export interface MultipleCallContractResult {
+    results: CallContractResult[];
+}
 export interface NodeInfo {
     buildInfo: BuildInfo;
     upnp: boolean;
@@ -674,6 +680,8 @@ export interface TestContract {
     group?: number;
     /** @format block-hash */
     blockHash?: string;
+    /** @format int64 */
+    blockTimeStamp?: number;
     /** @format 32-byte-hash */
     txId?: string;
     /** @format address */
@@ -920,7 +928,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 1.7.1
+ * @version 1.7.3
  * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -1381,7 +1389,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          *
          * @tags Transactions
          * @name PostTransactionsSweepAddressBuild
-         * @summary Build unsigned transactions to send all unlocked balanced of one address to another address
+         * @summary Build unsigned transactions to send all unlocked ALPH and token balances of one address to another address
          * @request POST:/transactions/sweep-address/build
          */
         postTransactionsSweepAddressBuild: (data: BuildSweepAddressTransactions, params?: RequestParams) => Promise<BuildSweepAddressTransactionsResult>;
@@ -1549,6 +1557,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/contracts/call-contract
          */
         postContractsCallContract: (data: CallContract, params?: RequestParams) => Promise<CallContractResult>;
+        /**
+         * No description
+         *
+         * @tags Contracts
+         * @name PostContractsMulticallContract
+         * @summary Multiple call contract
+         * @request POST:/contracts/multicall-contract
+         */
+        postContractsMulticallContract: (data: MultipleCallContract, params?: RequestParams) => Promise<MultipleCallContractResult>;
     };
     multisig: {
         /**

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

@@ -151,7 +151,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Alephium API
- * @version 1.7.1
+ * @version 1.7.3
  * @baseUrl ../
  */
 class Api extends HttpClient {
@@ -801,7 +801,7 @@ class Api extends HttpClient {
              *
              * @tags Transactions
              * @name PostTransactionsSweepAddressBuild
-             * @summary Build unsigned transactions to send all unlocked balanced of one address to another address
+             * @summary Build unsigned transactions to send all unlocked ALPH and token balances of one address to another address
              * @request POST:/transactions/sweep-address/build
              */
             postTransactionsSweepAddressBuild: (data, params = {}) => this.request({
@@ -1058,6 +1058,22 @@ class Api extends HttpClient {
                 type: ContentType.Json,
                 format: 'json',
                 ...params
+            }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Contracts
+             * @name PostContractsMulticallContract
+             * @summary Multiple call contract
+             * @request POST:/contracts/multicall-contract
+             */
+            postContractsMulticallContract: (data, params = {}) => this.request({
+                path: `/contracts/multicall-contract`,
+                method: 'POST',
+                body: data,
+                type: ContentType.Json,
+                format: 'json',
+                ...params
             }).then(utils_1.convertHttpResponse)
         };
         this.multisig = {

package/dist/src/api/node-provider.d.ts

@@ -1,5 +1,6 @@
-import { ApiRequestArguments, ApiRequestHandler } from './types';
+import { ApiRequestArguments, ApiRequestHandler, TokenMetaData } from './types';
 import { Api as NodeApi } from './api-alephium';
+import { HexString } from '../contract';
 export declare class NodeProvider {
     readonly wallets: NodeApi<string>['wallets'];
     readonly infos: NodeApi<string>['infos'];
@@ -18,4 +19,5 @@ export declare class NodeProvider {
     request: (args: ApiRequestArguments) => Promise<any>;
     static Proxy(nodeProvider: NodeProvider): NodeProvider;
     static Remote(handler: ApiRequestHandler): NodeProvider;
+    fetchStdTokenMetaData: (tokenId: HexString) => Promise<TokenMetaData>;
 }

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

@@ -21,6 +21,7 @@ exports.NodeProvider = void 0;
 const types_1 = require("./types");
 const api_alephium_1 = require("./api-alephium");
 const utils_1 = require("./utils");
+const utils_2 = require("../utils");
 function initializeNodeApi(baseUrl, apiKey, customFetch) {
     const nodeApi = new api_alephium_1.Api({
         baseUrl: baseUrl,
@@ -36,9 +37,17 @@ class NodeProvider {
         this.request = (args) => {
             return (0, types_1.request)(this, args);
         };
+        // Only use this when the token is following the standard token interface
+        this.fetchStdTokenMetaData = async (tokenId) => {
+            return fetchStdTokenMetaData(this.contracts, tokenId);
+        };
         let nodeApi;
         if (typeof param0 === 'string') {
-            nodeApi = initializeNodeApi(param0, apiKey, customFetch);
+            const api = initializeNodeApi(param0, apiKey, customFetch);
+            nodeApi = {
+                ...api,
+                fetchStdTokenMetaData: async (tokenId) => fetchStdTokenMetaData(api.contracts, tokenId)
+            };
         }
         else if (typeof param0 === 'function') {
             nodeApi = new NodeProvider('https://1.2.3.4:0');
@@ -68,3 +77,17 @@ class NodeProvider {
     }
 }
 exports.NodeProvider = NodeProvider;
+async function fetchStdTokenMetaData(contractAPI, tokenId) {
+    const group = 0;
+    const address = (0, utils_2.addressFromTokenId)(tokenId);
+    const calls = Array.from([0, 1, 2, 3], (index) => ({ methodIndex: index, group: group, address: address }));
+    const result = await contractAPI.postContractsMulticallContract({
+        calls: calls
+    });
+    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)
+    };
+}

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

@@ -30,3 +30,9 @@ export interface ApiRequestArguments {
 export declare type ApiRequestHandler = (args: ApiRequestArguments) => Promise<any>;
 export declare function forwardRequests(api: Record<string, any>, handler: ApiRequestHandler): void;
 export declare function request(provider: Record<string, any>, args: ApiRequestArguments): Promise<any>;
+export interface TokenMetaData {
+    name: string;
+    symbol: string;
+    decimals: number;
+    totalSupply: Number256;
+}

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

@@ -169,6 +169,7 @@ export interface TestContractParams<F extends Fields = Fields, A extends Argumen
     group?: number;
     address?: string;
     blockHash?: string;
+    blockTimeStamp?: number;
     txId?: string;
     initialFields: F;
     initialAsset?: Asset;
@@ -287,5 +288,6 @@ export declare function decodeEvent<F extends Fields, M extends ContractEvent<F>
 export declare function subscribeContractEvent<F extends Fields, M extends ContractEvent<F>>(contract: Contract, instance: ContractInstance, options: SubscribeOptions<M>, eventName: string, fromCount?: number): EventSubscription;
 export declare function subscribeContractEvents(contract: Contract, instance: ContractInstance, options: SubscribeOptions<ContractEvent<any>>, fromCount?: number): EventSubscription;
 export declare function callMethod<I, F extends Fields, A extends Arguments, R>(contract: ContractFactory<I, F>, instance: ContractInstance, methodName: string, params: Optional<CallContractParams<A>, 'args'>): Promise<CallContractResult<R>>;
+export declare function multicallMethods<I, F extends Fields>(contract: ContractFactory<I, F>, instance: ContractInstance, calls: Record<string, Optional<CallContractParams<any>, 'args'>>): Promise<Record<string, CallContractResult<any>>>;
 export declare function getContractEventsCurrentCount(contractAddress: Address): Promise<number>;
 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.getContractEventsCurrentCount = exports.callMethod = exports.subscribeContractEvents = exports.subscribeContractEvent = exports.decodeEvent = exports.subscribeContractDestroyedEvent = exports.subscribeContractCreatedEvent = exports.fetchContractState = exports.ContractInstance = exports.testMethod = exports.subscribeEventsFromContract = exports.decodeContractDestroyedEvent = exports.decodeContractCreatedEvent = exports.DestroyContractEventAddress = exports.CreateContractEventAddress = exports.ContractFactory = exports.randomTxId = exports.toApiVals = exports.Script = exports.Contract = exports.Artifact = exports.Project = exports.DEFAULT_COMPILER_OPTIONS = exports.DEFAULT_NODE_COMPILER_OPTIONS = void 0;
+exports.getContractEventsCurrentCount = exports.multicallMethods = exports.callMethod = exports.subscribeContractEvents = exports.subscribeContractEvent = exports.decodeEvent = exports.subscribeContractDestroyedEvent = exports.subscribeContractCreatedEvent = exports.fetchContractState = exports.ContractInstance = exports.testMethod = exports.subscribeEventsFromContract = exports.decodeContractDestroyedEvent = exports.decodeContractCreatedEvent = exports.DestroyContractEventAddress = exports.CreateContractEventAddress = exports.ContractFactory = exports.randomTxId = exports.toApiVals = exports.Script = exports.Contract = exports.Artifact = exports.Project = exports.DEFAULT_COMPILER_OPTIONS = exports.DEFAULT_NODE_COMPILER_OPTIONS = void 0;
 const buffer_1 = require("buffer/");
 const crypto_1 = require("crypto");
 const fs_1 = __importDefault(require("fs"));
@@ -551,6 +551,9 @@ class Contract extends Artifact {
         const mutFields = params.initialFields === undefined ? [] : extractFields(params.initialFields, this.fieldsSig, true);
         return {
             group: params.group,
+            blockHash: params.blockHash,
+            blockTimeStamp: params.blockTimeStamp,
+            txId: params.txId,
             address: params.address,
             bytecode: this.bytecodeDebug,
             initialImmFields: immFields,
@@ -1044,6 +1047,25 @@ async function callMethod(contract, instance, methodName, params) {
     return callResult;
 }
 exports.callMethod = callMethod;
+async function multicallMethods(contract, instance, calls) {
+    const callEntries = Object.entries(calls);
+    const callsParams = callEntries.map((entry) => {
+        const [methodName, params] = entry;
+        const methodIndex = contract.contract.getMethodIndex(methodName);
+        const txId = params?.txId ?? randomTxId();
+        return contract.contract.toApiCallContract({ ...params, txId: txId, args: params.args === undefined ? {} : params.args }, instance.groupIndex, instance.address, methodIndex);
+    });
+    const result = await (0, global_1.getCurrentNodeProvider)().contracts.postContractsMulticallContract({ calls: callsParams });
+    const callsResult = {};
+    callsParams.forEach((call, index) => {
+        const methodIndex = call.methodIndex;
+        const callResult = result.results[`${methodIndex}`];
+        const methodName = callEntries[`${index}`][`0`];
+        callsResult[`${methodName}`] = contract.contract.fromApiCallContractResult(callResult, call.txId, methodIndex);
+    });
+    return callsResult;
+}
+exports.multicallMethods = multicallMethods;
 async function getContractEventsCurrentCount(contractAddress) {
     return (0, global_1.getCurrentNodeProvider)()
         .events.getEventsContractContractaddressCurrentCount(contractAddress)

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

@@ -19,6 +19,7 @@ export declare function groupOfPrivateKey(privateKey: string, keyType?: KeyType)
 export declare function publicKeyFromPrivateKey(privateKey: string, _keyType?: KeyType): string;
 export declare function addressFromPublicKey(publicKey: string, _keyType?: KeyType): string;
 export declare function addressFromContractId(contractId: string): string;
+export declare function addressFromTokenId(tokenId: string): string;
 export declare function contractIdFromTx(txId: string, outputIndex: number): string;
 export declare function subContractId(parentContractId: string, pathInHex: string, group: number): string;
 export declare function blockChainIndex(blockHash: HexString): {

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.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 = 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.isHexString = exports.xorByte = exports.signatureDecode = exports.encodeHexSignature = exports.encodeSignature = void 0;
 const elliptic_1 = require("elliptic");
 const bn_js_1 = __importDefault(require("bn.js"));
 const blakejs_1 = __importDefault(require("blakejs"));
@@ -191,6 +191,11 @@ function addressFromContractId(contractId) {
     return bs58_1.default.encode(bytes);
 }
 exports.addressFromContractId = addressFromContractId;
+function addressFromTokenId(tokenId) {
+    const contractId = tokenId; // contract ID is the same as token ID
+    return addressFromContractId(contractId);
+}
+exports.addressFromTokenId = addressFromTokenId;
 function contractIdFromTx(txId, outputIndex) {
     const txIdBin = hexToBinUnsafe(txId);
     const data = buffer_1.Buffer.concat([txIdBin, buffer_1.Buffer.from([outputIndex])]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.6.6",
+  "version": "0.7.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": "1.7.1",
+    "alephium_version": "1.7.3",
     "explorer_backend_version": "1.13.0"
   },
   "scripts": {

package/src/api/api-alephium.ts

@@ -618,6 +618,14 @@ export interface MinerAddressesInfo {
 
 export type MisbehaviorAction = Ban | Unban
 
+export interface MultipleCallContract {
+  calls: CallContract[]
+}
+
+export interface MultipleCallContractResult {
+  results: CallContractResult[]
+}
+
 export interface NodeInfo {
   buildInfo: BuildInfo
   upnp: boolean
@@ -775,6 +783,8 @@ export interface TestContract {
   group?: number
   /** @format block-hash */
   blockHash?: string
+  /** @format int64 */
+  blockTimeStamp?: number
   /** @format 32-byte-hash */
   txId?: string
   /** @format address */
@@ -1206,7 +1216,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 1.7.1
+ * @version 1.7.3
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -2045,7 +2055,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      *
      * @tags Transactions
      * @name PostTransactionsSweepAddressBuild
-     * @summary Build unsigned transactions to send all unlocked balanced of one address to another address
+     * @summary Build unsigned transactions to send all unlocked ALPH and token balances of one address to another address
      * @request POST:/transactions/sweep-address/build
      */
     postTransactionsSweepAddressBuild: (data: BuildSweepAddressTransactions, params: RequestParams = {}) =>
@@ -2391,7 +2401,28 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
           format: 'json',
           ...params
         }
-      ).then(convertHttpResponse)
+      ).then(convertHttpResponse),
+
+    /**
+     * No description
+     *
+     * @tags Contracts
+     * @name PostContractsMulticallContract
+     * @summary Multiple call contract
+     * @request POST:/contracts/multicall-contract
+     */
+    postContractsMulticallContract: (data: MultipleCallContract, params: RequestParams = {}) =>
+      this.request<
+        MultipleCallContractResult,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/contracts/multicall-contract`,
+        method: 'POST',
+        body: data,
+        type: ContentType.Json,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse)
   }
   multisig = {
     /**

package/src/api/node-provider.ts

@@ -16,9 +16,11 @@ 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/>.
 */
 
-import { ApiRequestArguments, ApiRequestHandler, forwardRequests, request } from './types'
+import { ApiRequestArguments, ApiRequestHandler, forwardRequests, request, TokenMetaData } from './types'
 import { Api as NodeApi } from './api-alephium'
 import { DEFAULT_THROTTLE_FETCH } from './utils'
+import { HexString } from '../contract'
+import { addressFromTokenId } from '../utils'
 
 function initializeNodeApi(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): NodeApi<string> {
   const nodeApi = new NodeApi<string>({
@@ -50,7 +52,11 @@ export class NodeProvider {
   constructor(param0: string | NodeProvider | ApiRequestHandler, apiKey?: string, customFetch?: typeof fetch) {
     let nodeApi: NodeProvider
     if (typeof param0 === 'string') {
-      nodeApi = initializeNodeApi(param0, apiKey, customFetch)
+      const api = initializeNodeApi(param0, apiKey, customFetch)
+      nodeApi = {
+        ...api,
+        fetchStdTokenMetaData: async (tokenId: string) => fetchStdTokenMetaData(api.contracts, tokenId)
+      }
     } else if (typeof param0 === 'function') {
       nodeApi = new NodeProvider('https://1.2.3.4:0')
       forwardRequests(nodeApi, param0 as ApiRequestHandler)
@@ -83,4 +89,27 @@ export class NodeProvider {
   static Remote(handler: ApiRequestHandler): NodeProvider {
     return new NodeProvider(handler)
   }
+
+  // Only use this when the token is following the standard token interface
+  fetchStdTokenMetaData = async (tokenId: HexString): Promise<TokenMetaData> => {
+    return fetchStdTokenMetaData(this.contracts, tokenId)
+  }
+}
+
+async function fetchStdTokenMetaData(
+  contractAPI: NodeApi<string>['contracts'],
+  tokenId: HexString
+): Promise<TokenMetaData> {
+  const group = 0
+  const address = addressFromTokenId(tokenId)
+  const calls = Array.from([0, 1, 2, 3], (index) => ({ methodIndex: index, group: group, address: address }))
+  const result = await contractAPI.postContractsMulticallContract({
+    calls: calls
+  })
+  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)
+  }
 }

package/src/api/types.ts

@@ -268,3 +268,10 @@ export async function request(provider: Record<string, any>, args: ApiRequestArg
   const call = provider[`${args.path}`][`${args.method}`] as (...any) => Promise<any>
   return call(...args.params)
 }
+
+export interface TokenMetaData {
+  name: string
+  symbol: string
+  decimals: number
+  totalSupply: Number256
+}

package/src/contract/contract.ts

@@ -818,6 +818,9 @@ export class Contract extends Artifact {
       params.initialFields === undefined ? [] : extractFields(params.initialFields, this.fieldsSig, true)
     return {
       group: params.group,
+      blockHash: params.blockHash,
+      blockTimeStamp: params.blockTimeStamp,
+      txId: params.txId,
       address: params.address,
       bytecode: this.bytecodeDebug,
       initialImmFields: immFields,
@@ -1210,6 +1213,7 @@ export interface TestContractParams<F extends Fields = Fields, A extends Argumen
   group?: number // default 0
   address?: string
   blockHash?: string
+  blockTimeStamp?: number
   txId?: string
   initialFields: F
   initialAsset?: Asset // default 1 ALPH
@@ -1602,6 +1606,38 @@ export async function callMethod<I, F extends Fields, A extends Arguments, R>(
   return callResult as CallContractResult<R>
 }
 
+export async function multicallMethods<I, F extends Fields>(
+  contract: ContractFactory<I, F>,
+  instance: ContractInstance,
+  calls: Record<string, Optional<CallContractParams<any>, 'args'>>
+): Promise<Record<string, CallContractResult<any>>> {
+  const callEntries = Object.entries(calls)
+  const callsParams = callEntries.map((entry) => {
+    const [methodName, params] = entry
+    const methodIndex = contract.contract.getMethodIndex(methodName)
+    const txId = params?.txId ?? randomTxId()
+    return contract.contract.toApiCallContract(
+      { ...params, txId: txId, args: params.args === undefined ? {} : params.args },
+      instance.groupIndex,
+      instance.address,
+      methodIndex
+    )
+  })
+  const result = await getCurrentNodeProvider().contracts.postContractsMulticallContract({ calls: callsParams })
+  const callsResult: Record<string, CallContractResult<any>> = {}
+  callsParams.forEach((call, index) => {
+    const methodIndex = call.methodIndex
+    const callResult = result.results[`${methodIndex}`]
+    const methodName = callEntries[`${index}`][`0`]
+    callsResult[`${methodName}`] = contract.contract.fromApiCallContractResult(
+      callResult,
+      call.txId!,
+      methodIndex
+    ) as CallContractResult<any>
+  })
+  return callsResult
+}
+
 export async function getContractEventsCurrentCount(contractAddress: Address): Promise<number> {
   return getCurrentNodeProvider()
     .events.getEventsContractContractaddressCurrentCount(contractAddress)

package/src/utils/utils.ts

@@ -197,6 +197,11 @@ export function addressFromContractId(contractId: string): string {
   return bs58.encode(bytes)
 }
 
+export function addressFromTokenId(tokenId: string): string {
+  const contractId = tokenId // contract ID is the same as token ID
+  return addressFromContractId(contractId)
+}
+
 export function contractIdFromTx(txId: string, outputIndex: number): string {
   const txIdBin = hexToBinUnsafe(txId)
   const data = Buffer.concat([txIdBin, Buffer.from([outputIndex])])