@alephium/web3 0.2.0-rc.5 → 0.2.0-rc.6

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

@@ -11,6 +11,11 @@ declare enum SourceType {
     AbstractContract = 2,
     Interface = 3
 }
+export declare type CompilerOptions = {
+    errorOnWarnings: boolean;
+    ignoreUnusedConstantsWarnings: boolean;
+};
+export declare const DEFAULT_COMPILER_OPTIONS: CompilerOptions;
 declare class TypedMatcher<T extends SourceType> {
     matcher: RegExp;
     type: T;
@@ -47,8 +52,8 @@ export declare class Project {
     private constructor();
     private getContractPath;
     private static checkCompilerWarnings;
-    static contract(path: string, errorOnWarnings?: boolean, ignoreUnusedConstantsWarnings?: boolean): Contract;
-    static script(path: string, errorOnWarnings?: boolean, ignoreUnusedConstantsWarnings?: boolean): Script;
+    static contract(path: string, compilerOptions?: Partial<CompilerOptions>): Contract;
+    static script(path: string, compilerOptions?: Partial<CompilerOptions>): Script;
     private saveArtifactsToFile;
     contractByCodeHash(codeHash: string): Contract;
     private saveProjectArtifactToFile;

package/dist/src/contract/contract.js

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toApiVal = exports.extractArray = exports.Script = exports.Contract = exports.Artifact = exports.Project = void 0;
+exports.toApiVal = exports.extractArray = exports.Script = exports.Contract = exports.Artifact = exports.Project = exports.DEFAULT_COMPILER_OPTIONS = void 0;
 const buffer_1 = require("buffer/");
 const cryptojs = __importStar(require("crypto-js"));
 const crypto = __importStar(require("crypto"));
@@ -54,6 +54,10 @@ var SourceType;
     SourceType[SourceType["AbstractContract"] = 2] = "AbstractContract";
     SourceType[SourceType["Interface"] = 3] = "Interface";
 })(SourceType || (SourceType = {}));
+exports.DEFAULT_COMPILER_OPTIONS = {
+    errorOnWarnings: true,
+    ignoreUnusedConstantsWarnings: true
+};
 class TypedMatcher {
     constructor(pattern, type) {
         this.matcher = new RegExp(pattern, 'mg');
@@ -130,13 +134,15 @@ class Project {
                 ? path
                 : this.contractsRootPath + '/' + path;
     }
-    static checkCompilerWarnings(warnings, errorOnWarnings, ignoreUnusedConstantsWarnings) {
-        const remains = ignoreUnusedConstantsWarnings ? warnings.filter((s) => !s.includes('unused constants')) : warnings;
+    static checkCompilerWarnings(warnings, compilerOptions) {
+        const remains = compilerOptions.ignoreUnusedConstantsWarnings
+            ? warnings.filter((s) => !s.includes('unused constants'))
+            : warnings;
         if (remains.length !== 0) {
             const prefixPerWarning = '  - ';
             const warningString = prefixPerWarning + remains.join('\n' + prefixPerWarning);
             const output = 'Compilation warnings:\n' + warningString + '\n';
-            if (errorOnWarnings) {
+            if (compilerOptions.errorOnWarnings) {
                 throw new Error(output);
             }
             else {
@@ -144,22 +150,22 @@ class Project {
             }
         }
     }
-    static contract(path, errorOnWarnings = true, ignoreUnusedConstantsWarnings = true) {
+    static contract(path, compilerOptions) {
         const contractPath = Project.currentProject.getContractPath(path);
         const contract = Project.currentProject.contracts.find((c) => c.sourceFile.contractPath === contractPath);
         if (typeof contract === 'undefined') {
             throw new Error(`Contract ${contractPath} does not exist`);
         }
-        Project.checkCompilerWarnings(contract.warnings, errorOnWarnings, ignoreUnusedConstantsWarnings);
+        Project.checkCompilerWarnings(contract.warnings, { ...exports.DEFAULT_COMPILER_OPTIONS, ...compilerOptions });
         return contract.artifact;
     }
-    static script(path, errorOnWarnings = true, ignoreUnusedConstantsWarnings = true) {
+    static script(path, compilerOptions) {
         const contractPath = Project.currentProject.getContractPath(path);
         const script = Project.currentProject.scripts.find((c) => c.sourceFile.contractPath === contractPath);
         if (typeof script === 'undefined') {
             throw new Error(`Script ${contractPath} does not exist`);
         }
-        Project.checkCompilerWarnings(script.warnings, errorOnWarnings, ignoreUnusedConstantsWarnings);
+        Project.checkCompilerWarnings(script.warnings, { ...exports.DEFAULT_COMPILER_OPTIONS, ...compilerOptions });
         return script.artifact;
     }
     async saveArtifactsToFile() {

package/package.json

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

package/src/contract/contract.ts

@@ -39,6 +39,16 @@ enum SourceType {
   Interface = 3
 }
 
+export type CompilerOptions = {
+  errorOnWarnings: boolean
+  ignoreUnusedConstantsWarnings: boolean
+}
+
+export const DEFAULT_COMPILER_OPTIONS: CompilerOptions = {
+  errorOnWarnings: true,
+  ignoreUnusedConstantsWarnings: true
+}
+
 class TypedMatcher<T extends SourceType> {
   matcher: RegExp
   type: T
@@ -174,17 +184,15 @@ export class Project {
       : this.contractsRootPath + '/' + path
   }
 
-  private static checkCompilerWarnings(
-    warnings: string[],
-    errorOnWarnings: boolean,
-    ignoreUnusedConstantsWarnings: boolean
-  ): void {
-    const remains = ignoreUnusedConstantsWarnings ? warnings.filter((s) => !s.includes('unused constants')) : warnings
+  private static checkCompilerWarnings(warnings: string[], compilerOptions: CompilerOptions): void {
+    const remains = compilerOptions.ignoreUnusedConstantsWarnings
+      ? warnings.filter((s) => !s.includes('unused constants'))
+      : warnings
     if (remains.length !== 0) {
       const prefixPerWarning = '  - '
       const warningString = prefixPerWarning + remains.join('\n' + prefixPerWarning)
       const output = 'Compilation warnings:\n' + warningString + '\n'
-      if (errorOnWarnings) {
+      if (compilerOptions.errorOnWarnings) {
         throw new Error(output)
       } else {
         console.log(output)
@@ -192,23 +200,23 @@ export class Project {
     }
   }
 
-  static contract(path: string, errorOnWarnings = true, ignoreUnusedConstantsWarnings = true): Contract {
+  static contract(path: string, compilerOptions?: Partial<CompilerOptions>): Contract {
     const contractPath = Project.currentProject.getContractPath(path)
     const contract = Project.currentProject.contracts.find((c) => c.sourceFile.contractPath === contractPath)
     if (typeof contract === 'undefined') {
       throw new Error(`Contract ${contractPath} does not exist`)
     }
-    Project.checkCompilerWarnings(contract.warnings, errorOnWarnings, ignoreUnusedConstantsWarnings)
+    Project.checkCompilerWarnings(contract.warnings, { ...DEFAULT_COMPILER_OPTIONS, ...compilerOptions })
     return contract.artifact
   }
 
-  static script(path: string, errorOnWarnings = true, ignoreUnusedConstantsWarnings = true): Script {
+  static script(path: string, compilerOptions?: Partial<CompilerOptions>): Script {
     const contractPath = Project.currentProject.getContractPath(path)
     const script = Project.currentProject.scripts.find((c) => c.sourceFile.contractPath === contractPath)
     if (typeof script === 'undefined') {
       throw new Error(`Script ${contractPath} does not exist`)
     }
-    Project.checkCompilerWarnings(script.warnings, errorOnWarnings, ignoreUnusedConstantsWarnings)
+    Project.checkCompilerWarnings(script.warnings, { ...DEFAULT_COMPILER_OPTIONS, ...compilerOptions })
     return script.artifact
   }
 

package/templates/base/package.json

@@ -12,7 +12,7 @@
     "stop-devnet": "node scripts/stop-devnet.js"
   },
   "dependencies": {
-    "@alephium/web3": "0.2.0-rc.5"
+    "@alephium/web3": "0.2.0-rc.6"
   },
   "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.5",
+    "@alephium/web3": "0.2.0-rc.6",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "react-scripts": "5.0.1",

package/test/contract.test.ts

@@ -30,12 +30,12 @@ describe('contract', function () {
     await Project.build(provider)
 
     // ignore unused private function warnings
-    const add = Project.contract('add/add.ral', false)
+    const add = Project.contract('add/add.ral', { errorOnWarnings: false })
     const sub = Project.contract('sub/sub.ral')
 
     const subState = sub.toState({ result: 0 }, { alphAmount: BigInt('1000000000000000000') })
     const testParams: TestContractParams = {
-      initialFields: { subContractId: subState.contractId, result: 0 },
+      initialFields: { sub: subState.contractId, result: 0 },
       testArgs: { array: [2, 1] },
       existingContracts: [subState]
     }
@@ -44,7 +44,7 @@ describe('contract', function () {
     expect(testResult.contracts[0].codeHash).toEqual(sub.codeHash)
     expect(testResult.contracts[0].fields.result).toEqual(1)
     expect(testResult.contracts[1].codeHash).toEqual(add.codeHash)
-    expect(testResult.contracts[1].fields.subContractId).toEqual(subState.contractId)
+    expect(testResult.contracts[1].fields.sub).toEqual(subState.contractId)
     expect(testResult.contracts[1].fields.result).toEqual(3)
     const events = testResult.events.sort((a, b) => a.name.localeCompare(b.name))
     expect(events[0].name).toEqual('Add')
@@ -73,7 +73,7 @@ describe('contract', function () {
     expect(subSubmitResult.txId).toEqual(subDeployTx.txId)
 
     const addDeployTx = await add.transactionForDeployment(signer, {
-      initialFields: { subContractId: subContractId, result: 0 },
+      initialFields: { sub: subContractId, result: 0 },
       initialTokenAmounts: []
     })
     expect(addDeployTx.fromGroup).toEqual(0)
@@ -90,7 +90,7 @@ describe('contract', function () {
     let fetchedSubState = await sub.fetchState(subContractAddress, 0)
     expect(fetchedSubState.fields.result).toEqual(0)
     let fetchedAddState = await add.fetchState(addContractAddress, 0)
-    expect(fetchedAddState.fields.subContractId).toEqual(subContractId)
+    expect(fetchedAddState.fields.sub).toEqual(subContractId)
     expect(fetchedAddState.fields.result).toEqual(0)
 
     const main = Project.script('main.ral')
@@ -107,7 +107,7 @@ describe('contract', function () {
     fetchedSubState = await sub.fetchState(subContractAddress, 0)
     expect(fetchedSubState.fields.result).toEqual(1)
     fetchedAddState = await add.fetchState(addContractAddress, 0)
-    expect(fetchedAddState.fields.subContractId).toEqual(subContractId)
+    expect(fetchedAddState.fields.sub).toEqual(subContractId)
     expect(fetchedAddState.fields.result).toEqual(3)
   }
 
@@ -190,7 +190,7 @@ describe('contract', function () {
   it('should extract metadata of contracts', async () => {
     const provider = new NodeProvider('http://127.0.0.1:22973')
     await Project.build(provider)
-    const contract = Project.contract('test/metadata.ral', false)
+    const contract = Project.contract('test/metadata.ral', { errorOnWarnings: false })
     expect(contract.functions.map((func) => func.name)).toEqual(['foo', 'bar', 'baz'])
     expect(contract.publicFunctions()).toEqual(['foo'])
     expect(contract.usingPreapprovedAssetsFunctions()).toEqual(['foo'])
@@ -200,13 +200,13 @@ describe('contract', function () {
   it('should handle compiler warnings', async () => {
     const provider = new NodeProvider('http://127.0.0.1:22973')
     await Project.build(provider)
-    const contract = Project.contract('test/warnings.ral', false)
+    const contract = Project.contract('test/warnings.ral', { errorOnWarnings: false })
     expect(contract.publicFunctions()).toEqual(['foo'])
 
     expect(() => Project.contract('test/warnings.ral')).toThrowError(
       'Compilation warnings:\n  - Found unused variables in Warnings: foo.y\n  - Found unused fields in Warnings: b'
     )
-    expect(() => Project.contract('test/warnings.ral', true, false)).toThrowError(
+    expect(() => Project.contract('test/warnings.ral', { ignoreUnusedConstantsWarnings: false })).toThrowError(
       'Compilation warnings:\n  - Found unused variables in Warnings: foo.y\n  - Found unused constants in Warnings: C\n  - Found unused fields in Warnings: b'
     )
   })

package/test/events.test.ts

@@ -38,9 +38,9 @@ describe('events', function () {
     expect(subSubmitResult.txId).toEqual(subDeployTx.txId)
 
     // ignore unused private function warnings
-    const add = Project.contract('add/add.ral', false)
+    const add = Project.contract('add/add.ral', { errorOnWarnings: false })
     const addDeployTx = await add.transactionForDeployment(signer, {
-      initialFields: { subContractId: subContractId, result: 0 },
+      initialFields: { sub: subContractId, result: 0 },
       initialTokenAmounts: []
     })
     const addSubmitResult = await signer.submitTransaction(addDeployTx.unsignedTx, addDeployTx.txId)