Skip to content

Commit

Permalink
docs: clarify node announcement broadcast logic
Browse files Browse the repository at this point in the history
  • Loading branch information
enigbe committed Aug 6, 2024
1 parent 8791d7c commit cfd764b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ LDK Node currently comes with a decidedly opinionated set of design choices:
- Gossip data may be sourced via Lightning's peer-to-peer network or the [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) protocol.
- Entropy for the Lightning and on-chain wallets may be sourced from raw bytes or a [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic. In addition, LDK Node offers the means to generate and persist the entropy bytes to disk.

**Note**:
Regarding node announcements, we have decided not to broadcast these announcements if either the node's listening addresses or its node alias are not set.

## Language Support
LDK Node itself is written in [Rust][rust] and may therefore be natively added as a library dependency to any `std` Rust program. However, beyond its Rust API it also offers language bindings for [Swift][swift], [Kotlin][kotlin], and [Python][python] based on the [UniFFI](https://github.com/mozilla/uniffi-rs/). Moreover, [Flutter bindings][flutter_bindings] are also available.

Expand Down

0 comments on commit cfd764b

Please sign in to comment.