Skip to content

w3rkspacelabs/beest

Repository files navigation

██████╗ ███████╗███████╗███████╗████████╗ 
██╔══██╗██╔════╝██╔════╝██╔════╝╚══██╔══╝ 
██████╔╝█████╗  █████╗  ███████╗   ██║    
██╔══██╗██╔══╝  ██╔══╝  ╚════██║   ██║    
██████╔╝███████╗███████╗███████║   ██║    
╚═════╝ ╚══════╝╚══════╝╚══════╝   ╚═╝    

Bees Toolkit for Swarm

image

Requirements

  • node >= 20
  • node installed using nvm
  • any Linux distribution (tested on Ubuntu)

Warning

  • Install and manage node versions using nvm.
  • Do not install the nodejs apt package! It may require root privileges to install npm modules and lead to security issues!

1. Uninstall any existing nodejs apt packages

Uninstall Node.js:

sudo apt remove nodejs

Purge Configuration Files:

sudo apt purge nodejs

Remove Unused Dependencies (optional):

sudo apt autoremove

Clean Up Any Residual Configuration Files (optional):

sudo apt autoclean
sudo apt clean

2. Install latest node using nvm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
source ~/.bashrc
nvm install --lts
node -v
v20.xx.x

3. Run Beest

git clone https://github.com/rampall/beest.git
cd beest
npm install
npm start

Run an ultra-light node

image

Run a light node

image

Run a full node

image

Show status of bee nodes

image

4. Managing Beest processess

BEEST uses pm2 under the hood to manage all the bee & etherproxy processes under the "beest" namespace. You can use pm2 and all its supported commands to manage the various processes.

List all proceses

pm2 ls

Show log of a bee node (with pm_id = 2)

pm2 logs 2

Stop all proceses

pm2 stop beest

Delete all Beest proceses

pm2 delete beest

TODO

  • mainnet
    • run an bee ultralight node
    • run an bee light node
    • run an bee full node
  • show status of all bee nodes
    • funding wallet status
  • delete all bees
  • funding wallet to fund xdai for bee nodes
  • pm2 integration
  • etherproxy integration
  • setup to automatically start upon reboot/restart
  • stake bee node from funding wallet
  • manually upgrade bee nodes
  • interactive target neighborhood selection
  • testnet support
  • non-interactive CI/CD mode
  • serve a decentralized website with gateway-proxy

About

Beest - Bees Toolkit for Swarm

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published