Skip to content

Commit 148f56d

Browse files
authored
Update README.md
1 parent d619199 commit 148f56d

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,17 +66,29 @@ The web server starts at default address `localhost:3000` with the following rou
6666
If mining is enabled, the esplora broadcast endpoint is wrapped so that a block is mined just after the transaction is published to get it confirmed; this is useful when running in regtest network.
6767
All requests to chopsticks are (optionally) logged using a logger inspired by [negroni](https://github.com/urfave/negroni) package.
6868

69-
To customize server urls and ports use flags when running the binary:
70-
71-
- `--chain` one between `bitcoin` and `liquid`
72-
- `--addr` server listening address (default `localhost:3000`)
73-
- `--rpc-addr` btc RPC server listening address (default `localhost:19001`)
74-
- `--btc-cookie` btc RPC server user and password (default `admin1:123`)
75-
- `--liquid-addr` liquid RPC server listening address (default `localhost:18884`)
76-
- `--electrs-addr` electrs HTTP server listening address (default `localhost:3002`)
77-
- `--use-tls` specify using either `http` or `https` (default `true`)
78-
- `--use-faucet` to have a /faucet endpoint available for sending funds
79-
- `--use-mining` to have the esplora /broadcast endpoint wrapped so that a block is mined after the transaction
80-
is published
81-
- `--use-logger` to log every request/response
82-
- `--registry-path` to set the path for the asset registry db (default to current directory - Liquid only)
69+
70+
## Configuration: Command-Line Flags
71+
72+
### Network Selection
73+
- `--chain` - Choose between bitcoin or liquid networks
74+
- `--wallet-name` - Specify wallet name (default: empty string `""`)
75+
76+
### Server Configuration
77+
- `--addr` - Server listening address (default: localhost:3000)
78+
- `--use-tls` - Enable/disable HTTPS (default: true)
79+
- `--use-logger` - Log all request/response activity
80+
81+
### Bitcoin Node Connection
82+
- `--rpc-addr` - Bitcoin RPC server address (default: localhost:19001)
83+
- `--btc-cookie` - Bitcoin RPC credentials (default: admin1:123)
84+
85+
### Liquid Node Connection
86+
- `--liquid-addr` - Liquid RPC server address (default: localhost:18884)
87+
- `--registry-path` - Path for asset registry database (Liquid only, defaults to current directory)
88+
89+
### Electrum Server Connection
90+
- `--electrs-addr` - Electrs HTTP server address (default: localhost:3002)
91+
92+
### Testing Utilities
93+
- `--use-faucet` - Enable /faucet endpoint for requesting funds
94+
- `--use-mining` - Enable automatic block mining after transaction broadcast

0 commit comments

Comments
 (0)