@alephium/web3 0.2.0-rc.15 → 0.2.0-rc.16

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

@@ -317,8 +317,11 @@ export interface ChangeActiveAddress {
 export interface CompileContractResult {
     name: string;
     bytecode: string;
+    bytecodeDebugPatch: string;
     /** @format 32-byte-hash */
     codeHash: string;
+    /** @format 32-byte-hash */
+    codeHashDebug: string;
     fields: FieldsSig;
     functions: FunctionSig[];
     events: EventSig[];
@@ -331,6 +334,7 @@ export interface CompileProjectResult {
 export interface CompileScriptResult {
     name: string;
     bytecodeTemplate: string;
+    bytecodeDebugPatch: string;
     fields: FieldsSig;
     functions: FunctionSig[];
     warnings: string[];
@@ -422,6 +426,11 @@ export interface ContractState {
     fields: Val[];
     asset: AssetState;
 }
+export interface DebugMessage {
+    /** @format address */
+    contractAddress: string;
+    message: string;
+}
 export interface DecodeUnsignedTx {
     unsignedTx: string;
 }
@@ -672,6 +681,7 @@ export interface TestContractResult {
     txInputs: string[];
     txOutputs: Output[];
     events: ContractEventByTxId[];
+    debugMessages: DebugMessage[];
 }
 export interface TestInputAsset {
     /** @format address */

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

@@ -37,18 +37,18 @@ declare class Compiled<T extends Artifact> {
     warnings: string[];
     constructor(sourceFile: SourceFile, artifact: T, warnings: string[]);
 }
+declare type CodeInfo = {
+    sourceCodeHash: string;
+    bytecodeDebugPatch: string;
+    codeHashDebug: string;
+    warnings: string[];
+};
 declare class ProjectArtifact {
     static readonly artifactFileName = ".project.json";
     compilerOptionsUsed: node.CompilerOptions;
-    infos: Map<string, {
-        sourceCodeHash: string;
-        warnings: string[];
-    }>;
+    infos: Map<string, CodeInfo>;
     static checkCompilerOptionsParameter(compilerOptions: node.CompilerOptions): void;
-    constructor(compilerOptionsUsed: node.CompilerOptions, infos: Map<string, {
-        sourceCodeHash: string;
-        warnings: string[];
-    }>);
+    constructor(compilerOptionsUsed: node.CompilerOptions, infos: Map<string, CodeInfo>);
     saveToFile(rootPath: string): Promise<void>;
     needToReCompile(compilerOptions: node.CompilerOptions, files: SourceFile[]): boolean;
     static from(rootPath: string): Promise<ProjectArtifact | undefined>;
@@ -94,20 +94,24 @@ export declare abstract class Artifact {
 }
 export declare class Contract extends Artifact {
     readonly bytecode: string;
+    readonly bytecodeDebugPatch: string;
     readonly codeHash: string;
     readonly fieldsSig: FieldsSig;
     readonly eventsSig: EventSig[];
-    constructor(name: string, bytecode: string, codeHash: string, fieldsSig: FieldsSig, eventsSig: EventSig[], functions: FunctionSig[]);
-    static fromJson(artifact: any): Contract;
+    readonly bytecodeDebug: string;
+    readonly codeHashDebug: string;
+    constructor(name: string, bytecode: string, bytecodeDebugPatch: string, codeHash: string, codeHashDebug: string, fieldsSig: FieldsSig, eventsSig: EventSig[], functions: FunctionSig[]);
+    static fromJson(artifact: any, bytecodeDebugPatch?: string, codeHashDebug?: string): Contract;
     static fromCompileResult(result: node.CompileContractResult): Contract;
-    static fromArtifactFile(path: string): Promise<Contract>;
+    static fromArtifactFile(path: string, bytecodeDebugPatch: string, codeHashDebug: string): Promise<Contract>;
     fetchState(address: string, group: number): Promise<ContractState>;
     toString(): string;
     toState(fields: Fields, asset: Asset, address?: string): ContractState;
     static randomAddress(): string;
+    private _printDebugMessages;
     private _test;
-    testPublicMethod(funcName: string, params: TestContractParams): Promise<TestContractResult>;
-    testPrivateMethod(funcName: string, params: TestContractParams): Promise<TestContractResult>;
+    testPublicMethod(funcName: string, params: TestContractParams, printDebugMessages?: boolean): Promise<TestContractResult>;
+    testPrivateMethod(funcName: string, params: TestContractParams, printDebugMessages?: boolean): Promise<TestContractResult>;
     toApiFields(fields?: Fields): node.Val[];
     toApiArgs(funcName: string, args?: Arguments): node.Val[];
     getMethodIndex(funcName: string): number;
@@ -124,11 +128,12 @@ export declare class Contract extends Artifact {
 }
 export declare class Script extends Artifact {
     readonly bytecodeTemplate: string;
+    readonly bytecodeDebugPatch: string;
     readonly fieldsSig: FieldsSig;
-    constructor(name: string, bytecodeTemplate: string, fieldsSig: FieldsSig, functions: FunctionSig[]);
+    constructor(name: string, bytecodeTemplate: string, bytecodeDebugPatch: string, fieldsSig: FieldsSig, functions: FunctionSig[]);
     static fromCompileResult(result: node.CompileScriptResult): Script;
-    static fromJson(artifact: any): Script;
-    static fromArtifactFile(path: string): Promise<Script>;
+    static fromJson(artifact: any, bytecodeDebugPatch?: string): Script;
+    static fromArtifactFile(path: string, bytecodeDebugPatch: string): Promise<Script>;
     toString(): string;
     paramsForDeployment(params: BuildExecuteScriptTx): Promise<SignExecuteScriptTxParams>;
     transactionForDeployment(signer: SignerWithNodeProvider, params: Omit<BuildExecuteScriptTx, 'signerAddress'>): Promise<BuildScriptTxResult>;
@@ -174,14 +179,17 @@ export interface ContractEventByTxId {
     name: string;
     fields: Fields;
 }
+export declare type DebugMessage = node.DebugMessage;
 export interface TestContractResult {
     address: string;
     contractId: string;
+    contractAddress: string;
     returns: Val[];
     gasUsed: number;
     contracts: ContractState[];
     txOutputs: Output[];
     events: ContractEventByTxId[];
+    debugMessages: DebugMessage[];
 }
 export declare type Output = AssetOutput | ContractOutput;
 export interface AssetOutput extends Asset {

package/dist/src/contract/contract.js

@@ -172,12 +172,16 @@ class Project {
         contracts.forEach((c) => {
             files.set(c.sourceFile.contractPath, {
                 sourceCodeHash: c.sourceFile.sourceCodeHash,
+                bytecodeDebugPatch: c.artifact.bytecodeDebugPatch,
+                codeHashDebug: c.artifact.codeHashDebug,
                 warnings: c.warnings
             });
         });
         scripts.forEach((s) => {
             files.set(s.sourceFile.contractPath, {
                 sourceCodeHash: s.sourceFile.sourceCodeHash,
+                bytecodeDebugPatch: s.artifact.bytecodeDebugPatch,
+                codeHashDebug: '',
                 warnings: s.warnings
             });
         });
@@ -185,6 +189,8 @@ class Project {
         sourceFiles.slice(compiledSize).forEach((c) => {
             files.set(c.contractPath, {
                 sourceCodeHash: c.sourceCodeHash,
+                bytecodeDebugPatch: '',
+                codeHashDebug: '',
                 warnings: []
             });
         });
@@ -243,7 +249,7 @@ class Project {
         await this.projectArtifact.saveToFile(this.artifactsRootDir);
     }
     contractByCodeHash(codeHash) {
-        const contract = this.contracts.find((c) => c.artifact.codeHash === codeHash);
+        const contract = this.contracts.find((c) => c.artifact.codeHash === codeHash || c.artifact.codeHashDebug == codeHash);
         if (typeof contract === 'undefined') {
             throw new Error(`Unknown code with code hash: ${codeHash}`);
         }
@@ -284,11 +290,11 @@ class Project {
                 const warnings = info.warnings;
                 const artifactDir = file.getArtifactPath(artifactsRootDir);
                 if (file.type === SourceType.Contract) {
-                    const artifact = await Contract.fromArtifactFile(artifactDir);
+                    const artifact = await Contract.fromArtifactFile(artifactDir, info.bytecodeDebugPatch, info.codeHashDebug);
                     contracts.push(new Compiled(file, artifact, warnings));
                 }
                 else if (file.type === SourceType.Script) {
-                    const artifact = await Script.fromArtifactFile(artifactDir);
+                    const artifact = await Script.fromArtifactFile(artifactDir, info.bytecodeDebugPatch);
                     scripts.push(new Compiled(file, artifact, warnings));
                 }
             }
@@ -385,15 +391,18 @@ class Artifact {
 }
 exports.Artifact = Artifact;
 class Contract extends Artifact {
-    constructor(name, bytecode, codeHash, fieldsSig, eventsSig, functions) {
+    constructor(name, bytecode, bytecodeDebugPatch, codeHash, codeHashDebug, fieldsSig, eventsSig, functions) {
         super(name, functions);
         this.bytecode = bytecode;
+        this.bytecodeDebugPatch = bytecodeDebugPatch;
         this.codeHash = codeHash;
         this.fieldsSig = fieldsSig;
         this.eventsSig = eventsSig;
+        this.bytecodeDebug = ralph.buildDebugBytecode(this.bytecode, this.bytecodeDebugPatch);
+        this.codeHashDebug = codeHashDebug;
     }
     // TODO: safely parse json
-    static fromJson(artifact) {
+    static fromJson(artifact, bytecodeDebugPatch = '', codeHashDebug = '') {
         if (artifact.name == null ||
             artifact.bytecode == null ||
             artifact.codeHash == null ||
@@ -402,17 +411,17 @@ class Contract extends Artifact {
             artifact.functions == null) {
             throw Error('The artifact JSON for contract is incomplete');
         }
-        const contract = new Contract(artifact.name, artifact.bytecode, artifact.codeHash, artifact.fieldsSig, artifact.eventsSig, artifact.functions);
+        const contract = new Contract(artifact.name, artifact.bytecode, bytecodeDebugPatch, artifact.codeHash, codeHashDebug ? codeHashDebug : artifact.codeHash, artifact.fieldsSig, artifact.eventsSig, artifact.functions);
         return contract;
     }
     static fromCompileResult(result) {
-        return new Contract(result.name, result.bytecode, result.codeHash, result.fields, result.events, result.functions);
+        return new Contract(result.name, result.bytecode, result.bytecodeDebugPatch, result.codeHash, result.codeHashDebug, result.fields, result.events, result.functions);
     }
     // support both 'code.ral' and 'code.ral.json'
-    static async fromArtifactFile(path) {
+    static async fromArtifactFile(path, bytecodeDebugPatch, codeHashDebug) {
         const content = await fs_2.promises.readFile(path);
         const artifact = JSON.parse(content.toString());
-        return Contract.fromJson(artifact);
+        return Contract.fromJson(artifact, bytecodeDebugPatch, codeHashDebug);
     }
     async fetchState(address, group) {
         const state = await Project.currentProject.nodeProvider.contracts.getContractsAddressState(address, {
@@ -450,11 +459,20 @@ class Contract extends Artifact {
         bytes[0] = 3;
         return utils_1.bs58.encode(bytes);
     }
-    async _test(funcName, params, expectPublic, accessType) {
+    _printDebugMessages(funcName, messages) {
+        if (messages.length != 0) {
+            console.log(`Testing ${this.name}.${funcName}:`);
+            messages.forEach((m) => console.log(`Debug - ${m.contractAddress} - ${m.message}`));
+        }
+    }
+    async _test(funcName, params, expectPublic, accessType, printDebugMessages) {
         const apiParams = this.toTestContract(funcName, params);
         const apiResult = await Project.currentProject.nodeProvider.contracts.postContractsTestContract(apiParams);
         const methodIndex = typeof params.testMethodIndex !== 'undefined' ? params.testMethodIndex : this.getMethodIndex(funcName);
         const isPublic = this.functions[`${methodIndex}`].isPublic;
+        if (printDebugMessages) {
+            this._printDebugMessages(funcName, apiResult.debugMessages);
+        }
         if (isPublic === expectPublic) {
             const result = await this.fromTestContractResult(methodIndex, apiResult);
             return result;
@@ -463,11 +481,11 @@ class Contract extends Artifact {
             throw new Error(`The test method ${funcName} is not ${accessType}`);
         }
     }
-    async testPublicMethod(funcName, params) {
-        return this._test(funcName, params, true, 'public');
+    async testPublicMethod(funcName, params, printDebugMessages = true) {
+        return this._test(funcName, params, true, 'public', printDebugMessages);
     }
-    async testPrivateMethod(funcName, params) {
-        return this._test(funcName, params, false, 'private');
+    async testPrivateMethod(funcName, params, printDebugMessages = true) {
+        return this._test(funcName, params, false, 'private', printDebugMessages);
     }
     toApiFields(fields) {
         if (typeof fields === 'undefined') {
@@ -499,7 +517,7 @@ class Contract extends Artifact {
         return {
             group: params.group,
             address: params.address,
-            bytecode: this.bytecode,
+            bytecode: this.bytecodeDebug,
             initialFields: this.toApiFields(params.initialFields),
             initialAsset: typeof params.initialAsset !== 'undefined' ? toApiAsset(params.initialAsset) : undefined,
             methodIndex: this.getMethodIndex(funcName),
@@ -547,6 +565,7 @@ class Contract extends Artifact {
         return {
             address: result.address,
             contractId: (0, utils_1.binToHex)((0, utils_1.contractIdFromAddress)(result.address)),
+            contractAddress: result.address,
             returns: (0, api_1.fromApiArray)(result.returns, this.functions[`${methodIndex}`].returnTypes),
             gasUsed: result.gasUsed,
             contracts: await Promise.all(result.contracts.map((contract) => this.fromApiContractState(contract))),
@@ -560,7 +579,8 @@ class Contract extends Artifact {
                 else {
                     throw Error(`Cannot find codeHash for the contract address: ${contractAddress}`);
                 }
-            }))
+            })),
+            debugMessages: result.debugMessages
         };
     }
     async paramsForDeployment(params) {
@@ -600,28 +620,29 @@ Contract.ContractDestroyedEvent = {
     fieldTypes: ['Address']
 };
 class Script extends Artifact {
-    constructor(name, bytecodeTemplate, fieldsSig, functions) {
+    constructor(name, bytecodeTemplate, bytecodeDebugPatch, fieldsSig, functions) {
         super(name, functions);
         this.bytecodeTemplate = bytecodeTemplate;
+        this.bytecodeDebugPatch = bytecodeDebugPatch;
         this.fieldsSig = fieldsSig;
     }
     static fromCompileResult(result) {
-        return new Script(result.name, result.bytecodeTemplate, result.fields, result.functions);
+        return new Script(result.name, result.bytecodeTemplate, result.bytecodeDebugPatch, result.fields, result.functions);
     }
     // TODO: safely parse json
-    static fromJson(artifact) {
+    static fromJson(artifact, bytecodeDebugPatch = '') {
         if (artifact.name == null ||
             artifact.bytecodeTemplate == null ||
             artifact.fieldsSig == null ||
             artifact.functions == null) {
             throw Error('The artifact JSON for script is incomplete');
         }
-        return new Script(artifact.name, artifact.bytecodeTemplate, artifact.fieldsSig, artifact.functions);
+        return new Script(artifact.name, artifact.bytecodeTemplate, bytecodeDebugPatch, artifact.fieldsSig, artifact.functions);
     }
-    static async fromArtifactFile(path) {
+    static async fromArtifactFile(path, bytecodeDebugPatch) {
         const content = await fs_2.promises.readFile(path);
         const artifact = JSON.parse(content.toString());
-        return this.fromJson(artifact);
+        return this.fromJson(artifact, bytecodeDebugPatch);
     }
     toString() {
         const object = {

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

@@ -10,3 +10,4 @@ export declare function encodeScriptField(tpe: string, value: Val): Uint8Array;
 export declare function buildScriptByteCode(bytecodeTemplate: string, fields: Fields, fieldsSig: FieldsSig): string;
 export declare function buildContractByteCode(bytecode: string, fields: Fields, fieldsSig: FieldsSig): string;
 export declare function encodeContractField(tpe: string, value: Val): Uint8Array[];
+export declare function buildDebugBytecode(bytecode: string, bytecodePatch: string): string;

package/dist/src/contract/ralph.js

@@ -18,7 +18,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeContractField = exports.buildContractByteCode = exports.buildScriptByteCode = exports.encodeScriptField = exports.encodeScriptFieldAsString = exports.encodeAddress = exports.encodeByteVec = exports.encodeU256 = exports.encodeI256 = exports.encodeBool = void 0;
+exports.buildDebugBytecode = exports.encodeContractField = exports.buildContractByteCode = exports.buildScriptByteCode = exports.encodeScriptField = exports.encodeScriptFieldAsString = exports.encodeAddress = exports.encodeByteVec = exports.encodeU256 = exports.encodeI256 = exports.encodeBool = void 0;
 const buffer_1 = require("buffer/");
 const utils_1 = require("../utils");
 const bigIntZero = BigInt(0);
@@ -343,6 +343,32 @@ exports.encodeContractField = encodeContractField;
 function invalidVal(tpe, value) {
     return Error(`Invalid API value ${value} for type ${tpe}`);
 }
+function buildDebugBytecode(bytecode, bytecodePatch) {
+    if (bytecodePatch === '') {
+        return bytecode;
+    }
+    const pattern = /[=+-][0-9a-f]*/g;
+    let result = '';
+    let index = 0;
+    for (const parts of bytecodePatch.matchAll(pattern)) {
+        const part = parts[0];
+        const diffType = part[0];
+        if (diffType === '=') {
+            const length = parseInt(part.substring(1));
+            result = result + bytecode.slice(index, index + length);
+            index = index + length;
+        }
+        else if (diffType === '+') {
+            result = result + part.substring(1);
+        }
+        else {
+            const length = parseInt(part.substring(1));
+            index = index + length;
+        }
+    }
+    return result;
+}
+exports.buildDebugBytecode = buildDebugBytecode;
 // export function buildContractByteCode(
 //   compiled: node.TemplateContractByteCode,
 //   templateVariables: TemplateVariables

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.2.0-rc.15",
+  "version": "0.2.0-rc.16",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,8 +27,8 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.5.0-rc8",
-    "explorer_backend_version": "1.8.0"
+    "alephium_version": "1.5.0-rc9",
+    "explorer_backend_version": "1.9.0-rc0"
   },
   "scripts": {
     "build": "rm -rf dist/* && npx tsc --build . && webpack",

package/src/api/api-alephium.ts

@@ -437,9 +437,13 @@ export interface ChangeActiveAddress {
 export interface CompileContractResult {
   name: string
   bytecode: string
+  bytecodeDebugPatch: string
 
   /** @format 32-byte-hash */
   codeHash: string
+
+  /** @format 32-byte-hash */
+  codeHashDebug: string
   fields: FieldsSig
   functions: FunctionSig[]
   events: EventSig[]
@@ -454,6 +458,7 @@ export interface CompileProjectResult {
 export interface CompileScriptResult {
   name: string
   bytecodeTemplate: string
+  bytecodeDebugPatch: string
   fields: FieldsSig
   functions: FunctionSig[]
   warnings: string[]
@@ -574,6 +579,12 @@ export interface ContractState {
   asset: AssetState
 }
 
+export interface DebugMessage {
+  /** @format address */
+  contractAddress: string
+  message: string
+}
+
 export interface DecodeUnsignedTx {
   unsignedTx: string
 }
@@ -895,6 +906,7 @@ export interface TestContractResult {
   txInputs: string[]
   txOutputs: Output[]
   events: ContractEventByTxId[]
+  debugMessages: DebugMessage[]
 }
 
 export interface TestInputAsset {