Skip to content

Remove direct bitcoind dependency, sync via electrum/esplora indexer #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
bitwalt wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Remove direct bitcoind dependency, sync via electrum/esplora indexer #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 16 additions & 40 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,19 @@ chacha20poly1305 = { version = "0.10.1", features = ["stream"] }
chrono = { version = "0.4", default-features = false, features = ["clock"] }
clap = "4.5.20"
dirs = "5.0.1"
electrum-client = { version = "0.24.0", default-features = false, features = ["use-rustls"] }
esplora-client = { version = "0.12", default-features = false, features = ["blocking-https-rustls"] }
futures = "0.3"
hex = { package = "hex-conservative", version = "0.3.0", default-features = false }
lightning = { version = "0.2.0", path = "./rust-lightning/lightning", features = ["dnssec"] }
lightning-background-processor = { version = "0.2.0", path = "./rust-lightning/lightning-background-processor" }
lightning-block-sync = { version = "0.2.0", features = ["rpc-client", "tokio"] }
lightning-dns-resolver = { version = "0.3.0", path = "./rust-lightning/lightning-dns-resolver" }
lightning-invoice = { version = "0.34.0", features = ["std"], path = "./rust-lightning/lightning-invoice" }
lightning-macros = { version = "0.2.0" }
lightning-net-tokio = { version = "0.2.0" }
lightning-persister = { version = "0.2.0", path = "./rust-lightning/lightning-persister", features = ["tokio"] }
lightning-rapid-gossip-sync = { version = "0.2.0", path = "./rust-lightning/lightning-rapid-gossip-sync" }
lightning-transaction-sync = { version = "0.2.0", path = "./rust-lightning/lightning-transaction-sync", features = ["electrum", "esplora-blocking"] }
magic-crypt = "4.0.1"
rand = "0.8.5"
regex = { version = "1.11", default-features = false }
Expand All @@ -59,7 +61,6 @@ zip = { version = "2.2.0", default-features = false, features = ["time", "zstd"]

[dev-dependencies]
dircmp = "0.2.0"
electrum-client = "0.20.0"
http = "1.4.0"
lazy_static = { version = "1.5.0", default-features = false }
lightning = { version = "0.2.0", path = "./rust-lightning/lightning", features = ["_rln_test_hooks"] }
Expand Down
15 changes: 0 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,12 @@ docker build -t rgb-lightning-node .
## Run

In order to operate, the node will need:
- a bitcoind node
- an indexer instance (electrum or esplora)
- an [RGB proxy server] instance

Once services are running, daemons can be started.
Each daemon needs to be started in a separate shell with `rgb-lightning-node`,
specifying:
- bitcoind user, password, host and port
- node data directory
- node listening port
- LN peer listening port
Expand Down Expand Up @@ -129,18 +127,10 @@ For more info about regtest utility commands, run:
```

When unlocking regtest nodes use the following local services:
- bitcoind_rpc_username: user
- bitcoind_rpc_password: password
- bitcoind_rpc_host: localhost
- bitcoind_rpc_port: 18433
- indexer_url: 127.0.0.1:50001
- proxy_endpoint: rpc://127.0.0.1:3000/json-rpc

To unlock a regtest nodes running in docker use the following local services:
- bitcoind_rpc_username: user
- bitcoind_rpc_password: password
- bitcoind_rpc_host: bitcoind
- bitcoind_rpc_port: 18433
- indexer_url: electrs:50001
- proxy_endpoint: rpc://proxy:3000/json-rpc

Expand Down Expand Up @@ -172,18 +162,13 @@ rgb-lightning-node dataldk2/ --daemon-listening-port 3003 \
```

When unlocking testnet3 nodes you can use the following services:
- bitcoind_rpc_username: user
- bitcoind_rpc_username: password
- bitcoind_rpc_host: electrum.iriswallet.com
- bitcoind_rpc_port: 18332
- indexer_url: ssl://electrum.iriswallet.com:50013
- proxy_endpoint: rpcs://proxy.iriswallet.com/0.2/json-rpc

#### Testnet4

To run testnet4 use the same options as testnet3 except for:
- CLI arg: `--network testnet4`
- bitcoind_rpc_port: 18443
- indexer_url: ssl://electrum.iriswallet.com:50053

## Use
Expand Down
16 changes: 0 additions & 16 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3117,27 +3117,11 @@ components:
type: object
required:
- password
- bitcoind_rpc_username
- bitcoind_rpc_password
- bitcoind_rpc_host
- bitcoind_rpc_port
- announce_addresses
properties:
password:
type: string
example: nodepassword
bitcoind_rpc_username:
type: string
example: user
bitcoind_rpc_password:
type: string
example: password
bitcoind_rpc_host:
type: string
example: localhost
bitcoind_rpc_port:
type: integer
example: 18443
indexer_url:
type:
- string
Expand Down
Loading
Loading