Skip to content

Update the quickstart command #689

@Cafe137

Description

@Cafe137

Context

The swarm-cli quickstart command downloads the latest Bee binary for the user according to their OS, prompts the user whether they want an ultra-light or light node, and creates a matching configuration file. Lastly, the command prints the command to run the Bee node.

Example run:

~/tmp swarm-cli quickstart
Downloading Bee from https://github.com/ethersphere/bee/releases/download/v2.6.0/bee-darwin-arm64
Bee downloaded successfully
Running chmod +x bee to make it executable

Ultra-light: Limited download capabilities, no funding required.
Light: Full functionality; requires xDAI to launch and xBZZ for uploading and retrieving data.
? Select the type of configuration to create (Use arrow keys)
❯ ultra-light
  light

After selecting ultra-light:

All set! Start Bee node by running:

./bee start --config=bee.yaml

Example generated ultra-light node configuration file (bee.yaml):

api-addr: 127.0.0.1:1633
blockchain-rpc-endpoint: "https://xdai.fairdatasociety.org"
cors-allowed-origins: ["*"]
data-dir: "/Users/aron/tmp/data-dir"
full-node: false
mainnet: true
resolver-options: ["https://cloudflare-eth.com"]
storage-incentives-enable: false
swap-enable: false
password: "m44LewvuRI3A4AxUzxoW"

Problems

  1. The downloaded binary is outdated. It should be updated to the latest version, and we should have a CI workflow that opens a PR automatically whenever there is a new Bee release.
  2. The Ethereum JSON-RPC used to resolve .eth names (resolver-options property) uses https://cloudflare-eth.com which I believe is no longer working.
  3. There are no tests for this command, so we should have an end-to-end test or separate CI workflow that executes this command, and then runs the printed bee start command to verify that an ultra-light node can indeed start with the generated configuration.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions