README.md

near_rewards

Small console application to check the staking rewards for lockup accounts on NEAR protocol

Example result:

Prerequisites

This utility requires Rust. To install, run:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

(Official documentation)

Follow the directions which includes running:

source $HOME/.cargo/env

Usage

1. Create a near_rewards folder inside your home directory.

2. In near_rewards create a file accounts.json with the following structure:

[
  {
    "account_id": "account.near",
    "pool_account_id": "pool.poolv1.near"
  }
]

OR

[
  {
    "account_id": "account.lockup.near",
    "key": "ed25519:FQxoGzhKW129Vq8Uk8WqeSV1e8z3oJFMC1UbN6z6yBHT"
  }
]

Note: This tool only works for lockup accounts.

The tool works for any account in NEAR

3. Run cargo install --git https://github.com/khorolets/near_rewards in your terminal.
4. Run near-rewards in your terminal.