@rndlabs/monsi

monsi

A monitor for the upcoming Storage Incentives (SI) for the Ethersphere Bee swarm written in Typescript for node.js

Installing packages

To get started the following commands, or their equivalents, should work if you don't already have node and/or npm

sudo apt-get install nodejs
sudo apt-get install npm

Or for Windows or macOS, https://nodejs.org/en/download/

You'll also need git to clone this repository: https://git-scm.com/download/win

Installing dependencies

Then the following command should install the needed dependencies when executed in the cloned directory.

npm i

monSI uses blessed for drawing its TUI (Text User Interface) and ethers for blockchain RPC

Configuring

All parameters can be specified on the command line and some are supported in environment values (or .env file)

Running

Finally, to run monsi, use the following command in a shell or command prompt window:

node --experimental-specifier-resolution=node --loader=ts-node/esm ./src/index.ts --rpc-endpoint ws://<YourGoerliRPCIP:port>

This command will compile the typescript application and run it. Your screen should clear and boxes should appear with values. monSI defaults to going back 4 complete Schelling game rounds at startup. It also loads ALL stake events from the blockchain on every invocation.

Usage

Monitor Storage Incentives for Swarm

Arguments:
  overlays                   Overlay addresses for highlighting

Options:
  -V, --version              output the version number
  --mainnet                  Use Swarm mainnet (default: false)
  --rpc-endpoint <string>    RPC endpoint for the blockchain node (default: "ws://goerli-geth.dappnode:8546", env:
                             RPC_URL)
  -r, --rounds [rounds]      Load the last number of rounds from the blockchain (default: 4)
  -b, --block [block]        Block number to start loading from
  -R, --round [round]        Round number to start loading from
  -S, --singleRound [round]  Load a single round and stop
  -h, --help                 display help for command

Acknowledgements

monSI was originally written by @ldeffenb and was heavily based on monBee. @mfw78 graciously offered to restructure the original grungy monolithic code into something much more understandable, extendible, and maintainable. The result of this collaboration is the monSI that you see here.

Warning

Just don't run monSI for a long time if you use infura.io's (or any other provider's) free account because monSI monitors every single block and will eat up your 100,000 API hits in short order. No gETH, but every query is counted at infura.io, and monSI does LOTS of blockchain queries!

Having your own local goerli (gnosis in the future) RPC provider is strongly recommended!