@alephium/web3 0.2.0-rc.3 → 0.2.0-rc.4

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

@@ -30,7 +30,7 @@ export declare abstract class Common {
     static checkFileNameExtension(fileName: string): void;
     protected static _from<T extends {
         sourceCodeSha256: string;
-    }>(provider: NodeProvider, sourceFile: SourceFile, loadContractStr: (sourceFile: SourceFile, importsCache: string[]) => Promise<string>, compile: (provider: NodeProvider, sourceFile: SourceFile, contractStr: string, contractHash: string, errorOnWarnings: boolean) => Promise<T>, errorOnWarnings: boolean): Promise<T>;
+    }>(provider: NodeProvider, sourceFile: SourceFile, loadContractStr: (sourceFile: SourceFile, importsCache: string[]) => Promise<string>, compile: (provider: NodeProvider, sourceFile: SourceFile, contractStr: string, contractHash: string, errorOnWarnings: boolean, ignoreUnusedConstantsWarnings: boolean) => Promise<T>, errorOnWarnings: boolean, ignoreUnusedConstantsWarnings: boolean): Promise<T>;
     protected _saveToFile(sourceFile: SourceFile): Promise<void>;
     abstract buildByteCodeToDeploy(initialFields?: Fields): string;
     publicFunctions(): string[];
@@ -38,7 +38,7 @@ export declare abstract class Common {
     usingAssetsInContractFunctions(): string[];
     protected static checkCompilerWarnings(compiled: {
         warnings: string[];
-    }, errorOnWarnings: boolean): void;
+    }, errorOnWarnings: boolean, ignoreUnusedConstantsWarnings: boolean): void;
 }
 export declare class Contract extends Common {
     readonly bytecode: string;
@@ -48,7 +48,7 @@ export declare class Contract extends Common {
     constructor(sourceCodeSha256: string, bytecode: string, codeHash: string, fieldsSig: FieldsSig, eventsSig: EventSig[], functions: FunctionSig[]);
     static checkCodeType(fileName: string, contractStr: string): void;
     private static loadContractStr;
-    static fromSource(provider: NodeProvider, path: string, errorOnWarnings?: boolean): Promise<Contract>;
+    static fromSource(provider: NodeProvider, path: string, errorOnWarnings?: boolean, ignoreUnusedConstantsWarnings?: boolean): Promise<Contract>;
     private static compile;
     static fromJson(artifact: any): Contract;
     static fromArtifactFile(path: string): Promise<Contract>;
@@ -81,7 +81,7 @@ export declare class Script extends Common {
     constructor(sourceCodeSha256: string, bytecodeTemplate: string, fieldsSig: FieldsSig, functions: FunctionSig[]);
     static checkCodeType(fileName: string, contractStr: string): void;
     private static loadContractStr;
-    static fromSource(provider: NodeProvider, path: string, errorOnWarnings?: boolean): Promise<Script>;
+    static fromSource(provider: NodeProvider, path: string, errorOnWarnings?: boolean, ignoreUnusedConstantsWarnings?: boolean): Promise<Script>;
     private static compile;
     static fromJson(artifact: any): Script;
     static fromArtifactFile(path: string): Promise<Script>;

package/dist/src/contract/contract.js

@@ -135,7 +135,7 @@ class Common {
             throw new Error('Smart contract file name should end with ".ral"');
         }
     }
-    static async _from(provider, sourceFile, loadContractStr, compile, errorOnWarnings) {
+    static async _from(provider, sourceFile, loadContractStr, compile, errorOnWarnings, ignoreUnusedConstantsWarnings) {
         Common.checkFileNameExtension(sourceFile.contractPath);
         const contractStr = await loadContractStr(sourceFile, []);
         const contractHash = cryptojs.SHA256(contractStr).toString();
@@ -144,7 +144,7 @@ class Common {
             return existingContract;
         }
         else {
-            return compile(provider, sourceFile, contractStr, contractHash, errorOnWarnings);
+            return compile(provider, sourceFile, contractStr, contractHash, errorOnWarnings, ignoreUnusedConstantsWarnings);
         }
     }
     _saveToFile(sourceFile) {
@@ -163,10 +163,13 @@ class Common {
     usingAssetsInContractFunctions() {
         return this.functions.filter((func) => func.useAssetsInContract).map((func) => func.name);
     }
-    static checkCompilerWarnings(compiled, errorOnWarnings) {
-        if (compiled.warnings.length !== 0) {
+    static checkCompilerWarnings(compiled, errorOnWarnings, ignoreUnusedConstantsWarnings) {
+        const warnings = ignoreUnusedConstantsWarnings
+            ? compiled.warnings.filter((s) => !s.includes('unused constants'))
+            : compiled.warnings;
+        if (warnings.length !== 0) {
             const prefixPerWarning = '  - ';
-            const warningString = prefixPerWarning + compiled.warnings.join('\n' + prefixPerWarning);
+            const warningString = prefixPerWarning + warnings.join('\n' + prefixPerWarning);
             const output = 'Compilation warnings:\n' + warningString + '\n';
             if (errorOnWarnings) {
                 throw new Error(output);
@@ -215,18 +218,18 @@ class Contract extends Common {
     static async loadContractStr(sourceFile) {
         return Common._loadContractStr(sourceFile, [], (code) => Contract.checkCodeType(sourceFile.contractPath, code));
     }
-    static async fromSource(provider, path, errorOnWarnings = true) {
+    static async fromSource(provider, path, errorOnWarnings = true, ignoreUnusedConstantsWarnings = true) {
         if (!fs_1.default.existsSync(Common._artifactsFolder())) {
             fs_1.default.mkdirSync(Common._artifactsFolder(), { recursive: true });
         }
         const sourceFile = this.getSourceFile(path, []);
-        const contract = await Common._from(provider, sourceFile, (sourceFile) => Contract.loadContractStr(sourceFile), Contract.compile, errorOnWarnings);
+        const contract = await Common._from(provider, sourceFile, Contract.loadContractStr, Contract.compile, errorOnWarnings, ignoreUnusedConstantsWarnings);
         this._putArtifactToCache(contract);
         return contract;
     }
-    static async compile(provider, sourceFile, contractStr, contractHash, errorOnWarnings) {
+    static async compile(provider, sourceFile, contractStr, contractHash, errorOnWarnings, ignoreUnusedConstantsWarnings) {
         const compiled = await provider.contracts.postContractsCompileContract({ code: contractStr });
-        Common.checkCompilerWarnings(compiled, errorOnWarnings);
+        Common.checkCompilerWarnings(compiled, errorOnWarnings, ignoreUnusedConstantsWarnings);
         const artifact = new Contract(contractHash, compiled.bytecode, compiled.codeHash, compiled.fields, compiled.events, compiled.functions);
         await artifact._saveToFile(sourceFile);
         return artifact;
@@ -476,13 +479,13 @@ class Script extends Common {
     static async loadContractStr(sourceFile) {
         return Common._loadContractStr(sourceFile, [], (code) => Script.checkCodeType(sourceFile.contractPath, code));
     }
-    static async fromSource(provider, path, errorOnWarnings = true) {
+    static async fromSource(provider, path, errorOnWarnings = true, ignoreUnusedConstantsWarnings = true) {
         const sourceFile = this.getSourceFile(path, []);
-        return Common._from(provider, sourceFile, (sourceFile) => Script.loadContractStr(sourceFile), Script.compile, errorOnWarnings);
+        return Common._from(provider, sourceFile, (sourceFile) => Script.loadContractStr(sourceFile), Script.compile, errorOnWarnings, ignoreUnusedConstantsWarnings);
     }
-    static async compile(provider, sourceFile, scriptStr, contractHash, errorOnWarnings = true) {
+    static async compile(provider, sourceFile, scriptStr, contractHash, errorOnWarnings = true, ignoreUnusedConstantsWarnings = true) {
         const compiled = await provider.contracts.postContractsCompileScript({ code: scriptStr });
-        Common.checkCompilerWarnings(compiled, errorOnWarnings);
+        Common.checkCompilerWarnings(compiled, errorOnWarnings, ignoreUnusedConstantsWarnings);
         const artifact = new Script(contractHash, compiled.bytecodeTemplate, compiled.fields, compiled.functions);
         await artifact._saveToFile(sourceFile);
         return artifact;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.2.0-rc.3",
+  "version": "0.2.0-rc.4",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",

package/src/contract/contract.ts

@@ -161,9 +161,11 @@ export abstract class Common {
       sourceFile: SourceFile,
       contractStr: string,
       contractHash: string,
-      errorOnWarnings: boolean
+      errorOnWarnings: boolean,
+      ignoreUnusedConstantsWarnings: boolean
     ) => Promise<T>,
-    errorOnWarnings: boolean
+    errorOnWarnings: boolean,
+    ignoreUnusedConstantsWarnings: boolean
   ): Promise<T> {
     Common.checkFileNameExtension(sourceFile.contractPath)
 
@@ -173,7 +175,7 @@ export abstract class Common {
     if (typeof existingContract !== 'undefined') {
       return existingContract as unknown as T
     } else {
-      return compile(provider, sourceFile, contractStr, contractHash, errorOnWarnings)
+      return compile(provider, sourceFile, contractStr, contractHash, errorOnWarnings, ignoreUnusedConstantsWarnings)
     }
   }
 
@@ -199,10 +201,17 @@ export abstract class Common {
     return this.functions.filter((func) => func.useAssetsInContract).map((func) => func.name)
   }
 
-  protected static checkCompilerWarnings(compiled: { warnings: string[] }, errorOnWarnings: boolean): void {
-    if (compiled.warnings.length !== 0) {
+  protected static checkCompilerWarnings(
+    compiled: { warnings: string[] },
+    errorOnWarnings: boolean,
+    ignoreUnusedConstantsWarnings: boolean
+  ): void {
+    const warnings = ignoreUnusedConstantsWarnings
+      ? compiled.warnings.filter((s) => !s.includes('unused constants'))
+      : compiled.warnings
+    if (warnings.length !== 0) {
       const prefixPerWarning = '  - '
-      const warningString = prefixPerWarning + compiled.warnings.join('\n' + prefixPerWarning)
+      const warningString = prefixPerWarning + warnings.join('\n' + prefixPerWarning)
       const output = 'Compilation warnings:\n' + warningString + '\n'
       if (errorOnWarnings) {
         throw new Error(output)
@@ -259,7 +268,12 @@ export class Contract extends Common {
     return Common._loadContractStr(sourceFile, [], (code) => Contract.checkCodeType(sourceFile.contractPath, code))
   }
 
-  static async fromSource(provider: NodeProvider, path: string, errorOnWarnings = true): Promise<Contract> {
+  static async fromSource(
+    provider: NodeProvider,
+    path: string,
+    errorOnWarnings = true,
+    ignoreUnusedConstantsWarnings = true
+  ): Promise<Contract> {
     if (!fs.existsSync(Common._artifactsFolder())) {
       fs.mkdirSync(Common._artifactsFolder(), { recursive: true })
     }
@@ -267,9 +281,10 @@ export class Contract extends Common {
     const contract = await Common._from(
       provider,
       sourceFile,
-      (sourceFile) => Contract.loadContractStr(sourceFile),
+      Contract.loadContractStr,
       Contract.compile,
-      errorOnWarnings
+      errorOnWarnings,
+      ignoreUnusedConstantsWarnings
     )
     this._putArtifactToCache(contract)
     return contract
@@ -280,10 +295,11 @@ export class Contract extends Common {
     sourceFile: SourceFile,
     contractStr: string,
     contractHash: string,
-    errorOnWarnings: boolean
+    errorOnWarnings: boolean,
+    ignoreUnusedConstantsWarnings: boolean
   ): Promise<Contract> {
     const compiled = await provider.contracts.postContractsCompileContract({ code: contractStr })
-    Common.checkCompilerWarnings(compiled, errorOnWarnings)
+    Common.checkCompilerWarnings(compiled, errorOnWarnings, ignoreUnusedConstantsWarnings)
 
     const artifact = new Contract(
       contractHash,
@@ -604,14 +620,20 @@ export class Script extends Common {
     return Common._loadContractStr(sourceFile, [], (code) => Script.checkCodeType(sourceFile.contractPath, code))
   }
 
-  static async fromSource(provider: NodeProvider, path: string, errorOnWarnings = true): Promise<Script> {
+  static async fromSource(
+    provider: NodeProvider,
+    path: string,
+    errorOnWarnings = true,
+    ignoreUnusedConstantsWarnings = true
+  ): Promise<Script> {
     const sourceFile = this.getSourceFile(path, [])
     return Common._from(
       provider,
       sourceFile,
       (sourceFile) => Script.loadContractStr(sourceFile),
       Script.compile,
-      errorOnWarnings
+      errorOnWarnings,
+      ignoreUnusedConstantsWarnings
     )
   }
 
@@ -620,10 +642,11 @@ export class Script extends Common {
     sourceFile: SourceFile,
     scriptStr: string,
     contractHash: string,
-    errorOnWarnings = true
+    errorOnWarnings = true,
+    ignoreUnusedConstantsWarnings = true
   ): Promise<Script> {
     const compiled = await provider.contracts.postContractsCompileScript({ code: scriptStr })
-    Common.checkCompilerWarnings(compiled, errorOnWarnings)
+    Common.checkCompilerWarnings(compiled, errorOnWarnings, ignoreUnusedConstantsWarnings)
     const artifact = new Script(contractHash, compiled.bytecodeTemplate, compiled.fields, compiled.functions)
     await artifact._saveToFile(sourceFile)
     return artifact

package/templates/base/package.json

@@ -12,7 +12,7 @@
     "stop-devnet": "node scripts/stop-devnet.js"
   },
   "dependencies": {
-    "@alephium/web3": "0.2.0-rc.3"
+    "@alephium/web3": "0.2.0-rc.4"
   },
   "devDependencies": {
     "@types/elliptic": "^6.4.13",

package/templates/react/package.json

@@ -12,7 +12,7 @@
     "@types/node": "^16.11.26",
     "@types/react": "^18.0.3",
     "@types/react-dom": "^18.0.0",
-    "@alephium/web3": "0.2.0-rc.3",
+    "@alephium/web3": "0.2.0-rc.4",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "react-scripts": "5.0.1",

package/test/contract.test.ts

@@ -193,5 +193,8 @@ describe('contract', function () {
     await expect(Contract.fromSource(provider, 'test/warnings.ral')).rejects.toThrowError(
       'Compilation warnings:\n  - Found unused variables in function foo: foo.y\n  - Found unused fields: b'
     )
+    await expect(Contract.fromSource(provider, 'test/warnings.ral', true, false)).rejects.toThrowError(
+      'Compilation warnings:\n  - Found unused variables in function foo: foo.y\n  - Found unused constants: C\n  - Found unused fields: b'
+    )
   })
 })