From 0dafb7d8a87d2b7492d9e52433ec0f6bb7d6600e Mon Sep 17 00:00:00 2001 From: Patrick Mulligan Date: Sun, 15 Feb 2026 15:02:11 -0500 Subject: [PATCH] docs: add new dev.sh commands to README - Add atm, zeus, mine commands to table - Add --machine flag documentation - Ignore docker/.state/ directory (generated files) Co-Authored-By: Claude Opus 4.5 --- .gitignore | 1 + README.md | 52 +++++++++++++++------------- docker/.state/atm-app-id | 1 - docker/.state/atm-app-token | 1 - docker/.state/lightning-pub-nprofile | 1 - docker/.state/lightning-pub-pubkey | 1 - 6 files changed, 29 insertions(+), 28 deletions(-) delete mode 100644 docker/.state/atm-app-id delete mode 100644 docker/.state/atm-app-token delete mode 100644 docker/.state/lightning-pub-nprofile delete mode 100644 docker/.state/lightning-pub-pubkey diff --git a/.gitignore b/.gitignore index 92356a7..c90aa4a 100644 --- a/.gitignore +++ b/.gitignore @@ -59,6 +59,7 @@ apps/machine/release/ # Docker docker/**/data/ +docker/.state/ # Temporary tmp/ diff --git a/README.md b/README.md index fb5db33..a2c5361 100644 --- a/README.md +++ b/README.md @@ -41,23 +41,27 @@ If status shows all services running and ATM funded, you're ready to develop! ./docker/dev.sh [options] ``` -| Command | Description | -| ------------- | ---------------------------------------------- | -| `up` | Start regtest + Lightning.Pub + relay | -| `up --fund` | Start and auto-fund ATM with 100k sats | -| `down` | Stop all services | -| `status` | Show service status and ATM balance | -| `fund [sats]` | Fund ATM app owner (default: 100000) | -| `logs` | Follow service logs | -| `reset` | Stop services and clear all state | +| Command | Description | +| ---------------- | -------------------------------------- | +| `up` | Start regtest + Lightning.Pub + relay | +| `up --fund` | Start and auto-fund ATM with 100k sats | +| `up --machine` | Start and launch ATM app | +| `down` | Stop all services | +| `status` | Show service status and ATM balance | +| `atm` | Launch ATM application (Electron) | +| `zeus` | Show Zeus wallet connection QR code | +| `fund [sats]` | Fund ATM app owner (default: 100000) | +| `mine [blocks]` | Mine regtest blocks (default: 1) | +| `logs [service]` | Follow service logs | +| `reset` | Stop services and clear all state | ### pnpm Scripts -| Command | Description | -| -------------- | -------------------------- | -| `pnpm dev` | Start machine app (Vite + Electron) | -| `pnpm build` | Build all packages | -| `pnpm test` | Run unit tests | +| Command | Description | +| ------------ | ----------------------------------- | +| `pnpm dev` | Start machine app (Vite + Electron) | +| `pnpm build` | Build all packages | +| `pnpm test` | Run unit tests | ### Machine App @@ -85,16 +89,16 @@ lamassu-next/ ## Infrastructure Services -| Service | Port | Description | -| ----------------- | ----- | ------------------------------------ | -| strfry | 7777 | Nostr relay (ws://localhost:7777) | -| bitcoind | 18443 | Bitcoin regtest node | -| lnd-1 | 10001 | Lightning.Pub's LND node | -| lnd-2 | 10002 | Peer node for channel | -| lnd-3 | 10003 | Funding source (auto-miner rewards) | -| Lightning.Pub | 1776 | Nostr-native accounts API | -| Withdraw Extension| 1777 | LNURL-withdraw for cash-in | -| PostgreSQL | 5432 | Lightning.Pub database | +| Service | Port | Description | +| ------------------ | ----- | ----------------------------------- | +| strfry | 7777 | Nostr relay (ws://localhost:7777) | +| bitcoind | 18443 | Bitcoin regtest node | +| lnd-1 | 10001 | Lightning.Pub's LND node | +| lnd-2 | 10002 | Peer node for channel | +| lnd-3 | 10003 | Funding source (auto-miner rewards) | +| Lightning.Pub | 1776 | Nostr-native accounts API | +| Withdraw Extension | 1777 | LNURL-withdraw for cash-in | +| PostgreSQL | 5432 | Lightning.Pub database | ## Testing Cash-In Flow diff --git a/docker/.state/atm-app-id b/docker/.state/atm-app-id deleted file mode 100644 index e461f80..0000000 --- a/docker/.state/atm-app-id +++ /dev/null @@ -1 +0,0 @@ -02f5340554b29537f4b9c3bb6c131f69c08044b2114939849d3bec8c4df456e7 diff --git a/docker/.state/atm-app-token b/docker/.state/atm-app-token deleted file mode 100644 index 6ac561e..0000000 --- a/docker/.state/atm-app-token +++ /dev/null @@ -1 +0,0 @@ -eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6IjAyZjUzNDA1NTRiMjk1MzdmNGI5YzNiYjZjMTMxZjY5YzA4MDQ0YjIxMTQ5Mzk4NDlkM2JlYzhjNGRmNDU2ZTciLCJpYXQiOjE3NzExODIwMTZ9.uE473GYJdB946daNCZ-5PqPe1JGihSM6KnL66n1AN7k diff --git a/docker/.state/lightning-pub-nprofile b/docker/.state/lightning-pub-nprofile deleted file mode 100644 index 00d067e..0000000 --- a/docker/.state/lightning-pub-nprofile +++ /dev/null @@ -1 +0,0 @@ -nprofile1qyg8wue69uhhxarjvee8jw3hxumnwqpq35fnkv4nguyhrutu4tspkjlfaqs95pnnegzqkg24h040vn3852jshankcx diff --git a/docker/.state/lightning-pub-pubkey b/docker/.state/lightning-pub-pubkey deleted file mode 100644 index 3434c71..0000000 --- a/docker/.state/lightning-pub-pubkey +++ /dev/null @@ -1 +0,0 @@ -8d133b32b3470971f17caae01b4be9e8205a0673ca040b2155bbeaf64e27a2a5