Skip to content

Commit

Permalink
Merge pull request #451 from quake/quake/readme-update-0.1.0
Browse files Browse the repository at this point in the history
chore: update readme
  • Loading branch information
quake authored Jan 7, 2025
2 parents 93df639 + 3d4093c commit 8b957e5
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,13 @@ Fiber Network Node (FNN) is a reference implementation of Fiber Network Protocol
* Payments over fiber channel (via [fiber-scripts])
* Cross-chain asset transfer

Please note that the implementation is still under development, there are two major features not implemented yet:

* Watchtower service to monitor and revoke on-chain transactions
* Multihop payments
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.

But as a prototype, it's a good starting point for developers to understand the FNP and try out the integration with their applications.

## Build and run a testnet node

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

```
cargo build --release
Expand All @@ -26,6 +23,7 @@ cargo build --release

```
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
Expand All @@ -46,6 +44,20 @@ head -n 1 ./ckb/exported-key > ./ckb/key
RUST_LOG=info ./fnn -c config.yml -d .
```

## Testnet compatibility issues

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:

1. [list all channels](./src/rpc/README.md#channel-list_channels) and [close](./src/rpc/README.md#channel-shutdown_channel) 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 binary with the new version and start the node again.

## Documentation

* [Light Paper](./docs/light-paper.md)
Expand Down

0 comments on commit 8b957e5

Please sign in to comment.