filecoin-spade-client

An application to automatically fetch and seal deals through Spade, using Lotus and Boost

Table of Contents

• Install
• Configure
• Contribute
• License

Install

Either download the binary or build this repository from source. go run . or go build in the cmd/spade-client folder should suffice.

Requires Aria2c (sudo apt-get install aria2) running as a daemon

Configure

Lotus and Boost configuration comes from the following environment variables;

FULLNODE_API_INFO
MINER_API_INFO
MARKETS_API_INFO

Please be sure these are properly set.

Run aria2c as a daemon:

aria2c --enable-rpc

Example

spade-client run --download-path /tmp/downloadfolder/ --max-spade-deals-active 2

Usage

NAME:
   spade-client - Filecoin Spade Client

USAGE:
   spade-client [global options] command [command options] [arguments...]

VERSION:
   1.0.0

DESCRIPTION:
   A client for Filecoin's Spade service

COMMANDS:
   run, r   Runs DukeSoft's Spade Client for Lotus
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  show version information (default: false)

Run usage

NAME:
   spade-client run - Runs DukeSoft's Spade Client for Lotus

USAGE:
   spade-client run [command options] [arguments...]

OPTIONS:
   --download-path value           The location where the downloaded files should reside (default: "/tmp/filecoin-spade-downloads")
   --max-spade-deals-active value  Total number of spade deals that should be actively downloading / requesting (This doesn't include other deals or sealing!) (default: 2)
   --aria2-url value               RPC API URL for Aria2C (default: "ws://localhost:6800/jsonrpc")
   --aria2-password value          Aria2C JSON RPC Password
   --boost-graphql-port value      Boost's GraphQL port (default: 8080)
   --help, -h                      show help

Contribute

Contributions welcome. Please check out the issues.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2024 DukeSoft BV