Swan Provider

• Join us on our public discord channel for news, discussions, and status updates.
• Check out our medium for the latest posts and announcements.

Table of Contents

• Features
• Prerequisite
• Installation
• Config
• License

Features

Swan Provider listens to offline deals that come from Swan platform. It provides the following functions:

• Download offline deals automatically using aria2 for downloading service.
• Import deals using lotus once download completed.
• Synchronize deal status to Swan Platform, so that both clients and miners will know the status changes in realtime.
• Auto bid task from FilSwan bidding market.

Prerequisite

• lotus-miner
• aria2

arial2 installation

sudo apt install aria2

Lotus Miner Token creation

Lotus miner token is used for importing deal for swan provider

lotus-miner auth create-token --perm write

Note that the Lotus Miner need to be running in the background! The created token located at $LOTUS_STORAGE_PATH/token

Reference: Lotus: API tokens

Installation

Option:one: Prebuilt package: See release assets

mkdir swan-provider
cd swan-provider
wget --no-check-certificate https://github.com/filswan/go-swan-provider/releases/download/v2.0.0-rc1/install.sh
chmod +x ./install.sh
./install.sh

Option:two: Source Code

🔔go 1.16+ is required

git clone https://github.com/filswan/go-swan-provider.git
cd go-swan-provider
git checkout <release_branch>
./build_from_source.sh

‼️ Important

After installation, swan-provider maybe quit due to lack of configuration. Under this situation, you need

• 1️⃣ Edit config file ~/.swan/provider/config.toml to solve this.
• 2️⃣ Execute swan-provider using one of the following commands

./swan-provider-2.0.0-rc1-linux-amd64 daemon  #After installation from Option 1
./build/swan-provider daemon                  #After installation from Option 2

Note

• Logs are in directory ./logs
• You can add nohup before ./swan-provider to ignore the HUP (hangup) signal and therefore avoid stop when you log out.
• You can add >> swan-provider.log in the command to let all the logs output to swan-provider.log.
• You can add & at the end of the command to let the program run in background.
• Such as:

nohup ./swan-provider-2.0.0-rc1-linux-amd64 daemon >> swan-provider.log &   #After installation from Option 1
nohup ./build/swan-provider daemon >> swan-provider.log &                   #After installation from Option 2

Config

• port: Default 8888, web api port for extension in future
• release: Default true, when work in release mode: set this to true, otherwise to false and enviornment variable GIN_MODE not to release

[lotus]

• ‼️client_api_url: Url of lotus client web api, such as: http://[ip]:[port]/rpc/v0, generally the [port] is 1234. See Lotus API
• ‼️market_api_url: Url of lotus market web api, such as: http://[ip]:[port]/rpc/v0, generally the [port] is 2345. When market and miner are not separate, it is also the url of miner web api. See Lotus API
• ‼️market_access_token: Access token of lotus market web api. When market and miner are not separate, it is also the access token of miner access token. See Obtaining Tokens

[aria2]

• aria2_download_dir: Directory where offline deal files will be downloaded for importing
• aria2_host: Aria2 server address
• aria2_port: Aria2 server port
• aria2_secret: Must be the same value as rpc-secret in aria2.conf

[main]

• api_url: Swan API address. For Swan production, it is https://go-swan-server.filswan.com
• ‼️miner_fid: Your filecoin Miner ID
• import_interval: 600 seconds or 10 minutes. Importing interval between each deal.
• scan_interval: 600 seconds or 10 minutes. Time interval to scan all the ongoing deals and update status on Swan platform.
• ‼️api_key: Your api key. Acquire from Swan Platform -> "My Profile"->"Developer Settings". You can also check the Guide.
• ‼️access_token: Your access token. Acquire from Swan Platform -> "My Profile"->"Developer Settings". You can also check the Guide.
• api_heartbeat_interval: 300 seconds or 5 minutes. Time interval to send heartbeat.

[bid]

• bid_mode: 0: manual, 1: auto
• expected_sealing_time: 1920 epoch or 16 hours. The time expected for sealing deals. Deals starting too soon will be rejected.
• start_epoch: 2880 epoch or 24 hours. Relative value to current epoch
• auto_bid_deal_per_day: auto-bid deal limit per day for your miner defined above

Common Isuse and solutions

• My aria is not downloaded

  Please check if aria2 is running

  ps -ef | grep aria2

• error msg="no response from swan platform”

  Please check your API endpiont is correct, it should be https://go-swan-server.filswan.com

License

Apache