Debugging Boost with VSCode and a local docker devnet

[jacobheun]

Sometimes it's convenient to run a local devnet in docker while being able to quickly run and debug a local Boost instance.

My current process for this is to:

1. Follow the readme and launch the needed containers, ie docker compose up -d lotus lotus-miner boost demo-http-server
2. Make a few deals, as needed. Follow the random-deal.sh script comments for steps.
3. Once you no longer need any new deals, spin down the boost container docker compose stop boost
4. Get the MINER_API_INFO and FULLNODE_API_INFO values:

$ docker exec -it lotus lotus auth api-info --perm=admin | sed 's/dns\/lotus/ip4\/127\.0\.0\.1/'
FULLNODE_API_INFO=eyJ...ms4:/ip4/127.0.0.1/tcp/1234/http

$ docker exec -it lotus-miner lotus-miner auth api-info --perm=admin | sed 's/dns\/lotus\-miner/ip4\/127\.0\.0\.1/'
MINER_API_INFO=eyJ...UlI:/ip4/127.0.0.1/tcp/2345/http

6. Update your VSCode launch config to include the API values and the path to the Boost docker repo.

"configurations": [
    {
      "name": "Launch Package",
      "type": "go",
      "request": "launch",
      "mode": "auto",
      "program": "${workspaceFolder}/cmd/boostd",
      "args": ["run"],
      "env": {
        "BOOST_PATH": "${workspaceFolder}/docker/devnet/data/boost",
        "FULLNODE_API_INFO": "eyJ...ms4:/ip4/127.0.0.1/tcp/1234/http",
        "MINER_API_INFO":"eyJ...UlI:/ip4/127.0.0.1/tcp/2345/http"
      }
    }
  ]

7. Edit the docker devnet Boost config ./docker/devnet/data/boost/config.toml:
   1. Replace SealerApiInfo and SectorIndexApiInfo with the value for MINER_API_INFO above.
   2. Update the API.ListenAddress to use ip4 ListenAddress = "/ip4/127.0.0.1/tcp/1288/http"
   3. Update Tracing.Endpoint to use ip4 Endpoint = "http://tempo:14268/api/traces"
8. Debug to your hearts content.

Note: You can skip editing the config.toml file (step 7) if you add the following to your /etc/hosts file:

## Boost testing
127.0.0.1       lotus
127.0.0.1       lotus-miner
127.0.0.1       boost
127.0.0.1       tempo
## End of section

I would like to make this simpler in the future, but wanted to document this now in case it's useful to others. Multi boost process support should make this easier, and updating docker settings the the dns host addresses could help minimize the need to update addresses there.