@cartesi/cli 2.0.0-alpha.2 → 2.0.0-alpha.21

package/dist/commands/hash.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../src/commands/hash.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,WAAW,CAAC,OAAO,WAAW,CAAC;IACpE,MAAM,CAAC,OAAO,SAA0D;IAExE,MAAM,CAAC,WAAW,SAC2F;IAE7G,OAAc,cAAc,UAAQ;IAEvB,GAAG;;;CAgBnB"}
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../src/commands/hash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAItD,eAAO,MAAM,iBAAiB;;MAsB7B,CAAC"}

package/dist/commands/hash.js

@@ -1,22 +1,22 @@
+import { Command } from "@commander-js/extra-typings";
 import chalk from "chalk";
-import { BaseCommand } from "../baseCommand.js";
-class HashCommand extends BaseCommand {
-    async run() {
-        const hash = this.getMachineHash();
+import { getMachineHash } from "../base.js";
+export const createHashCommand = () => {
+    return new Command("hash")
+        .description("Converts the binary generated by the build command to hexadecimal and prints out the result to console.")
+        .option("--json", "Format output as json.")
+        .action(async ({ json }, command) => {
+        const hash = getMachineHash();
         if (hash) {
-            if (!this.jsonEnabled()) {
-                process.stdout.write(`${chalk.green("?")} Cartesi machine templateHash ${chalk.cyan(hash)}\n`);
+            if (!json) {
+                console.log(`${chalk.green("?")} Cartesi machine templateHash ${chalk.cyan(hash)}\n`);
             }
             else {
-                return { hash };
+                process.stdout.write(JSON.stringify({ hash }));
             }
         }
         else {
-            this.error(`Cartesi machine snapshot not found, run '${this.config.bin} build'`);
+            command.error(`Cartesi machine snapshot not found, run 'build'`);
         }
-    }
-}
-HashCommand.summary = "Prints out image hash generated by the build command";
-HashCommand.description = "Converts the binary generated by the build command to hexadecimal and prints out the result to console";
-HashCommand.enableJsonFlag = true;
-export default HashCommand;
+    });
+};

package/dist/commands/logs.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "@commander-js/extra-typings";
+export declare const createLogsCommand: () => Command<[], {
+    projectName?: string | undefined;
+    follow?: true | undefined;
+    since?: string | undefined;
+    tail: string;
+    until?: string | undefined;
+}, {}>;
+//# sourceMappingURL=logs.d.ts.map

package/dist/commands/logs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.d.ts","sourceRoot":"","sources":["../../src/commands/logs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAItD,eAAO,MAAM,iBAAiB;;;;;;MA6C7B,CAAC"}

package/dist/commands/logs.js

@@ -0,0 +1,34 @@
+import { Command } from "@commander-js/extra-typings";
+import { execa } from "execa";
+import { getProjectName, getServiceInfo } from "../base.js";
+export const createLogsCommand = () => {
+    return new Command("logs")
+        .description("Show logs of a local environment.")
+        .option("--project-name <string>", "name of project (used by docker compose and cartesi-rollups-node)")
+        .option("-f, --follow", "Follow log output")
+        .option("--since <string>", "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)")
+        .option("-n, --tail <string>", "Number of lines to show from the end of the logs", "all")
+        .option("--until <string>", "Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)")
+        .configureHelp({ showGlobalOptions: true })
+        .action(async (options) => {
+        const { follow, since, tail, until } = options;
+        const projectName = getProjectName(options);
+        const logOptions = [];
+        if (follow)
+            logOptions.push("--follow");
+        if (since)
+            logOptions.push("--since", since);
+        if (tail)
+            logOptions.push("--tail", tail);
+        if (until)
+            logOptions.push("--until", until);
+        const serviceInfo = await getServiceInfo({
+            projectName,
+            service: "rollups-node",
+        });
+        if (!serviceInfo) {
+            throw new Error(`service rollups-node not found`);
+        }
+        await execa("docker", ["container", "logs", ...logOptions, serviceInfo.ID], { stdio: "inherit" });
+    });
+};

package/dist/commands/run.d.ts

@@ -1,21 +1,15 @@
-import { BaseCommand } from "../baseCommand.js";
-export default class Run extends BaseCommand<typeof Run> {
-    static summary: string;
-    static description: string;
-    static examples: string[];
-    static flags: {
-        "block-time": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        "disable-explorer": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-        "disable-bundler": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-        "disable-paymaster": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-        "epoch-length": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        "no-backend": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-        verbose: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-        "listen-port": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        cpus: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        memory: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        "dry-run": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-    };
-    run(): Promise<void>;
-}
+import { Command } from "@commander-js/extra-typings";
+export declare const createRunCommand: () => Command<[], {
+    blockTime: number;
+    cpus?: number | undefined;
+    defaultBlock: "latest" | "pending" | "safe" | "finalized";
+    dryRun: boolean;
+    memory?: number | undefined;
+    epochLength: number;
+    port?: number | undefined;
+    runtimeVersion: string;
+    projectName?: string | undefined;
+    services: string[];
+    verbose: boolean;
+}, {}>;
 //# sourceMappingURL=run.d.ts.map

package/dist/commands/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/commands/run.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,OAAO,OAAO,GAAI,SAAQ,WAAW,CAAC,OAAO,GAAG,CAAC;IACpD,MAAM,CAAC,OAAO,SAA2B;IAEzC,MAAM,CAAC,WAAW,SAAmD;IAErE,MAAM,CAAC,QAAQ,WAA2C;IAE1D,MAAM,CAAC,KAAK;;;;;;;;;;;;MAyDV;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAoJpC"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/commands/run.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,OAAO,EAGV,MAAM,6BAA6B,CAAC;AA8JrC,eAAO,MAAM,gBAAgB;;;;;;;;;;;;MA4J5B,CAAC"}

package/dist/commands/run.js

@@ -1,191 +1,202 @@
-import { Flags } from "@oclif/core";
-import { execa } from "execa";
-import fs from "fs-extra";
-import path from "path";
-import { BaseCommand } from "../baseCommand.js";
-class Run extends BaseCommand {
-    async run() {
-        const { flags } = await this.parse(Run);
-        let projectName;
-        if (flags["no-backend"]) {
-            projectName = "cartesi-node";
-        }
-        else {
-            // get machine hash
-            const hash = this.getMachineHash();
-            // Check if snapshot exists
-            if (!hash) {
-                throw new Error(`Cartesi machine snapshot not found, run '${this.config.bin} build'`);
+import { Command, Option, } from "@commander-js/extra-typings";
+import { ExitPromptError } from "@inquirer/core";
+import chalk from "chalk";
+import { ExecaError } from "execa";
+import getPort, { portNumbers } from "get-port";
+import ora from "ora";
+import { numberToHex } from "viem";
+import { getMachineHash, getProjectName } from "../base.js";
+import { DEFAULT_SDK_VERSION, PREFERRED_PORT } from "../config.js";
+import { AVAILABLE_SERVICES, deployApplication, removeApplication, startEnvironment, stopEnvironment, waitHealthyEnvironment, } from "../exec/rollups.js";
+import { keySelect } from "../prompts.js";
+const commaSeparatedList = (value) => value.split(",");
+const shell = async (options) => {
+    const { build, epochLength, log, projectName } = options;
+    // keep track of last deployment
+    let lastDeployment;
+    let salt = 0;
+    // deploy for the first time
+    const hash = getMachineHash();
+    if (hash) {
+        lastDeployment = await deploy({
+            epochLength,
+            hash,
+            projectName,
+            salt: numberToHex(salt++, { size: 32 }),
+        });
+    }
+    else {
+        console.warn(chalk.yellow("machine snapshot not found, waiting for build"));
+    }
+    while (true) {
+        try {
+            const option = await keySelect({
+                choices: [
+                    { name: "View logs", value: "l" },
+                    { name: "Build and redeploy", value: "b" },
+                    { name: "Quit", value: "q" },
+                ],
+            }, {});
+            switch (option) {
+                case "l": {
+                    try {
+                        await log?.parseAsync(["--project-name", projectName, "--follow"], {
+                            from: "user",
+                        });
+                    }
+                    catch (error) {
+                        if (error instanceof ExecaError) {
+                            // just continue gracefully
+                            if (error.exitCode === 130) {
+                                break;
+                            }
+                            throw error;
+                        }
+                    }
+                    break;
+                }
+                case "b": {
+                    // build
+                    await build?.parseAsync([], { from: "user" });
+                    // redeploy
+                    const hash = getMachineHash();
+                    if (hash) {
+                        if (lastDeployment) {
+                            await undeploy({ projectName });
+                        }
+                        lastDeployment = await deploy({
+                            consensus: lastDeployment?.consensus,
+                            epochLength,
+                            hash,
+                            projectName,
+                            salt: numberToHex(salt++, { size: 32 }),
+                        });
+                    }
+                    break;
+                }
+                case "q": {
+                    return;
+                }
             }
-            projectName = hash.substring(2, 10);
-        }
-        // path of the tool instalation
-        const binPath = path.join(path.dirname(new URL(import.meta.url).pathname), "..");
-        // setup the environment variable used in docker compose
-        const blockInterval = flags["block-time"];
-        const epochLength = flags["epoch-length"];
-        const listenPort = flags["listen-port"];
-        const env = {
-            ANVIL_VERBOSITY: flags.verbose ? "--steps-tracing" : "--silent",
-            BLOCK_TIME: blockInterval.toString(),
-            BLOCK_TIMEOUT: (blockInterval + 3).toString(),
-            CARTESI_EPOCH_LENGTH: epochLength.toString(),
-            CARTESI_EXPERIMENTAL_DISABLE_CONFIG_LOG: flags.verbose
-                ? "false"
-                : "true",
-            CARTESI_EXPERIMENTAL_SERVER_MANAGER_BYPASS_LOG: flags.verbose
-                ? "false"
-                : "true",
-            CARTESI_LOG_LEVEL: flags.verbose ? "info" : "error",
-            CARTESI_SNAPSHOT_DIR: "/usr/share/rollups-node/snapshot",
-            CARTESI_BIN_PATH: binPath,
-            CARTESI_LISTEN_PORT: listenPort.toString(),
-            CARTESI_VALIDATOR_CPUS: flags.cpus?.toString(),
-            CARTESI_VALIDATOR_MEMORY: flags.memory?.toString(),
-        };
-        // validator
-        const composeFiles = ["docker-compose-validator.yaml"];
-        if (flags.cpus) {
-            composeFiles.push("docker-compose-validator-cpus.yaml");
-        }
-        if (flags.memory) {
-            composeFiles.push("docker-compose-validator-memory.yaml");
         }
-        // prompt
-        composeFiles.push("docker-compose-prompt.yaml");
-        // database
-        composeFiles.push("docker-compose-database.yaml");
-        // proxy
-        composeFiles.push("docker-compose-proxy.yaml");
-        // anvil
-        composeFiles.push("docker-compose-anvil.yaml");
-        // explorer
-        if (!flags["disable-explorer"]) {
-            composeFiles.push("docker-compose-explorer.yaml");
-        }
-        // account abstraction
-        if (!flags["disable-bundler"]) {
-            composeFiles.push("docker-compose-bundler.yaml");
-        }
-        if (!flags["disable-paymaster"] && !flags["disable-bundler"]) {
-            // only add paymaster if bundler is enabled
-            composeFiles.push("docker-compose-paymaster.yaml");
-        }
-        // load the no-backend compose file
-        if (flags["no-backend"]) {
-            composeFiles.push("docker-compose-host.yaml");
-        }
-        else {
-            // snapshot volume
-            composeFiles.push("docker-compose-snapshot-volume.yaml");
+        catch (error) {
+            if (error instanceof ExitPromptError) {
+                // gracefully exit
+                return;
+            }
+            throw error;
         }
-        // add project env file loading
-        if (fs.existsSync("./.cartesi.env")) {
-            composeFiles.push("docker-compose-envfile.yaml");
+    }
+};
+const undeploy = async (options) => {
+    const { projectName } = options;
+    const progress = ora(`${chalk.cyan(projectName)} undeploying...`).start();
+    await removeApplication({
+        application: projectName,
+        force: true,
+        projectName,
+    });
+    progress.succeed(`${chalk.cyan(projectName)} undeployed`);
+};
+const deploy = async (options) => {
+    const { consensus, epochLength, hash, projectName, salt } = options;
+    // deploy application to node (onchain and offchain)
+    const progress = ora(`deploying ${chalk.cyan(hash)} as ${chalk.cyan(projectName)}`);
+    const application = await deployApplication({
+        consensus,
+        epochLength,
+        name: projectName,
+        projectName,
+        salt,
+        snapshotPath: "/var/lib/cartesi-rollups-node/snapshots/image",
+    });
+    progress.succeed(`${chalk.cyan(projectName)} machine hash is ${chalk.cyan(hash)}`);
+    progress.succeed(`${chalk.cyan(projectName)} contract deployed at ${chalk.cyan(application.address)}`);
+    return application;
+};
+export const createRunCommand = () => {
+    return new Command("run")
+        .description("Run a local cartesi node for the application.")
+        .addOption(new Option("--block-time <number>", "interval between blocks (in seconds)")
+        .argParser(Number)
+        .default(2))
+        .addOption(new Option("--cpus <number>", "number of cpu limits for the rollups-node").argParser(Number))
+        .addOption(new Option("--default-block <string>", "default block to be used when fetching new blocks.")
+        .choices(["latest", "safe", "pending", "finalized"])
+        .default("latest"))
+        .option("--dry-run", "show the docker compose configuration", false)
+        .addOption(new Option("--memory <number>", "memory limit for the rollups-node in MB").argParser(Number))
+        .addOption(new Option("--epoch-length <number>", "length of an epoch (in blocks)")
+        .argParser(Number)
+        .default(720))
+        .option("-p, --port <number>", "port to listen on", Number)
+        .addOption(new Option("--runtime-version <version>", "version for Cartesi Rollups Runtime to use")
+        .default(DEFAULT_SDK_VERSION)
+        .hideHelp())
+        .option("--project-name <string>", "name of project (used by docker compose and cartesi-rollups-node)")
+        .option("--services <string>", `optional services to start, comma separated list from [${AVAILABLE_SERVICES.join(", ")}]`, commaSeparatedList, [])
+        .option("-v, --verbose", "verbose output", false)
+        .action(async (options, program) => {
+        const { blockTime, cpus, defaultBlock, dryRun, epochLength, memory, runtimeVersion, services, verbose, } = options;
+        const progress = ora();
+        if (defaultBlock !== "finalized") {
+            console.warn(chalk.yellow(`WARNING: default block is set to '${defaultBlock}', production configuration will likely use 'finalized'`));
         }
-        // create the "--file <file>" list
-        const files = composeFiles
-            .map((f) => ["--file", path.join(binPath, "node", f)])
-            .flat();
-        const compose_args = [
-            "compose",
-            ...files,
-            "--project-directory",
-            ".",
-            "--project-name",
+        // project name explicitly defined or the current directory name
+        const projectName = getProjectName(options);
+        // resolve port number, using the first free port in a range, unless explicitly set
+        const port = options.port ||
+            (await getPort({
+                port: portNumbers(PREFERRED_PORT, PREFERRED_PORT + 10),
+            }));
+        // run compose environment (detached)
+        const { address, config } = await startEnvironment({
+            blockTime,
+            cpus,
+            defaultBlock,
+            dryRun,
+            memory,
+            port,
             projectName,
-        ];
-        const up_args = [];
-        if (!flags.verbose) {
-            compose_args.push("--progress", "quiet");
-            up_args.push("--attach", "validator");
-            up_args.push("--attach", "prompt");
+            runtimeVersion,
+            services,
+            verbose,
+        });
+        if (dryRun && config) {
+            // just show the docker compose configuration and quit
+            process.stdout.write(config);
+            return;
         }
-        // XXX: need this handler, so SIGINT can still call the finally block below
-        process.on("SIGINT", () => { });
-        try {
-            if (flags["dry-run"]) {
-                // show the docker compose configuration
-                await execa("docker", [...compose_args, "config"], {
-                    env,
-                    stdio: "inherit",
-                });
-                return;
+        progress.succeed(`${chalk.cyan(projectName)} starting at ${chalk.cyan(`${address}`)}`);
+        // wait for the environment to be healthy
+        await waitHealthyEnvironment({
+            name: projectName,
+            port,
+            projectName,
+            services,
+        });
+        const shutdown = async () => {
+            progress.start(`${chalk.cyan(projectName)} stopping...`);
+            try {
+                await stopEnvironment({ projectName });
+                progress.succeed(`${chalk.cyan(projectName)} stopped`);
             }
-            // run compose environment
-            await execa("docker", [...compose_args, "up", ...up_args], {
-                env,
-                stdio: "inherit",
-            });
-        }
-        catch (e) {
-            // 130 is a graceful shutdown, so we can swallow it
-            if (e.exitCode !== 130) {
-                throw e;
+            catch (e) {
+                progress.fail(e instanceof Error ? e.message : "Unknown error");
             }
-        }
-        finally {
-            // shut it down, including volumes
-            await execa("docker", [...compose_args, "down", "--volumes"], {
-                env,
-                stdio: "inherit",
-            });
-        }
-    }
-}
-Run.summary = "Run application node.";
-Run.description = "Run a local cartesi node for the application.";
-Run.examples = ["<%= config.bin %> <%= command.id %>"];
-Run.flags = {
-    "block-time": Flags.integer({
-        description: "interval between blocks (in seconds)",
-        default: 5,
-    }),
-    "disable-explorer": Flags.boolean({
-        default: false,
-        description: "disable local explorer service to save machine resources",
-        summary: "disable explorer service",
-    }),
-    "disable-bundler": Flags.boolean({
-        default: false,
-        description: "disable local bundler service to save machine resources",
-        summary: "disable bundler service",
-    }),
-    "disable-paymaster": Flags.boolean({
-        default: false,
-        description: "disable local paymaster service to save machine resources",
-        summary: "disable paymaster service",
-    }),
-    "epoch-length": Flags.integer({
-        description: "length of an epoch (in blocks)",
-        default: 720,
-    }),
-    "no-backend": Flags.boolean({
-        description: "Run a node without the application code. Application must be executed by the developer on the host machine, fetching inputs from the node running at http://localhost:5004",
-        summary: "run a node without the application code",
-        default: false,
-    }),
-    verbose: Flags.boolean({
-        description: "verbose output",
-        default: false,
-        char: "v",
-    }),
-    "listen-port": Flags.integer({
-        description: "port to listen for incoming connections",
-        default: 8080,
-    }),
-    cpus: Flags.integer({
-        description: "Define the number of CPUs to use (eg.: 1) for the rollups-node",
-        summary: "number of cpu limits for the rollups-node",
-    }),
-    memory: Flags.integer({
-        description: "Define the amount of memory to use for the rollups-node in MB (eg.: 1024)",
-        summary: "memory limit for the rollups-node in MB",
-    }),
-    "dry-run": Flags.boolean({
-        description: "show the docker compose configuration",
-        default: false,
-        hidden: true,
-    }),
+            process.exit(0);
+        };
+        // inhibit SIGINT and SIGTERM, will be handled gracefully by the shell
+        process.on("SIGINT", () => { });
+        process.on("SIGTERM", () => { });
+        const log = program.parent?.commands.find((c) => c.name() === "logs");
+        const build = program.parent?.commands.find((c) => c.name() === "build");
+        await shell({
+            build,
+            epochLength,
+            log,
+            projectName,
+        });
+        await shutdown();
+    });
 };
-export default Run;

package/dist/commands/send.d.ts

@@ -0,0 +1,10 @@
+import { Command } from "@commander-js/extra-typings";
+export declare const createSendCommand: () => Command<[string | undefined], {
+    from?: string | undefined;
+    application?: string | undefined;
+    encoding?: "string" | "hex" | "abi" | undefined;
+    abiParams?: string | undefined;
+    projectName?: string | undefined;
+    rpcUrl?: string | undefined;
+}, {}>;
+//# sourceMappingURL=send.d.ts.map

package/dist/commands/send.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.d.ts","sourceRoot":"","sources":["../../src/commands/send.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAU,MAAM,6BAA6B,CAAC;AAmG9D,eAAO,MAAM,iBAAiB;;;;;;;MA4D7B,CAAC"}