Skip to content

CIDgravity/CIDgravity-X

Repository files navigation

The "CIDgravity connector" connects a boost node to the CIDgravity service. This lighweight connector is executed locally by the markets node daemon each time a deal proposal is received.

Compatibility

Node Supported
boost
droplet(venus)
lotus-markets

Requirements

  1. Get a CIDgravity account : https://cidgravity.com
  2. Set the miner get-ask prices to 0 and size to the widest range via the BoostUI(:8080/settings) or Venus Settings :
    • Price = 0
    • Verified Price = 0
    • Min Piece Size = 256
    • Max Piece Size = 32G or 64G
  3. Install python modules : toml and requests
sudo apt install python3-toml python3-requests

Get Started

  1. Install the connector
sudo -i -u "<USER_RUNNING_BOOST_PROCESS>"
git clone https://github.com/CIDgravity/CIDgravity-X.git
cd CIDgravity-X
cp -n cidgravity_storage_connector.toml.sample cidgravity_storage_connector.toml
  1. Add the CIDgravity authentication (located at https://app.cidgravity.com under Settings/Other settings")
nano ./cidgravity_storage_connector.toml

Boost

  1. Run the check process
./cidgravity_storage_connector.py --check-boost
  1. Enable "CIDgravity connector" Add the following lines to boost config (usually ~/.boost/config.toml) under the [Dealmaking] and [LotusDealmaking] section
Filter = "<ABSOLUTE_PATH>/cidgravity_storage_connector.py --reject"
RetrievalFilter = "<ABSOLUTE_PATH>/cidgravity_storage_connector.py --reject"
  1. Restart boost

Droplet (Venus)

  1. Run the check process
./cidgravity_storage_connector.py --check-venus  
  1. Enable "CIDgravity connector"

Add the following lines to droplet config (under path ~/.droplet/config.toml by default) in the [CommonProvider] section (for more details, please refer to documentation here)

Filter = "<ABSOLUTE_PATH>/cidgravity_storage_connector.py --reject"
RetrievalFilter = "<ABSOLUTE_PATH>/cidgravity_storage_connector.py --reject"
  1. Restart droplet