# boost

**Repository Path**: fproject/boost

## Basic Information

- **Project Name**: boost
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-01
- **Last Updated**: 2024-07-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Boost

Boost is an initial experiment/prototype of markets v2 module for Filecoin. It aims to replace the `lotus-miner` markets service. For more information, see: https://docs.filecoin.io/mine/lotus/split-markets-miners/

## Building

```
git clone https://github.com/filecoin-project/boost
cd boost
make build
```

## Initialisation and Running

0. Compile and install (move binaries to $PATH)

```
make build
make install
```

1. 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
```


2. Create Boost repository

```
export $(lotus auth api-info --perm=admin)
export $(lotus-miner auth api-info --perm=admin)

boost --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-collateral-pledge=`lotus wallet new bls` \
      --max-staging-deals-bytes=50000000000
```

3. Run Boost service

```
export $(lotus auth api-info --perm=admin)

boost --vv run
```

4. 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`

```
boost dummydeal <client address> <provider address>
```

## Web UI

1. Install and build

```
cd react
npm install
npm run build
```

2. Open UI

```
http://localhost:8080
```

### Development mode

To run the web UI in development mode:

1. Run the server

```
cd react
npm install
npm start
```

2. Open UI

```
http://localhost:3000
```

## License

Dual-licensed under [MIT](https://github.com/filecoin-project/boost/blob/main/LICENSE-MIT) + [Apache 2.0](https://github.com/filecoin-project/boost/blob/main/LICENSE-APACHE)