boost

module
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 15, 2022 License: Apache-2.0, MIT

README

Boost

Boost is a tool for Filecoin storage providers to manage data storage and retrievals on Filecoin.

See the docs at https://boost.filecoin.io to get started.

For development:

  1. Install using instructions in the building and installation section in the docs.

  2. Make sure you have a local Lotus fullnode and miner running and listening to localhost:1234 and localhost:2345 respectively, for example with a devnet:

devnet

Note that currently devnet is using the default paths that lotus and lotus-miner use for their repositories, and you should make sure these directories are empty:

LOTUS_PATH=~/.lotus
LOTUS_MINER_PATH=~/.lotusminer

rm -rf ~/.lotus ~/.lotusminer
  1. Create Boost repository
export $(lotus auth api-info --perm=admin)
export $(lotus-miner auth api-info --perm=admin)

boostd --vv init \
       --api-sealer=`lotus-miner auth api-info --perm=admin` \
       --api-sector-index=`lotus-miner auth api-info --perm=admin` \
       --wallet-publish-storage-deals=`lotus wallet new bls` \
       --wallet-deal-collateral=`lotus wallet new bls` \
       --max-staging-deals-bytes=50000000000
  1. Run the Boost daemon service
export $(lotus auth api-info --perm=admin)

boostd --vv run
  1. Interact with Boost

Pass the client address (wallet) and the provider address to the dummydeal command. Note that

  • the client address is the address of a wallet with funds in lotus wallet list
  • you can find the provider address in ~/.boost/config.toml under the config key Wallets.Miner
boostd dummydeal <client address> <provider address>

Running the UI in Development Mode:

  1. Run the server
cd react
npm install
npm start
  1. Open UI
http://localhost:3000

Running a devnet:

Follow the instructions in the devnet guide

License

Dual-licensed under MIT + Apache 2.0

Directories

Path Synopsis
api
cli
cmd
db
extern
boostd-data Module
gen
api
gql
itests
lib
pkg
mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
storage
types/mock_types
Package mock_types is a generated GoMock package.
Package mock_types is a generated GoMock package.
mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL