Crates.io | fedimint-ln-server |
lib.rs | fedimint-ln-server |
version | 0.3.2 |
source | src |
created_at | 2023-11-25 20:47:04.508085 |
updated_at | 2024-07-02 16:53:25.623149 |
description | fedimint-ln is a lightning payment service module. |
homepage | |
repository | https://github.com/fedimint/fedimint |
max_upload_size | |
id | 1048566 |
size | 76,611 |
Fedimint is a module based system for building federated applications. It is designed to be a trust-minimized, censorship-resistant, and private alternative to centralized applications.
Fedimint is alpha software released under an MIT License and recently cut its 0.2 release. We recommend you run Fedimint on testnets like mutinynet, or on mainnet with small amounts of money.
Fedimint ships with 3 default modules: Bitcoin, Lightning, and Chaumian Ecash, for out-of-the-box best practices for private and trust-minimized payments. You can write custom modules that define further consensus items and transaction types leveraging the payments modules to build your own federated applications.
The Fedimint Developer Discord is the best place to get help and ask questions. Join the Discord and say hi! We are extremely active and work to onboard developers or all skill levels to Fedimint and associated open-source Bitcoin projects. Fedimint touches many different areas of Bitcoin development, so there is something for everyone. See below for more information on how to get involved.
It's easy to set up and run your own federations. Fedimint is designed to be Byzantine Fault Tolerant so is resilient to m
malicious nodes in a federation of 3m + 1
nodes. If you run a federation of 4 guardians you are resilient to 1 malicious guardian, if you run a federation of 7 guardians you are resilient to 2 guardians, etc.
Fedimint's 0.2 release can also be run in "solo mode" with a single guardian. This is useful for testing and development, but is not recommended for production use.
To do lightning payments, Fedimint requires a Lightning Gateway: a user of the federation that accepts ecash in exchange for sending/receiving lightning payments. The Lightning Gateway is not a guardian and acts as an untrusted economic actor serving the federation.
See the Fedimint Mutinynet Setup Guide. You can modify the configuration options to deploy it on
We are actively looking for developers to help build Fedimint and associated open-source Bitcoin projects. Fedimint touches many different areas of Bitcoin development, so there is something for everyone. The best places to get started are:
Fedimint is a Rust project and uses the Nix package manager to manage dependencies and build the project.
Fedimint's developer environment and rust build pipeline is managed through Nix flakebox (https://github.com/rustshop/flakebox). To get started, install Nix.
sh <(curl -L https://nixos.org/nix/install) --daemon
Then fork and clone the Fedimint repo.
git clone https://github.com/your-username/fedimint.git
Then enter the nix developer environment.
nix develop
and start a local regtest network with 4 guardians and a lightning gateway.
just mprocs
You can then interact with the guardians and lightning gateway through the mprocs cli.
If you want to run with UIs, see the UI repo for developer environment instructions.
For contribution guidelines, Areas of contributions and how to get involved, please refer to the Contributing Guidelines.