@alephium/web3 1.1.2 → 1.2.1-rc.0

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.2",
+  "version": "1.2.1-rc.0",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -33,8 +33,8 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "3.2.0",
-    "explorer_backend_version": "1.19.3"
+    "alephium_version": "3.3.0",
+    "explorer_backend_version": "2.0.0"
   },
   "type": "commonjs",
   "dependencies": {

package/src/address/address.ts

@@ -41,6 +41,15 @@ export function validateAddress(address: string) {
   decodeAndValidateAddress(address)
 }
 
+export function isValidAddress(address: string): boolean {
+  try {
+    validateAddress(address)
+    return true
+  } catch {
+    return false
+  }
+}
+
 function decodeAndValidateAddress(address: string): Uint8Array {
   let decoded: Uint8Array
   try {

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 = {
     /**