0.7.0 • Published 4 years ago
@lntools/gossip-rocksdb v0.7.0
LNTools
The goal of LNTools is to build composible modules of the Lightning Network specificiation. These modules can be combined into tools that can interact with the Lightning Network for research, testing, or building awesome things.
This module is not intended to be an alternative to LND, c-lightning, or Eclair.
Structure and Modules
LNTools is structured as a monorepo with individual packages existing inside of packages.
- @lntools/bitcoin - tools for building and parsing Bitcoin blocks and transactions
- @lntools/bitcoind - bitcoind RPC and zeromq client
- @lntools/buffer-cursor - utility for reading and writing Buffers
- @lntools/crypto - common cryptography utilities
- @lntools/gossip-rocksdb - stores gossip messages in RocksDB
- @lntools/graph - builds and maintains a Lightning Network routing graph
- @lntools/invoice - encoding/decoding Lightning Network invoices
- @lntools/logger - logging utility
- @lntools/noise - Noise Protocol socket/server
- @lntools/wire - wire protocol and gossipfor the Lightning Network
Examples of usage can be found inside examples
- examples/peer - simple peer connectiono example
- examples/gossip - basic gossip example
- examples/graph - full gossip, storage, and graph construction example
BOLT Status
Current status of Lightning RFC specification implementation:
- BOLT 1 - Base Protocol
- BOLT 2 - Peer Protocol for Channel Management
- BOLT 3 - Bitcoin Transaction and Script Format
- BOLT 4 - Onion Routing Protocol
- BOLT 5 - Recommendations for On-chain Transaction Handling
- BOLT 7 - P2P Node and Channel Discovery: @lntools/wire, @lntools/graph
- BOLT 8 - Encrypted and Authenticated Transport: @lntools/noise
- BOLT 9 - Assigned Feature Flags: @lntools/wire
- BOLT 10 - DNS Bootstrap and Assisted Node Location
- BOLT 11 - Invoice Protocol for Lightning Payments: @lntools/invoice
Contributing
Refer to the contribution guide.