restake

(โ˜… 372)

Auto-compounder script for Cosmos Validators using REStake

  • .dockerignore
  • .env.sample
  • .gitignore
  • .nvmrc
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • package-lock.json
  • package.json
  • README.md
  • README_TURKISH.md

# Installation Guide

1. Get the code
git clone https://github.com/eco-stake/restake

Downloads the entire project code from GitHub to your computer.

cd restake

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu ๊ณ„์—ด) Built into Debian/Ubuntu-based Linux distributions.
apt install nodejs -y

Installs directly from the APT package repository (Debian/Ubuntu-based).

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker-compose run --rm app npm install

Runs the command against the services defined in the compose file.

docker-compose build --no-cache

Runs the command against the services defined in the compose file.

docker-compose run --rm app npm run autostake

Runs the command against the services defined in the compose file.

0 21 * * * /bin/bash -c "cd restake && docker compose run --rm app npm run autostake" > ./restake.log 2>&1

Runs the command against the services defined in the compose file.

0 0 * * */7 /usr/bin/docker image prune -a -f

Type this command into your terminal and run it.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm --version

Type this command into your terminal and run it.

npm install

Downloads and installs the libraries listed in package.json.

docker-compose run --rm app npm install

Runs the command against the services defined in the compose file.

docker-compose run --rm app npm run autostake

Runs the command against the services defined in the compose file.

npm run autostake

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation