feat: support for multiple sdks and abstract machine making into create_image script in sdk

apps/cli/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.15.0
+
+### Minor Changes
+
+- Add capability for picking SDK through sdk_name
+
 ## 0.14.1
 
 ### Patch Changes

apps/cli/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cartesi/cli",
-    "version": "0.14.1",
+    "version": "0.15.0",
     "description": "Cartesi CLI",
     "author": "Danilo Tuler <[email protected]>",
     "bin": {

apps/cli/src/commands/build.ts

@@ -19,6 +19,7 @@
     env: string[];
     ramSize: string;
     sdkVersion: string;
+    sdkName: string;
     workdir: string;
 };
 
@@ -28,7 +29,8 @@
 const CARTESI_DEFAULT_RAM_SIZE = "128Mi";
 
 const CARTESI_LABEL_SDK_VERSION = `${CARTESI_LABEL_PREFIX}.sdk_version`;
-const CARTESI_DEFAULT_SDK_VERSION = "0.6.0";
+const CARTESI_LABEL_SDK_NAME = `${CARTESI_LABEL_PREFIX}.sdk_name`;
+const CARTESI_DEFAULT_SDK_VERSION = "0.7.0";
 
 export default class BuildApplication extends BaseCommand<
     typeof BuildApplication
@@ -99,6 +101,7 @@
             entrypoint: imageInfo["Config"]["Entrypoint"] ?? [],
             env: imageInfo["Config"]["Env"] || [],
             ramSize: labels[CARTESI_LABEL_RAM_SIZE] ?? CARTESI_DEFAULT_RAM_SIZE,
+            sdkName: labels[CARTESI_LABEL_SDK_NAME] ?? "cartesi/sdk",
             sdkVersion:
                 labels[CARTESI_LABEL_SDK_VERSION] ??
                 CARTESI_DEFAULT_SDK_VERSION,
@@ -112,7 +115,10 @@
         // fail if using unsupported sdk version
         if (!semver.valid(info.sdkVersion)) {
             this.warn("sdk version is not a valid semver");
-        } else if (semver.lt(info.sdkVersion, CARTESI_DEFAULT_SDK_VERSION)) {
+        } else if (
+            info.sdkName == "cartesi/sdk" &&
+            semver.lt(info.sdkVersion, CARTESI_DEFAULT_SDK_VERSION)
+        ) {
             throw new Error(`Unsupported sdk version: ${info.sdkVersion} (used) < ${CARTESI_DEFAULT_SDK_VERSION} (minimum).
 Update your application Dockerfile using one of the templates at https://github.com/cartesi/application-templates/tree/${DEFAULT_TEMPLATES_BRANCH}
 `);
@@ -147,7 +153,7 @@
         outputFilePath: string,
     ): Promise<void> {
         // create docker tarball from app image
         const { stdout: appCid } = await execa("docker", [
             "image",
             "save",
             image,
@@ -232,26 +238,22 @@
         const driveLabel = "root"; // XXX: does this need to be customizable?
 
         // list of environment variables of docker image
-        const envs = info.env.map(
-            (variable) => `--append-entrypoint=export ${variable}`,
-        );
+        const envs = info.env.map((variable) => `--env=${variable}`);
 
         // ENTRYPOINT and CMD as a space separated string
         const entrypoint = [...info.entrypoint, ...info.cmd].join(" ");
 
         // command to change working directory if WORKDIR is defined
-        const cwd = info.workdir ? `--append-init=WORKDIR=${info.workdir}` : "";
+        const cwd = info.workdir ? `--workdir=${info.workdir}` : "";
         return [
-            "cartesi-machine",
-            "--assert-rolling-template",
+            "create_machine_snapshot",
             `--ram-length=${ramSize}`,
-            `--flash-drive=label:${driveLabel},filename:/tmp/input`,
-            "--final-hash",
-            `--store=/tmp/output`,
-            "--append-bootargs=no4lvl",
+            `--drive-label=${driveLabel}`,
+            `--drive-filename=/tmp/input`,
+            `--output=/tmp/output`,
             cwd,
             ...envs,
-            `--append-entrypoint=${entrypoint}`,
+            `--entrypoint=${entrypoint}`,
         ];
     }
 

packages/sdk/CHANGELOG.md

@@ -1,5 +1,11 @@
 # sdk
 
+## 0.7.0
+
+### Minor Changes
+
+- Add capability for picking SDK through sdk_name
+
 ## 0.6.1
 
 ### Patch Changes

packages/sdk/Dockerfile

@@ -105,6 +105,7 @@ COPY devnet /usr/local/bin
 COPY eth_isready /usr/local/bin
 COPY eth_dump /usr/local/bin
 COPY eth_load /usr/local/bin
+COPY create_machine_snapshot /usr/local/bin
 
 COPY entrypoint.sh /usr/local/bin/
 COPY --from=su-exec /usr/local/src/su-exec /usr/local/bin/

packages/sdk/create_machine_snapshot

@@ -0,0 +1,82 @@
+#!/bin/bash
+set -e
+
+# Define function to display usage
+usage() {
+    echo "Usage: $0 [options]"
+    echo "Options:"
+    echo "  -r, --ram-length <size>        Specify RAM size"
+    echo "  -d, --drive-label <label>      Specify drive label, filename for input"
+    echo "  -m, --drive-filename <path>    Specify raw drive image filename"
+    echo "  -o, --output <path>            Specify output directory"
+    echo "  -w, --workdir <path>           Set the working directory"
+    echo "  -e, --entrypoint <cmd>         Set the entrypoint command"
+    echo "  -v, --env <var=value>          Add an environment variable"
+    echo "  -h, --help                     Display this help and exit"
+}
+
+# Initialize variables with default values
+ram_length=""
+drive_label=""
+drive_filename=""
+output_path=""
+workdir=""
+entrypoint=""
+declare -a env_vars
+
+# Parse command line options using getopt
+TEMP=$(getopt -o r:d:m:o:w:e:v:h --long ram-length:,drive-label:,drive-filename:,output:,workdir:,entrypoint:,env:,help -- "$@")
+eval set -- "$TEMP"
+
+# Extract options and their arguments into variables.
+while true ; do
+    case "$1" in
+        -r|--ram-length)
+            ram_length="$2"
+            shift 2 ;;
+        -d|--drive-label)
+            drive_label="$2"
+            shift 2 ;;
+        -m|--drive-filename)
+            drive_filename="$2"
+            shift 2 ;;
+        -o|--output)
+            output_path="$2"
+            shift 2 ;;
+        -w|--workdir)
+            workdir="$2"
+            shift 2 ;;
+        -e|--entrypoint)
+            entrypoint="$2"
+            shift 2 ;;
+        -v|--env)
+            env_vars+=("$2")
+            shift 2 ;;
+        --)
+            shift ; break ;;
+        -h|--help)
+            usage
+            exit 0 ;;
+        *)
+            echo "Invalid option: $1" >&2
+            usage
+            exit 1 ;;
+    esac
+done
+
+# Construct the command line for cartesi-machine
+cmd=("cartesi-machine")
+for env_var in "${env_vars[@]}"; do
+    cmd+=("--append-entrypoint=export $env_var")
+done
+[[ -n "$ram_length" ]] && cmd+=("--ram-length=$ram_length")
+[[ -n "$drive_label" ]] && [[ -n $drive_filename ]] && cmd+=("--flash-drive=label:$drive_label,filename:$drive_filename")
+[[ -n "$output_path" ]] && cmd+=("--store=$output_path")
+[[ -n "$workdir" ]] && cmd+=("--append-init=WORKDIR=$workdir")
+[[ -n "$entrypoint" ]] && cmd+=("--append-entrypoint=$entrypoint")
+cmd+=("--append-bootargs=no4lvl")
+cmd+=("--assert-rolling-template")
+cmd+=("--final-hash")
+
+# Execute the command
+"${cmd[@]}"

packages/sdk/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@cartesi/sdk",
     "private": true,
-    "version": "0.6.1",
+    "version": "0.7.0",
     "scripts": {
         "build": "docker buildx bake --load"
     }