Top Related Projects
Quick Overview
LND (Lightning Network Daemon) is an implementation of the Lightning Network protocol, a second-layer payment protocol that operates on top of a blockchain-based cryptocurrency such as Bitcoin. It enables fast, scalable, low-cost transactions for cryptocurrencies, addressing some of the scalability issues of blockchain networks.
Pros
- Fast and low-cost transactions: LND allows for near-instant payments with minimal fees
- Increased scalability: Enables a higher volume of transactions without congesting the main blockchain
- Cross-chain atomic swaps: Supports atomic swaps between different cryptocurrencies
- Privacy-enhancing: Provides improved transaction privacy compared to on-chain transactions
Cons
- Complexity: Requires additional setup and management compared to standard cryptocurrency wallets
- Channel limitations: Users need to lock up funds in payment channels, which can be inconvenient
- Still evolving: The Lightning Network is a relatively new technology, with ongoing development and potential security concerns
- Requires online presence: Nodes need to be online to route payments, which can be challenging for some users
Code Examples
- Creating a new wallet:
import (
"github.com/lightningnetwork/lnd/lnrpc"
"github.com/lightningnetwork/lnd/macaroons"
)
ctx := context.Background()
conn, err := grpc.Dial(address, grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})))
client := lnrpc.NewLightningClient(conn)
response, err := client.GenSeed(ctx, &lnrpc.GenSeedRequest{})
- Opening a channel:
request := &lnrpc.OpenChannelRequest{
NodePubkey: []byte("remote_node_pubkey"),
LocalFundingAmount: 1000000, // in satoshis
PushSat: 0,
}
stream, err := client.OpenChannel(ctx, request)
- Sending a payment:
paymentRequest := "lnbc..."
sendRequest := &lnrpc.SendRequest{
PaymentRequest: paymentRequest,
}
response, err := client.SendPaymentSync(ctx, sendRequest)
Getting Started
- Install Go and set up your Go environment
- Clone the LND repository:
git clone https://github.com/lightningnetwork/lnd.git
- Build LND:
cd lnd make make install
- Create a configuration file (lnd.conf) with your desired settings
- Start LND:
lnd --bitcoin.active --bitcoin.testnet --bitcoin.node=neutrino
- Create a new wallet or unlock an existing one using
lncli create
orlncli unlock
For more detailed instructions, refer to the official LND documentation.
Competitor Comparisons
A scala implementation of the Lightning Network.
Pros of Eclair
- Written in Scala, offering functional programming benefits and concise code
- Modular architecture, making it easier to extend and customize
- Strong focus on privacy features and onion routing
Cons of Eclair
- Smaller community and ecosystem compared to LND
- Less extensive documentation and tutorials
- Fewer third-party tools and integrations available
Code Comparison
Eclair (Scala):
def makeChannelUpdate(announce: Boolean): ChannelUpdate = {
val timestamp = System.currentTimeMillis / 1000
makeChannelUpdate(announce, timestamp)
}
LND (Go):
func (c *channelLink) updateChannelFee(feePerKw lnwire.MilliSatoshi) error {
c.cfg.FeeEstimator.UpdateForwardingPolicy(c.ShortChannelID, feePerKw)
return c.cfg.UpdateForwardingPolicies()
}
The Eclair code snippet demonstrates Scala's concise syntax and functional approach, while the LND code shows Go's more imperative style. Eclair's modular design is evident in the function composition, whereas LND's code reflects its object-oriented structure.
Both implementations are efficient, but Eclair's functional paradigm may offer advantages in terms of code readability and maintainability for some developers. However, LND's larger community and extensive documentation may make it easier for newcomers to get started and find support.
Core Lightning — Lightning Network implementation focusing on spec compliance and performance
Pros of lightning
- Written in C, potentially offering better performance and lower resource usage
- Supports multiple blockchains, including Bitcoin and Elements/Liquid sidechains
- More flexible plugin system, allowing for easier customization and extension
Cons of lightning
- Smaller developer community compared to lnd
- Less extensive documentation and fewer third-party tools
- Steeper learning curve due to C codebase and more complex architecture
Code Comparison
lightning (C):
struct channel *new_channel(struct lightningd *ld, struct peer *peer)
{
struct channel *channel = tal(ld, struct channel);
channel->peer = peer;
channel->state = CHANNELD_AWAITING_LOCKIN;
return channel;
}
lnd (Go):
func newChannel(cfg *channeldb.ChannelConfig, nodeKey *btcec.PublicKey) (*Channel, error) {
c := &Channel{
cfg: cfg,
nodeKey: nodeKey,
State: channeldb.ChanStatusPending,
}
return c, nil
}
Both implementations create a new channel object, but lightning uses a more C-style approach with manual memory allocation, while lnd leverages Go's struct initialization and garbage collection.
A secure bitcoin wallet daemon written in Go (golang)
Pros of btcwallet
- Focused solely on Bitcoin wallet functionality, making it more lightweight and specialized
- Easier to integrate into existing Bitcoin-only applications
- More straightforward codebase for developers primarily interested in Bitcoin wallet operations
Cons of btcwallet
- Limited to Bitcoin transactions, lacking support for Lightning Network
- Less active development and smaller community compared to lnd
- Fewer advanced features and integrations available out-of-the-box
Code Comparison
btcwallet (wallet creation):
cfg := &walletdb.Config{
DbType: "bdb",
DbName: "wallet.db",
DbDir: dbDir,
}
db, err := walletdb.Create(cfg)
lnd (wallet creation):
db, err := walletdb.Create("bdb", dbPath)
if err != nil {
return nil, err
}
wallet, err := wallet.Create(db, pubPass, privPass, seed, time.Now())
Both projects use similar wallet creation patterns, but lnd's implementation includes additional parameters for enhanced security and functionality. The lnd codebase is generally more complex due to its broader scope, including Lightning Network support, while btcwallet maintains a simpler structure focused on core Bitcoin wallet operations.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Lightning Network Daemon
The Lightning Network Daemon (lnd
) - is a complete implementation of a
Lightning Network node. lnd
has several pluggable back-end
chain services including btcd
(a
full-node), bitcoind
, and
neutrino
(a new experimental light client). The project's codebase uses the
btcsuite set of Bitcoin libraries, and also
exports a large set of isolated re-usable Lightning Network related libraries
within it. In the current state lnd
is capable of:
- Creating channels.
- Closing channels.
- Completely managing all channel states (including the exceptional ones!).
- Maintaining a fully authenticated+validated channel graph.
- Performing path finding within the network, passively forwarding incoming payments.
- Sending outgoing onion-encrypted payments through the network.
- Updating advertised fee schedules.
- Automatic channel management (
autopilot
).
Lightning Network Specification Compliance
lnd
fully conforms to the Lightning Network specification
(BOLTs). BOLT stands for:
Basis of Lightning Technology. The specifications are currently being drafted
by several groups of implementers based around the world including the
developers of lnd
. The set of specification documents as well as our
implementation of the specification are still a work-in-progress. With that
said, the current status of lnd
's BOLT compliance is:
- BOLT 1: Base Protocol
- BOLT 2: Peer Protocol for Channel Management
- BOLT 3: Bitcoin Transaction and Script Formats
- BOLT 4: Onion Routing Protocol
- BOLT 5: Recommendations for On-chain Transaction Handling
- BOLT 7: P2P Node and Channel Discovery
- BOLT 8: Encrypted and Authenticated Transport
- BOLT 9: Assigned Feature Flags
- BOLT 10: DNS Bootstrap and Assisted Node Location
- BOLT 11: Invoice Protocol for Lightning Payments
Developer Resources
The daemon has been designed to be as developer friendly as possible in order
to facilitate application development on top of lnd
. Two primary RPC
interfaces are exported: an HTTP REST API, and a gRPC
service. The exported APIs are not yet stable, so be warned: they may change
drastically in the near future.
An automatically generated set of documentation for the RPC APIs can be found at api.lightning.community. A set of developer resources including guides, articles, example applications and community resources can be found at: docs.lightning.engineering.
Finally, we also have an active
Slack where protocol developers, application developers, testers and users gather to
discuss various aspects of lnd
and also Lightning in general.
Installation
In order to build from source, please see the installation instructions.
Docker
To run lnd from Docker, please see the main Docker instructions
IRC
- irc.libera.chat
- channel #lnd
- webchat
Safety
When operating a mainnet lnd
node, please refer to our operational safety
guidelines. It is important to note that lnd
is still
beta software and that ignoring these operational guidelines can lead to
loss of funds.
Security
The developers of lnd
take security very seriously. The disclosure of
security vulnerabilities helps us secure the health of lnd
, privacy of our
users, and also the health of the Lightning Network as a whole. If you find
any issues regarding security or privacy, please disclose the information
responsibly by sending an email to security at lightning dot engineering,
preferably encrypted using our designated PGP key
(91FE464CD75101DA6B6BAB60555C6465E5BCB3AF
) which can be found
here.
Further reading
Top Related Projects
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot