@alephium/web3 1.1.1 → 1.2.0

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

@@ -359,7 +359,7 @@ export interface CallContract {
     /** @format int32 */
     methodIndex: number;
     args?: Val[];
-    existingContracts?: string[];
+    interestedContracts?: string[];
     inputAssets?: TestInputAsset[];
 }
 /** CallContractFailed */
@@ -381,6 +381,32 @@ export interface CallContractSucceeded {
     debugMessages: DebugMessage[];
     type: string;
 }
+/** CallTxScript */
+export interface CallTxScript {
+    /** @format int32 */
+    group: number;
+    /** @format hex-string */
+    bytecode: string;
+    /** @format address */
+    callerAddress?: string;
+    /** @format block-hash */
+    worldStateBlockHash?: string;
+    /** @format 32-byte-hash */
+    txId?: string;
+    inputAssets?: TestInputAsset[];
+    interestedContracts?: string[];
+}
+/** CallTxScriptResult */
+export interface CallTxScriptResult {
+    returns: Val[];
+    /** @format int32 */
+    gasUsed: number;
+    contracts: ContractState[];
+    txInputs: string[];
+    txOutputs: Output[];
+    events: ContractEventByTxId[];
+    debugMessages: DebugMessage[];
+}
 /** ChainInfo */
 export interface ChainInfo {
     /** @format int32 */
@@ -1153,7 +1179,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 3.2.0
+ * @version 3.3.0
  * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -1820,6 +1846,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/contracts/multicall-contract
          */
         postContractsMulticallContract: (data: MultipleCallContract, params?: RequestParams) => Promise<MultipleCallContractResult>;
+        /**
+         * No description
+         *
+         * @tags Contracts
+         * @name PostContractsCallTxScript
+         * @summary Call TxScript
+         * @request POST:/contracts/call-tx-script
+         */
+        postContractsCallTxScript: (data: CallTxScript, params?: RequestParams) => Promise<CallTxScriptResult>;
     };
     multisig: {
         /**

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

@@ -151,7 +151,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Alephium API
- * @version 3.2.0
+ * @version 3.3.0
  * @baseUrl ../
  */
 class Api extends HttpClient {
@@ -1118,6 +1118,22 @@ class Api extends HttpClient {
                 type: ContentType.Json,
                 format: 'json',
                 ...params
+            }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Contracts
+             * @name PostContractsCallTxScript
+             * @summary Call TxScript
+             * @request POST:/contracts/call-tx-script
+             */
+            postContractsCallTxScript: (data, params = {}) => this.request({
+                path: `/contracts/call-tx-script`,
+                method: 'POST',
+                body: data,
+                type: ContentType.Json,
+                format: 'json',
+                ...params
             }).then(utils_1.convertHttpResponse)
         };
         this.multisig = {

package/dist/src/codec/codec.d.ts

@@ -5,3 +5,4 @@ export interface Codec<T> {
     decode(input: Uint8Array): T;
 }
 export declare function assert(value: boolean, message: string): void;
+export declare function fixedSizeBytes(name: string, length: number): Parser;

package/dist/src/codec/codec.js

@@ -1,9 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assert = void 0;
+exports.fixedSizeBytes = exports.assert = void 0;
+/*
+Copyright 2018 - 2022 The Alephium Authors
+This file is part of the alephium project.
+
+The library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+The library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+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/>.
+*/
+const binary_parser_1 = require("binary-parser");
 function assert(value, message) {
     if (!value) {
         throw new Error(message);
     }
 }
 exports.assert = assert;
+function fixedSizeBytes(name, length) {
+    return binary_parser_1.Parser.start().wrapped({
+        length,
+        type: binary_parser_1.Parser.start().buffer(name, { length }),
+        wrapper: function (result) {
+            if (result.length === length) {
+                return result;
+            }
+            throw new Error(`Too few bytes when parsing ${name}, expected ${length}, got ${result.length}`);
+        }
+    });
+}
+exports.fixedSizeBytes = fixedSizeBytes;

package/dist/src/codec/lockup-script-codec.js

@@ -20,10 +20,11 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 const binary_parser_1 = require("binary-parser");
 const compact_int_codec_1 = require("./compact-int-codec");
+const codec_1 = require("./codec");
 const array_codec_1 = require("./array-codec");
 class PublicKeyHashCodec {
     constructor() {
-        this.parser = binary_parser_1.Parser.start().buffer('publicKeyHash', { length: 32 });
+        this.parser = (0, codec_1.fixedSizeBytes)('publicKeyHash', 32);
     }
     encode(input) {
         return input.publicKeyHash;

package/dist/src/codec/unlock-script-codec.js

@@ -21,13 +21,14 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 const binary_parser_1 = require("binary-parser");
 const array_codec_1 = require("./array-codec");
 const compact_int_codec_1 = require("./compact-int-codec");
+const codec_1 = require("./codec");
 const script_codec_1 = require("./script-codec");
 const bytestring_codec_1 = require("./bytestring-codec");
 const lockup_script_codec_1 = require("./lockup-script-codec");
 const utils_1 = require("../utils");
 class P2PKHCodec {
     constructor() {
-        this.parser = binary_parser_1.Parser.start().buffer('publicKey', { length: 33 });
+        this.parser = (0, codec_1.fixedSizeBytes)('publicKey', 33);
     }
     encode(input) {
         return input.publicKey;

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

@@ -184,10 +184,12 @@ export declare abstract class ContractFactory<I extends ContractInstance, F exte
     deploy(signer: SignerProvider, deployParams: DeployContractParams<F>): Promise<DeployContractResult<I>>;
     stateForTest(initFields: F, asset?: Asset, address?: string): ContractState<F>;
 }
-export declare class ExecutableScript<P extends Fields = Fields> {
+export declare class ExecutableScript<P extends Fields = Fields, R extends Val | null = null> {
     readonly script: Script;
-    constructor(script: Script);
+    readonly getContractByCodeHash: (codeHash: string) => Contract;
+    constructor(script: Script, getContractByCodeHash: (codeHash: string) => Contract);
     execute(signer: SignerProvider, params: ExecuteScriptParams<P>): Promise<ExecuteScriptResult>;
+    call(params: CallScriptParams<P>): Promise<CallScriptResult<R>>;
 }
 export interface ExecuteScriptParams<P extends Fields = Fields> {
     initialFields: P;
@@ -204,11 +206,21 @@ export interface ExecuteScriptResult {
     gasAmount: number;
     gasPrice: Number256;
 }
+export interface CallScriptParams<P extends Fields = Fields> {
+    initialFields: P;
+    groupIndex?: number;
+    callerAddress?: string;
+    worldStateBlockHash?: string;
+    txId?: string;
+    interestedContracts?: string[];
+    inputAssets?: InputAsset[];
+}
+export type CallScriptResult<R> = CallContractResult<R>;
 export interface CallContractParams<T extends Arguments = Arguments> {
     args: T;
     worldStateBlockHash?: string;
     txId?: string;
-    existingContracts?: string[];
+    interestedContracts?: string[];
     inputAssets?: InputAsset[];
 }
 export interface CallContractResult<R> {

package/dist/src/contract/contract.js

@@ -382,19 +382,7 @@ class Contract extends Artifact {
     fromApiCallContractResult(result, txId, methodIndex, getContractByCodeHash) {
         const returnTypes = this.functions[`${methodIndex}`].returnTypes;
         const callResult = (0, api_1.tryGetCallResult)(result);
-        const rawReturn = fromApiArray(callResult.returns, returnTypes, this.structs);
-        const returns = rawReturn.length === 0 ? null : rawReturn.length === 1 ? rawReturn[0] : rawReturn;
-        const addressToCodeHash = new Map();
-        callResult.contracts.forEach((contract) => addressToCodeHash.set(contract.address, contract.codeHash));
-        return {
-            returns: returns,
-            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),
-            debugMessages: callResult.debugMessages
-        };
+        return fromCallResult(callResult, txId, returnTypes, this.structs, getContractByCodeHash);
     }
 }
 exports.Contract = Contract;
@@ -410,6 +398,21 @@ Contract.ContractDestroyedEvent = {
     fieldNames: ['address'],
     fieldTypes: ['Address']
 };
+function fromCallResult(callResult, txId, returnTypes, structs, getContractByCodeHash) {
+    const rawReturn = fromApiArray(callResult.returns, returnTypes, structs);
+    const returns = rawReturn.length === 0 ? null : rawReturn.length === 1 ? rawReturn[0] : rawReturn;
+    const addressToCodeHash = new Map();
+    callResult.contracts.forEach((contract) => addressToCodeHash.set(contract.address, contract.codeHash));
+    return {
+        returns: returns,
+        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),
+        debugMessages: callResult.debugMessages
+    };
+}
 class Script extends Artifact {
     constructor(version, name, bytecodeTemplate, bytecodeDebugPatch, fieldsSig, functions, structs) {
         super(version, name, functions);
@@ -635,13 +638,32 @@ class ContractFactory {
 }
 exports.ContractFactory = ContractFactory;
 class ExecutableScript {
-    constructor(script) {
+    constructor(script, getContractByCodeHash) {
         this.script = script;
+        this.getContractByCodeHash = getContractByCodeHash;
     }
     async execute(signer, params) {
         const signerParams = await this.script.txParamsForExecution(signer, params);
         return await signer.signAndSubmitExecuteScriptTx(signerParams);
     }
+    async call(params) {
+        const mainFunc = this.script.functions.find((f) => f.name === 'main');
+        if (mainFunc === undefined) {
+            throw new Error(`There is no main function in script ${this.script.name}`);
+        }
+        const bytecode = this.script.buildByteCodeToDeploy(params.initialFields);
+        const txId = params.txId ?? randomTxId();
+        const provider = (0, global_1.getCurrentNodeProvider)();
+        const callResult = await provider.contracts.postContractsCallTxScript({
+            ...params,
+            group: params.groupIndex ?? 0,
+            bytecode: bytecode,
+            inputAssets: toApiInputAssets(params.inputAssets)
+        });
+        const returnTypes = mainFunc.returnTypes;
+        const result = fromCallResult(callResult, txId, returnTypes, this.script.structs, this.getContractByCodeHash);
+        return result;
+    }
 }
 exports.ExecutableScript = ExecutableScript;
 function specialContractAddress(eventIndex, groupIndex) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -33,7 +33,7 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "3.2.0",
+    "alephium_version": "3.3.0",
     "explorer_backend_version": "1.19.3"
   },
   "type": "commonjs",

package/src/api/api-alephium.ts

@@ -401,7 +401,7 @@ export interface CallContract {
   /** @format int32 */
   methodIndex: number
   args?: Val[]
-  existingContracts?: string[]
+  interestedContracts?: string[]
   inputAssets?: TestInputAsset[]
 }
 
@@ -427,6 +427,34 @@ export interface CallContractSucceeded {
   type: string
 }
 
+/** CallTxScript */
+export interface CallTxScript {
+  /** @format int32 */
+  group: number
+  /** @format hex-string */
+  bytecode: string
+  /** @format address */
+  callerAddress?: string
+  /** @format block-hash */
+  worldStateBlockHash?: string
+  /** @format 32-byte-hash */
+  txId?: string
+  inputAssets?: TestInputAsset[]
+  interestedContracts?: string[]
+}
+
+/** CallTxScriptResult */
+export interface CallTxScriptResult {
+  returns: Val[]
+  /** @format int32 */
+  gasUsed: number
+  contracts: ContractState[]
+  txInputs: string[]
+  txOutputs: Output[]
+  events: ContractEventByTxId[]
+  debugMessages: DebugMessage[]
+}
+
 /** ChainInfo */
 export interface ChainInfo {
   /** @format int32 */
@@ -1453,7 +1481,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 3.2.0
+ * @version 3.3.0
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -2714,7 +2742,27 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         type: ContentType.Json,
         format: 'json',
         ...params
-      }).then(convertHttpResponse)
+      }).then(convertHttpResponse),
+
+    /**
+     * No description
+     *
+     * @tags Contracts
+     * @name PostContractsCallTxScript
+     * @summary Call TxScript
+     * @request POST:/contracts/call-tx-script
+     */
+    postContractsCallTxScript: (data: CallTxScript, params: RequestParams = {}) =>
+      this.request<CallTxScriptResult, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>(
+        {
+          path: `/contracts/call-tx-script`,
+          method: 'POST',
+          body: data,
+          type: ContentType.Json,
+          format: 'json',
+          ...params
+        }
+      ).then(convertHttpResponse)
   }
   multisig = {
     /**

package/src/codec/codec.ts

@@ -28,3 +28,16 @@ export function assert(value: boolean, message: string) {
     throw new Error(message)
   }
 }
+
+export function fixedSizeBytes(name: string, length: number): Parser {
+  return Parser.start().wrapped({
+    length,
+    type: Parser.start().buffer(name, { length }),
+    wrapper: function (result) {
+      if (result.length === length) {
+        return result
+      }
+      throw new Error(`Too few bytes when parsing ${name}, expected ${length}, got ${result.length}`)
+    }
+  })
+}

package/src/codec/contract-codec.ts

@@ -19,7 +19,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 import { Parser } from 'binary-parser'
 import { ArrayCodec, DecodedArray } from './array-codec'
 import { Codec } from './codec'
-import { compactSignedIntCodec, compactUnsignedIntCodec, DecodedCompactInt } from './compact-int-codec'
+import { compactSignedIntCodec, DecodedCompactInt } from './compact-int-codec'
 import { Method, MethodCodec, methodCodec } from './method-codec'
 import { concatBytes } from '../utils'
 

package/src/codec/lockup-script-codec.ts

@@ -17,7 +17,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 import { Parser } from 'binary-parser'
 import { DecodedCompactInt, compactSignedIntCodec } from './compact-int-codec'
-import { Codec } from './codec'
+import { Codec, fixedSizeBytes } from './codec'
 import { ArrayCodec, DecodedArray } from './array-codec'
 
 export interface PublicKeyHash {
@@ -25,7 +25,7 @@ export interface PublicKeyHash {
 }
 
 class PublicKeyHashCodec implements Codec<PublicKeyHash> {
-  parser = Parser.start().buffer('publicKeyHash', { length: 32 })
+  parser = fixedSizeBytes('publicKeyHash', 32)
 
   encode(input: PublicKeyHash): Uint8Array {
     return input.publicKeyHash

package/src/codec/unlock-script-codec.ts

@@ -18,7 +18,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 import { Parser } from 'binary-parser'
 import { ArrayCodec, DecodedArray } from './array-codec'
 import { compactUnsignedIntCodec, compactSignedIntCodec, DecodedCompactInt } from './compact-int-codec'
-import { Codec } from './codec'
+import { Codec, fixedSizeBytes } from './codec'
 import { DecodedScript, scriptCodec } from './script-codec'
 import { ByteString, byteStringCodec } from './bytestring-codec'
 import { LockupScript, lockupScriptCodec } from './lockup-script-codec'
@@ -29,7 +29,7 @@ export interface P2PKH {
 }
 
 class P2PKHCodec implements Codec<P2PKH> {
-  parser = Parser.start().buffer('publicKey', { length: 33 })
+  parser = fixedSizeBytes('publicKey', 33)
 
   encode(input: P2PKH): Uint8Array {
     return input.publicKey

package/src/contract/contract.ts

@@ -77,7 +77,6 @@ import {
   StoreMutFieldByIndex,
   DestroySelf,
   Pop,
-  byteStringCodec,
   StoreLocal,
   instrCodec,
   U256Const,
@@ -603,20 +602,30 @@ export class Contract extends Artifact {
   ): CallContractResult<unknown> {
     const returnTypes = this.functions[`${methodIndex}`].returnTypes
     const callResult = tryGetCallResult(result)
-    const rawReturn = fromApiArray(callResult.returns, returnTypes, this.structs)
-    const returns = rawReturn.length === 0 ? null : rawReturn.length === 1 ? rawReturn[0] : rawReturn
+    return fromCallResult(callResult, txId, returnTypes, this.structs, getContractByCodeHash)
+  }
+}
 
-    const addressToCodeHash = new Map<string, string>()
-    callResult.contracts.forEach((contract) => addressToCodeHash.set(contract.address, contract.codeHash))
-    return {
-      returns: returns,
-      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),
-      debugMessages: callResult.debugMessages
-    }
+function fromCallResult(
+  callResult: node.CallContractSucceeded | node.CallTxScriptResult,
+  txId: string,
+  returnTypes: string[],
+  structs: Struct[],
+  getContractByCodeHash: (codeHash: string) => Contract
+): CallContractResult<unknown> {
+  const rawReturn = fromApiArray(callResult.returns, returnTypes, structs)
+  const returns = rawReturn.length === 0 ? null : rawReturn.length === 1 ? rawReturn[0] : rawReturn
+
+  const addressToCodeHash = new Map<string, string>()
+  callResult.contracts.forEach((contract) => addressToCodeHash.set(contract.address, contract.codeHash))
+  return {
+    returns: returns,
+    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),
+    debugMessages: callResult.debugMessages
   }
 }
 
@@ -1011,17 +1020,38 @@ export abstract class ContractFactory<I extends ContractInstance, F extends Fiel
   }
 }
 
-export class ExecutableScript<P extends Fields = Fields> {
+export class ExecutableScript<P extends Fields = Fields, R extends Val | null = null> {
   readonly script: Script
+  readonly getContractByCodeHash: (codeHash: string) => Contract
 
-  constructor(script: Script) {
+  constructor(script: Script, getContractByCodeHash: (codeHash: string) => Contract) {
     this.script = script
+    this.getContractByCodeHash = getContractByCodeHash
   }
 
   async execute(signer: SignerProvider, params: ExecuteScriptParams<P>): Promise<ExecuteScriptResult> {
     const signerParams = await this.script.txParamsForExecution(signer, params)
     return await signer.signAndSubmitExecuteScriptTx(signerParams)
   }
+
+  async call(params: CallScriptParams<P>): Promise<CallScriptResult<R>> {
+    const mainFunc = this.script.functions.find((f) => f.name === 'main')
+    if (mainFunc === undefined) {
+      throw new Error(`There is no main function in script ${this.script.name}`)
+    }
+    const bytecode = this.script.buildByteCodeToDeploy(params.initialFields)
+    const txId = params.txId ?? randomTxId()
+    const provider = getCurrentNodeProvider()
+    const callResult = await provider.contracts.postContractsCallTxScript({
+      ...params,
+      group: params.groupIndex ?? 0,
+      bytecode: bytecode,
+      inputAssets: toApiInputAssets(params.inputAssets)
+    })
+    const returnTypes = mainFunc.returnTypes
+    const result = fromCallResult(callResult, txId, returnTypes, this.script.structs, this.getContractByCodeHash)
+    return result as CallScriptResult<R>
+  }
 }
 
 export interface ExecuteScriptParams<P extends Fields = Fields> {
@@ -1041,11 +1071,23 @@ export interface ExecuteScriptResult {
   gasPrice: Number256
 }
 
+export interface CallScriptParams<P extends Fields = Fields> {
+  initialFields: P
+  groupIndex?: number
+  callerAddress?: string
+  worldStateBlockHash?: string
+  txId?: string
+  interestedContracts?: string[]
+  inputAssets?: InputAsset[]
+}
+
+export type CallScriptResult<R> = CallContractResult<R>
+
 export interface CallContractParams<T extends Arguments = Arguments> {
   args: T
   worldStateBlockHash?: string
   txId?: string
-  existingContracts?: string[]
+  interestedContracts?: string[]
   inputAssets?: InputAsset[]
 }