@alephium/web3 1.3.0 → 1.4.0

package/dist/src/address/address.js

@@ -214,6 +214,12 @@ function subContractId(parentContractId, pathInHex, group) {
     if (group < 0 || group >= constants_1.TOTAL_NUMBER_OF_GROUPS) {
         throw new Error(`Invalid group ${group}`);
     }
+    if (!(0, utils_1.isHexString)(parentContractId)) {
+        throw new Error(`Invalid parent contract ID: ${parentContractId}, expected hex string`);
+    }
+    if (!(0, utils_1.isHexString)(pathInHex)) {
+        throw new Error(`Invalid path: ${pathInHex}, expected hex string`);
+    }
     const data = (0, utils_1.concatBytes)([(0, utils_1.hexToBinUnsafe)(parentContractId), (0, utils_1.hexToBinUnsafe)(pathInHex)]);
     const bytes = new Uint8Array([
         ...blakejs_1.default.blake2b(blakejs_1.default.blake2b(data, undefined, 32), undefined, 32).slice(0, -1),

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

@@ -10,7 +10,6 @@ export interface AddressBalance {
     lockedBalance: string;
     /** @format x.x ALPH */
     lockedBalanceHint: string;
-    warning?: string;
 }
 /** AddressInfo */
 export interface AddressInfo {
@@ -75,7 +74,6 @@ export interface Balance {
     lockedTokenBalances?: Token[];
     /** @format int32 */
     utxoNum: number;
-    warning?: string;
 }
 /** Balances */
 export interface Balances {
@@ -473,6 +471,7 @@ export interface CompilerOptions {
     ignoreUnusedPrivateFunctionsWarnings?: boolean;
     ignoreUpdateFieldsCheckWarnings?: boolean;
     ignoreCheckExternalCallerWarnings?: boolean;
+    ignoreUnusedFunctionReturnWarnings?: boolean;
 }
 /** Confirmed */
 export interface Confirmed {
@@ -1015,7 +1014,6 @@ export interface UTXO {
 /** UTXOs */
 export interface UTXOs {
     utxos: UTXO[];
-    warning?: string;
 }
 /** Unauthorized */
 export interface Unauthorized {
@@ -1191,7 +1189,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 3.4.0
+ * @version 3.5.0
  * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {

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

@@ -151,7 +151,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Alephium API
- * @version 3.4.0
+ * @version 3.5.0
  * @baseUrl ../
  */
 class Api extends HttpClient {

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

@@ -182,6 +182,7 @@ export declare abstract class ContractFactory<I extends ContractInstance, F exte
     constructor(contract: Contract);
     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>;
 }
 export declare class ExecutableScript<P extends Fields = Fields, R extends Val | null = null> {

package/dist/src/contract/contract.js

@@ -60,7 +60,8 @@ exports.DEFAULT_NODE_COMPILER_OPTIONS = {
     ignoreUnusedFieldsWarnings: false,
     ignoreUnusedPrivateFunctionsWarnings: false,
     ignoreUpdateFieldsCheckWarnings: false,
-    ignoreCheckExternalCallerWarnings: false
+    ignoreCheckExternalCallerWarnings: false,
+    ignoreUnusedFunctionReturnWarnings: false
 };
 exports.DEFAULT_COMPILER_OPTIONS = { errorOnWarnings: true, ...exports.DEFAULT_NODE_COMPILER_OPTIONS };
 class Struct {
@@ -627,6 +628,11 @@ class ContractFactory {
             contractInstance: this.at(result.contractAddress)
         };
     }
+    async deployTemplate(signer) {
+        return this.deploy(signer, {
+            initialFields: this.contract.getInitialFieldsWithDefaultValues()
+        });
+    }
     // This is used for testing contract functions
     stateForTest(initFields, asset, address) {
         const newAsset = {
@@ -1068,8 +1074,8 @@ exports.callMethod = callMethod;
 async function signExecuteMethod(contract, instance, methodName, params) {
     const methodIndex = contract.contract.getMethodIndex(methodName);
     const functionSig = contract.contract.functions[methodIndex];
-    const usePreapprovedAssets = contract.contract.decodedMethods[methodIndex].usePreapprovedAssets;
-    const bytecodeTemplate = getBytecodeTemplate(methodIndex, usePreapprovedAssets, functionSig, contract.contract.structs, params.attoAlphAmount, params.tokens);
+    const methodUsePreapprovedAssets = contract.contract.decodedMethods[methodIndex].usePreapprovedAssets;
+    const bytecodeTemplate = getBytecodeTemplate(methodIndex, methodUsePreapprovedAssets, functionSig, contract.contract.structs, params.attoAlphAmount, params.tokens);
     const fieldsSig = toFieldsSig(contract.contract.name, functionSig);
     const bytecode = ralph.buildScriptByteCode(bytecodeTemplate, { __contract__: instance.contractId, ...params.args }, fieldsSig, contract.contract.structs);
     const signer = params.signer;
@@ -1086,16 +1092,17 @@ async function signExecuteMethod(contract, instance, methodName, params) {
     return await signer.signAndSubmitExecuteScriptTx(signerParams);
 }
 exports.signExecuteMethod = signExecuteMethod;
-function getBytecodeTemplate(methodIndex, usePreapprovedAssets, functionSig, structs, attoAlphAmount, tokens) {
+function getBytecodeTemplate(methodIndex, methodUsePreapprovedAssets, functionSig, structs, attoAlphAmount, tokens) {
     // For the default TxScript main function
     const numberOfMethods = '01';
     const isPublic = '01';
-    const modifier = usePreapprovedAssets ? '03' : '00';
+    const scriptUseApprovedAssets = attoAlphAmount !== undefined || tokens !== undefined;
+    const modifier = scriptUseApprovedAssets ? '03' : '00';
     const argsLength = '00';
     const returnsLength = '00';
     const [templateVarStoreLocalInstrs, templateVarsLength] = getTemplateVarStoreLocalInstrs(functionSig, structs);
-    const approveAlphInstrs = getApproveAlphInstrs(usePreapprovedAssets ? attoAlphAmount : undefined);
-    const approveTokensInstrs = getApproveTokensInstrs(usePreapprovedAssets ? tokens : undefined);
+    const approveAlphInstrs = getApproveAlphInstrs(methodUsePreapprovedAssets ? attoAlphAmount : undefined);
+    const approveTokensInstrs = getApproveTokensInstrs(methodUsePreapprovedAssets ? tokens : undefined);
     const callerInstrs = getCallAddressInstrs(approveAlphInstrs.length / 2 + approveTokensInstrs.length / 3);
     // First template var is the contract
     const functionArgsNum = encodeU256Const(BigInt(templateVarsLength - 1));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "1.3.0",
+  "version": "1.4.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.4.0",
+    "alephium_version": "3.5.0",
     "explorer_backend_version": "2.0.0"
   },
   "type": "commonjs",

package/src/address/address.ts

@@ -22,7 +22,7 @@ import { TOTAL_NUMBER_OF_GROUPS } from '../constants'
 import blake from 'blakejs'
 import bs58 from '../utils/bs58'
 import djb2 from '../utils/djb2'
-import { binToHex, concatBytes, hexToBinUnsafe } from '../utils'
+import { binToHex, concatBytes, hexToBinUnsafe, isHexString } from '../utils'
 import { KeyType } from '../signer'
 import { MultiSig, lockupScriptCodec } from '../codec/lockup-script-codec'
 import { compactSignedIntCodec } from '../codec'
@@ -211,6 +211,12 @@ export function subContractId(parentContractId: string, pathInHex: string, group
   if (group < 0 || group >= TOTAL_NUMBER_OF_GROUPS) {
     throw new Error(`Invalid group ${group}`)
   }
+  if (!isHexString(parentContractId)) {
+    throw new Error(`Invalid parent contract ID: ${parentContractId}, expected hex string`)
+  }
+  if (!isHexString(pathInHex)) {
+    throw new Error(`Invalid path: ${pathInHex}, expected hex string`)
+  }
   const data = concatBytes([hexToBinUnsafe(parentContractId), hexToBinUnsafe(pathInHex)])
   const bytes = new Uint8Array([
     ...blake.blake2b(blake.blake2b(data, undefined, 32), undefined, 32).slice(0, -1),

package/src/api/api-alephium.ts

@@ -21,7 +21,6 @@ export interface AddressBalance {
   lockedBalance: string
   /** @format x.x ALPH */
   lockedBalanceHint: string
-  warning?: string
 }
 
 /** AddressInfo */
@@ -93,7 +92,6 @@ export interface Balance {
   lockedTokenBalances?: Token[]
   /** @format int32 */
   utxoNum: number
-  warning?: string
 }
 
 /** Balances */
@@ -527,6 +525,7 @@ export interface CompilerOptions {
   ignoreUnusedPrivateFunctionsWarnings?: boolean
   ignoreUpdateFieldsCheckWarnings?: boolean
   ignoreCheckExternalCallerWarnings?: boolean
+  ignoreUnusedFunctionReturnWarnings?: boolean
 }
 
 /** Confirmed */
@@ -1146,7 +1145,6 @@ export interface UTXO {
 /** UTXOs */
 export interface UTXOs {
   utxos: UTXO[]
-  warning?: string
 }
 
 /** Unauthorized */
@@ -1495,7 +1493,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 3.4.0
+ * @version 3.5.0
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {

package/src/contract/contract.ts

@@ -112,7 +112,8 @@ export const DEFAULT_NODE_COMPILER_OPTIONS: node.CompilerOptions = {
   ignoreUnusedFieldsWarnings: false,
   ignoreUnusedPrivateFunctionsWarnings: false,
   ignoreUpdateFieldsCheckWarnings: false,
-  ignoreCheckExternalCallerWarnings: false
+  ignoreCheckExternalCallerWarnings: false,
+  ignoreUnusedFunctionReturnWarnings: false
 }
 
 export const DEFAULT_COMPILER_OPTIONS: CompilerOptions = { errorOnWarnings: true, ...DEFAULT_NODE_COMPILER_OPTIONS }
@@ -1010,6 +1011,12 @@ export abstract class ContractFactory<I extends ContractInstance, F extends Fiel
     }
   }
 
+  async deployTemplate(signer: SignerProvider): Promise<DeployContractResult<I>> {
+    return this.deploy(signer, {
+      initialFields: this.contract.getInitialFieldsWithDefaultValues() as F
+    })
+  }
+
   // This is used for testing contract functions
   stateForTest(initFields: F, asset?: Asset, address?: string): ContractState<F> {
     const newAsset = {
@@ -1681,10 +1688,10 @@ export async function signExecuteMethod<I extends ContractInstance, F extends Fi
 ): Promise<SignExecuteScriptTxResult> {
   const methodIndex = contract.contract.getMethodIndex(methodName)
   const functionSig = contract.contract.functions[methodIndex]
-  const usePreapprovedAssets = contract.contract.decodedMethods[methodIndex].usePreapprovedAssets
+  const methodUsePreapprovedAssets = contract.contract.decodedMethods[methodIndex].usePreapprovedAssets
   const bytecodeTemplate = getBytecodeTemplate(
     methodIndex,
-    usePreapprovedAssets,
+    methodUsePreapprovedAssets,
     functionSig,
     contract.contract.structs,
     params.attoAlphAmount,
@@ -1716,7 +1723,7 @@ export async function signExecuteMethod<I extends ContractInstance, F extends Fi
 
 function getBytecodeTemplate(
   methodIndex: number,
-  usePreapprovedAssets: boolean,
+  methodUsePreapprovedAssets: boolean,
   functionSig: FunctionSig,
   structs: Struct[],
   attoAlphAmount?: Number256,
@@ -1725,14 +1732,15 @@ function getBytecodeTemplate(
   // For the default TxScript main function
   const numberOfMethods = '01'
   const isPublic = '01'
-  const modifier = usePreapprovedAssets ? '03' : '00'
+  const scriptUseApprovedAssets = attoAlphAmount !== undefined || tokens !== undefined
+  const modifier = scriptUseApprovedAssets ? '03' : '00'
   const argsLength = '00'
   const returnsLength = '00'
 
   const [templateVarStoreLocalInstrs, templateVarsLength] = getTemplateVarStoreLocalInstrs(functionSig, structs)
 
-  const approveAlphInstrs: string[] = getApproveAlphInstrs(usePreapprovedAssets ? attoAlphAmount : undefined)
-  const approveTokensInstrs: string[] = getApproveTokensInstrs(usePreapprovedAssets ? tokens : undefined)
+  const approveAlphInstrs: string[] = getApproveAlphInstrs(methodUsePreapprovedAssets ? attoAlphAmount : undefined)
+  const approveTokensInstrs: string[] = getApproveTokensInstrs(methodUsePreapprovedAssets ? tokens : undefined)
   const callerInstrs: string[] = getCallAddressInstrs(approveAlphInstrs.length / 2 + approveTokensInstrs.length / 3)
 
   // First template var is the contract