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

package/src/contract/contract.ts

@@ -119,11 +119,13 @@ class Compiled<T extends Artifact> {
   }
 }
 
+type CodeInfo = { sourceCodeHash: string; bytecodeDebugPatch: string; codeHashDebug: string; warnings: string[] }
+
 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 {
     if (Object.keys(compilerOptions).length != Object.keys(DEFAULT_NODE_COMPILER_OPTIONS).length) {
@@ -136,10 +138,7 @@ class ProjectArtifact {
     }
   }
 
-  constructor(
-    compilerOptionsUsed: node.CompilerOptions,
-    infos: Map<string, { sourceCodeHash: string; warnings: string[] }>
-  ) {
+  constructor(compilerOptionsUsed: node.CompilerOptions, infos: Map<string, CodeInfo>) {
     ProjectArtifact.checkCompilerOptionsParameter(compilerOptionsUsed)
     this.compilerOptionsUsed = compilerOptionsUsed
     this.infos = infos
@@ -184,7 +183,7 @@ class ProjectArtifact {
     const content = await fsPromises.readFile(filepath)
     const json = JSON.parse(content.toString())
     const compilerOptionsUsed = json.compilerOptionsUsed as node.CompilerOptions
-    const files = new Map(Object.entries<{ sourceCodeHash: string; warnings: string[] }>(json.infos))
+    const files = new Map(Object.entries<CodeInfo>(json.infos))
     return new ProjectArtifact(compilerOptionsUsed, files)
   }
 }
@@ -221,16 +220,20 @@ export class Project {
     scripts: Compiled<Script>[],
     compilerOptions: node.CompilerOptions
   ): ProjectArtifact {
-    const files: Map<string, { sourceCodeHash: string; warnings: string[] }> = new Map()
+    const files: Map<string, CodeInfo> = new Map()
     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
       })
     })
@@ -238,6 +241,8 @@ export class Project {
     sourceFiles.slice(compiledSize).forEach((c) => {
       files.set(c.contractPath, {
         sourceCodeHash: c.sourceCodeHash,
+        bytecodeDebugPatch: '',
+        codeHashDebug: '',
         warnings: []
       })
     })
@@ -327,7 +332,9 @@ export class Project {
   }
 
   contractByCodeHash(codeHash: string): Contract {
-    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}`)
     }
@@ -394,10 +401,10 @@ export 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))
         }
       }
@@ -476,7 +483,7 @@ export class Project {
     const { errorOnWarnings, ...nodeCompilerOptions } = { ...DEFAULT_COMPILER_OPTIONS, ...compilerOptionsPartial }
     const projectArtifact = await ProjectArtifact.from(artifactsRootDir)
     if (typeof projectArtifact === 'undefined' || projectArtifact.needToReCompile(nodeCompilerOptions, sourceFiles)) {
-      console.log(`Compile contracts in folder "${contractsRootDir}"`)
+      console.log(`Compiling contracts in folder "${contractsRootDir}"`)
       Project.currentProject = await Project.compile(
         provider,
         sourceFiles,
@@ -486,7 +493,7 @@ export class Project {
         nodeCompilerOptions
       )
     } else {
-      console.log(`Load compiled contracts from folder "${artifactsRootDir}"`)
+      console.log(`Contracts are compiled already. Loading them from folder "${artifactsRootDir}"`)
       Project.currentProject = await Project.loadArtifacts(
         provider,
         sourceFiles,
@@ -526,27 +533,37 @@ export abstract class Artifact {
 
 export class Contract extends Artifact {
   readonly bytecode: string
+  readonly bytecodeDebugPatch: string
   readonly codeHash: string
   readonly fieldsSig: FieldsSig
   readonly eventsSig: EventSig[]
 
+  readonly bytecodeDebug: string
+  readonly codeHashDebug: string
+
   constructor(
     name: string,
     bytecode: string,
+    bytecodeDebugPatch: string,
     codeHash: string,
+    codeHashDebug: string,
     fieldsSig: FieldsSig,
     eventsSig: EventSig[],
     functions: FunctionSig[]
   ) {
     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: any): Contract {
+  static fromJson(artifact: any, bytecodeDebugPatch = '', codeHashDebug = ''): Contract {
     if (
       artifact.name == null ||
       artifact.bytecode == null ||
@@ -560,7 +577,9 @@ export class Contract extends Artifact {
     const contract = new Contract(
       artifact.name,
       artifact.bytecode,
+      bytecodeDebugPatch,
       artifact.codeHash,
+      codeHashDebug ? codeHashDebug : artifact.codeHash,
       artifact.fieldsSig,
       artifact.eventsSig,
       artifact.functions
@@ -569,14 +588,23 @@ export class Contract extends Artifact {
   }
 
   static fromCompileResult(result: node.CompileContractResult): Contract {
-    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: string): Promise<Contract> {
+  static async fromArtifactFile(path: string, bytecodeDebugPatch: string, codeHashDebug: string): Promise<Contract> {
     const content = await fsPromises.readFile(path)
     const artifact = JSON.parse(content.toString())
-    return Contract.fromJson(artifact)
+    return Contract.fromJson(artifact, bytecodeDebugPatch, codeHashDebug)
   }
 
   async fetchState(address: string, group: number): Promise<ContractState> {
@@ -619,11 +647,19 @@ export class Contract extends Artifact {
     return bs58.encode(bytes)
   }
 
+  private _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}`))
+    }
+  }
+
   private async _test(
     funcName: string,
     params: TestContractParams,
     expectPublic: boolean,
-    accessType: string
+    accessType: string,
+    printDebugMessages: boolean
   ): Promise<TestContractResult> {
     const apiParams: node.TestContract = this.toTestContract(funcName, params)
     const apiResult = await Project.currentProject.nodeProvider.contracts.postContractsTestContract(apiParams)
@@ -631,6 +667,9 @@ export class Contract extends Artifact {
     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
@@ -639,12 +678,20 @@ export class Contract extends Artifact {
     }
   }
 
-  async testPublicMethod(funcName: string, params: TestContractParams): Promise<TestContractResult> {
-    return this._test(funcName, params, true, 'public')
+  async testPublicMethod(
+    funcName: string,
+    params: TestContractParams,
+    printDebugMessages = true
+  ): Promise<TestContractResult> {
+    return this._test(funcName, params, true, 'public', printDebugMessages)
   }
 
-  async testPrivateMethod(funcName: string, params: TestContractParams): Promise<TestContractResult> {
-    return this._test(funcName, params, false, 'private')
+  async testPrivateMethod(
+    funcName: string,
+    params: TestContractParams,
+    printDebugMessages = true
+  ): Promise<TestContractResult> {
+    return this._test(funcName, params, false, 'private', printDebugMessages)
   }
 
   toApiFields(fields?: Fields): node.Val[] {
@@ -680,7 +727,7 @@ export 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),
@@ -746,6 +793,7 @@ export class Contract extends Artifact {
     return {
       address: result.address,
       contractId: binToHex(contractIdFromAddress(result.address)),
+      contractAddress: result.address,
       returns: fromApiArray(result.returns, this.functions[`${methodIndex}`].returnTypes),
       gasUsed: result.gasUsed,
       contracts: await Promise.all(result.contracts.map((contract) => this.fromApiContractState(contract))),
@@ -760,7 +808,8 @@ export class Contract extends Artifact {
             throw Error(`Cannot find codeHash for the contract address: ${contractAddress}`)
           }
         })
-      )
+      ),
+      debugMessages: result.debugMessages
     }
   }
 
@@ -797,20 +846,28 @@ export class Contract extends Artifact {
 
 export 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[]
+  ) {
     super(name, functions)
     this.bytecodeTemplate = bytecodeTemplate
+    this.bytecodeDebugPatch = bytecodeDebugPatch
     this.fieldsSig = fieldsSig
   }
 
   static fromCompileResult(result: node.CompileScriptResult): Script {
-    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: any): Script {
+  static fromJson(artifact: any, bytecodeDebugPatch = ''): Script {
     if (
       artifact.name == null ||
       artifact.bytecodeTemplate == null ||
@@ -819,13 +876,19 @@ export class Script extends Artifact {
     ) {
       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: string): Promise<Script> {
+  static async fromArtifactFile(path: string, bytecodeDebugPatch: string): Promise<Script> {
     const content = await fsPromises.readFile(path)
     const artifact = JSON.parse(content.toString())
-    return this.fromJson(artifact)
+    return this.fromJson(artifact, bytecodeDebugPatch)
   }
 
   override toString(): string {
@@ -981,14 +1044,18 @@ export interface ContractEventByTxId {
   fields: Fields
 }
 
+export 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/src/contract/ralph.ts

@@ -343,6 +343,31 @@ function invalidVal(tpe: string, value: Val): Error {
   return Error(`Invalid API value ${value} for type ${tpe}`)
 }
 
+export function buildDebugBytecode(bytecode: string, bytecodePatch: string): string {
+  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
+}
+
 // export function buildContractByteCode(
 //   compiled: node.TemplateContractByteCode,
 //   templateVariables: TemplateVariables

package/dist/scripts/rename-gitignore.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/scripts/rename-gitignore.js

@@ -1,24 +0,0 @@
-"use strict";
-/*
-Copyright 2018 - 2022 The Alephium Authors
-This file is part of the alephium project.
-
-The library is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-The library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU Lesser General Public License for more details.
-
-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/>.
-*/
-const { rename } = require('fs');
-rename(process.argv[2], process.argv[3], function (error) {
-    if (error)
-        console.log(error);
-    console.log(`Renamed ${process.argv[2]} to ${process.argv[3]}.`);
-});

package/scripts/rename-gitignore.js

@@ -1,24 +0,0 @@
-/*
-Copyright 2018 - 2022 The Alephium Authors
-This file is part of the alephium project.
-
-The library is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-The library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU Lesser General Public License for more details.
-
-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/>.
-*/
-
-const { rename } = require('fs')
-
-rename(process.argv[2], process.argv[3], function (error) {
-  if (error) console.log(error)
-  console.log(`Renamed ${process.argv[2]} to ${process.argv[3]}.`)
-})