fix/versions (#30)

* fix: readme and enumable version

* 0.2.12

* export type

Author: djm07073

README.md

@@ -80,6 +80,27 @@ async function readExample() {
 }
 ```
 
+### Test Move Package
+```ts
+import { MoveBuilder } from '@initia/builder.js';
+
+async function testExample() {
+    const builder = new MoveBuilder(path.resolve(__dirname, 'moon_coin'), {});
+    // test module with options
+    const testResult = await builder.test({
+      filter: '...',
+      reportStatistics: true,
+      reportStorageOnError: true,
+      ignoreCompileWarnings: true,
+      computeCoverage: true,
+    })
+    console.log(testResult) // 'ok'
+}
+```
+> **⚠ WARNING:**  
+> If the test fails due to a native function conflict, note that `builder.js` always follows the latest MoveVM version.  
+> If you are using an older version of MoveVM, you need to replace the library used in `@initia/builder.js/library`.  
+> You should replace the `.so` files in `node_modules/@initia/builder.js/library` with the `.so` libraries from the movevm version you are using.  
 ## Options
 
 For more details on the available options, refer to the [source code](src/types/options.ts).

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@initia/builder.js",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "description": "The JavaScript Move Builder for Initia",
   "license": "MIT",
   "author": "Initia Foundation",

package.json

@@ -14,13 +14,16 @@ import {
   DecodedModuleBytes,
   DecodedScriptBytes,
   ModuleInfo,
+  BytecodeVersion,
+  LanguageVersion,
+  CompilerVersion,
 } from './types'
 
 type ModuleName = string
 
-const DEFAULT_BYTECODE_VERSION = 7
-const DEFAULT_LANGUAGE_VERSION = '2'
-const DEFAULT_COMPILER_VERSION = '2'
+const DEFAULT_BYTECODE_VERSION = BytecodeVersion.V7
+const DEFAULT_LANGUAGE_VERSION = LanguageVersion.V2_1
+const DEFAULT_COMPILER_VERSION = CompilerVersion.V2_1
 export class MoveBuilder {
   private readonly packagePath: string
   private buildOptions: BuildOptions

src/builder.ts

@@ -5,5 +5,8 @@ export {
   ModuleInfo,
   DecodedModuleBytes,
   DecodedScriptBytes,
+  BytecodeVersion,
+  CompilerVersion,
+  LanguageVersion,
 } from './types'
 export * from './builder'

src/index.ts

@@ -1,3 +1,20 @@
+export enum BytecodeVersion {
+  V6 = 6,
+  V7 = 7,
+}
+
+export enum LanguageVersion {
+  V1 = '1',
+  V2_0 = '2.0',
+  V2_1 = '2.1',
+}
+
+export enum CompilerVersion {
+  V1 = '1',
+  V2_0 = '2.0',
+  V2_1 = '2.1',
+}
+
 export interface BuildOptions {
   /**
    * Compile in 'dev' mode. The 'dev-addresses' and 'dev-dependencies' fields will be used if
@@ -43,19 +60,19 @@ export interface BuildOptions {
   skipFetchLatestGitDeps?: boolean
 
   /**
-   * Bytecode version. Set to 0 to unset and use default.
+   * Bytecode version. unset and use default.
    */
-  bytecodeVersion?: number
+  bytecodeVersion?: BytecodeVersion
 
   /**
-   * Compiler version. Set to 0 to unset and use default.
+   * Compiler version. unset and use default.
    */
-  compilerVersion?: string
+  compilerVersion?: CompilerVersion
 
   /**
-   * Language version. Set to 0 to unset and use default.
+   * Language version. unset and use default.
    */
-  languageVersion?: string
+  languageVersion?: LanguageVersion
 
   /**
    * Additional named address mapping. Useful for tools in Rust.

src/types/options.ts

@@ -1,6 +1,7 @@
 import path from 'path'
 import { readFile } from 'fs/promises'
 import { MoveBuilder } from '../src/builder'
+import { BytecodeVersion, CompilerVersion, LanguageVersion } from '../src/types'
 
 describe('build move package', () => {
   const contractDir = path.resolve(__dirname, 'contract/dummy')
@@ -12,9 +13,9 @@ describe('build move package', () => {
     forceRecompilation: true,
     fetchDepsOnly: true,
     skipFetchLatestGitDeps: true,
-    bytecodeVersion: 7,
-    compilerVersion: '2',
-    languageVersion: '1',
+    bytecodeVersion: BytecodeVersion.V7,
+    compilerVersion: CompilerVersion.V2_1,
+    languageVersion: LanguageVersion.V2_1,
     additionalNamedAddresses: [['test', '0x4']],
   })
   const dummyModulePath = path.join(
@@ -25,9 +26,9 @@ describe('build move package', () => {
 
   it('get default values of move builder', () => {
     expect(MoveBuilder.getDefaultVersions()).toEqual({
-      bytecodeVersion: 7,
-      compilerVersion: '2',
-      languageVersion: '2',
+      bytecodeVersion: BytecodeVersion.V7,
+      compilerVersion: CompilerVersion.V2_1,
+      languageVersion: LanguageVersion.V2_1,
     })
   })