@mimicprotocol/cli 0.0.1-rc.30 → 0.0.1-rc.32

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @mimicprotocol/cli
 
+## 0.0.1-rc.32
+
+### Patch Changes
+
+- 8853afe: Fix clashing Result import
+- e1277c7: Refactor Result to use unwrap instead of value
+- 323663a: Change directory to positional argument in init and test command
+- faac37c: Ensure early returns in favor of else blocks
+
+## 0.0.1-rc.31
+
+### Patch Changes
+
+- 1e48dff: Bump runner-node to version 0.0.1-rc.8
+
 ## 0.0.1-rc.30
 
 ### Patch Changes

package/dist/commands/init.js

@@ -45,8 +45,9 @@ const packageManager_1 = require("../lib/packageManager");
 const log_1 = __importDefault(require("../log"));
 class Init extends core_1.Command {
     async run() {
-        const { flags } = await this.parse(Init);
-        const { directory, force } = flags;
+        const { args, flags } = await this.parse(Init);
+        const { directory } = args;
+        const { force } = flags;
         const fullDirectory = path.resolve(directory);
         if (force && fs.existsSync(fullDirectory) && fs.readdirSync(fullDirectory).length > 0) {
             const shouldDelete = process.env.NODE_ENV === 'test'
@@ -73,7 +74,7 @@ class Init extends core_1.Command {
             this.error(`Directory ${log_1.default.highlightText(fullDirectory)} is not empty`, {
                 code: 'DirectoryNotEmpty',
                 suggestions: [
-                    'You can specify the directory with --directory',
+                    'You can specify the directory as a positional argument',
                     `You can ${log_1.default.warnText('overwrite')} an existing directory with --force`,
                 ],
             });
@@ -107,9 +108,11 @@ class Init extends core_1.Command {
     }
 }
 Init.description = 'Initializes a new Mimic-compatible project structure in the specified directory';
-Init.examples = ['<%= config.bin %> <%= command.id %> --directory ./new-project --force'];
+Init.examples = ['<%= config.bin %> <%= command.id %> ./new-project --force'];
+Init.args = {
+    directory: core_1.Args.string({ description: 'Directory to initialize project', required: false, default: './' }),
+};
 Init.flags = {
-    directory: core_1.Flags.string({ char: 'd', description: 'Directory to initialize project', default: './' }),
     force: core_1.Flags.boolean({ char: 'f', description: 'Overwrite existing files if they already exist', default: false }),
 };
 exports.default = Init;

package/dist/commands/test.js

@@ -34,20 +34,16 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
-const child_process_1 = require("child_process");
 const path = __importStar(require("path"));
 const packageManager_1 = require("../lib/packageManager");
 class Test extends core_1.Command {
-    runOrExit(cmd, args, cwd) {
-        const result = (0, child_process_1.spawnSync)(cmd, args, { cwd, stdio: 'inherit' });
-        if (result.status !== 0)
-            this.exit(result.status ?? 1);
-    }
     async run() {
-        const { flags } = await this.parse(Test);
-        const baseDir = path.resolve(flags.directory);
+        const { args, flags } = await this.parse(Test);
+        const { directory } = args;
+        const { 'skip-compile': skipCompile } = flags;
+        const baseDir = path.resolve(directory);
         const testPath = path.join(baseDir, 'tests');
-        if (!flags.skipCompile) {
+        if (!skipCompile) {
             const cg = (0, packageManager_1.execBinCommand)('mimic', ['codegen'], baseDir);
             if (cg.status !== 0)
                 this.exit(cg.status ?? 1);
@@ -60,9 +56,11 @@ class Test extends core_1.Command {
     }
 }
 Test.description = 'Runs task tests';
-Test.examples = ['<%= config.bin %> <%= command.id %> --directory ./'];
+Test.examples = ['<%= config.bin %> <%= command.id %> ./'];
+Test.args = {
+    directory: core_1.Args.string({ description: 'task directory', required: false, default: './' }),
+};
 Test.flags = {
-    directory: core_1.Flags.string({ char: 'd', description: 'task directory', default: './' }),
-    skipCompile: core_1.Flags.boolean({ description: 'skip codegen and compile steps' }),
+    'skip-compile': core_1.Flags.boolean({ description: 'skip codegen and compile steps' }),
 };
 exports.default = Test;

package/dist/lib/AbisInterfaceGenerator/FunctionHandler.js

@@ -91,14 +91,18 @@ class FunctionHandler {
         const methodName = fn.escapedName || fn.name;
         const capitalizedName = this.getCapitalizedName(fn);
         const isPayable = fn.stateMutability === 'payable';
-        const fullMethodParams = methodParams.concat(isPayable ? `${methodParams.length > 0 ? ', ' : ''}value: ${types_1.LibTypes.BigInt}` : '');
+        const hasValueParameter = inputs.some((input) => input.escapedName === 'value');
+        const payableParamName = isPayable && hasValueParameter ? '_payableValue' : 'value';
+        const fullMethodParams = methodParams.concat(isPayable
+            ? `${methodParams.length > 0 ? ', ' : ''}${payableParamName}: ${types_1.LibTypes.BigInt} = ${types_1.LibTypes.BigInt}.zero()`
+            : '');
         lines.push(`${methodName}(${fullMethodParams}): ${returnType} {`);
         lines.push(`const encodedData = ${contractName}Utils.encode${capitalizedName}(${inputs.map((p) => p.escapedName).join(', ')})`);
         importManager.addType(types_1.LibTypes.Bytes);
         importManager.addType('EvmCallBuilder');
         if (isPayable)
             importManager.addType(types_1.LibTypes.BigInt);
-        lines.push(`return EvmCallBuilder.forChain(this._chainId).addCall(this._address, encodedData${isPayable ? ', value' : ''})`);
+        lines.push(`return EvmCallBuilder.forChain(this._chainId).addCall(this._address, encodedData${isPayable ? `, ${payableParamName}` : ''})`);
         lines.push(`}`);
         lines.push('');
     }
@@ -113,18 +117,21 @@ class FunctionHandler {
         const isVoid = returnType === 'void';
         if (isVoid)
             importManager.addType(types_1.LibTypes.Void);
-        const resultReturnType = isVoid ? `Result<${types_1.LibTypes.Void}, string>` : `Result<${returnType}, string>`;
+        const resultIdentifier = NameManager_1.default.getImportNameForCode('Result');
+        const resultReturnType = isVoid
+            ? `${resultIdentifier}<${types_1.LibTypes.Void}, string>`
+            : `${resultIdentifier}<${returnType}, string>`;
         lines.push(`${methodName}(${methodParams}): ${resultReturnType} {`);
         lines.push(`const encodedData = ${contractName}Utils.encode${capitalizedName}(${inputs.map((p) => p.escapedName).join(', ')})`);
         const contractCallLine = `environment.evmCallQuery(this._address, this._chainId, encodedData.toHexString(), this._timestamp)`;
         lines.push(`const response = ${contractCallLine}`);
-        lines.push(`if (response.isError) return Result.err<${isVoid ? types_1.LibTypes.Void : returnType}, string>(response.error)`);
+        lines.push(`if (response.isError) return ${resultIdentifier}.err<${isVoid ? types_1.LibTypes.Void : returnType}, string>(response.error)`);
         if (isVoid) {
-            lines.push(`return Result.ok<${types_1.LibTypes.Void}, string>(new ${types_1.LibTypes.Void}())`);
+            lines.push(`return ${resultIdentifier}.ok<${types_1.LibTypes.Void}, string>(new ${types_1.LibTypes.Void}())`);
         }
         else {
-            lines.push(`const decoded = ${contractName}Utils.decode${capitalizedName}(response.value)`);
-            lines.push(`return Result.ok<${returnType}, string>(decoded)`);
+            lines.push(`const decoded = ${contractName}Utils.decode${capitalizedName}(response.unwrap())`);
+            lines.push(`return ${resultIdentifier}.ok<${returnType}, string>(decoded)`);
         }
         lines.push(`}`);
         lines.push('');

package/dist/lib/AbisInterfaceGenerator/ImportManager.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const NameManager_1 = __importDefault(require("./NameManager"));
 class ImportManager {
     constructor() {
         this.types = new Set();
@@ -11,7 +15,8 @@ class ImportManager {
         if (this.types.size === 0)
             return '';
         const sortedTypes = [...this.types].sort((a, b) => String(a).localeCompare(String(b)));
-        return `import { ${sortedTypes.join(', ')} } from '@mimicprotocol/lib-ts'`;
+        const importIdentifiers = sortedTypes.map((type) => NameManager_1.default.formatImportStatement(type));
+        return `import { ${importIdentifiers.join(', ')} } from '@mimicprotocol/lib-ts'`;
     }
 }
 exports.default = ImportManager;

package/dist/lib/AbisInterfaceGenerator/NameManager.js

@@ -1,14 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NameContext = void 0;
-const types_1 = require("../../types");
 var NameContext;
 (function (NameContext) {
     NameContext["FUNCTION_PARAMETER"] = "function_parameter";
     NameContext["LOCAL_VARIABLE"] = "local_variable";
     NameContext["CLASS_PROPERTY"] = "class_property";
     NameContext["METHOD_NAME"] = "method_name";
-    NameContext["TUPLE_CLASS_NAME"] = "tuple_class_name";
 })(NameContext || (exports.NameContext = NameContext = {}));
 class NameManager {
     static resolveNameConflicts(names, context) {
@@ -41,6 +39,17 @@ class NameManager {
             escapedName: resolvedNames[index],
         }));
     }
+    static getImportNameForCode(type) {
+        const alias = this.getImportAlias(type);
+        return alias ?? type;
+    }
+    static formatImportStatement(type) {
+        const alias = this.getImportAlias(type);
+        return alias ? `${type} as ${alias}` : type;
+    }
+    static getImportAlias(type) {
+        return this.IMPORT_ALIASES[type] ?? null;
+    }
     static hasConflict(name, context) {
         if (this.RESERVED_BY_CONTEXT[context]?.has(name))
             return true;
@@ -68,13 +77,14 @@ class NameManager {
                 return '_prop';
             case NameContext.METHOD_NAME:
                 return '_';
-            case NameContext.TUPLE_CLASS_NAME:
-                return '_class';
             default:
                 return '_safe';
         }
     }
 }
+NameManager.IMPORT_ALIASES = {
+    Result: '_Result',
+};
 NameManager.RESERVED_BY_CONTEXT = {
     [NameContext.FUNCTION_PARAMETER]: new Set([
         'response',
@@ -97,7 +107,6 @@ NameManager.RESERVED_BY_CONTEXT = {
         'timestamp',
     ]),
     [NameContext.METHOD_NAME]: new Set(['constructor']),
-    [NameContext.TUPLE_CLASS_NAME]: new Set([...Object.values(types_1.LibTypes), 'JSON']),
 };
 NameManager.INTERNAL_NAME_PATTERNS = [/^item\d+$/, /^s\d+$/];
 exports.default = NameManager;

package/dist/lib/AbisInterfaceGenerator/TupleHandler.js

@@ -103,7 +103,6 @@ class TupleHandler {
                 if (structMatch && structMatch[1])
                     className = structMatch[1];
             }
-            className = NameManager_1.default.escapeName(className, NameManager_1.NameContext.TUPLE_CLASS_NAME);
             const key = baseInternalType || className;
             const components = this.resolveComponentNames(tupleToDefine.components, NameManager_1.NameContext.CLASS_PROPERTY);
             tupleDefinitions.set(key, {

package/dist/types.js

@@ -7,9 +7,9 @@ var LibTypes;
     LibTypes["Address"] = "Address";
     LibTypes["Bytes"] = "Bytes";
     LibTypes["ChainId"] = "ChainId";
-    LibTypes["TokenAmount"] = "TokenAmount";
     LibTypes["Void"] = "Void";
     LibTypes["Result"] = "Result";
+    LibTypes["JSON"] = "JSON";
 })(LibTypes || (exports.LibTypes = LibTypes = {}));
 var AssemblyPrimitiveTypes;
 (function (AssemblyPrimitiveTypes) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimicprotocol/cli",
-  "version": "0.0.1-rc.30",
+  "version": "0.0.1-rc.32",
   "license": "GPL-3.0",
   "private": false,
   "type": "commonjs",