Installation

Install and Run

Install FCR

Currently, you can only install FCR by building from source.

Prerequisites

1. You will need to have Go (version 1.17.9 or later) installed. To obtain Go, visit here.
2. You will also need to have make, gcc and git installed if not already.

Instructions

1. Clone the repository and checkout to one of the releases here. The following example uses release v0.1.2.

git clone https://github.com/wcgcyx/fcr.git
cd fcr/
git checkout v0.1.2

2. Build and install the binary.

make build
sudo mv ./build/fcr /usr/local/bin/fcr

3. Test installation.

fcr version

4. Now you should have FCR installed. You can now start running an FCR node.

Run FCR

At the moment, FCR network runs only on filecoin calibration network with the currency ID be 1.

FCR daemon requires a configuration file to run. The repository comes with a pre-baked configuration file that by default uses the testnet glif node endpoint. To use this configuration:

mkdir ~/.fcr/
mv ./config/config.yaml ~/.fcr/

If you wish to use local lotus node to access the network, set TRANSACTOR_FILECOIN_AP to be the local lotus API address (by default http://localhost:1234/rpc/v0) and set TRANSACTOR_FILECOIN_AUTH_TOKEN to be the API token. If you wish to understand the configuration file, visit here.

2. Run daemon.

fcr daemon

3. Set a private key for sending/receiving payment.

It is recommended that you generate a random account to join FCR network at this stage.

fcr wallet generate 1 # This will generate a private key
fcr wallet set 1 1 ${private key}

Once you set the private key. You can inspect your filecoin address by fcr wallet list -l.

You can then obtain some testing FIL from the faucet here.

4. Bootstrapping

To connect the network, you need to do a bootstrapping. You can find a list of available peers here.

fcr system connect ${peer addr}

5. Now you should have joined the FCR network.

FCR Operation

To learn how to operate FCR node, visit here.