https://github.com/w3rkspacelabs/beest
Beest - Bees Toolkit for Swarm
https://github.com/w3rkspacelabs/beest
Last synced: about 1 month ago
JSON representation
Beest - Bees Toolkit for Swarm
- Host: GitHub
- URL: https://github.com/w3rkspacelabs/beest
- Owner: w3rkspacelabs
- License: mit
- Created: 2024-08-26T04:52:42.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T08:51:40.000Z (7 months ago)
- Last Synced: 2024-11-08T09:03:25.013Z (6 months ago)
- Language: TypeScript
- Homepage:
- Size: 242 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-swarm - Beest - An interactive CLI toolkit that simplifies the management of multiple Bee nodes (Projects / Tools)
README
```
██████╗ ███████╗███████╗███████╗████████╗
██╔══██╗██╔════╝██╔════╝██╔════╝╚══██╔══╝
██████╔╝█████╗ █████╗ ███████╗ ██║
██╔══██╗██╔══╝ ██╔══╝ ╚════██║ ██║
██████╔╝███████╗███████╗███████║ ██║
╚═════╝ ╚══════╝╚══════╝╚══════╝ ╚═╝
```
**Bees** **T**oolkit for [Swarm](https://www.ethswarm.org/)
## Requirements
- `node` >= 20
- `node` installed using `nvm`
- any Linux distribution (tested on Ubuntu)
> [!WARNING]
> - Install and manage node versions using [nvm](https://github.com/nvm-sh/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
### Run a light node
### Run a full node
### Show status of bee nodes
## 4. Managing Beest processess
BEEST uses [pm2](https://github.com/Unitech/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
- [x] mainnet
- [x] run an bee ultralight node
- [x] run an bee light node
- [x] run an bee full node
- [x] show status of all bee nodes
- [ ] funding wallet status
- [x] delete all bees
- [x] funding wallet to fund xdai for bee nodes
- [x] pm2 integration
- [x] etherproxy integration
- [x] setup to automatically start upon reboot/restart
- [ ] stake bee node from funding wallet
- [ ] manually upgrade bee nodes
- [ ] interactive target neighborhood selection
- [x] testnet support
- [ ] non-interactive CI/CD mode
- [ ] serve a decentralized website with gateway-proxy