@mysten-incubation/devstack 0.0.0

package/images/walrus/deploy-walrus.sh

@@ -0,0 +1,305 @@
+#!/bin/bash
+# Walrus testbed deploy script for the devstack-rewrite local-cluster
+# mode. Reads CLI flags (NOT env vars — that's the v3 contract; the
+# rewrite passes flags from `plugins/walrus/deploy.ts::runDeployOneShot`).
+#
+# Required flags (passed by deploy.ts):
+#   --output-dir DIR         — working dir for deploy outputs.
+#   --committee-size N       — N storage nodes in the committee.
+#   --shards N               — total shards (must be >= committee-size).
+#   --epoch-duration D       — walrus epoch duration (e.g. 24h).
+#   --sui-rpc-url URL        — sui RPC endpoint reachable from this
+#                               container (host.docker.internal).
+#   --faucet-url URL         — sui faucet endpoint (same host).
+#   --public-hosts CSV       — comma-separated public hostnames (one
+#                               per node) used in on-chain Committee.
+#   --listening-ips CSV      — comma-separated bind IPs (one per node).
+#
+# Optional flags:
+#   --gc                     — append a `db_config` + `garbage_collection`
+#                               block to every generated dryrun-node yaml
+#                               so blob GC + data deletion run inside the
+#                               storage node. Relevant for plugin authors
+#                               testing storage-node cleanup; off by
+#                               default (matches procman's default).
+#
+# Outputs (under --output-dir):
+#   - deploy                       — summary file walrus-deploy emits.
+#                                    Contains `walrus_package_id:`,
+#                                    `system_object:`, `staking_object:`,
+#                                    `exchange_object:` etc.
+#   - dryrun-node-<i>.yaml         — per-node walrus-node config.
+#   - dryrun-node-<i>.keystore     — per-node sui keystore.
+#   - dryrun-node-<i>-sui.yaml     — per-node sui client config.
+#
+# Stdout MUST include the deploy summary in `key: 0x<hex>` format
+# (plugins/walrus/deploy.ts::parseDeployOutput regexes pick these out).
+set -euo pipefail
+
+WORKING_DIR=""
+COMMITTEE_SIZE=""
+SHARDS=100
+EPOCH_DURATION="24h"
+SUI_RPC_URL=""
+FAUCET_URL=""
+PUBLIC_HOSTS_CSV=""
+LISTENING_IPS_CSV=""
+GC=false
+
+while [ $# -gt 0 ]; do
+	case "$1" in
+		--output-dir) WORKING_DIR="$2"; shift 2 ;;
+		--committee-size) COMMITTEE_SIZE="$2"; shift 2 ;;
+		--shards) SHARDS="$2"; shift 2 ;;
+		--epoch-duration) EPOCH_DURATION="$2"; shift 2 ;;
+		--sui-rpc-url) SUI_RPC_URL="$2"; shift 2 ;;
+		--faucet-url) FAUCET_URL="$2"; shift 2 ;;
+		--public-hosts) PUBLIC_HOSTS_CSV="$2"; shift 2 ;;
+		--listening-ips) LISTENING_IPS_CSV="$2"; shift 2 ;;
+		--gc) GC=true; shift 1 ;;
+		*) echo "deploy-walrus: unknown arg '$1'" >&2; exit 2 ;;
+	esac
+done
+
+[ -n "$WORKING_DIR" ] || { echo "deploy-walrus: --output-dir is required" >&2; exit 1; }
+[ -n "$COMMITTEE_SIZE" ] || { echo "deploy-walrus: --committee-size is required" >&2; exit 1; }
+[ -n "$SUI_RPC_URL" ] || { echo "deploy-walrus: --sui-rpc-url is required" >&2; exit 1; }
+[ -n "$FAUCET_URL" ] || { echo "deploy-walrus: --faucet-url is required" >&2; exit 1; }
+[ -n "$PUBLIC_HOSTS_CSV" ] || { echo "deploy-walrus: --public-hosts is required" >&2; exit 1; }
+[ -n "$LISTENING_IPS_CSV" ] || { echo "deploy-walrus: --listening-ips is required" >&2; exit 1; }
+
+OUTPUT_DIR="$WORKING_DIR"
+STAGING_DIR="$OUTPUT_DIR/.deploy-next-$$"
+WORKING_DIR="$STAGING_DIR"
+
+IFS=',' read -r -a PUBLIC_HOSTS <<< "$PUBLIC_HOSTS_CSV"
+IFS=',' read -r -a LISTENING_IPS <<< "$LISTENING_IPS_CSV"
+
+if [ "${#PUBLIC_HOSTS[@]}" -ne "$COMMITTEE_SIZE" ]; then
+	echo "deploy-walrus: --public-hosts has ${#PUBLIC_HOSTS[@]} entries but --committee-size=$COMMITTEE_SIZE" >&2
+	exit 1
+fi
+if [ "${#LISTENING_IPS[@]}" -ne "$COMMITTEE_SIZE" ]; then
+	echo "deploy-walrus: --listening-ips has ${#LISTENING_IPS[@]} entries but --committee-size=$COMMITTEE_SIZE" >&2
+	exit 1
+fi
+if ! [ "$SHARDS" -ge "$COMMITTEE_SIZE" ] 2>/dev/null; then
+	echo "deploy-walrus: --shards=$SHARDS must be >= --committee-size=$COMMITTEE_SIZE" >&2
+	exit 1
+fi
+
+WALRUS_DEPLOY_BIN="${WALRUS_DEPLOY_BIN:-/opt/walrus/bin/walrus-deploy}"
+WALRUS_CONTRACT_DIR="${WALRUS_CONTRACT_DIR:-/opt/walrus/contracts}"
+SUI_BIN="${SUI_BIN:-/root/sui_bin/sui}"
+
+if [ ! -x "$WALRUS_DEPLOY_BIN" ]; then
+	echo "deploy-walrus: walrus-deploy binary is missing or not executable at $WALRUS_DEPLOY_BIN" >&2
+	exit 127
+fi
+if [ ! -x "$SUI_BIN" ]; then
+	echo "deploy-walrus: sui binary is missing or not executable at $SUI_BIN" >&2
+	exit 127
+fi
+
+mkdir -p "$OUTPUT_DIR"
+rm -rf "$STAGING_DIR"
+mkdir -p "$WORKING_DIR"
+
+fix_output_ownership() {
+	if [ -n "${DEVSTACK_HOST_UID_GID:-}" ]; then
+		chown -R "$DEVSTACK_HOST_UID_GID" "$OUTPUT_DIR" 2>/dev/null || true
+	fi
+}
+cleanup() {
+	rm -rf "$STAGING_DIR" 2>/dev/null || true
+	fix_output_ownership
+}
+trap cleanup EXIT
+
+# Clean stale build artifacts. Deploy outputs are written into a staging
+# directory and copied into place only after a complete successful deploy, so a
+# timeout or interrupted redeploy cannot destroy the previous runnable cluster
+# config.
+[ -d "$WALRUS_CONTRACT_DIR" ] && find "$WALRUS_CONTRACT_DIR" -name 'build' -type d -exec rm -rf {} + || true
+
+# Pre-create admin wallet so sui-cli picks up the right active_env name
+# (walrus-deploy's wallet-loading path needs `localnet`, not `custom`).
+ADMIN_WALLET_YAML="$WORKING_DIR/sui_admin.yaml"
+ADMIN_KEYSTORE="$WORKING_DIR/sui_admin.keystore"
+
+export HOME="$WORKING_DIR/.suihome"
+rm -rf "$HOME"
+mkdir -p "$HOME/.sui/sui_config"
+
+"$SUI_BIN" client new-address ed25519 admin --json > /dev/null
+"$SUI_BIN" client new-env --alias localnet --rpc "$SUI_RPC_URL" > /dev/null
+"$SUI_BIN" client switch --env localnet > /dev/null
+"$SUI_BIN" client switch --address admin > /dev/null
+
+ADMIN_ADDR=$("$SUI_BIN" client active-address)
+if [ "${ADMIN_ADDR#0x}" = "$ADMIN_ADDR" ]; then
+	echo "deploy-walrus: failed to resolve admin address from sui client (got '$ADMIN_ADDR')" >&2
+	exit 1
+fi
+
+cp "$HOME/.sui/sui_config/sui.keystore" "$ADMIN_KEYSTORE"
+sed -e "s|$HOME/.sui/sui_config/sui.keystore|$ADMIN_KEYSTORE|" \
+	"$HOME/.sui/sui_config/client.yaml" > "$ADMIN_WALLET_YAML"
+
+# Faucet the admin so the publish has gas. This mirrors the central
+# SUI faucet strategy's wire contract: non-2xx and body-level Failure are
+# "not funded yet", not success. The local faucet can briefly return
+# HTTP failure while it is transaction-ready for one account but still
+# serializing another request, so deploy uses a bounded retry instead of
+# letting curl's exit 22 abort the whole one-shot.
+echo "deploy-walrus: faucet → $ADMIN_ADDR ($FAUCET_URL)"
+FAUCET_RESPONSE=""
+FAUCET_MAX_ATTEMPTS=45
+FAUCET_RETRY_SLEEP=2
+FAUCET_RESPONSE_FILE="$WORKING_DIR/faucet-response.json"
+
+request_admin_faucet_once() {
+	local response_file="$1"
+	local http_code=""
+	local curl_status=0
+	local body=""
+
+	rm -f "$response_file"
+	http_code=$(curl -sS -X POST \
+		-o "$response_file" \
+		-w '%{http_code}' \
+		-H 'Content-Type: application/json' \
+		-d "{\"FixedAmountRequest\":{\"recipient\":\"$ADMIN_ADDR\"}}" \
+		"$FAUCET_URL") || curl_status=$?
+	[ -f "$response_file" ] && body="$(cat "$response_file")"
+
+	if [ "$curl_status" -ne 0 ]; then
+		echo "deploy-walrus: faucet POST failed (curl=$curl_status http=${http_code:-000}): ${body:0:400}" >&2
+		return 1
+	fi
+	if ! [[ "$http_code" =~ ^[0-9][0-9][0-9]$ ]]; then
+		echo "deploy-walrus: faucet POST returned malformed HTTP status '$http_code': ${body:0:400}" >&2
+		return 1
+	fi
+	if [ "$http_code" -lt 200 ] || [ "$http_code" -ge 300 ]; then
+		echo "deploy-walrus: faucet POST returned HTTP $http_code: ${body:0:400}" >&2
+		return 1
+	fi
+	if echo "$body" | grep -q '"Failure"'; then
+		echo "deploy-walrus: faucet body reported Failure: ${body:0:400}" >&2
+		return 1
+	fi
+
+	FAUCET_RESPONSE="$body"
+	return 0
+}
+
+for attempt in $(seq 1 "$FAUCET_MAX_ATTEMPTS"); do
+	if request_admin_faucet_once "$FAUCET_RESPONSE_FILE"; then
+		break
+	fi
+	if [ "$attempt" -lt "$FAUCET_MAX_ATTEMPTS" ]; then
+		echo "deploy-walrus: faucet attempt $attempt/$FAUCET_MAX_ATTEMPTS failed; retrying in ${FAUCET_RETRY_SLEEP}s" >&2
+		sleep "$FAUCET_RETRY_SLEEP"
+	fi
+done
+if [ -z "$FAUCET_RESPONSE" ]; then
+	echo "deploy-walrus: faucet did not accept admin funding after $FAUCET_MAX_ATTEMPTS attempts" >&2
+	exit 1
+fi
+echo "deploy-walrus: faucet response: ${FAUCET_RESPONSE:0:200}..."
+
+# Poll balance until faucet's coins settle.
+echo "deploy-walrus: polling for admin balance to settle"
+BALANCE=0
+for i in $(seq 1 30); do
+	BALANCE_JSON=$(curl -fsS -X POST \
+		-H 'Content-Type: application/json' \
+		-d "{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"suix_getBalance\",\"params\":[\"$ADMIN_ADDR\"]}" \
+		"$SUI_RPC_URL" || echo '{}')
+	BALANCE=$(echo "$BALANCE_JSON" | grep -oE '"totalBalance":"[0-9]+"' | head -1 | grep -oE '[0-9]+' || echo "0")
+	if [ -n "$BALANCE" ] && [ "$BALANCE" -gt 0 ] 2>/dev/null; then
+		echo "deploy-walrus: admin balance settled at $BALANCE MIST after ${i} polls"
+		break
+	fi
+	sleep 1
+done
+if [ -z "$BALANCE" ] || ! [ "$BALANCE" -gt 0 ] 2>/dev/null; then
+	echo "deploy-walrus: admin balance still 0 after 30s — faucet drip likely failed" >&2
+	exit 1
+fi
+
+# Build the walrus-deploy network arg (rpc;faucet form).
+WALRUS_NETWORK_ARG="${SUI_RPC_URL};${FAUCET_URL}"
+
+# Run walrus-deploy. The contract dir is baked into the image at
+# /opt/walrus/contracts (placed there during the upstream image build —
+# but since the release tarball doesn't ship contracts, we fall back to
+# `--package-path` once the move-source sibling is wired. For now we
+# rely on `--do-not-copy-contracts` and the in-image contract bundle.)
+"$WALRUS_DEPLOY_BIN" deploy-system-contract \
+	--working-dir "$WORKING_DIR" \
+	--admin-wallet-path "$ADMIN_WALLET_YAML" \
+	--contract-dir "$WALRUS_CONTRACT_DIR" \
+	--do-not-copy-contracts \
+	--sui-network "$WALRUS_NETWORK_ARG" \
+	--n-shards "$SHARDS" \
+	--host-addresses "${PUBLIC_HOSTS[@]}" \
+	--rest-api-port 9185 \
+	--storage-price 5 \
+	--write-price 1 \
+	--epoch-duration "$EPOCH_DURATION" \
+	--with-wal-exchange \
+	| tee "$WORKING_DIR/deploy"
+
+"$WALRUS_DEPLOY_BIN" generate-dry-run-configs \
+	--working-dir "$WORKING_DIR" \
+	--listening-ips "${LISTENING_IPS[@]}"
+
+# Patch generated node configs: storage_path → writable layer, rebind on
+# 0.0.0.0, disable TLS (in-network plain HTTP behind router), optionally
+# enable blob GC + data deletion when --gc was passed.
+for f in "$WORKING_DIR"/dryrun-node-*[0-9].yaml; do
+	sed -i "s|^storage_path: ${WORKING_DIR}/|storage_path: /var/walrus/storage/|" "$f"
+	sed -i -E "s|^(rest_api_address): [0-9.]+:|\\1: 0.0.0.0:|" "$f"
+	sed -i -E "s|^(metrics_address): [0-9.]+:|\\1: 0.0.0.0:|" "$f"
+	cat >> "$f" <<-NODEEOF
+
+	event_processor_config:
+	  adaptive_downloader_config:
+	    max_workers: 2
+	    initial_workers: 2
+	tls:
+	  disable_tls: true
+	NODEEOF
+	if [ "$GC" = "true" ]; then
+		cat >> "$f" <<-GCEOF
+		db_config:
+		  global:
+		    experimental_use_optimistic_transaction_db: true
+		garbage_collection:
+		  enable_blob_info_cleanup: true
+		  enable_data_deletion: true
+		GCEOF
+	fi
+done
+
+# The generator wrote staging paths into the yaml files. Rewrite those references
+# to the stable mounted output path before publishing the staged tree.
+for f in "$WORKING_DIR"/*.yaml; do
+	[ -e "$f" ] || continue
+	sed -i "s|${WORKING_DIR}|${OUTPUT_DIR}|g" "$f"
+done
+
+find "$OUTPUT_DIR" -mindepth 1 -maxdepth 1 ! -name "$(basename "$STAGING_DIR")" -exec rm -rf {} +
+cp -a "$WORKING_DIR"/. "$OUTPUT_DIR"/
+
+# Re-emit the deploy summary on stdout so the rewrite's
+# `parseDeployOutput` regexes (which match `key: 0x<hex>` lines) pick
+# up the system/staking/exchange ids. walrus-deploy already writes them
+# to $WORKING_DIR/deploy; we just `cat` here so they're on stdout too.
+echo ""
+echo "==== deploy-walrus summary ===="
+cat "$OUTPUT_DIR/deploy"
+
+rm -rf "$HOME"

package/images/walrus/run-walrus.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+# Walrus storage-node entrypoint for the devstack-rewrite local-cluster
+# mode. Adapted from the v3 run-walrus.sh.
+#
+# Required env (set by container env / docker):
+#   HOSTNAME              — provided by docker (matches `dryrun-node-N`).
+set -euo pipefail
+
+mkdir -p /root/.sui/sui_config /var/walrus
+WORKING_DIR="${DEPLOY_OUTPUT_DIR:-/opt/walrus/outputs}"
+
+echo "run-walrus: preparing ${HOSTNAME} config from ${WORKING_DIR}"
+
+# Relocate per-node sui keystore + yaml configs out of /opt/walrus/outputs
+# (read-only mount on macOS Docker; osxfs/gRPC-fuse return ENOTSUP for
+# keystore lock/write ops the sui SDK performs during transaction signing).
+cp "$WORKING_DIR/${HOSTNAME}.keystore" /root/.sui/sui_config/sui.keystore
+cp "$WORKING_DIR/${HOSTNAME}-sui.yaml" /root/walrus-sui.yaml
+cp "$WORKING_DIR/${HOSTNAME}.yaml" /root/walrus-node.yaml
+
+# Rewrite path references inside relocated copies.
+sed -i \
+	"s|${WORKING_DIR}/${HOSTNAME}.keystore|/root/.sui/sui_config/sui.keystore|" \
+	/root/walrus-sui.yaml 2>/dev/null || true
+
+sed -i \
+	-e "s|wallet_config: ${WORKING_DIR}/${HOSTNAME}-sui.yaml|wallet_config: /root/walrus-sui.yaml|" \
+	-e "s|admin_socket_path: ${WORKING_DIR}/|admin_socket_path: /var/walrus/|" \
+	/root/walrus-node.yaml
+
+# sui CLI client config pointing at relocated keystore + active address.
+cp "$WORKING_DIR/${HOSTNAME}-sui.yaml" /root/.sui/sui_config/client.yaml
+sed -i \
+	"s|${WORKING_DIR}/${HOSTNAME}.keystore|/root/.sui/sui_config/sui.keystore|" \
+	/root/.sui/sui_config/client.yaml
+
+# walrus CLI client config pointing at deployed system/staking/exchange.
+mkdir -p /root/.config/walrus
+SYSTEM_OBJECT=$(grep '^system_object:' "$WORKING_DIR/deploy" | awk '{print $2}')
+STAKING_OBJECT=$(grep '^staking_object:' "$WORKING_DIR/deploy" | awk '{print $2}')
+EXCHANGE_OBJECT=$(grep '^exchange_object:' "$WORKING_DIR/deploy" | awk '{print $2}' || true)
+
+cat > /root/.config/walrus/client_config.yaml <<EOF
+system_object: ${SYSTEM_OBJECT}
+staking_object: ${STAKING_OBJECT}
+EOF
+if [ -n "${EXCHANGE_OBJECT:-}" ]; then
+	echo "exchange_objects: [${EXCHANGE_OBJECT}]" >> /root/.config/walrus/client_config.yaml
+fi
+
+# Launch walrus-node.
+echo "run-walrus: starting walrus-node on ${HOSTNAME}"
+exec /opt/walrus/bin/walrus-node run --config-path /root/walrus-node.yaml

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@mysten-incubation/devstack",
+  "version": "0.0.0",
+  "description": "Next-generation Sui devstack package.",
+  "keywords": [
+    "sui",
+    "devstack",
+    "effect",
+    "developer-experience"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MystenLabs/ts-sdks-incubation.git",
+    "directory": "packages/devstack"
+  },
+  "homepage": "https://github.com/MystenLabs/ts-sdks-incubation/tree/main/packages/devstack#readme",
+  "bugs": {
+    "url": "https://github.com/MystenLabs/ts-sdks-incubation/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "bin": {
+    "devstack": "./dist/cli/main.mjs"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./vitest": {
+      "types": "./dist/build-integrations/vitest/index.d.mts",
+      "import": "./dist/build-integrations/vitest/index.mjs"
+    },
+    "./vitest/setup": {
+      "types": "./dist/build-integrations/vitest/setup.d.mts",
+      "import": "./dist/build-integrations/vitest/setup.mjs"
+    },
+    "./playwright": {
+      "types": "./dist/build-integrations/playwright/index.d.mts",
+      "import": "./dist/build-integrations/playwright/index.mjs"
+    },
+    "./runtime": {
+      "types": "./dist/build-integrations/runtime/index.d.mts",
+      "import": "./dist/build-integrations/runtime/index.mjs"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "images",
+    "!dist/samples",
+    "!dist/node_modules"
+  ],
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "dependencies": {
+    "@effect/platform-node": "4.0.0-beta.65",
+    "@mysten/codegen": "^0.10.4",
+    "@mysten/deepbook-v3": "^1.3.3",
+    "@mysten/sui": "^2.17.0",
+    "@stricli/core": "^1.2.7",
+    "effect": "4.0.0-beta.65",
+    "ink": "^7.0.0",
+    "react": "^19.2.5"
+  },
+  "devDependencies": {
+    "@effect/vitest": "4.0.0-beta.65",
+    "@types/node": "^24.12.2",
+    "@types/react": "^19.2.14",
+    "ink-testing-library": "^4.0.0",
+    "tsdown": "^0.21.10",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.6",
+    "@mysten-incubation/tsconfig": "0.0.0"
+  },
+  "peerDependencies": {
+    "vitest": "^4.1.6"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "smoke:pack-consumer": "node scripts/packed-consumer-typecheck.mjs",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:e2e": "DEVSTACK_RUN_E2E=1 vitest run"
+  }
+}