@alephium/web3 0.29.0 → 0.29.2

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

@@ -157,6 +157,8 @@ export interface BuildDeployContractTx {
     initialTokenAmounts?: Token[];
     /** @format uint256 */
     issueTokenAmount?: string;
+    /** @format address */
+    issueTokenTo?: string;
     /** @format gas */
     gasAmount?: number;
     /** @format uint256 */
@@ -213,6 +215,13 @@ export interface BuildInfo {
     releaseVersion: string;
     commit: string;
 }
+export interface BuildMultiAddressesTransaction {
+    from: Source[];
+    /** @format uint256 */
+    gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
+}
 export interface BuildMultisig {
     /** @format address */
     fromAddress: string;
@@ -329,6 +338,7 @@ export interface CallContractSucceeded {
     txInputs: string[];
     txOutputs: Output[];
     events: ContractEventByTxId[];
+    debugMessages: DebugMessage[];
     type: string;
 }
 export interface ChainInfo {
@@ -670,6 +680,16 @@ export interface SignResult {
     /** @format signature */
     signature: string;
 }
+export interface Source {
+    /** @format hex-string */
+    fromPublicKey: string;
+    destinations: Destination[];
+    /** @format hex-string */
+    fromPublicKeyType?: string;
+    /** @format gas */
+    gasAmount?: number;
+    utxos?: OutputRef[];
+}
 export interface SubmitMultisig {
     unsignedTx: string;
     signatures: string[];
@@ -963,7 +983,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 2.5.5
+ * @version 2.8.2
  * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -1431,6 +1451,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/transactions/build
          */
         postTransactionsBuild: (data: BuildTransaction, params?: RequestParams) => Promise<BuildTransactionResult>;
+        /**
+         * No description
+         *
+         * @tags Transactions
+         * @name PostTransactionsBuildMultiAddresses
+         * @summary Build an unsigned transaction with multiple addresses to a number of recipients
+         * @request POST:/transactions/build-multi-addresses
+         */
+        postTransactionsBuildMultiAddresses: (data: BuildMultiAddressesTransaction, params?: RequestParams) => Promise<BuildTransactionResult>;
         /**
          * No description
          *

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

@@ -151,7 +151,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Alephium API
- * @version 2.5.5
+ * @version 2.8.2
  * @baseUrl ../
  */
 class Api extends HttpClient {
@@ -811,6 +811,22 @@ class Api extends HttpClient {
                 format: 'json',
                 ...params
             }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Transactions
+             * @name PostTransactionsBuildMultiAddresses
+             * @summary Build an unsigned transaction with multiple addresses to a number of recipients
+             * @request POST:/transactions/build-multi-addresses
+             */
+            postTransactionsBuildMultiAddresses: (data, params = {}) => this.request({
+                path: `/transactions/build-multi-addresses`,
+                method: 'POST',
+                body: data,
+                type: ContentType.Json,
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse),
             /**
              * No description
              *

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

@@ -99,10 +99,11 @@ export declare abstract class Artifact {
     readonly name: string;
     readonly functions: FunctionSig[];
     constructor(version: string, name: string, functions: FunctionSig[]);
-    abstract buildByteCodeToDeploy(initialFields?: Fields): string;
+    abstract buildByteCodeToDeploy(initialFields: Fields, isDevnet: boolean): string;
     publicFunctions(): string[];
     usingPreapprovedAssetsFunctions(): string[];
     usingAssetsInContractFunctions(): string[];
+    isDevnet(signer: SignerProvider): Promise<boolean>;
 }
 export declare class Contract extends Artifact {
     readonly bytecode: string;
@@ -138,7 +139,7 @@ export declare class Contract extends Artifact {
     static fromApiEvent(event: node.ContractEventByTxId, codeHash: string | undefined, txId: string, getContractByCodeHash?: (codeHash: string) => Contract): ContractEvent;
     fromApiTestContractResult(methodName: string, result: node.TestContractResult, txId: string): TestContractResult<unknown>;
     txParamsForDeployment<P extends Fields>(signer: SignerProvider, params: DeployContractParams<P>): Promise<SignDeployContractTxParams>;
-    buildByteCodeToDeploy(initialFields: Fields): string;
+    buildByteCodeToDeploy(initialFields: Fields, isDevnet: boolean): string;
     static fromApiEvents(events: node.ContractEventByTxId[], addressToCodeHash: Map<string, string>, txId: string, getContractByCodeHash?: (codeHash: string) => Contract): ContractEvent[];
     toApiCallContract<T extends Arguments>(params: CallContractParams<T>, groupIndex: number, contractAddress: string, methodIndex: number): node.CallContract;
     fromApiCallContractResult(result: node.CallContractResult, txId: string, methodIndex: number, getContractByCodeHash?: (codeHash: string) => Contract): CallContractResult<unknown>;
@@ -224,6 +225,7 @@ export interface DeployContractParams<P extends Fields = Fields> {
     initialAttoAlphAmount?: Number256;
     initialTokenAmounts?: Token[];
     issueTokenAmount?: Number256;
+    issueTokenTo?: string;
     gasAmount?: number;
     gasPrice?: Number256;
 }
@@ -271,6 +273,7 @@ export interface CallContractResult<R> {
     txInputs: string[];
     txOutputs: Output[];
     events: ContractEvent[];
+    debugMessages: DebugMessage[];
 }
 export declare const CreateContractEventAddress: string;
 export declare const DestroyContractEventAddress: string;

package/dist/src/contract/contract.js

@@ -494,6 +494,13 @@ class Artifact {
     usingAssetsInContractFunctions() {
         return this.functions.filter((func) => func.useAssetsInContract).map((func) => func.name);
     }
+    async isDevnet(signer) {
+        if (!signer.nodeProvider) {
+            return false;
+        }
+        const chainParams = await signer.nodeProvider.infos.getInfosChainParams();
+        return (0, utils_1.isDevnet)(chainParams.networkId);
+    }
 }
 exports.Artifact = Artifact;
 class Contract extends Artifact {
@@ -587,7 +594,7 @@ class Contract extends Artifact {
     printDebugMessages(funcName, messages) {
         if (messages.length != 0) {
             console.log(`Testing ${this.name}.${funcName}:`);
-            messages.forEach((m) => console.log(`Debug - ${m.contractAddress} - ${m.message}`));
+            messages.forEach((m) => console.log(`> Contract @ ${m.contractAddress} - ${m.message}`));
         }
     }
     toApiFields(fields) {
@@ -701,8 +708,9 @@ class Contract extends Artifact {
         };
     }
     async txParamsForDeployment(signer, params) {
+        const isDevnet = await this.isDevnet(signer);
         const initialFields = params.initialFields ?? {};
-        const bytecode = this.buildByteCodeToDeploy(addStdIdToFields(this, initialFields));
+        const bytecode = this.buildByteCodeToDeploy(addStdIdToFields(this, initialFields), isDevnet);
         const selectedAccount = await signer.getSelectedAccount();
         const signerParams = {
             signerAddress: selectedAccount.address,
@@ -716,9 +724,9 @@ class Contract extends Artifact {
         };
         return signerParams;
     }
-    buildByteCodeToDeploy(initialFields) {
+    buildByteCodeToDeploy(initialFields, isDevnet) {
         try {
-            return ralph.buildContractByteCode(this.bytecode, initialFields, this.fieldsSig);
+            return ralph.buildContractByteCode(isDevnet ? this.bytecodeDebug : this.bytecode, initialFields, this.fieldsSig);
         }
         catch (error) {
             throw new Error(`Failed to build bytecode for contract ${this.name}, error: ${error}`);
@@ -760,7 +768,8 @@ class Contract extends Artifact {
             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)
+            events: Contract.fromApiEvents(callResult.events, addressToCodeHash, txId, getContractByCodeHash),
+            debugMessages: callResult.debugMessages
         };
     }
 }
@@ -1154,6 +1163,7 @@ async function callMethod(contract, instance, methodName, params, getContractByC
     const callParams = contract.contract.toApiCallContract({ ...params, txId: txId, args: params.args === undefined ? {} : params.args }, instance.groupIndex, instance.address, methodIndex);
     const result = await (0, global_1.getCurrentNodeProvider)().contracts.postContractsCallContract(callParams);
     const callResult = contract.contract.fromApiCallContractResult(result, txId, methodIndex, getContractByCodeHash);
+    contract.contract.printDebugMessages(methodName, callResult.debugMessages);
     return callResult;
 }
 exports.callMethod = callMethod;

package/dist/src/signer/types.d.ts

@@ -45,6 +45,7 @@ export interface SignDeployContractTxParams {
     initialAttoAlphAmount?: Number256;
     initialTokenAmounts?: Token[];
     issueTokenAmount?: Number256;
+    issueTokenTo?: string;
     gasAmount?: number;
     gasPrice?: Number256;
 }

package/dist/src/utils/utils.d.ts

@@ -39,6 +39,7 @@ export declare function blockChainIndex(blockHash: HexString): {
 export declare function stringToHex(str: string): string;
 export declare function hexToString(str: string): string;
 export declare function sleep(ms: number): Promise<void>;
+export declare function isDevnet(networkId?: number): boolean;
 type _Eq<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
 export type Eq<X, Y> = _Eq<{
     [P in keyof X]: X[P];

package/dist/src/utils/utils.js

@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertType = exports.sleep = exports.hexToString = exports.stringToHex = exports.blockChainIndex = exports.subContractId = exports.contractIdFromTx = exports.addressFromTokenId = exports.addressFromContractId = exports.addressFromScript = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.groupOfPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.AddressType = exports.toNonNegativeBigInt = exports.isHexString = exports.xorByte = exports.signatureDecode = exports.encodeHexSignature = exports.encodeSignature = exports.networkIds = void 0;
+exports.assertType = exports.isDevnet = exports.sleep = exports.hexToString = exports.stringToHex = exports.blockChainIndex = exports.subContractId = exports.contractIdFromTx = exports.addressFromTokenId = exports.addressFromContractId = exports.addressFromScript = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.groupOfPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.AddressType = exports.toNonNegativeBigInt = exports.isHexString = exports.xorByte = exports.signatureDecode = exports.encodeHexSignature = exports.encodeSignature = exports.networkIds = void 0;
 const elliptic_1 = require("elliptic");
 const bn_js_1 = __importDefault(require("bn.js"));
 const blakejs_1 = __importDefault(require("blakejs"));
@@ -257,6 +257,10 @@ function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
 exports.sleep = sleep;
+function isDevnet(networkId) {
+    return networkId !== 0 && networkId !== 1;
+}
+exports.isDevnet = isDevnet;
 // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars
 function assertType() { }
 exports.assertType = assertType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.29.0",
+  "version": "0.29.2",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,7 +27,7 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "2.5.5",
+    "alephium_version": "2.8.2",
     "explorer_backend_version": "1.16.1"
   },
   "type": "commonjs",

package/src/api/api-alephium.ts

@@ -185,6 +185,8 @@ export interface BuildDeployContractTx {
   initialTokenAmounts?: Token[]
   /** @format uint256 */
   issueTokenAmount?: string
+  /** @format address */
+  issueTokenTo?: string
   /** @format gas */
   gasAmount?: number
   /** @format uint256 */
@@ -246,6 +248,14 @@ export interface BuildInfo {
   commit: string
 }
 
+export interface BuildMultiAddressesTransaction {
+  from: Source[]
+  /** @format uint256 */
+  gasPrice?: string
+  /** @format block-hash */
+  targetBlockHash?: string
+}
+
 export interface BuildMultisig {
   /** @format address */
   fromAddress: string
@@ -373,6 +383,7 @@ export interface CallContractSucceeded {
   txInputs: string[]
   txOutputs: Output[]
   events: ContractEventByTxId[]
+  debugMessages: DebugMessage[]
   type: string
 }
 
@@ -773,6 +784,17 @@ export interface SignResult {
   signature: string
 }
 
+export interface Source {
+  /** @format hex-string */
+  fromPublicKey: string
+  destinations: Destination[]
+  /** @format hex-string */
+  fromPublicKeyType?: string
+  /** @format gas */
+  gasAmount?: number
+  utxos?: OutputRef[]
+}
+
 export interface SubmitMultisig {
   unsignedTx: string
   signatures: string[]
@@ -1256,7 +1278,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 2.5.5
+ * @version 2.8.2
  * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -2114,6 +2136,27 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(convertHttpResponse),
 
+    /**
+     * No description
+     *
+     * @tags Transactions
+     * @name PostTransactionsBuildMultiAddresses
+     * @summary Build an unsigned transaction with multiple addresses to a number of recipients
+     * @request POST:/transactions/build-multi-addresses
+     */
+    postTransactionsBuildMultiAddresses: (data: BuildMultiAddressesTransaction, params: RequestParams = {}) =>
+      this.request<
+        BuildTransactionResult,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/transactions/build-multi-addresses`,
+        method: 'POST',
+        body: data,
+        type: ContentType.Json,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
     /**
      * No description
      *

package/src/contract/contract.ts

@@ -55,7 +55,8 @@ import {
   groupOfAddress,
   addressFromContractId,
   WebCrypto,
-  hexToBinUnsafe
+  hexToBinUnsafe,
+  isDevnet
 } from '../utils'
 import { getCurrentNodeProvider } from '../global'
 import * as path from 'path'
@@ -715,7 +716,7 @@ export abstract class Artifact {
     this.functions = functions
   }
 
-  abstract buildByteCodeToDeploy(initialFields?: Fields): string
+  abstract buildByteCodeToDeploy(initialFields: Fields, isDevnet: boolean): string
 
   publicFunctions(): string[] {
     return this.functions.filter((func) => func.isPublic).map((func) => func.name)
@@ -728,6 +729,14 @@ export abstract class Artifact {
   usingAssetsInContractFunctions(): string[] {
     return this.functions.filter((func) => func.useAssetsInContract).map((func) => func.name)
   }
+
+  async isDevnet(signer: SignerProvider): Promise<boolean> {
+    if (!signer.nodeProvider) {
+      return false
+    }
+    const chainParams = await signer.nodeProvider.infos.getInfosChainParams()
+    return isDevnet(chainParams.networkId)
+  }
 }
 
 export class Contract extends Artifact {
@@ -884,7 +893,7 @@ export class Contract extends Artifact {
   printDebugMessages(funcName: string, messages: DebugMessage[]) {
     if (messages.length != 0) {
       console.log(`Testing ${this.name}.${funcName}:`)
-      messages.forEach((m) => console.log(`Debug - ${m.contractAddress} - ${m.message}`))
+      messages.forEach((m) => console.log(`> Contract @ ${m.contractAddress} - ${m.message}`))
     }
   }
 
@@ -1039,8 +1048,9 @@ export class Contract extends Artifact {
     signer: SignerProvider,
     params: DeployContractParams<P>
   ): Promise<SignDeployContractTxParams> {
+    const isDevnet = await this.isDevnet(signer)
     const initialFields: Fields = params.initialFields ?? {}
-    const bytecode = this.buildByteCodeToDeploy(addStdIdToFields(this, initialFields))
+    const bytecode = this.buildByteCodeToDeploy(addStdIdToFields(this, initialFields), isDevnet)
     const selectedAccount = await signer.getSelectedAccount()
     const signerParams: SignDeployContractTxParams = {
       signerAddress: selectedAccount.address,
@@ -1055,9 +1065,9 @@ export class Contract extends Artifact {
     return signerParams
   }
 
-  buildByteCodeToDeploy(initialFields: Fields): string {
+  buildByteCodeToDeploy(initialFields: Fields, isDevnet: boolean): string {
     try {
-      return ralph.buildContractByteCode(this.bytecode, initialFields, this.fieldsSig)
+      return ralph.buildContractByteCode(isDevnet ? this.bytecodeDebug : this.bytecode, initialFields, this.fieldsSig)
     } catch (error) {
       throw new Error(`Failed to build bytecode for contract ${this.name}, error: ${error}`)
     }
@@ -1116,7 +1126,8 @@ export class Contract extends Artifact {
       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)
+      events: Contract.fromApiEvents(callResult.events, addressToCodeHash, txId, getContractByCodeHash),
+      debugMessages: callResult.debugMessages
     }
   }
 }
@@ -1410,6 +1421,7 @@ export interface DeployContractParams<P extends Fields = Fields> {
   initialAttoAlphAmount?: Number256
   initialTokenAmounts?: Token[]
   issueTokenAmount?: Number256
+  issueTokenTo?: string
   gasAmount?: number
   gasPrice?: Number256
 }
@@ -1502,6 +1514,7 @@ export interface CallContractResult<R> {
   txInputs: string[]
   txOutputs: Output[]
   events: ContractEvent[]
+  debugMessages: DebugMessage[]
 }
 
 function specialContractAddress(n: number): string {
@@ -1766,6 +1779,7 @@ export async function callMethod<I extends ContractInstance, F extends Fields, A
   )
   const result = await getCurrentNodeProvider().contracts.postContractsCallContract(callParams)
   const callResult = contract.contract.fromApiCallContractResult(result, txId, methodIndex, getContractByCodeHash)
+  contract.contract.printDebugMessages(methodName, callResult.debugMessages)
   return callResult as CallContractResult<R>
 }
 

package/src/signer/types.ts

@@ -73,6 +73,7 @@ export interface SignDeployContractTxParams {
   initialAttoAlphAmount?: Number256
   initialTokenAmounts?: Token[]
   issueTokenAmount?: Number256
+  issueTokenTo?: string
   gasAmount?: number
   gasPrice?: Number256
 }

package/src/utils/utils.ts

@@ -265,6 +265,10 @@ export function sleep(ms: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, ms))
 }
 
+export function isDevnet(networkId?: number): boolean {
+  return networkId !== 0 && networkId !== 1
+}
+
 type _Eq<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false
 export type Eq<X, Y> = _Eq<{ [P in keyof X]: X[P] }, { [P in keyof Y]: Y[P] }>
 // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars