@alephium/web3 2.0.1 → 2.0.3

package/dist/src/contract/contract.js

@@ -43,7 +43,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getContractCodeByCodeHash = 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.printDebugMessagesFromTx = exports.getDebugMessagesFromTx = 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 signer_1 = require("../signer");
 const ralph = __importStar(require("./ralph"));
 const utils_1 = require("../utils");
 const address_1 = require("../address");
@@ -54,7 +53,6 @@ const blake = __importStar(require("blakejs"));
 const debug_1 = require("../debug");
 const codec_1 = require("../codec");
 const error_1 = require("../error");
-const script_codec_1 = require("../codec/script-codec");
 const crypto = new utils_1.WebCrypto();
 exports.StdIdFieldName = '__stdInterfaceId';
 exports.DEFAULT_NODE_COMPILER_OPTIONS = {
@@ -525,7 +523,6 @@ class Script extends Artifact {
     async txParamsForExecution(params) {
         const selectedAccount = await params.signer.getSelectedAccount();
         const bytecode = this.buildByteCodeToDeploy(params.initialFields ?? {});
-        const group = getGroupFromTxScript(bytecode, selectedAccount);
         const signerParams = {
             signerAddress: selectedAccount.address,
             signerKeyType: selectedAccount.keyType,
@@ -534,7 +531,6 @@ class Script extends Artifact {
             tokens: params.tokens,
             gasAmount: params.gasAmount,
             gasPrice: params.gasPrice,
-            group,
             dustAmount: params.dustAmount
         };
         return signerParams;
@@ -549,33 +545,6 @@ class Script extends Artifact {
     }
 }
 exports.Script = Script;
-function getGroupFromTxScript(bytecode, account) {
-    if ((0, signer_1.isGroupedAccount)(account))
-        return account.group;
-    const script = script_codec_1.scriptCodec.decode((0, utils_1.hexToBinUnsafe)(bytecode));
-    const instrs = script.methods.flatMap((method) => method.instrs);
-    for (let index = 0; index < instrs.length - 1; index += 1) {
-        const instr = instrs[`${index}`];
-        const nextInstr = instrs[index + 1];
-        if (instr.name === 'BytesConst' &&
-            instr.value.length === 32 &&
-            (nextInstr.name === 'CallExternal' || nextInstr.name === 'CallExternalBySelector')) {
-            const groupIndex = instr.value[instr.value.length - 1];
-            if (groupIndex >= 0 && groupIndex < constants_1.TOTAL_NUMBER_OF_GROUPS) {
-                return groupIndex;
-            }
-        }
-    }
-    for (const instr of instrs) {
-        if (instr.name === 'BytesConst' && instr.value.length === 32) {
-            const groupIndex = instr.value[instr.value.length - 1];
-            if (groupIndex >= 0 && groupIndex < constants_1.TOTAL_NUMBER_OF_GROUPS) {
-                return groupIndex;
-            }
-        }
-    }
-    return (0, address_1.groupOfAddress)(account.address);
-}
 function fromApiFields(immFields, mutFields, fieldsSig, structs) {
     let [immIndex, mutIndex] = [0, 0];
     const func = (type, isMutable) => {

package/dist/src/signer/tx-builder.d.ts

@@ -12,8 +12,11 @@ export declare abstract class TransactionBuilder {
     static buildUnsignedTx(params: SignUnsignedTxParams): Omit<SignUnsignedTxResult, 'signature'>;
     private buildTransferTxParams;
     private buildDeployContractTxParams;
+    private static checkAndGetParams;
     private buildExecuteScriptTxParams;
     private convertTransferTxResult;
     private convertDeployContractTxResult;
     private convertExecuteScriptTxResult;
 }
+export declare function getGroupFromTxScript(bytecode: string): number | undefined;
+export declare function updateBytecodeWithGroup(bytecode: string, group: number): string;

package/dist/src/signer/tx-builder.js

@@ -17,14 +17,17 @@ 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/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionBuilder = void 0;
+exports.updateBytecodeWithGroup = exports.getGroupFromTxScript = exports.TransactionBuilder = void 0;
 const utils_1 = require("../utils");
 const api_1 = require("../api");
 const address_1 = require("../address");
 const signer_1 = require("./signer");
+const types_1 = require("./types");
 const codec_1 = require("../codec");
 const transaction_1 = require("../transaction");
 const hash_1 = require("../codec/hash");
+const constants_1 = require("../constants");
+const script_codec_1 = require("../codec/script-codec");
 class TransactionBuilder {
     static from(param0, param1, customFetch) {
         const nodeProvider = typeof param0 === 'string' ? new api_1.NodeProvider(param0, param1, customFetch) : param0;
@@ -147,12 +150,29 @@ class TransactionBuilder {
             ...rest
         };
     }
+    static checkAndGetParams(params) {
+        if ((0, types_1.isGroupedKeyType)(params.signerKeyType ?? 'default')) {
+            return params;
+        }
+        if (!(0, address_1.isGrouplessAddress)(params.signerAddress)) {
+            throw new Error('Invalid signer key type for groupless address');
+        }
+        const group = params.group ?? getGroupFromTxScript(params.bytecode);
+        const defaultGroup = (0, address_1.groupOfAddress)(params.signerAddress);
+        if (group === undefined || group === defaultGroup) {
+            return { ...params, group: defaultGroup };
+        }
+        const newBytecode = updateBytecodeWithGroup(params.bytecode, group);
+        const newParams = { ...params, bytecode: newBytecode };
+        return { ...newParams, group };
+    }
     buildExecuteScriptTxParams(params, publicKey) {
         TransactionBuilder.validatePublicKey(params, publicKey, params.signerKeyType);
-        const { attoAlphAmount, tokens, gasPrice, dustAmount, ...rest } = params;
+        const newParams = TransactionBuilder.checkAndGetParams(params);
+        const { signerKeyType, attoAlphAmount, tokens, gasPrice, dustAmount, ...rest } = newParams;
         return {
             fromPublicKey: publicKey,
-            fromPublicKeyType: params.signerKeyType,
+            fromPublicKeyType: signerKeyType,
             attoAlphAmount: (0, api_1.toApiNumber256Optional)(attoAlphAmount),
             tokens: (0, api_1.toApiTokens)(tokens),
             gasPrice: (0, api_1.toApiNumber256Optional)(gasPrice),
@@ -229,3 +249,45 @@ class TransactionBuilder {
     }
 }
 exports.TransactionBuilder = TransactionBuilder;
+function getGroupFromTxScript(bytecode) {
+    const script = script_codec_1.scriptCodec.decode((0, utils_1.hexToBinUnsafe)(bytecode));
+    const instrs = script.methods.flatMap((method) => method.instrs);
+    for (let index = 0; index < instrs.length - 1; index += 1) {
+        const instr = instrs[`${index}`];
+        const nextInstr = instrs[index + 1];
+        if (instr.name === 'BytesConst' &&
+            instr.value.length === 32 &&
+            (nextInstr.name === 'CallExternal' || nextInstr.name === 'CallExternalBySelector')) {
+            const groupIndex = instr.value[instr.value.length - 1];
+            if (groupIndex >= 0 && groupIndex < constants_1.TOTAL_NUMBER_OF_GROUPS) {
+                return groupIndex;
+            }
+        }
+    }
+    for (const instr of instrs) {
+        if (instr.name === 'BytesConst' && instr.value.length === 32) {
+            const groupIndex = instr.value[instr.value.length - 1];
+            if (groupIndex >= 0 && groupIndex < constants_1.TOTAL_NUMBER_OF_GROUPS) {
+                return groupIndex;
+            }
+        }
+    }
+    return undefined;
+}
+exports.getGroupFromTxScript = getGroupFromTxScript;
+function updateBytecodeWithGroup(bytecode, group) {
+    const script = script_codec_1.scriptCodec.decode((0, utils_1.hexToBinUnsafe)(bytecode));
+    const newMethods = script.methods.map((method) => {
+        const newInstrs = method.instrs.map((instr) => {
+            if (instr.name === 'AddressConst' && instr.value.kind === 'P2PK') {
+                const newLockupScript = { ...instr.value, value: { ...instr.value.value, group } };
+                return { ...instr, value: newLockupScript };
+            }
+            return instr;
+        });
+        return { ...method, instrs: newInstrs };
+    });
+    const bytes = script_codec_1.scriptCodec.encode({ methods: newMethods });
+    return (0, utils_1.binToHex)(bytes);
+}
+exports.updateBytecodeWithGroup = updateBytecodeWithGroup;

package/package.json

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

package/src/contract/contract.ts

@@ -42,9 +42,7 @@ import {
   SignExecuteScriptTxParams,
   SignerProvider,
   Address,
-  SignExecuteScriptTxResult,
-  Account,
-  isGroupedAccount
+  SignExecuteScriptTxResult
 } from '../signer'
 import * as ralph from './ralph'
 import {
@@ -61,13 +59,7 @@ import {
   isHexString,
   hexToString
 } from '../utils'
-import {
-  contractIdFromAddress,
-  groupOfAddress,
-  addressFromContractId,
-  subContractId,
-  isGrouplessAddressWithoutGroupIndex
-} from '../address'
+import { contractIdFromAddress, groupOfAddress, addressFromContractId, subContractId } from '../address'
 import { getCurrentNodeProvider } from '../global'
 import { EventSubscribeOptions, EventSubscription, subscribeToEvents } from './events'
 import { MINIMAL_CONTRACT_DEPOSIT, ONE_ALPH, TOTAL_NUMBER_OF_GROUPS } from '../constants'
@@ -100,7 +92,6 @@ import {
 } from '../codec'
 import { TraceableError } from '../error'
 import { SimulationResult } from '../api/api-alephium'
-import { scriptCodec } from '../codec/script-codec'
 
 const crypto = new WebCrypto()
 
@@ -799,7 +790,6 @@ export class Script extends Artifact {
   async txParamsForExecution<P extends Fields>(params: ExecuteScriptParams<P>): Promise<SignExecuteScriptTxParams> {
     const selectedAccount = await params.signer.getSelectedAccount()
     const bytecode = this.buildByteCodeToDeploy(params.initialFields ?? {})
-    const group = getGroupFromTxScript(bytecode, selectedAccount)
     const signerParams: SignExecuteScriptTxParams = {
       signerAddress: selectedAccount.address,
       signerKeyType: selectedAccount.keyType,
@@ -808,7 +798,6 @@ export class Script extends Artifact {
       tokens: params.tokens,
       gasAmount: params.gasAmount,
       gasPrice: params.gasPrice,
-      group,
       dustAmount: params.dustAmount
     }
     return signerParams
@@ -823,36 +812,6 @@ export class Script extends Artifact {
   }
 }
 
-function getGroupFromTxScript(bytecode: string, account: Account): number {
-  if (isGroupedAccount(account)) return account.group
-
-  const script = scriptCodec.decode(hexToBinUnsafe(bytecode))
-  const instrs = script.methods.flatMap((method) => method.instrs)
-  for (let index = 0; index < instrs.length - 1; index += 1) {
-    const instr = instrs[`${index}`]
-    const nextInstr = instrs[index + 1]
-    if (
-      instr.name === 'BytesConst' &&
-      instr.value.length === 32 &&
-      (nextInstr.name === 'CallExternal' || nextInstr.name === 'CallExternalBySelector')
-    ) {
-      const groupIndex = instr.value[instr.value.length - 1]
-      if (groupIndex >= 0 && groupIndex < TOTAL_NUMBER_OF_GROUPS) {
-        return groupIndex
-      }
-    }
-  }
-  for (const instr of instrs) {
-    if (instr.name === 'BytesConst' && instr.value.length === 32) {
-      const groupIndex = instr.value[instr.value.length - 1]
-      if (groupIndex >= 0 && groupIndex < TOTAL_NUMBER_OF_GROUPS) {
-        return groupIndex
-      }
-    }
-  }
-  return groupOfAddress(account.address)
-}
-
 export function fromApiFields(
   immFields: node.Val[],
   mutFields: node.Val[],

package/src/contract/ralph.ts

@@ -39,13 +39,13 @@ import {
   instrCodec,
   u256Codec,
   toU256,
-  toI256,
-  intAs4BytesCodec
+  toI256
 } from '../codec'
 import { boolCodec } from '../codec/codec'
 import { TraceableError } from '../error'
-import djb2 from '../utils/djb2'
-import { addressToBytes, groupFromHint } from '../address'
+import { addressToBytes, isGrouplessAddressWithoutGroupIndex, isValidAddress } from '../address'
+import { scriptCodec } from '../codec/script-codec'
+import { TOTAL_NUMBER_OF_GROUPS } from '../constants'
 
 export function encodeByteVec(hex: string): Uint8Array {
   if (!isHexString(hex)) {

package/src/signer/tx-builder.ts

@@ -18,7 +18,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 
 import { binToHex, hexToBinUnsafe } from '../utils'
 import { fromApiNumber256, node, NodeProvider, toApiNumber256Optional, toApiTokens } from '../api'
-import { addressFromPublicKey, contractIdFromAddress } from '../address'
+import { addressFromPublicKey, contractIdFromAddress, groupOfAddress, isGrouplessAddress } from '../address'
 import { toApiDestinations } from './signer'
 import {
   SignChainedTxParams,
@@ -36,7 +36,7 @@ import {
   SignUnsignedTxParams,
   SignUnsignedTxResult,
   BuildTxResult,
-  GrouplessBuildTxResult
+  isGroupedKeyType
 } from './types'
 import { unsignedTxCodec } from '../codec'
 import { groupIndexOfTransaction } from '../transaction'
@@ -47,6 +47,9 @@ import {
   BuildExecuteScriptTxResult,
   BuildTransferTxResult
 } from '../api/api-alephium'
+import { TOTAL_NUMBER_OF_GROUPS } from '../constants'
+import { scriptCodec } from '../codec/script-codec'
+import { LockupScript } from '../codec/lockup-script-codec'
 
 export abstract class TransactionBuilder {
   abstract get nodeProvider(): NodeProvider
@@ -204,13 +207,34 @@ export abstract class TransactionBuilder {
     }
   }
 
+  private static checkAndGetParams(params: SignExecuteScriptTxParams): SignExecuteScriptTxParams {
+    if (isGroupedKeyType(params.signerKeyType ?? 'default')) {
+      return params
+    }
+
+    if (!isGrouplessAddress(params.signerAddress)) {
+      throw new Error('Invalid signer key type for groupless address')
+    }
+
+    const group = params.group ?? getGroupFromTxScript(params.bytecode)
+    const defaultGroup = groupOfAddress(params.signerAddress)
+    if (group === undefined || group === defaultGroup) {
+      return { ...params, group: defaultGroup }
+    }
+
+    const newBytecode = updateBytecodeWithGroup(params.bytecode, group)
+    const newParams = { ...params, bytecode: newBytecode }
+    return { ...newParams, group }
+  }
+
   private buildExecuteScriptTxParams(params: SignExecuteScriptTxParams, publicKey: string): node.BuildExecuteScriptTx {
     TransactionBuilder.validatePublicKey(params, publicKey, params.signerKeyType)
 
-    const { attoAlphAmount, tokens, gasPrice, dustAmount, ...rest } = params
+    const newParams = TransactionBuilder.checkAndGetParams(params)
+    const { signerKeyType, attoAlphAmount, tokens, gasPrice, dustAmount, ...rest } = newParams
     return {
       fromPublicKey: publicKey,
-      fromPublicKeyType: params.signerKeyType,
+      fromPublicKeyType: signerKeyType,
       attoAlphAmount: toApiNumber256Optional(attoAlphAmount),
       tokens: toApiTokens(tokens),
       gasPrice: toApiNumber256Optional(gasPrice),
@@ -296,3 +320,47 @@ export abstract class TransactionBuilder {
     }
   }
 }
+
+export function getGroupFromTxScript(bytecode: string): number | undefined {
+  const script = scriptCodec.decode(hexToBinUnsafe(bytecode))
+  const instrs = script.methods.flatMap((method) => method.instrs)
+  for (let index = 0; index < instrs.length - 1; index += 1) {
+    const instr = instrs[`${index}`]
+    const nextInstr = instrs[index + 1]
+    if (
+      instr.name === 'BytesConst' &&
+      instr.value.length === 32 &&
+      (nextInstr.name === 'CallExternal' || nextInstr.name === 'CallExternalBySelector')
+    ) {
+      const groupIndex = instr.value[instr.value.length - 1]
+      if (groupIndex >= 0 && groupIndex < TOTAL_NUMBER_OF_GROUPS) {
+        return groupIndex
+      }
+    }
+  }
+  for (const instr of instrs) {
+    if (instr.name === 'BytesConst' && instr.value.length === 32) {
+      const groupIndex = instr.value[instr.value.length - 1]
+      if (groupIndex >= 0 && groupIndex < TOTAL_NUMBER_OF_GROUPS) {
+        return groupIndex
+      }
+    }
+  }
+  return undefined
+}
+
+export function updateBytecodeWithGroup(bytecode: string, group: number): string {
+  const script = scriptCodec.decode(hexToBinUnsafe(bytecode))
+  const newMethods = script.methods.map((method) => {
+    const newInstrs = method.instrs.map((instr) => {
+      if (instr.name === 'AddressConst' && instr.value.kind === 'P2PK') {
+        const newLockupScript: LockupScript = { ...instr.value, value: { ...instr.value.value, group } }
+        return { ...instr, value: newLockupScript }
+      }
+      return instr
+    })
+    return { ...method, instrs: newInstrs }
+  })
+  const bytes = scriptCodec.encode({ methods: newMethods })
+  return binToHex(bytes)
+}