aiolabs/bitspire
9
0
Fork 0
Code Issues 52 Pull requests 2 Projects Releases Packages Wiki Activity Actions

docs: add new dev.sh commands to README

Browse source 
- Add atm, zeus, mine commands to table
- Add --machine flag documentation
- Ignore docker/.state/ directory (generated files)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Patrick Mulligan 2026-02-15 15:02:11 -05:00
commit 0dafb7d8a8
6 changed files with 29 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -59,6 +59,7 @@ apps/machine/release/
# Docker # Docker
docker/**/data/ docker/**/data/
docker/.state/
# Temporary # Temporary
tmp/ tmp/

52
README.md
View file

@ -41,23 +41,27 @@ If status shows all services running and ATM funded, you're ready to develop!
./docker/dev.sh <command> [options] ./docker/dev.sh <command> [options]
``` ```
| Command | Description | | Command | Description |
| ------------- | ---------------------------------------------- | | ---------------- | -------------------------------------- |
| `up` | Start regtest + Lightning.Pub + relay | | `up` | Start regtest + Lightning.Pub + relay |
| `up --fund` | Start and auto-fund ATM with 100k sats | | `up --fund` | Start and auto-fund ATM with 100k sats |
| `down` | Stop all services | | `up --machine` | Start and launch ATM app |
| `status` | Show service status and ATM balance | | `down` | Stop all services |
| `fund [sats]` | Fund ATM app owner (default: 100000) | | `status` | Show service status and ATM balance |
| `logs` | Follow service logs | | `atm` | Launch ATM application (Electron) |
| `reset` | Stop services and clear all state | | `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 ### pnpm Scripts
| Command | Description | | Command | Description |
| -------------- | -------------------------- | | ------------ | ----------------------------------- |
| `pnpm dev` | Start machine app (Vite + Electron) | | `pnpm dev` | Start machine app (Vite + Electron) |
| `pnpm build` | Build all packages | | `pnpm build` | Build all packages |
| `pnpm test` | Run unit tests | | `pnpm test` | Run unit tests |
### Machine App ### Machine App
@ -85,16 +89,16 @@ lamassu-next/
## Infrastructure Services ## Infrastructure Services
| Service | Port | Description | | Service | Port | Description |
| ----------------- | ----- | ------------------------------------ | | ------------------ | ----- | ----------------------------------- |
| strfry | 7777 | Nostr relay (ws://localhost:7777) | | strfry | 7777 | Nostr relay (ws://localhost:7777) |
| bitcoind | 18443 | Bitcoin regtest node | | bitcoind | 18443 | Bitcoin regtest node |
| lnd-1 | 10001 | Lightning.Pub's LND node | | lnd-1 | 10001 | Lightning.Pub's LND node |
| lnd-2 | 10002 | Peer node for channel | | lnd-2 | 10002 | Peer node for channel |
| lnd-3 | 10003 | Funding source (auto-miner rewards) | | lnd-3 | 10003 | Funding source (auto-miner rewards) |
| Lightning.Pub | 1776 | Nostr-native accounts API | | Lightning.Pub | 1776 | Nostr-native accounts API |
| Withdraw Extension| 1777 | LNURL-withdraw for cash-in | | Withdraw Extension | 1777 | LNURL-withdraw for cash-in |
| PostgreSQL | 5432 | Lightning.Pub database | | PostgreSQL | 5432 | Lightning.Pub database |
## Testing Cash-In Flow ## Testing Cash-In Flow

1
docker/.state/atm-app-id
View file

@ -1 +0,0 @@
02f5340554b29537f4b9c3bb6c131f69c08044b2114939849d3bec8c4df456e7

1
docker/.state/atm-app-token
View file

@ -1 +0,0 @@
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6IjAyZjUzNDA1NTRiMjk1MzdmNGI5YzNiYjZjMTMxZjY5YzA4MDQ0YjIxMTQ5Mzk4NDlkM2JlYzhjNGRmNDU2ZTciLCJpYXQiOjE3NzExODIwMTZ9.uE473GYJdB946daNCZ-5PqPe1JGihSM6KnL66n1AN7k

1
docker/.state/lightning-pub-nprofile
View file

@ -1 +0,0 @@
nprofile1qyg8wue69uhhxarjvee8jw3hxumnwqpq35fnkv4nguyhrutu4tspkjlfaqs95pnnegzqkg24h040vn3852jshankcx

1
docker/.state/lightning-pub-pubkey
View file

@ -1 +0,0 @@
8d133b32b3470971f17caae01b4be9e8205a0673ca040b2155bbeaf64e27a2a5