Skip to content

Commit aa18dcb

Browse files
gStart9kn0wmad
andauthored
Sparrow Guide using Bitcoin Core RPC makeover (Start9Labs#113)
* Sparrow Guide using Bitcoin Core RPC makeover * Update images * A couple touchups, 1 image update * 1 doc typo, 1 image touchup * Update guide.md --------- Co-authored-by: kn0wmad <[email protected]>
1 parent f775a0c commit aa18dcb

File tree

7 files changed

+17
-23
lines changed

7 files changed

+17
-23
lines changed
12.1 KB
Loading
-1.08 KB
Loading
9.89 KB
Loading
-186 Bytes
Loading
-8.63 KB
Loading
-11.1 KB
Loading

docs/integrations/sparrow/guide.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,44 @@
11
# Sparrow Wallet Setup Guide
22

3-
You have several options for connecting Sparrow to your Embassy. You may connect via the Bitcoin Proxy service, which will allow you to make an RPC user and password specifically for Sparrow. This is the recommended method. The next option is to use your Bitcoin Core service directly. In future, Embassy will also have an Electrum Server service for even greater flexibility. This guide will be added when available.
3+
You have two options for connecting Sparrow directly to Bitcoin's RPC: LAN (.local) and Tor (.onion). LAN of course only works on the lan but is very fast, while Tor works remotely but is slow. Switching between them is just a matter of changing .local to .onion (or vice versa) and switching the Tor proxy off or on, respectively.
44

5-
## Using Bitcoin Proxy
5+
If you use tor, you will need to have Tor running natively on your device in order to use Sparrow remotely. You can find the relevant setup documentation in the Resources section at the bottom of this page.
66

7-
You will need to have Tor running natively on your device in order to use Sparrow. You can find the relevant setup documentation in the Resources section at the bottom of this page.
7+
## Configuring Sparrow to use the Bitcoin Core RPC
88

9-
1. First install the Bitcoin Core and Bitcoin Proxy services to your Embassy from the Marketplace.
9+
1. First, install the Bitcoin Core service to your Embassy from the Start9 Marketplace.
1010

1111
2. Configure Bitcoin Core and allow it to begin the Initial Blockchain Download if you have not already. You may continue even if this is still in progress, but you will need to let the sync complete before creating your first transaction. Bitcoin Core MUST have the "Enable Wallet" feature turned on. This is found in *Bitcoin Core > Config > Wallet*.
1212

13-
3. Configure Bitcoin Proxy and create a new user. You may call it "sparrow," for example, or anything you will remember for use with your Sparrow wallet. Embassy will generate a unique password for you, but you may change it if you wish (this will always be available to view or change as you wish). Make sure the option for "Fetch Blocks" is turned off.
14-
15-
![Sparrow Server Setup](./assets/sparrow-server-setup0.png "Setup Bitcoin Proxy")
16-
17-
4. Next, download, install, and launch Sparrow. If this is the first time you have run Sparrow, you will be guided to a screen where you will be asked to configure your Bitcoin server. Otherwise, you can find the server setup in Preferences. Select the option for "Bitcoin Core" as the "Server Type."
13+
3. Next, [download](https://sparrowwallet.com/download/), install, and launch Sparrow. If this is the first time you have run Sparrow, you will be guided to a screen where you will be asked to configure your Bitcoin server. Otherwise, you can find the server setup in Preferences. Select the option for "Bitcoin Core" as the **Server** Type:
1814

1915
![Sparrow Server Setup](./assets/sparrow-server-setup2.png "Setup Your Bitcoin Server")
2016

21-
5. From your Bitcoin Proxy service page, click "Interfaces," and copy your Tor address. Paste this into the "URL" field, removing the `http://` prefix, as Sparrow does not require it. In the "Port" field, type `8332`.
17+
4. From your Embassy's Bitcoin Core service page, click "Interfaces," and copy the `Tor Address` under **RPC Interface**. Paste this into Sparrow's "URL" field, removing the `http://` prefix, as Sparrow will not accept it. In the "Port" field, type `443`:
2218

2319
![Sparrow Server Setup](./assets/sparrow-server-setup3.png "Enter URL & Port")
2420

25-
6. Select "User/Pass" as the Authentication method. Return to the Proxy service page again, click "Properties" -> "RPC Users" -> and select the Sparrow user you created earlier. Copy the password. Enter the user's name where indicated in the Sparrow server setup, and paste in the password.
21+
**Note**: Use port `8332` if you are using your Tor Address.
2622

27-
![Sparrow Server Setup](./assets/sparrow-server-setup4.png "Add RPC User & Password")
23+
5. Return to your Embassy's Bitcoin Core service page again, and click "Properties" -> "RPC Username". Copy the Username using the button to the right:
2824

29-
7. Select "Use Proxy," and enter the default values of `127.0.0.1` and `9050` for the URL and Port, respectively.
25+
![Bitcoin RPC Credentials](./assets/sparrow-server-setup4-rpc-user-pass.png "Copy Bitcoin RPC Username and Password")
3026

31-
![Sparrow Server Setup](./assets/sparrow-server-setup5.png "Use Tor Proxy")
27+
In Sparrow, select "User/Pass" as the Authentication method and paste in the previously copied Username into the **User** field in Sparrow. Do the same for the "RPC Password":
3228

33-
8. Finally, click "Test Connection" to verify that you are able to reach your Bitcoin node. If your node is not yet synced, Sparrow will let you know, as shown in our example
29+
![Sparrow Server Setup](./assets/sparrow-server-setup4.png "Add RPC User & Password to Sparrow")
3430

35-
![Sparrow Server Setup](./assets/sparrow-server-setup6.png "Test Connection")
31+
6. OPTIONAL - Only applies if you are using the .onion: Select "Use Proxy," and enter the default values of `localhost` and `9050` for the URL and Port, respectively:
3632

37-
From here you can complete your wallet setup and begin using Sparrow Wallet!
38-
39-
**NOTE** Sparrow has a dependency that has not yet added Taproot support, so only Segwit wallets (the default) are currently available with this platform. The only existing workaround at this time is to use an Electrum Server.
33+
![Sparrow Server Setup](./assets/sparrow-server-setup5.png "Use Tor Proxy")
4034

41-
## Using Bitcoin Core
35+
**Note**: If you are using the .local, leave "Use Proxy" **disabled**.
4236

43-
The steps are the same as above, with 2 changes:
37+
7. Finally, click "Test Connection" to verify that you are able to reach your Bitcoin node. If your node is not yet synced, Sparrow will let you know it's not fully ready to be connected to. Otherwise, you should just see a Satoshi message:
4438

45-
In Step 5: instead of using your Bitcoin Proxy Tor address, you will use your Bitcoin Core Tor address.
39+
![Sparrow Server Setup](./assets/sparrow-server-setup6.png "Test Connection")
4640

47-
In Step 6: instead of using the Proxy User and Password, you will use the Bitcoin Core credentials, found under "Properties" in the Bitcoin Core Service page.
41+
From here you can click **[Close]** complete your wallet setup and begin using Sparrow Wallet!
4842

4943
## Using an Electrum Server
5044

0 commit comments

Comments
 (0)