Feat: localnet subcommand

.github/workflows/secrets_scanner.yaml

@@ -0,0 +1,17 @@
+name: Leaked Secrets Scan
+on: [pull_request]
+jobs:
+  TruffleHog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
+        with:
+          fetch-depth: 0
+      - name: TruffleHog OSS
+        uses: trufflesecurity/trufflehog@0c66d30c1f4075cee1aada2e1ab46dabb1b0071a
+        with:
+          path: ./
+          base: ${{ github.event.repository.default_branch }}
+          head: HEAD
+          extra_args: --debug --only-verified

bin/index.js

@@ -12,7 +12,8 @@ const figlet_1 = __importDefault(require("figlet"));
 const create_1 = __importDefault(require("./create"));
 const deposit_1 = __importDefault(require("./deposit"));
 const withdraw_1 = __importDefault(require("./withdraw"));
-const availableOptions = ['create', 'deposit', 'withdraw'];
+const localnet_1 = __importDefault(require("./localnet"));
+const availableOptions = ['create', 'deposit', 'withdraw', 'localnet'];
 // second argument should be the selected option
 const option = process.argv[2];
 if (!availableOptions.includes(option)) {
@@ -33,4 +34,8 @@ switch (option) {
     case 'withdraw':
         (0, withdraw_1.default)();
         break;
+    case 'localnet':
+        const subcommandName = process.argv[3] || undefined;
+        (0, localnet_1.default)(subcommandName);
+        break;
 }

bin/localnet.d.ts

@@ -0,0 +1 @@
+export default function (operationName: string | undefined): Promise<void>;

bin/localnet.js

@@ -0,0 +1,140 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const os = __importStar(require("os"));
+// ---------------------------------------------------------------------------------------
+// Utilities
+// ---------------------------------------------------------------------------------------
+function runCommand(command, options) {
+    const defaultOptions = { cwd: repoDirectory(), encoding: 'utf-8' };
+    const unifiedOptions = Object.assign(Object.assign({}, defaultOptions), options);
+    return (0, child_process_1.execSync)(command, unifiedOptions).toString();
+}
+function repoDirectory() {
+    const xdgStateHome = process.env.XDG_STATE_HOME || path.join(os.homedir(), ".local/state");
+    return path.join(xdgStateHome, "zksync-cli/local-setup");
+}
+function isRepoCloned() {
+    return fs.existsSync(repoDirectory());
+}
+function cloneRepo() {
+    const parentDirectory = path.join(repoDirectory(), "..");
+    runCommand(`mkdir -p "${parentDirectory}"`);
+    const options = { cwd: parentDirectory };
+    runCommand("git clone https://github.com/matter-labs/local-setup.git", options);
+}
+function createStartInBackgroundScript() {
+    runCommand("sed 's/^docker-compose up$/docker-compose up --detach/' start.sh > start-background.sh");
+    runCommand("chmod +x start-background.sh");
+}
+function setUp() {
+    cloneRepo();
+    createStartInBackgroundScript();
+}
+// ---------------------------------------------------------------------------------------
+// Localnet operations
+// ---------------------------------------------------------------------------------------
+function logs() {
+    const options = { stdio: 'inherit' };
+    runCommand("docker-compose logs --follow", options);
+    return 0;
+}
+function up() {
+    if (!isRepoCloned()) {
+        setUp();
+    }
+    runCommand("./start-background.sh");
+    return 0;
+}
+function down() {
+    runCommand("docker-compose down");
+    return 0;
+}
+function clear() {
+    runCommand("./clear.sh");
+    return 0;
+}
+function wallets() {
+    const rawJSON = fs.readFileSync(path.join(repoDirectory(), "rich-wallets.json")).toString();
+    const wallets = JSON.parse(rawJSON);
+    console.log(wallets);
+    return 0;
+}
+// ---------------------------------------------------------------------------------------
+// Command handling
+// ---------------------------------------------------------------------------------------
+function help() {
+    console.log("USAGE: zksync-cli localnet <operation>");
+    console.log("");
+    console.log("Manage local L1 and L2 chains");
+    console.log("");
+    console.log("Available operations");
+    console.log('  up      -- Start L1 and L2 localnets');
+    console.log('  down    -- Stop L1 and L2 localnets');
+    console.log('  clear   -- Reset the localnet state');
+    console.log('  logs    -- Display logs');
+    console.log('  help    -- Display this message and quit');
+    console.log('  wallets -- Display seeded wallet keys');
+    return 0;
+}
+function handleUndefinedOperation() {
+    console.error("No operation provided");
+    help();
+    return 1;
+}
+function handleInvalidOperation(operationName) {
+    const validOperationNames = Array.from(operationHandlers.keys());
+    console.error('Invalid operation: ', operationName);
+    help();
+    return 1;
+}
+const operationHandlers = new Map([
+    ['up', up],
+    ['down', down],
+    ['logs', logs],
+    ['help', help],
+    ['wallets', wallets],
+    ['clear', clear],
+    [undefined, handleUndefinedOperation],
+]);
+function default_1(operationName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const handler = operationHandlers.get(operationName) || (() => handleInvalidOperation(operationName));
+        process.exit(handler());
+    });
+}
+exports.default = default_1;

src/index.ts

@@ -10,8 +10,9 @@ import figlet from 'figlet';
 import create from './create';
 import deposit from './deposit';
 import withdraw from './withdraw';
+import localnet from './localnet';
 
-const availableOptions: string[] = ['create', 'deposit', 'withdraw'];
+const availableOptions: string[] = ['create', 'deposit', 'withdraw', 'localnet'];
 
 // second argument should be the selected option
 const option: string = process.argv[2];
@@ -43,4 +44,8 @@ switch (option) {
   case 'withdraw':
     withdraw();
     break;
+  case 'localnet':
+    const subcommandName = process.argv[3] || undefined;
+    localnet(subcommandName);
+    break;
 }

src/localnet.ts

@@ -0,0 +1,122 @@
+import { execSync, ExecSyncOptions } from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs';
+import * as os from 'os';
+
+// ---------------------------------------------------------------------------------------
+// Utilities
+// ---------------------------------------------------------------------------------------
+
+function runCommand(command: string, options?: ExecSyncOptions): string {
+    const defaultOptions: ExecSyncOptions = { cwd: repoDirectory(), encoding: 'utf-8' };
+    const unifiedOptions: ExecSyncOptions = {...defaultOptions, ...options};
+    return execSync(command, unifiedOptions).toString();
+}
+
+function repoDirectory(): string {
+    const xdgStateHome = process.env.XDG_STATE_HOME || path.join(os.homedir(), ".local/state");
+    return path.join(xdgStateHome, "zksync-cli/local-setup");
+}
+
+function isRepoCloned(): boolean {
+    return fs.existsSync(repoDirectory());
+}
+
+function cloneRepo() {
+    const parentDirectory = path.join(repoDirectory(), "..");
+    runCommand(`mkdir -p "${parentDirectory}"`);
+    const options: ExecSyncOptions = { cwd: parentDirectory };
+    runCommand("git clone https://github.com/matter-labs/local-setup.git", options);
+}
+
+function createStartInBackgroundScript() {
+    runCommand("sed 's/^docker-compose up$/docker-compose up --detach/' start.sh > start-background.sh");
+    runCommand("chmod +x start-background.sh");
+}
+
+function setUp() {
+    cloneRepo();
+    createStartInBackgroundScript();
+}
+
+// ---------------------------------------------------------------------------------------
+// Localnet operations
+// ---------------------------------------------------------------------------------------
+
+function logs(): number {
+    const options: ExecSyncOptions = { stdio: 'inherit' };
+    runCommand("docker-compose logs --follow", options);
+    return 0;
+}
+
+function up(): number {
+    if (! isRepoCloned()) {
+        setUp();
+    }
+    runCommand("./start-background.sh")
+    return 0;
+}
+
+function down(): number {
+    runCommand("docker-compose down");
+    return 0;
+}
+
+function clear(): number {
+    runCommand("./clear.sh")
+    return 0;
+}
+
+function wallets(): number {
+    const rawJSON = fs.readFileSync(path.join(repoDirectory(), "rich-wallets.json")).toString();
+    const wallets = JSON.parse(rawJSON);
+    console.log(wallets);
+    return 0;
+}
+
+// ---------------------------------------------------------------------------------------
+// Command handling
+// ---------------------------------------------------------------------------------------
+
+function help(): number {
+    console.log("USAGE: zksync-cli localnet <operation>");
+    console.log("");
+    console.log("Manage local L1 and L2 chains");
+    console.log("");
+    console.log("Available operations");
+    console.log('  up      -- Start L1 and L2 localnets');
+    console.log('  down    -- Stop L1 and L2 localnets');
+    console.log('  clear   -- Reset the localnet state');
+    console.log('  logs    -- Display logs');
+    console.log('  help    -- Display this message and quit');
+    console.log('  wallets -- Display seeded wallet keys');
+    return 0;
+}
+
+function handleUndefinedOperation(): number {
+    console.error("No operation provided");
+    help();
+    return 1;
+}
+
+function handleInvalidOperation(operationName: string): number {
+    const validOperationNames = Array.from(operationHandlers.keys());
+    console.error('Invalid operation: ', operationName);
+    help();
+    return 1;
+}
+
+const operationHandlers = new Map<string | undefined, () => number>([
+    ['up', up],
+    ['down', down],
+    ['logs', logs],
+    ['help', help],
+    ['wallets', wallets],
+    ['clear', clear],
+    [undefined, handleUndefinedOperation],
+]);
+
+export default async function (operationName: string | undefined) {
+    const handler = operationHandlers.get(operationName) || (() => handleInvalidOperation(operationName!));
+    process.exit(handler());
+}