@alephium/web3 1.7.0 → 1.7.2

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

@@ -121,6 +121,9 @@ export interface ContractState<T extends Fields = Fields> {
     fieldsSig: FieldsSig;
     asset: Asset;
 }
+export interface ContractStateWithMaps<T extends Fields = Fields, M extends Record<string, Map<Val, Val>> = Record<string, Map<Val, Val>>> extends ContractState<T> {
+    maps?: M;
+}
 export type TestContractParamsWithoutMaps<F extends Fields = Fields, A extends Arguments = Arguments> = Omit<TestContractParams<F, A>, 'initialMaps'>;
 export interface TestContractParams<F extends Fields = Fields, A extends Arguments = Arguments, M extends Record<string, Map<Val, Val>> = Record<string, Map<Val, Val>>> {
     group?: number;
@@ -133,7 +136,7 @@ export interface TestContractParams<F extends Fields = Fields, A extends Argumen
     initialMaps?: M;
     initialAsset?: Asset;
     testArgs: A;
-    existingContracts?: ContractState[];
+    existingContracts?: ContractStateWithMaps[];
     inputAssets?: InputAsset[];
 }
 export interface ContractEvent<T extends Fields = Fields> {
@@ -152,7 +155,7 @@ export interface TestContractResult<R, M extends Record<string, Map<Val, Val>> =
     returns: R;
     gasUsed: number;
     maps?: M;
-    contracts: ContractState[];
+    contracts: ContractStateWithMaps[];
     txOutputs: Output[];
     events: ContractEvent[];
     debugMessages: DebugMessage[];
@@ -190,7 +193,7 @@ export declare abstract class ContractFactory<I extends ContractInstance, F exte
     abstract at(address: string): I;
     deploy(signer: SignerProvider, deployParams: DeployContractParams<F>): Promise<DeployContractResult<I>>;
     deployTemplate(signer: SignerProvider): Promise<DeployContractResult<I>>;
-    stateForTest(initFields: F, asset?: Asset, address?: string): ContractState<F>;
+    protected stateForTest_(initFields: F, asset?: Asset, address?: string, maps?: Record<string, Map<Val, Val>>): ContractState<F> | ContractStateWithMaps<F>;
 }
 export declare class ExecutableScript<P extends Fields = Fields, R extends Val | null = null> {
     readonly script: Script;
@@ -266,6 +269,10 @@ export declare function subscribeEventsFromContract<T extends Fields, M extends
 export declare function addStdIdToFields<F extends Fields>(contract: Contract, fields: F): F | (F & {
     __stdInterfaceId: HexString;
 });
+export declare function extractMapsFromApiResult(selfAddress: string, params: Optional<TestContractParams, 'testArgs' | 'initialFields'>, group: number, apiResult: node.TestContractResult, getContractByCodeHash: (codeHash: string) => Contract): {
+    address: string;
+    maps: Record<string, Map<Val, Val>>;
+}[];
 export declare function testMethod<I extends ContractInstance, F extends Fields, A extends Arguments, R, M extends Record<string, Map<Val, Val>> = Record<string, Map<Val, Val>>>(factory: ContractFactory<I, F>, methodName: string, params: Optional<TestContractParams<F, A, M>, 'testArgs' | 'initialFields'>, getContractByCodeHash: (codeHash: string) => Contract): Promise<TestContractResult<R, M>>;
 export declare class RalphMap<K extends Val, V extends Val> {
     private readonly parentContract;

package/dist/src/contract/contract.js

@@ -40,7 +40,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTokenIdFromUnsignedTx = exports.getContractIdFromUnsignedTx = exports.getContractEventsCurrentCount = exports.multicallMethods = exports.signExecuteMethod = exports.callMethod = exports.subscribeContractEvents = exports.subscribeContractEvent = exports.decodeEvent = exports.subscribeContractDestroyedEvent = exports.subscribeContractCreatedEvent = exports.fetchContractState = exports.ContractInstance = exports.getMapItem = exports.RalphMap = exports.testMethod = exports.addStdIdToFields = exports.subscribeEventsFromContract = exports.decodeContractDestroyedEvent = exports.decodeContractCreatedEvent = exports.DestroyContractEventAddresses = exports.CreateContractEventAddresses = exports.ExecutableScript = exports.ContractFactory = exports.randomTxId = exports.fromApiEventFields = exports.fromApiArray = exports.getDefaultValue = exports.fromApiFields = exports.Script = exports.Contract = exports.Artifact = exports.Struct = exports.DEFAULT_COMPILER_OPTIONS = exports.DEFAULT_NODE_COMPILER_OPTIONS = exports.StdIdFieldName = void 0;
+exports.getTokenIdFromUnsignedTx = exports.getContractIdFromUnsignedTx = exports.getContractEventsCurrentCount = exports.multicallMethods = exports.signExecuteMethod = exports.callMethod = exports.subscribeContractEvents = exports.subscribeContractEvent = exports.decodeEvent = exports.subscribeContractDestroyedEvent = exports.subscribeContractCreatedEvent = exports.fetchContractState = exports.ContractInstance = exports.getMapItem = exports.RalphMap = exports.testMethod = exports.extractMapsFromApiResult = exports.addStdIdToFields = exports.subscribeEventsFromContract = exports.decodeContractDestroyedEvent = exports.decodeContractCreatedEvent = exports.DestroyContractEventAddresses = exports.CreateContractEventAddresses = exports.ExecutableScript = exports.ContractFactory = exports.randomTxId = exports.fromApiEventFields = exports.fromApiArray = exports.getDefaultValue = exports.fromApiFields = exports.Script = exports.Contract = exports.Artifact = exports.Struct = exports.DEFAULT_COMPILER_OPTIONS = exports.DEFAULT_NODE_COMPILER_OPTIONS = exports.StdIdFieldName = void 0;
 const fs_1 = require("fs");
 const api_1 = require("../api");
 const ralph = __importStar(require("./ralph"));
@@ -379,6 +379,9 @@ class Contract extends Artifact {
         return signerParams;
     }
     buildByteCodeToDeploy(initialFields, isDevnet, exposePrivateFunctions = false) {
+        if (exposePrivateFunctions && !isDevnet) {
+            throw new Error('Cannot expose private functions in non-devnet environment');
+        }
         try {
             const bytecode = exposePrivateFunctions && isDevnet
                 ? this.getByteCodeForTesting()
@@ -669,12 +672,18 @@ class ContractFactory {
         });
     }
     // This is used for testing contract functions
-    stateForTest(initFields, asset, address) {
+    stateForTest_(initFields, asset, address, maps) {
         const newAsset = {
-            alphAmount: asset?.alphAmount ?? constants_1.ONE_ALPH,
+            alphAmount: asset?.alphAmount ?? constants_1.MINIMAL_CONTRACT_DEPOSIT,
             tokens: asset?.tokens
         };
-        return this.contract.toState(addStdIdToFields(this.contract, initFields), newAsset, address);
+        const state = this.contract.toState(addStdIdToFields(this.contract, initFields), newAsset, address);
+        return {
+            ...state,
+            bytecode: this.contract.bytecodeDebug,
+            codeHash: this.contract.codeHash,
+            maps: maps
+        };
     }
 }
 exports.ContractFactory = ContractFactory;
@@ -872,29 +881,65 @@ function mapsToExistingContracts(contract, parentContractId, group, initialMaps)
     });
     return contractStates;
 }
+function hasMap(state) {
+    return state.maps !== undefined;
+}
+function getTestExistingContracts(selfContract, selfContractId, group, params, getContractByCodeHash) {
+    const selfMaps = params.initialMaps ?? {};
+    const selfMapEntries = mapsToExistingContracts(selfContract, selfContractId, group, selfMaps);
+    const existingContracts = params.existingContracts ?? [];
+    const existingMapEntries = existingContracts.flatMap((contractState) => {
+        return hasMap(contractState)
+            ? mapsToExistingContracts(getContractByCodeHash(contractState.codeHash), contractState.contractId, group, contractState.maps ?? {})
+            : [];
+    });
+    return existingContracts.concat(selfMapEntries, existingMapEntries);
+}
+function extractMapsFromApiResult(selfAddress, params, group, apiResult, getContractByCodeHash) {
+    const selfMaps = params.initialMaps ?? {};
+    const existingContracts = params.existingContracts ?? [];
+    const filtered = apiResult.contracts.filter((c) => c.address === selfAddress || existingContracts.find((s) => s.address === c.address) !== undefined);
+    const allMaps = [];
+    filtered.forEach((state) => {
+        const artifact = getContractByCodeHash(state.codeHash);
+        if (artifact.mapsSig !== undefined) {
+            const originMaps = state.address === selfAddress
+                ? selfMaps
+                : existingContracts.find((s) => s.address === state.address).maps;
+            const maps = existingContractsToMaps(artifact, state.address, group, apiResult, originMaps ?? {});
+            allMaps.push({ address: state.address, maps });
+        }
+    });
+    return allMaps;
+}
+exports.extractMapsFromApiResult = extractMapsFromApiResult;
 async function testMethod(factory, methodName, params, getContractByCodeHash) {
     const txId = params?.txId ?? randomTxId();
-    const contract = factory.contract;
-    const address = params.address ?? (0, address_1.addressFromContractId)((0, utils_1.binToHex)(crypto.getRandomValues(new Uint8Array(32))));
-    const contractId = (0, utils_1.binToHex)((0, address_1.contractIdFromAddress)(address));
+    const selfContract = factory.contract;
+    const selfAddress = params.address ?? (0, address_1.addressFromContractId)((0, utils_1.binToHex)(crypto.getRandomValues(new Uint8Array(32))));
+    const selfContractId = (0, utils_1.binToHex)((0, address_1.contractIdFromAddress)(selfAddress));
     const group = params.group ?? 0;
-    const initialMaps = params.initialMaps ?? {};
-    const contractStates = mapsToExistingContracts(contract, contractId, group, initialMaps);
-    const apiParams = contract.toApiTestContractParams(methodName, {
+    const existingContracts = getTestExistingContracts(selfContract, selfContractId, group, params, getContractByCodeHash);
+    const apiParams = selfContract.toApiTestContractParams(methodName, {
         ...params,
-        address,
+        address: selfAddress,
         txId: txId,
-        initialFields: addStdIdToFields(contract, params.initialFields ?? {}),
+        initialFields: addStdIdToFields(selfContract, params.initialFields ?? {}),
         testArgs: params.testArgs === undefined ? {} : params.testArgs,
-        existingContracts: (params.existingContracts ?? []).concat(contractStates)
+        existingContracts
     });
     const apiResult = await (0, global_1.getCurrentNodeProvider)().contracts.postContractsTestContract(apiParams);
-    const maps = existingContractsToMaps(contract, address, group, apiResult, initialMaps);
-    const testResult = contract.fromApiTestContractResult(methodName, apiResult, txId, getContractByCodeHash);
-    contract.printDebugMessages(methodName, testResult.debugMessages);
+    const allMaps = extractMapsFromApiResult(selfAddress, params, group, apiResult, getContractByCodeHash);
+    const testResult = selfContract.fromApiTestContractResult(methodName, apiResult, txId, getContractByCodeHash);
+    testResult.contracts.forEach((c) => {
+        const maps = allMaps.find((v) => v.address === c.address)?.maps;
+        if (maps !== undefined)
+            c['maps'] = maps;
+    });
+    selfContract.printDebugMessages(methodName, testResult.debugMessages);
     return {
         ...testResult,
-        maps
+        maps: allMaps.find((v) => v.address === selfAddress)?.maps
     };
 }
 exports.testMethod = testMethod;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",

package/src/contract/contract.ts

@@ -59,7 +59,7 @@ import {
 import { contractIdFromAddress, groupOfAddress, addressFromContractId, subContractId } from '../address'
 import { getCurrentNodeProvider } from '../global'
 import { EventSubscribeOptions, EventSubscription, subscribeToEvents } from './events'
-import { ONE_ALPH, TOTAL_NUMBER_OF_GROUPS } from '../constants'
+import { MINIMAL_CONTRACT_DEPOSIT, ONE_ALPH, TOTAL_NUMBER_OF_GROUPS } from '../constants'
 import * as blake from 'blakejs'
 import { isContractDebugMessageEnabled } from '../debug'
 import {
@@ -589,6 +589,10 @@ export class Contract extends Artifact {
   }
 
   buildByteCodeToDeploy(initialFields: Fields, isDevnet: boolean, exposePrivateFunctions = false): string {
+    if (exposePrivateFunctions && !isDevnet) {
+      throw new Error('Cannot expose private functions in non-devnet environment')
+    }
+
     try {
       const bytecode =
         exposePrivateFunctions && isDevnet
@@ -881,6 +885,13 @@ export interface ContractState<T extends Fields = Fields> {
   asset: Asset
 }
 
+export interface ContractStateWithMaps<
+  T extends Fields = Fields,
+  M extends Record<string, Map<Val, Val>> = Record<string, Map<Val, Val>>
+> extends ContractState<T> {
+  maps?: M
+}
+
 function toApiContractState(state: ContractState, structs: Struct[]): node.ContractState {
   const stateFields = state.fields ?? {}
   const fieldsSig = state.fieldsSig
@@ -938,7 +949,7 @@ export interface TestContractParams<
   initialMaps?: M
   initialAsset?: Asset // default 1 ALPH
   testArgs: A
-  existingContracts?: ContractState[] // default no existing contracts
+  existingContracts?: ContractStateWithMaps[] // default no existing contracts
   inputAssets?: InputAsset[] // default no input asserts
 }
 
@@ -961,7 +972,7 @@ export interface TestContractResult<R, M extends Record<string, Map<Val, Val>> =
   returns: R
   gasUsed: number
   maps?: M
-  contracts: ContractState[]
+  contracts: ContractStateWithMaps[]
   txOutputs: Output[]
   events: ContractEvent[]
   debugMessages: DebugMessage[]
@@ -1061,12 +1072,23 @@ export abstract class ContractFactory<I extends ContractInstance, F extends Fiel
   }
 
   // This is used for testing contract functions
-  stateForTest(initFields: F, asset?: Asset, address?: string): ContractState<F> {
+  protected stateForTest_(
+    initFields: F,
+    asset?: Asset,
+    address?: string,
+    maps?: Record<string, Map<Val, Val>>
+  ): ContractState<F> | ContractStateWithMaps<F> {
     const newAsset = {
-      alphAmount: asset?.alphAmount ?? ONE_ALPH,
+      alphAmount: asset?.alphAmount ?? MINIMAL_CONTRACT_DEPOSIT,
       tokens: asset?.tokens
     }
-    return this.contract.toState(addStdIdToFields(this.contract, initFields), newAsset, address)
+    const state = this.contract.toState(addStdIdToFields(this.contract, initFields), newAsset, address)
+    return {
+      ...state,
+      bytecode: this.contract.bytecodeDebug,
+      codeHash: this.contract.codeHash,
+      maps: maps
+    }
   }
 }
 
@@ -1377,6 +1399,60 @@ function mapsToExistingContracts(
   return contractStates
 }
 
+function hasMap(state: ContractState): state is ContractStateWithMaps {
+  return (state as ContractStateWithMaps).maps !== undefined
+}
+
+function getTestExistingContracts(
+  selfContract: Contract,
+  selfContractId: string,
+  group: number,
+  params: Optional<TestContractParams, 'testArgs' | 'initialFields'>,
+  getContractByCodeHash: (codeHash: string) => Contract
+): ContractState[] {
+  const selfMaps = params.initialMaps ?? {}
+  const selfMapEntries = mapsToExistingContracts(selfContract, selfContractId, group, selfMaps)
+  const existingContracts = params.existingContracts ?? []
+  const existingMapEntries = existingContracts.flatMap((contractState) => {
+    return hasMap(contractState)
+      ? mapsToExistingContracts(
+          getContractByCodeHash(contractState.codeHash),
+          contractState.contractId,
+          group,
+          contractState.maps ?? {}
+        )
+      : []
+  })
+  return existingContracts.concat(selfMapEntries, existingMapEntries)
+}
+
+export function extractMapsFromApiResult(
+  selfAddress: string,
+  params: Optional<TestContractParams, 'testArgs' | 'initialFields'>,
+  group: number,
+  apiResult: node.TestContractResult,
+  getContractByCodeHash: (codeHash: string) => Contract
+): { address: string; maps: Record<string, Map<Val, Val>> }[] {
+  const selfMaps = params.initialMaps ?? {}
+  const existingContracts = params.existingContracts ?? []
+  const filtered = apiResult.contracts.filter(
+    (c) => c.address === selfAddress || existingContracts.find((s) => s.address === c.address) !== undefined
+  )
+  const allMaps: { address: string; maps: Record<string, Map<Val, Val>> }[] = []
+  filtered.forEach((state) => {
+    const artifact = getContractByCodeHash(state.codeHash)
+    if (artifact.mapsSig !== undefined) {
+      const originMaps =
+        state.address === selfAddress
+          ? selfMaps
+          : (existingContracts.find((s) => s.address === state.address) as ContractStateWithMaps).maps
+      const maps = existingContractsToMaps(artifact, state.address, group, apiResult, originMaps ?? {})
+      allMaps.push({ address: state.address, maps })
+    }
+  })
+  return allMaps
+}
+
 export async function testMethod<
   I extends ContractInstance,
   F extends Fields,
@@ -1390,27 +1466,31 @@ export async function testMethod<
   getContractByCodeHash: (codeHash: string) => Contract
 ): Promise<TestContractResult<R, M>> {
   const txId = params?.txId ?? randomTxId()
-  const contract = factory.contract
-  const address = params.address ?? addressFromContractId(binToHex(crypto.getRandomValues(new Uint8Array(32))))
-  const contractId = binToHex(contractIdFromAddress(address))
+  const selfContract = factory.contract
+  const selfAddress = params.address ?? addressFromContractId(binToHex(crypto.getRandomValues(new Uint8Array(32))))
+  const selfContractId = binToHex(contractIdFromAddress(selfAddress))
   const group = params.group ?? 0
-  const initialMaps = params.initialMaps ?? {}
-  const contractStates = mapsToExistingContracts(contract, contractId, group, initialMaps)
-  const apiParams = contract.toApiTestContractParams(methodName, {
+  const existingContracts = getTestExistingContracts(selfContract, selfContractId, group, params, getContractByCodeHash)
+
+  const apiParams = selfContract.toApiTestContractParams(methodName, {
     ...params,
-    address,
+    address: selfAddress,
     txId: txId,
-    initialFields: addStdIdToFields(contract, params.initialFields ?? {}),
+    initialFields: addStdIdToFields(selfContract, params.initialFields ?? {}),
     testArgs: params.testArgs === undefined ? {} : params.testArgs,
-    existingContracts: (params.existingContracts ?? []).concat(contractStates)
+    existingContracts
   })
   const apiResult = await getCurrentNodeProvider().contracts.postContractsTestContract(apiParams)
-  const maps = existingContractsToMaps(contract, address, group, apiResult, initialMaps)
-  const testResult = contract.fromApiTestContractResult(methodName, apiResult, txId, getContractByCodeHash)
-  contract.printDebugMessages(methodName, testResult.debugMessages)
+  const allMaps = extractMapsFromApiResult(selfAddress, params, group, apiResult, getContractByCodeHash)
+  const testResult = selfContract.fromApiTestContractResult(methodName, apiResult, txId, getContractByCodeHash)
+  testResult.contracts.forEach((c) => {
+    const maps = allMaps.find((v) => v.address === c.address)?.maps
+    if (maps !== undefined) c['maps'] = maps
+  })
+  selfContract.printDebugMessages(methodName, testResult.debugMessages)
   return {
     ...testResult,
-    maps
+    maps: allMaps.find((v) => v.address === selfAddress)?.maps
   } as TestContractResult<R, M>
 }