@aztec/cli 0.7.9 → 0.8.4

package/package.json

@@ -1,15 +1,47 @@
 {
   "name": "@aztec/cli",
-  "version": "0.7.9",
-  "main": "./dest/index.js",
+  "version": "0.8.4",
   "type": "module",
+  "main": "./dest/index.js",
+  "bin": {
+    "aztec-cli": "./dest/bin/index.js"
+  },
+  "typedocOptions": {
+    "entryPoints": [
+      "./src/index.ts"
+    ],
+    "name": "Aztec CLI",
+    "tsconfig": "./tsconfig.json"
+  },
+  "scripts": {
+    "build": "yarn clean && tsc -b",
+    "build:dev": "tsc -b --watch",
+    "clean": "rm -rf ./dest .tsbuildinfo",
+    "formatting": "run -T prettier --check ./src && run -T eslint ./src",
+    "formatting:fix": "run -T prettier -w ./src",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --passWithNoTests",
+    "start": "node --no-warnings ./dest/bin/index.js"
+  },
+  "inherits": [
+    "../package.common.json"
+  ],
+  "jest": {
+    "preset": "ts-jest/presets/default-esm",
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.m?js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src"
+  },
   "dependencies": {
-    "@aztec/aztec.js": "0.7.9",
-    "@aztec/ethereum": "0.7.9",
-    "@aztec/foundation": "0.7.9",
-    "@aztec/noir-compiler": "0.7.9",
-    "@aztec/noir-contracts": "0.7.9",
-    "@aztec/types": "0.7.9",
+    "@aztec/aztec.js": "0.8.4",
+    "@aztec/ethereum": "0.8.4",
+    "@aztec/foundation": "0.8.4",
+    "@aztec/l1-artifacts": "0.8.4",
+    "@aztec/noir-compiler": "0.8.4",
+    "@aztec/noir-contracts": "0.8.4",
+    "@aztec/types": "0.8.4",
+    "@libp2p/peer-id-factory": "^3.0.4",
     "commander": "^9.0.0",
     "jszip": "^3.10.1",
     "lodash.startcase": "^4.4.0",
@@ -18,7 +50,26 @@
     "tslib": "^2.4.0",
     "viem": "^1.2.5"
   },
-  "bin": {
-    "aztec-cli": "./dest/bin/index.js"
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@rushstack/eslint-patch": "^1.1.4",
+    "@types/jest": "^29.5.0",
+    "@types/lodash.startcase": "^4.4.7",
+    "@types/node": "^18.7.23",
+    "@types/semver": "^7.5.2",
+    "jest": "^29.5.0",
+    "jest-mock-extended": "^3.0.5",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "dest",
+    "src",
+    "!*.test.*"
+  ],
+  "types": "./dest/index.d.ts",
+  "engines": {
+    "node": ">=18"
   }
 }

package/src/client.ts

@@ -1,4 +1,4 @@
-import { AztecRPC, createAztecRpcClient } from '@aztec/aztec.js';
+import { PXE, createPXEClient } from '@aztec/aztec.js';
 import { DebugLogger } from '@aztec/foundation/log';
 import { fileURLToPath } from '@aztec/foundation/url';
 
@@ -7,51 +7,42 @@ import { dirname, resolve } from 'path';
 import { gtr, ltr, satisfies, valid } from 'semver';
 
 /**
- * Creates an Aztec RPC client with a given set of retries on non-server errors.
- * @param rpcUrl - URL of the RPC server.
- * @returns An RPC client.
- */
-export function createClient(rpcUrl: string) {
-  return createAztecRpcClient(rpcUrl);
-}
-
-/**
- * Creates an Aztec RPC client with a given set of retries on non-server errors.
- * Checks that the RPC server matches the expected version, and warns if not.
- * @param rpcUrl - URL of the RPC server.
+ * Creates a PXE client with a given set of retries on non-server errors.
+ * Checks that PXE matches the expected version, and warns if not.
+ * @param rpcUrl - URL of the RPC server wrapping the PXE.
  * @param logger - Debug logger to warn version incompatibilities.
- * @returns An RPC client.
+ * @returns A PXE client.
  */
 export async function createCompatibleClient(rpcUrl: string, logger: DebugLogger) {
-  const client = createClient(rpcUrl);
+  const pxe = createPXEClient(rpcUrl);
   const packageJsonPath = resolve(dirname(fileURLToPath(import.meta.url)), '../package.json');
   const packageJsonContents = JSON.parse(readFileSync(packageJsonPath).toString());
   const expectedVersionRange = packageJsonContents.version; // During sandbox, we'll expect exact matches
 
   try {
-    await checkServerVersion(client, expectedVersionRange);
+    await checkServerVersion(pxe, expectedVersionRange);
   } catch (err) {
     if (err instanceof VersionMismatchError) {
-      logger.debug(err.message);
+      logger.warn(err.message);
     } else {
       throw err;
     }
   }
 
-  return client;
+  return pxe;
 }
 
 /** Mismatch between server and client versions. */
 class VersionMismatchError extends Error {}
 
 /**
- * Checks that the RPC server version matches the expected one by this CLI. Throws if not.
- * @param rpc - RPC server connection.
+ * Checks that Private eXecution Environment (PXE) version matches the expected one by this CLI. Throws if not.
+ * @param pxe - PXE client.
  * @param expectedVersionRange - Expected version by CLI.
  */
-export async function checkServerVersion(rpc: AztecRPC, expectedVersionRange: string) {
+export async function checkServerVersion(pxe: PXE, expectedVersionRange: string) {
   const serverName = 'Aztec Sandbox';
-  const { sandboxVersion } = await rpc.getNodeInfo();
+  const { sandboxVersion } = await pxe.getNodeInfo();
   if (!sandboxVersion) {
     throw new VersionMismatchError(`Couldn't determine ${serverName} version. You may run into issues.`);
   }

package/src/encoding.ts

@@ -72,12 +72,12 @@ function encodeArg(arg: string, abiType: ABIType, name: string): any {
       throw new Error(`Unable to parse arg ${arg} as struct`);
     }
     if (Array.isArray(obj)) throw Error(`Array passed for arg ${name}. Expected a struct.`);
-    const res = [];
+    const res: any = {};
     for (const field of abiType.fields) {
       // Remove field name from list as it's present
       const arg = obj[field.name];
       if (!arg) throw Error(`Expected field ${field.name} not found in struct ${name}.`);
-      res.push(encodeArg(obj[field.name], field.type, field.name));
+      res[field.name] = encodeArg(obj[field.name], field.type, field.name);
     }
     return res;
   }
@@ -91,13 +91,13 @@ function encodeArg(arg: string, abiType: ABIType, name: string): any {
 export function encodeArgs(args: any[], params: ABIParameter[]) {
   if (args.length !== params.length) {
     throw new Error(
-      `Invalid number of args provided. Expected: ${params.length}, received: ${args.length}\nReceived args: ${args}`,
+      `Invalid args provided.\nExpected args: [${params
+        .map(param => param.name + ': ' + param.type.kind)
+        .join(', ')}]\nReceived args: ${args.join(', ')}`,
     );
   }
-  return args
-    .map((arg: any, index) => {
-      const { type, name } = params[index];
-      return encodeArg(arg, type, name);
-    })
-    .flat();
+  return args.map((arg: any, index) => {
+    const { type, name } = params[index];
+    return encodeArg(arg, type, name);
+  });
 }