Fiber Network Node

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). We believe payment and swap are the two foundational primitives of finance.

Features

• Multiple assets support, e.g. stable coins, RGB++ assets issued on Bitcoin ledger, and UDT assets issued on CKB ledger;
• Extremely low-cost micropayments, e.g. 0.0001 cent payment with 0.00000001 cent fee;
• Instant swap between any asset pairs, as long as there's available channel paths;
• Cross-network asset payment/swap, e.g. from Lightning network to Fiber network, and vice versa;
• Watchtower support, make it easier for node operators;
• Multi-hop payment, anyone can facilitate payments and earn payment fees by running a fiber node and becoming a hop on payment paths;
• Low latency, e.g. 0.0001 cent payment in your p2p connection latency, e.g. 20ms;
• High throughput, because transactions are only processed by involved peers, no network consensus required;
• High privacy, your transactions are only seen by involved peers;
• Based on more advanced cryptographic techniques to ensure security and privacy, e.g. uses PTLC not HTLC;
• Composable with other contracts/scripts on CKB;

!!! 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.

TODO

• Establishing connections with other fiber nodes
• Creating and closing fiber channel
• Payments over fiber channel (via fiber-scripts)
• Cross-network asset transfer
• Web-browser friendly runtime
• Programmable conditional payment
• Advanced channel liquidity management
• Atomic multi-path payment

Build and run a testnet node

1. Build the project, if you are using the released binary, you can skip this step:

cargo build --release

2. Create a data folder for the node, then copy the built binary and testnet config file to it:

mkdir /folder-to/my-fnn
// if you are using the released binary, replace target/release/fnn with the path of released binary
cp target/release/fnn /folder-to/my-fnn
cp config/testnet/config.yml /folder-to/my-fnn
cd /folder-to/my-fnn

3. FNN has the built-in wallet functionality to sign funding transactions, let's create or import a private key first. The private key is stored in the data folder and named ckb/key. You may use the ckb-cli to generate a new key or export an existing key:

mkdir ckb
ckb-cli account export --lock-arg <lock_arg> --extended-privkey-path ./ckb/exported-key
// ckb-cli exports master private key and chain code, FNN only needs the private key part
head -n 1 ./ckb/exported-key > ./ckb/key

4. Start the node, by default it will output logs to the console, you may redirect it to a file:

RUST_LOG=info ./fnn -c config.yml -d .

Testnet compatibility issues

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!

1. list all channels and close them via RPC.

2. Stop the node and remove the storage of the node:

rm -rf /folder-to/my-fnn/fiber/store

3. Repalce the fnn binary with the new version and start the node again.

If you want to keep the channel state, you may try to migrate the storage format manually:

1. Stop the node.

2. Backup the storage folder /folder-to/my-fnn/fiber/store.

3. Run the fnn-migrate (it can be found in the release binary package) to migrate the storage format:

fnn-migrate -p /folder-to/my-fnn/fiber/store

4. Repalce the fnn binary with the new version and start the node again.

Documentation

• Light Paper
• RPC Documentation
• P2P Message Protocol
• Invoice Protocol

We are in a actively developing stage, don't hesitate to report issues or ask for help in the channel of the Nervos dev community.

Testnet deployment information

• TODO: Add testnet deployed nodes information *