@fairmint/canton-node-sdk 0.0.251 → 0.0.252

package/README.md

@@ -4,10 +4,10 @@ Low-level TypeScript SDK for Canton Network nodes (Ledger JSON API, Validator AP
 
 ## Developer documentation
 
-The public [GitHub wiki](https://github.com/Fairmint/canton-node-sdk/wiki) is the canonical guide for
-configuration, API boundaries, external signing, LocalNet, examples, and contribution. The public
-[`src/index.ts`](https://github.com/Fairmint/canton-node-sdk/blob/main/src/index.ts) defines the
-supported package surface; use the installed declarations and public
+The public [GitHub wiki](https://github.com/Fairmint/canton-node-sdk/wiki) is the canonical guide
+for configuration, API boundaries, external signing, LocalNet, examples, and contribution. The
+public [`src/index.ts`](https://github.com/Fairmint/canton-node-sdk/blob/main/src/index.ts) defines
+the supported package surface; use the installed declarations and public
 [`examples/`](https://github.com/Fairmint/canton-node-sdk/tree/main/examples) and
 [`test/`](https://github.com/Fairmint/canton-node-sdk/tree/main/test) for exact methods, request
 shapes, and error behavior.
@@ -19,10 +19,10 @@ npm install @fairmint/canton-node-sdk
 ```
 
 ```ts
-import { Canton } from "@fairmint/canton-node-sdk";
+import { Canton } from '@fairmint/canton-node-sdk';
 
 async function main(): Promise<void> {
-  const canton = new Canton({ network: "localnet" });
+  const canton = new Canton({ network: 'localnet' });
   const version = await canton.ledger.getVersion();
   console.log(version);
 }
@@ -44,4 +44,31 @@ npm test
 npm run build
 ```
 
-Run `npm run localnet:verify` for the full LocalNet smoke and integration path.
+### LocalNet (owned by `@fairmint/canton-dev-tools`)
+
+LocalNet lifecycle and shared test helpers live in
+[`@fairmint/canton-dev-tools@0.1.1`](https://www.npmjs.com/package/@fairmint/canton-dev-tools)
+(see its [COMPATIBILITY.md](https://github.com/Fairmint/canton-dev-tools/blob/main/COMPATIBILITY.md)).
+This SDK does not publish a LocalNet CLI or `scripts/localnet-cloud.sh`.
+
+```bash
+npm install   # installs @fairmint/canton-dev-tools as an exact-pinned devDependency
+npm run localnet:start
+npm run localnet:smoke
+npm run localnet:stop
+
+# Or call the Dev Tools CLI directly:
+npx @fairmint/canton-dev-tools start
+```
+
+Integration helpers:
+
+```ts
+import {
+  buildIntegrationTestClientConfig,
+  getLocalnetParticipantAdminLedgerClient,
+} from '@fairmint/canton-dev-tools/testing';
+```
+
+See [docs/package-boundary.md](docs/package-boundary.md) for what the npm package publishes versus
+CI-only surfaces (`npm run check:package-artifacts`).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fairmint/canton-node-sdk",
-  "version": "0.0.251",
+  "version": "0.0.252",
   "description": "Canton Node SDK",
   "keywords": [
     "canton",
@@ -21,13 +21,8 @@
   "author": "Fairmint",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
-  "bin": {
-    "canton-localnet": "bin/canton-localnet"
-  },
   "files": [
-    "bin/canton-localnet",
-    "scripts/localnet-cloud.sh",
-    "build/**"
+    "build/src/**"
   ],
   "scripts": {
     "artifacts:manifest": "mkdir -p artifacts && npm pack --dry-run --json --ignore-scripts > /tmp/npm-pack.json 2>/dev/null && jq -r '.[0].files[].path' /tmp/npm-pack.json | sort | tsx scripts/collapse-manifest.ts > artifacts/npm-manifest.txt",
@@ -47,14 +42,17 @@
     "lint:fix": "eslint . --fix",
     "lint:npm": "npmPkgJsonLint . --fix",
     "lint:npm:check": "npmPkgJsonLint .",
-    "localnet:logs": "bash ./bin/canton-localnet logs",
-    "localnet:quickstart": "bash ./bin/canton-localnet setup",
-    "localnet:setup": "bash ./bin/canton-localnet setup",
-    "localnet:smoke": "bash ./bin/canton-localnet smoke",
-    "localnet:start": "bash ./bin/canton-localnet start",
-    "localnet:status": "bash ./bin/canton-localnet status",
-    "localnet:stop": "bash ./bin/canton-localnet stop",
-    "localnet:verify": "bash ./bin/canton-localnet verify",
+    "localnet:diagnostics": "canton-dev-tools diagnostics",
+    "localnet:logs": "canton-dev-tools logs",
+    "localnet:quickstart": "canton-dev-tools setup",
+    "localnet:readiness": "canton-dev-tools readiness",
+    "localnet:setup": "canton-dev-tools setup",
+    "localnet:smoke": "canton-dev-tools smoke",
+    "localnet:start": "canton-dev-tools start",
+    "localnet:status": "canton-dev-tools status",
+    "localnet:stop": "canton-dev-tools stop",
+    "localnet:teardown": "canton-dev-tools teardown",
+    "localnet:verify": "canton-dev-tools verify",
     "prepack": "npm run clean && npm run build:core",
     "prepare-release": "tsx scripts/prepare-release.ts",
     "prepublishOnly": "npm run prepack",
@@ -81,6 +79,7 @@
     "zod": "4.4.3"
   },
   "devDependencies": {
+    "@fairmint/canton-dev-tools": "0.1.1",
     "@types/jest": "30.0.0",
     "@types/node": "26.1.0",
     "@types/ws": "8.18.1",

package/bin/canton-localnet

@@ -1,213 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-resolve_script_dir() {
-  local source="$1"
-  local dir=""
-
-  while [[ -L "${source}" ]]; do
-    dir="$(cd -P "$(dirname "${source}")" && pwd)"
-    source="$(readlink "${source}")"
-    if [[ "${source}" != /* ]]; then
-      source="${dir}/${source}"
-    fi
-  done
-
-  cd -P "$(dirname "${source}")" && pwd
-}
-
-PACKAGE_ROOT="$(cd "$(resolve_script_dir "${BASH_SOURCE[0]}")/.." && pwd)"
-LOCALNET_SCRIPT="${PACKAGE_ROOT}/scripts/localnet-cloud.sh"
-DEFAULT_QUICKSTART_REPO="https://github.com/digital-asset/cn-quickstart.git"
-DEFAULT_QUICKSTART_REF="2f4edfc17621a7dfb6d44357050c22f4b3914c89"
-DEFAULT_SPLICE_VERSION="0.6.8"
-
-log() {
-  printf '[canton-localnet] %s\n' "$*"
-}
-
-usage() {
-  cat <<'USAGE'
-Usage: canton-localnet <command>
-
-Commands:
-  setup    Prepare LocalNet prerequisites
-  start    Start lean LocalNet + Keycloak and wait for ready endpoints
-  stop     Stop LocalNet services
-  logs     Show LocalNet diagnostic logs
-  status   Show docker + endpoint status
-  smoke    Run endpoint smoke checks
-  test     Run project integration tests when configured
-  verify   Run setup + start + smoke + test
-
-One-liners:
-  npx @fairmint/canton-node-sdk start
-  npx @fairmint/canton-node-sdk verify
-
-Environment:
-  CANTON_LOCALNET_QUICKSTART_DIR   Use an existing cn-quickstart/quickstart directory
-  CANTON_LOCALNET_CACHE_DIR        Cache root for fetched cn-quickstart assets
-  CANTON_LOCALNET_QUICKSTART_REF   cn-quickstart git ref to fetch
-  CANTON_LOCALNET_SPLICE_VERSION   Splice image tag (defaults to the SDK's pinned API version)
-  CANTON_LOCALNET_INFRA_ONLY       Defaults to true for this package binary
-USAGE
-}
-
-require_command() {
-  local cmd="$1"
-  if ! command -v "${cmd}" >/dev/null 2>&1; then
-    log "Missing required command: ${cmd}"
-    exit 1
-  fi
-}
-
-cache_root() {
-  if [[ -n "${CANTON_LOCALNET_CACHE_DIR:-}" ]]; then
-    printf '%s' "${CANTON_LOCALNET_CACHE_DIR}"
-    return
-  fi
-
-  if [[ -n "${XDG_CACHE_HOME:-}" ]]; then
-    printf '%s' "${XDG_CACHE_HOME}/fairmint/canton-localnet"
-    return
-  fi
-
-  printf '%s' "${HOME}/.cache/fairmint/canton-localnet"
-}
-
-quickstart_ref() {
-  printf '%s' "${CANTON_LOCALNET_QUICKSTART_REF:-${DEFAULT_QUICKSTART_REF}}"
-}
-
-quickstart_repo() {
-  printf '%s' "${CANTON_LOCALNET_QUICKSTART_REPO:-${DEFAULT_QUICKSTART_REPO}}"
-}
-
-default_splice_version() {
-  if [[ -f "${PACKAGE_ROOT}/libs/splice/VERSION" ]]; then
-    local version=""
-    version="$(tr -d '[:space:]' < "${PACKAGE_ROOT}/libs/splice/VERSION")"
-    if [[ -n "${version}" ]]; then
-      printf '%s' "${version}"
-      return
-    fi
-  fi
-
-  printf '%s' "${DEFAULT_SPLICE_VERSION}"
-}
-
-default_quickstart_root() {
-  printf '%s/cn-quickstart-%s' "$(cache_root)" "$(quickstart_ref)"
-}
-
-repo_quickstart_dir() {
-  printf '%s/libs/cn-quickstart/quickstart' "${PACKAGE_ROOT}"
-}
-
-use_repo_quickstart_default() {
-  [[ -z "${CANTON_LOCALNET_QUICKSTART_DIR:-}" \
-    && -f "${PACKAGE_ROOT}/.gitmodules" \
-    && ( -d "${PACKAGE_ROOT}/.git" || -f "${PACKAGE_ROOT}/.git" ) ]]
-}
-
-quickstart_dir() {
-  if [[ -n "${CANTON_LOCALNET_QUICKSTART_DIR:-}" ]]; then
-    printf '%s' "${CANTON_LOCALNET_QUICKSTART_DIR}"
-    return
-  fi
-
-  if use_repo_quickstart_default; then
-    repo_quickstart_dir
-    return
-  fi
-
-  printf '%s/quickstart' "$(default_quickstart_root)"
-}
-
-ensure_quickstart_checkout() {
-  local dir=""
-  local root=""
-  local tmp=""
-
-  if use_repo_quickstart_default; then
-    return
-  fi
-
-  dir="$(quickstart_dir)"
-  if [[ -d "${dir}/docker/modules/localnet" ]]; then
-    return
-  fi
-
-  if [[ -n "${CANTON_LOCALNET_QUICKSTART_DIR:-}" ]]; then
-    log "CANTON_LOCALNET_QUICKSTART_DIR is not a cn-quickstart quickstart directory: ${dir}"
-    exit 1
-  fi
-
-  require_command git
-
-  root="$(default_quickstart_root)"
-  if [[ -e "${root}" ]]; then
-    log "Cached cn-quickstart directory exists but is incomplete: ${root}"
-    log "Remove it or set CANTON_LOCALNET_CACHE_DIR to use a fresh cache."
-    exit 1
-  fi
-
-  mkdir -p "$(cache_root)"
-  tmp="$(mktemp -d "$(cache_root)/cn-quickstart.XXXXXX")"
-  trap 'rm -rf "${tmp}"' RETURN
-
-  log "Fetching cn-quickstart $(quickstart_ref)..."
-  git -C "${tmp}" init -q
-  git -C "${tmp}" remote add origin "$(quickstart_repo)"
-  if git -C "${tmp}" fetch --depth 1 origin "$(quickstart_ref)"; then
-    git -C "${tmp}" checkout --detach FETCH_HEAD -q
-  else
-    log "Direct ref fetch failed; retrying with a blobless repository fetch."
-    git -C "${tmp}" fetch --filter=blob:none origin
-    git -C "${tmp}" checkout --detach "$(quickstart_ref)" -q
-  fi
-
-  if [[ ! -d "${tmp}/quickstart/docker/modules/localnet" ]]; then
-    log "Fetched cn-quickstart does not contain quickstart/docker/modules/localnet."
-    exit 1
-  fi
-
-  mv "${tmp}" "${root}"
-  trap - RETURN
-  log "Cached cn-quickstart at ${root}."
-}
-
-main() {
-  local command="${1:-}"
-  local dir=""
-
-  case "${command}" in
-    "" | -h | --help | help)
-      usage
-      if [[ -z "${command}" ]]; then
-        exit 1
-      fi
-      exit 0
-      ;;
-    setup | start | verify)
-      ensure_quickstart_checkout
-      ;;
-    logs | status | stop | smoke | test)
-      ;;
-    *)
-      usage
-      exit 1
-      ;;
-  esac
-
-  dir="$(quickstart_dir)"
-  if ! use_repo_quickstart_default; then
-    export CANTON_LOCALNET_QUICKSTART_DIR="${dir}"
-  fi
-  export CANTON_LOCALNET_SPLICE_VERSION="${CANTON_LOCALNET_SPLICE_VERSION:-$(default_splice_version)}"
-  export CANTON_LOCALNET_INFRA_ONLY="${CANTON_LOCALNET_INFRA_ONLY:-true}"
-
-  exec bash "${LOCALNET_SCRIPT}" "$@"
-}
-
-main "$@"