Add the force recompile flag

gen.ts

@@ -16,7 +16,8 @@ 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/>.
 */
 
-import { codegen, Project } from '@alephium/cli'
+import { codegen } from '@alephium/cli'
+import { Project } from './packages/cli/src/project'
 import { web3 } from '@alephium/web3'
 
 async function gen() {

packages/cli/cli_internal.ts

@@ -28,13 +28,13 @@
   codegen,
   getConfigFile,
   getSdkFullNodeVersion,
-  isDeployedOnMainnet,
+  isDeployed,
   isNetworkLive,
   loadConfig
 } from './src'
 import { Project } from './src/project'
 
 function getConfig(options: any): Configuration {
   const configFile = options.config ? (options.config as string) : getConfigFile()
   console.log(`Loading alephium config file: ${configFile}`)
   const config = loadConfig(configFile)
@@ -91,7 +91,7 @@
     try {
       const config = getConfig(options)
       const networkId = checkAndGetNetworkId(options.network)
       const nodeUrl = config.networks[networkId].nodeUrl
       if (!(await isNetworkLive(nodeUrl))) {
         throw new Error(`${networkId} is not live`)
       }
@@ -103,14 +103,17 @@
       console.log(`Full node version: ${connectedFullNodeVersion}`)
 
       const cwd = path.resolve(process.cwd())
-      const skipSaveArtifacts = config.skipSaveArtifacts || isDeployedOnMainnet(config)
+      const isContractDeployed = isDeployed(config)
+      if (!config.forceRecompile && isContractDeployed) {
+        console.warn(`The contracts has been deployed on testnet/mainnet, and the artifacts will not be updated.`)
+      }
       const project = await Project.compile(
         config.compilerOptions,
         cwd,
         config.sourceDir,
         config.artifactDir,
         connectedFullNodeVersion,
-        skipSaveArtifacts
+        config.forceRecompile || !isContractDeployed
       )
       console.log('✅ Compilation completed!')
       if (options.skipGenerate) {

packages/cli/src/deployment.ts

@@ -55,7 +55,7 @@
   getConfigFile,
   getDeploymentFilePath,
   getNetwork,
-  isDeployedOnMainnet,
+  isDeployed,
   loadConfig,
   retryFetch,
   taskIdToVariable,
@@ -174,7 +174,7 @@
   }
 
   getInstance<I extends ContractInstance>(
     contract: ContractFactory<I, any>,
     group?: number,
     taskId?: string
   ): I | undefined {
@@ -225,7 +225,7 @@
     return this.contracts.size === 0 && this.scripts.size === 0 && this.migrations.size === 0
   }
 
   marshal(): any {
     return {
       deployerAddress: this.deployerAddress,
       contracts: Object.fromEntries(this.contracts),
@@ -234,7 +234,7 @@
     }
   }
 
   static unmarshal(json: any): DeploymentsPerAddress {
     const deployerAddress = json.deployerAddress as string
     const contracts = new Map(Object.entries<DeployContractExecutionResult>(json.contracts))
     const scripts = new Map(Object.entries<RunScriptResult>(json.scripts))
@@ -295,7 +295,7 @@
     return true
   }
   // previous !== undefined if retry is false
   return previous!.issueTokenAmount !== issueTokenAmount
 }
 
 async function needToRunScript(
@@ -575,14 +575,14 @@
   const artifactDir = configuration.artifactDir ?? DEFAULT_CONFIGURATION_VALUES.artifactDir
   let project: Project | undefined = undefined
   if (configuration.skipRecompile !== true) {
-    const skipSaveArtifacts = configuration.skipSaveArtifacts || isDeployedOnMainnet(configuration)
+    const forceRecompile = configuration.forceRecompile || !isDeployed(configuration)
     project = await Project.compile(
       configuration.compilerOptions,
       path.resolve(process.cwd()),
       configuration.sourceDir ?? DEFAULT_CONFIGURATION_VALUES.sourceDir,
       artifactDir,
       undefined,
-      skipSaveArtifacts
+      forceRecompile
     )
   }
 

packages/cli/src/index.ts

@@ -20,4 +20,3 @@ export * from './types'
 export * from './utils'
 export * from './deployment'
 export * from './codegen'
-export * from './project'

packages/cli/src/project.test.ts

@@ -0,0 +1,65 @@
+/*
+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/>.
+*/
+
+import { DEFAULT_NODE_COMPILER_OPTIONS } from '@alephium/web3'
+import { CodeInfo, ProjectArtifact, SourceInfo } from './project'
+
+describe('project', () => {
+  function newCodeInfo(hash: string): CodeInfo {
+    return {
+      sourceFile: '',
+      sourceCodeHash: hash,
+      bytecodeDebugPatch: '',
+      codeHashDebug: '',
+      warnings: []
+    }
+  }
+
+  function newSourceInfo(name: string, hash: string): SourceInfo {
+    return new SourceInfo(0, name, '', hash, '', false)
+  }
+
+  it('should get changed sources', () => {
+    const codes: Map<string, CodeInfo> = new Map([
+      ['Foo', newCodeInfo('Foo')],
+      ['Bar', newCodeInfo('Bar')],
+      ['Baz', newCodeInfo('Baz')]
+    ])
+    const preArtifacts = new ProjectArtifact('', DEFAULT_NODE_COMPILER_OPTIONS, codes)
+    const sources = [newSourceInfo('Foo', 'Foo1'), newSourceInfo('Bar', 'Bar1'), newSourceInfo('Baz', 'Baz')]
+    expect(preArtifacts.getChangedSources(sources)).toEqual(['Foo', 'Bar'])
+  })
+
+  it('should get new added sources', () => {
+    const codes: Map<string, CodeInfo> = new Map([['Foo', newCodeInfo('Foo')]])
+    const preArtifacts = new ProjectArtifact('', DEFAULT_NODE_COMPILER_OPTIONS, codes)
+    const sources = [newSourceInfo('Foo', 'Foo'), newSourceInfo('Bar', 'Bar'), newSourceInfo('Baz', 'Baz')]
+    expect(preArtifacts.getChangedSources(sources)).toEqual(['Bar', 'Baz'])
+  })
+
+  it('should get removed sources', () => {
+    const codes: Map<string, CodeInfo> = new Map([
+      ['Foo', newCodeInfo('Foo')],
+      ['Bar', newCodeInfo('Bar')],
+      ['Baz', newCodeInfo('Baz')]
+    ])
+    const preArtifacts = new ProjectArtifact('', DEFAULT_NODE_COMPILER_OPTIONS, codes)
+    const sources = [newSourceInfo('Bar', 'Bar')]
+    expect(preArtifacts.getChangedSources(sources)).toEqual(['Foo', 'Baz'])
+  })
+})

packages/cli/src/project.ts

@@ -66,7 +66,7 @@ enum SourceKind {
   Struct = 4
 }
 
-class SourceInfo {
+export class SourceInfo {
   type: SourceKind
   name: string
   contractRelativePath: string
@@ -127,7 +127,7 @@ class Compiled<T extends Artifact> {
   }
 }
 
-type CodeInfo = {
+export type CodeInfo = {
   sourceFile: string
   sourceCodeHash: string
   bytecodeDebugPatch: string
@@ -206,14 +206,21 @@ export class ProjectArtifact {
     return fsPromises.writeFile(filepath, content)
   }
 
-  getChangedSources(sourceInfos: SourceInfo[]): SourceInfo[] {
-    const result: SourceInfo[] = []
-    for (const sourceInfo of sourceInfos) {
+  getChangedSources(sourceInfos: SourceInfo[]): string[] {
+    const result: string[] = []
+    // get all changed and new sources
+    sourceInfos.forEach((sourceInfo) => {
       const info = this.infos.get(sourceInfo.name)
-      if (typeof info === 'undefined' || info.sourceCodeHash !== sourceInfo.sourceCodeHash) {
-        result.push(sourceInfo)
+      if (info === undefined || info.sourceCodeHash !== sourceInfo.sourceCodeHash) {
+        result.push(sourceInfo.name)
       }
-    }
+    })
+    // get all removed sources
+    this.infos.forEach((_, name) => {
+      if (sourceInfos.find((s) => s.name === name) === undefined) {
+        result.push(name)
+      }
+    })
     return result
   }
 
@@ -364,17 +371,21 @@ export class Project {
   static checkCompilerWarnings(
     contracts: Map<string, Compiled<Contract>>,
     scripts: Map<string, Compiled<Script>>,
-    changedSources: SourceInfo[],
-    skipSaveArtifacts: boolean,
+    changedSources: string[],
+    forceRecompile: boolean,
     errorOnWarnings: boolean
   ): void {
     const warnings: string[] = []
     contracts.forEach((contract) => {
-      if (!skipSaveArtifacts || changedSources.find((s) => s.name === contract.sourceInfo.name) !== undefined) {
+      if (Project.needToUpdate(forceRecompile, changedSources, contract.sourceInfo.name)) {
         warnings.push(...contract.warnings)
       }
     })
-    scripts.forEach((script) => warnings.push(...script.warnings))
+    scripts.forEach((script) => {
+      if (Project.needToUpdate(forceRecompile, changedSources, script.sourceInfo.name)) {
+        warnings.push(...script.warnings)
+      }
+    })
     if (warnings.length !== 0) {
       const prefixPerWarning = '  - '
       const warningString = prefixPerWarning + warnings.join('\n' + prefixPerWarning)
@@ -421,10 +432,14 @@ export class Project {
     return fsPromises.writeFile(filePath, JSON.stringify(structs, null, 2))
   }
 
+  private static needToUpdate(forceRecompile: boolean, changedSources: string[], name: string): boolean {
+    return forceRecompile || changedSources.includes(name)
+  }
+
   private async saveArtifactsToFile(
     projectRootDir: string,
-    skipSaveArtifacts: boolean,
-    changedSources: SourceInfo[]
+    forceRecompile: boolean,
+    changedSources: string[]
   ): Promise<void> {
     const artifactsRootDir = this.artifactsRootDir
     const saveToFile = async function (compiled: Compiled<Artifact>): Promise<void> {
@@ -436,24 +451,26 @@ export class Project {
       return fsPromises.writeFile(artifactPath, compiled.artifact.toString())
     }
     for (const [_, contract] of this.contracts) {
-      if (!skipSaveArtifacts || changedSources.find((s) => s.name === contract.sourceInfo.name) !== undefined) {
+      if (Project.needToUpdate(forceRecompile, changedSources, contract.sourceInfo.name)) {
         await saveToFile(contract)
       }
     }
     for (const [_, script] of this.scripts) {
-      await saveToFile(script)
+      if (Project.needToUpdate(forceRecompile, changedSources, script.sourceInfo.name)) {
+        await saveToFile(script)
+      }
     }
     await this.saveStructsToFile()
-    await this.saveProjectArtifact(projectRootDir, skipSaveArtifacts, changedSources)
+    await this.saveProjectArtifact(projectRootDir, forceRecompile, changedSources)
   }
 
-  private async saveProjectArtifact(projectRootDir: string, skipSaveArtifacts: boolean, changedSources: SourceInfo[]) {
-    if (skipSaveArtifacts) {
-      // we should not update the `codeHashDebug` if the `skipSaveArtifacts` is enabled
+  private async saveProjectArtifact(projectRootDir: string, forceRecompile: boolean, changedSources: string[]) {
+    if (!forceRecompile) {
+      // we should not update the `codeHashDebug` if the `forceRecompile` is disable
       const prevProjectArtifact = await ProjectArtifact.from(projectRootDir)
       if (prevProjectArtifact !== undefined) {
         for (const [name, info] of this.projectArtifact.infos) {
-          if (changedSources.find((s) => s.name === name) === undefined) {
+          if (!changedSources.includes(name)) {
             const prevInfo = prevProjectArtifact.infos.get(name)
             info.bytecodeDebugPatch = prevInfo?.bytecodeDebugPatch ?? info.bytecodeDebugPatch
             info.codeHashDebug = prevInfo?.codeHashDebug ?? info.codeHashDebug
@@ -515,8 +532,8 @@ export class Project {
     artifactsRootDir: string,
     errorOnWarnings: boolean,
     compilerOptions: node.CompilerOptions,
-    changedSources: SourceInfo[],
-    skipSaveArtifacts = false
+    changedSources: string[],
+    forceRecompile: boolean
   ): Promise<Project> {
     const removeDuplicates = sourceInfos.reduce((acc: SourceInfo[], sourceInfo: SourceInfo) => {
       if (acc.find((info) => info.sourceCodeHash === sourceInfo.sourceCodeHash) === undefined) {
@@ -558,7 +575,7 @@ export class Project {
       scripts,
       compilerOptions
     )
-    Project.checkCompilerWarnings(contracts, scripts, changedSources, skipSaveArtifacts, errorOnWarnings)
+    Project.checkCompilerWarnings(contracts, scripts, changedSources, forceRecompile, errorOnWarnings)
     const project = new Project(
       contractsRootDir,
       artifactsRootDir,
@@ -568,7 +585,7 @@ export class Project {
       structs,
       projectArtifact
     )
-    await project.saveArtifactsToFile(projectRootDir, skipSaveArtifacts, changedSources)
+    await project.saveArtifactsToFile(projectRootDir, forceRecompile, changedSources)
     return project
   }
 
@@ -580,8 +597,8 @@ export class Project {
     artifactsRootDir: string,
     errorOnWarnings: boolean,
     compilerOptions: node.CompilerOptions,
-    changedSources: SourceInfo[],
-    skipSaveArtifacts: boolean
+    changedSources: string[],
+    forceRecompile: boolean
   ): Promise<Project> {
     const projectArtifact = await ProjectArtifact.from(projectRootDir)
     if (projectArtifact === undefined) {
@@ -612,7 +629,7 @@ export class Project {
         }
       }
 
-      Project.checkCompilerWarnings(contracts, scripts, changedSources, skipSaveArtifacts, errorOnWarnings)
+      Project.checkCompilerWarnings(contracts, scripts, changedSources, forceRecompile, errorOnWarnings)
       return new Project(contractsRootDir, artifactsRootDir, sourceInfos, contracts, scripts, structs, projectArtifact)
     } catch (error) {
       console.log(`Failed to load artifacts, error: ${error}, try to re-compile contracts...`)
@@ -625,7 +642,8 @@ export class Project {
         artifactsRootDir,
         errorOnWarnings,
         compilerOptions,
-        changedSources
+        changedSources,
+        forceRecompile
       )
     }
   }
@@ -749,14 +767,14 @@ export class Project {
     contractsRootDir = Project.DEFAULT_CONTRACTS_DIR,
     artifactsRootDir = Project.DEFAULT_ARTIFACTS_DIR,
     defaultFullNodeVersion: string | undefined = undefined,
-    skipSaveArtifacts = false
+    forceRecompile = false
   ): Promise<Project> {
     const provider = web3.getCurrentNodeProvider()
     const fullNodeVersion = defaultFullNodeVersion ?? (await provider.infos.getInfosVersion()).version
     const sourceFiles = await Project.loadSourceFiles(projectRootDir, contractsRootDir)
     const { errorOnWarnings, ...nodeCompilerOptions } = { ...DEFAULT_COMPILER_OPTIONS, ...compilerOptionsPartial }
     const projectArtifact = await ProjectArtifact.from(projectRootDir)
-    const changedSources = projectArtifact?.getChangedSources(sourceFiles) ?? sourceFiles
+    const changedSources = projectArtifact?.getChangedSources(sourceFiles) ?? sourceFiles.map((s) => s.name)
     if (
       projectArtifact === undefined ||
       projectArtifact.needToReCompile(nodeCompilerOptions, fullNodeVersion) ||
@@ -776,7 +794,7 @@ export class Project {
         errorOnWarnings,
         nodeCompilerOptions,
         changedSources,
-        skipSaveArtifacts
+        forceRecompile
       )
     }
     // we need to reload those contracts that did not regenerate bytecode
@@ -789,7 +807,7 @@ export class Project {
       errorOnWarnings,
       nodeCompilerOptions,
       changedSources,
-      skipSaveArtifacts
+      forceRecompile
     )
   }
 }

packages/cli/src/types.ts

@@ -33,14 +33,13 @@ import {
   ContractInstance
 } from '@alephium/web3'
 import { getConfigFile, loadConfig } from './utils'
-import path from 'path'
 import { Project } from './project'
 
 export interface Network<Settings = unknown> {
   networkId?: number
   nodeUrl: string
   privateKeys: string[] | string
-  deploymentStatusFile?: string
+  deploymentFile?: string
   confirmations?: number
   settings: Settings
 }
@@ -60,7 +59,7 @@ export interface Configuration<Settings = unknown> {
   networks: Record<NetworkId, Network<Settings>>
 
   enableDebugMode?: boolean
-  skipSaveArtifacts?: boolean
+  forceRecompile?: boolean
 }
 
 export const DEFAULT_CONFIGURATION_VALUES = {
@@ -87,7 +86,7 @@ export const DEFAULT_CONFIGURATION_VALUES = {
       confirmations: 2
     }
   },
-  skipSaveArtifacts: false
+  forceRecompile: false
 }
 
 export interface Environment<Settings = unknown> {