Skip to content

Commit 2682a7c

Browse files
authored
Merge pull request #520 from janx/polish-docs
update README
2 parents 7d6688b + 01de4c1 commit 2682a7c

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

README.md

+29-11
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,33 @@
11
# Fiber Network Node
22

3-
Fiber Network Node (FNN) is a reference implementation of Fiber Network Protocol (FNP). In the current stage, it's not a production-ready implementation, but a prototype to demonstrate the feasibility of FNP. It's capable of:
4-
5-
* Establishing connections with other FNN
6-
* Creating and closing fiber channel
7-
* Payments over fiber channel (via [fiber-scripts])
8-
* Cross-chain asset transfer
9-
10-
Please note that the implementation is still under development, there are many limitations and known issues, you may find or report them in the issue tracker.
11-
12-
But as a prototype, it's a good starting point for developers to understand the FNP and try out the integration with their applications.
3+
Fiber Network Node (FNN) is a reference node implementation of Fiber Network Protocol (FNP). Fiber network is a peer-to-peer payment/swap network (like [Lightning Network](https://lightning.network/)). We believe payment and swap are the two foundational primitives of finance.
4+
5+
Features
6+
7+
- **Multiple assets support**, e.g. stable coins, RGB++ assets issued on Bitcoin ledger, and UDT assets issued on CKB ledger;
8+
- **Extremely low-cost micropayments**, e.g. 0.0001 cent payment with 0.00000001 cent fee;
9+
- **Instant swap between any asset pairs**, as long as there's available channel paths;
10+
- **Cross-network asset payment/swap**, e.g. from Lightning network to Fiber network, and vice versa;
11+
- **Watchtower support**, make it easier for node operators;
12+
- **Multi-hop payment**, anyone can facilitate payments and earn payment fees by running a fiber node and becoming a hop on payment paths;
13+
- **Low latency**, e.g. 0.0001 cent payment in your p2p connection latency, e.g. 20ms;
14+
- **High throughput**, because transactions are only processed by involved peers, no network consensus required;
15+
- **High privacy**, your transactions are only seen by involved peers;
16+
- **Based on more advanced cryptographic techniques** to ensure security and privacy, e.g. uses PTLC not HTLC;
17+
- **Composable** with other contracts/scripts on CKB;
18+
19+
!!! The implementation is still a work-in-progress and will have iterations even after mainnet, please use it with caution and report any issues/limitations in the issue tracker.
20+
21+
TODO
22+
23+
- [x] Establishing connections with other fiber nodes
24+
- [x] Creating and closing fiber channel
25+
- [x] Payments over fiber channel (via [fiber-scripts])
26+
- [x] Cross-network asset transfer
27+
- [ ] Web-browser friendly runtime
28+
- [ ] Programmable conditional payment
29+
- [ ] Advanced channel liquidity management
30+
- [ ] Atomic multi-path payment
1331

1432
## Build and run a testnet node
1533

@@ -46,7 +64,7 @@ RUST_LOG=info ./fnn -c config.yml -d .
4664

4765
## Testnet compatibility issues
4866

49-
The current state of the FNN is not stable, the protocol and storage format may changed between versions. We strongly recommend you to close the channel before upgrading the node, otherwise, you may lose the channel state:
67+
FNN is still under development, the protocol and storage format may changed between versions. We strongly recommend you to close the channel before upgrading the node, otherwise, you may lose channel data and funds!
5068

5169
1. [list all channels](./src/rpc/README.md#channel-list_channels) and [close](./src/rpc/README.md#channel-shutdown_channel) them via RPC.
5270

0 commit comments

Comments
 (0)