FEATURE: Adding keeper

Cargo.toml

@@ -1,7 +1,8 @@
 [workspace]
 members = [
   "keepers/*",
-  "programs/*",
+  "programs/*", 
+  "sdk",
   "tests",
   "utils/*",
 ]

Dockerfile

@@ -1,4 +1,4 @@
-FROM rust:1.71-slim-buster as builder
+FROM rust:1.75-slim-buster as builder
 
 RUN apt-get update && apt-get install -y libudev-dev clang pkg-config libssl-dev build-essential cmake protobuf-compiler
 

README.md

@@ -1,10 +1,14 @@
-# Validator History Program
+# Stakenet
 
 ## About
 
+Jito StakeNet is a decentralized Solana stake pool manager, blending Validator History and Steward Programs for secure, transparent validator management and autonomous stake operations.
+
+## History Program
+
 The Validator History Program, a component of Jito StakeNet, is an on-chain record of verified Solana validator data, storing up to 512 epochs of history per validator. It takes fields accessible to the solana runtime like validator performance history, validator commission, MEV commission, as well as Gossip data like validator IP, version, and client type, and stores them all in a single account. It also contains some fields that currently require permissioned upload but are easily verifiable with a getVoteAccounts call, like total active stake per validator, stake rank, and superminority status. All these fields are stored in a single account per validator, the ValidatorHistory account. This enables all these disparate fields to be easily composed with in on chain programs, with a long lookback period and ease of access through the single account.
 
-## Structure
+### Structure
 
 The main Anchor program is in `programs/validator-history`.
 
@@ -22,43 +26,42 @@ Note that this is a `zero_copy` account, which allows us to initialize a lot of
 
 `Config`: Tracks admin authorities as well as global program metadata.
 
-## Test
+## Steward Program
+
+Harnessing on-chain validator metrics and network data, the Steward Program employs advanced algorithms to evaluate and rank validators. Automated keepers then execute a state machine to optimally allocate stake, maximizing network security and efficiency.
+
+## Repo
+
+### Test
 
 Tests are in `tests/` written with solana-program-test.
 
-All tests can be run by running:
+All tests can be run by running ( root directory ):
+
 ```shell
 ./run_tests.sh
 ```
 
-## Build
+### Build
 
 `anchor build --program-name validator_history` (regular anchor build)
 `solana-verify build --library-name validator_history` (solana verified build)
 
-## Verify
+### Verify
 
 Verify with [solana-verifiable-build](https://github.com/Ellipsis-Labs/solana-verifiable-build):
 
 `solana-verify verify-from-repo -um --program-id HistoryJTGbKQD2mRgLZ3XhqHnN811Qpez8X9kCcGHoa https://github.com/jito-foundation/stakenet`
 
 ## Running Keeper
 
-Run as binary:
-
-Build: `cargo b -r --package validator-keeper`
+Check out the [Keeper Bot Quick Start](./keeper-bot-quick-start.md)
 
-Run: `./target/release/validator-keeper --json-rpc-url <YOUR RPC> --cluster mainnet --tip-distribution-program-id F2Zu7QZiTYUhPd7u9ukRVwxh7B71oA3NMJcHuCHc29P2 --program-id HistoryJTGbKQD2mRgLZ3XhqHnN811Qpez8X9kCcGHoa --interval 600 --keypair <YOUR KEYPAIR>`
+## CLIs
 
-Run as docker container (need to set environment variables in config/.env file):
+### Validator History
 
-`docker compose --env-file config/.env up -d --build  validator-keeper`
-
-Metrics for running can be sent to your influx server if you set the SOLANA_METRICS_CONFIG env var.
-
-## CLI
-
-The CLI can be used to see the status of on-chain validator history data.
+This CLI can be used to see the status of on-chain validator history data.
 
 Build: `cargo b -r --package validator-history-cli`
 
@@ -69,3 +72,12 @@ To see the current epoch state of all validator history accounts:
 To see the historical state of a single validator history account:
 
 `./target/release/validator-history-cli --json-rpc-url <YOUR RPC URL> history <VOTE ACCOUNT>`
+
+### Steward
+
+This CLI can be used to see the status of on-chain validator history data.
+
+Build: `cargo b -r --package steward-cli`
+
+To see all of the available commands:
+`./target/release/steward-cli -h`

docker-compose.yaml

@@ -0,0 +1,37 @@
+version: "3"
+services:
+  validator-keeper:
+    build:
+      context: .
+      target: validator-history
+    container_name: validator-keeper
+    environment:
+      - RUST_LOG=${RUST_LOG:-info}
+      - SOLANA_METRICS_CONFIG=${SOLANA_METRICS_CONFIG}
+      - JSON_RPC_URL=${JSON_RPC_URL}
+      - KEYPAIR=${KEYPAIR}
+      - ORACLE_AUTHORITY_KEYPAIR=${ORACLE_AUTHORITY_KEYPAIR}
+      - CLUSTER=${CLUSTER}
+      - VALIDATOR_HISTORY_PROGRAM_ID=${VALIDATOR_HISTORY_PROGRAM_ID}
+      - TIP_DISTRIBUTION_PROGRAM_ID=${TIP_DISTRIBUTION_PROGRAM_ID}
+      - STEWARD_PROGRAM_ID=${STEWARD_PROGRAM_ID}
+      - STEWARD_CONFIG=${STEWARD_CONFIG}
+      - PRIORITY_FEES=${PRIORITY_FEES}
+      - RUN_CLUSTER_HISTORY=${RUN_CLUSTER_HISTORY}
+      - RUN_COPY_VOTE_ACCOUNTS=${RUN_COPY_VOTE_ACCOUNTS}
+      - RUN_MEV_COMMISSION=${RUN_MEV_COMMISSION}
+      - RUN_MEV_EARNED=${RUN_MEV_EARNED}
+      - RUN_STEWARD=${RUN_STEWARD}
+      - VALIDATOR_HISTORY_INTERVAL=${VALIDATOR_HISTORY_INTERVAL}
+      - STEWARD_INTERVAL=${STEWARD_INTERVAL}
+      - METRICS_INTERVAL=${METRICS_INTERVAL}
+      - RUN_STAKE_UPLOAD=${RUN_STAKE_UPLOAD}
+      - RUN_GOSSIP_UPLOAD=${RUN_GOSSIP_UPLOAD}
+      - FULL_STARTUP=${FULL_STARTUP}
+      - NO_PACK=${NO_PACK}
+      - PAY_FOR_NEW_ACCOUNTS=${PAY_FOR_NEW_ACCOUNTS}
+      - COOL_DOWN_RANGE=${COOL_DOWN_RANGE}
+      - GOSSIP_ENTRYPOINT=${GOSSIP_ENTRYPOINT}
+    volumes:
+      - ./credentials:/credentials
+    restart: on-failure:5

keeper-bot-quick-start.md

@@ -0,0 +1,145 @@
+# Keeper Bot Quick-start
+
+Below are the steps to configuring and running the Stakenet Keeper Bot. We recommend running the docker container.
+
+## Setup
+
+### Credentials
+
+In the root directory create a new folder named `credentials` and then populate it with a keypair. This is keypair that signs and pays for all transactions.
+
+```bash
+mkdir credentials
+solana-keygen new -o ./credentials/keypair.json
+```
+
+### ENV
+
+In the root directory create a new folder named `config` and create a `.env` file inside of it
+
+```bash
+mkdir config
+touch ./config/.env
+```
+
+Then copy into the `.env` file the contents below. Everything should be set as-is, however consider replacing the `JSON_RPC_URL` and adjusting the `PRIORITY_FEES`
+
+```.env
+# RPC URL for the cluster
+JSON_RPC_URL=https://api.mainnet-beta.solana.com
+
+# Cluster to specify (mainnet, testnet, devnet)
+CLUSTER=mainnet
+
+# Log levels
+RUST_LOG="info,solana_gossip=error,solana_metrics=info"
+
+# Path to keypair used to pay for account creation and execute transactions
+KEYPAIR=./credentials/keypair.json
+
+# Validator history program ID (Pubkey as base58 string)
+VALIDATOR_HISTORY_PROGRAM_ID=HistoryJTGbKQD2mRgLZ3XhqHnN811Qpez8X9kCcGHoa
+
+# Tip distribution program ID (Pubkey as base58 string)
+TIP_DISTRIBUTION_PROGRAM_ID=4R3gSG8BpU4t19KYj8CfnbtRpnT8gtk4dvTHxVRwc2r7
+
+# Steward program ID
+STEWARD_PROGRAM_ID=Stewardf95sJbmtcZsyagb2dg4Mo8eVQho8gpECvLx8
+
+# Steward config account
+STEWARD_CONFIG=jitoVjT9jRUyeXHzvCwzPgHj7yWNRhLcUoXtes4wtjv
+
+# Priority Fees in microlamports
+PRIORITY_FEES=20000
+
+# Run flags (true/false)
+RUN_CLUSTER_HISTORY=true
+RUN_COPY_VOTE_ACCOUNTS=true
+RUN_MEV_COMMISSION=true
+RUN_MEV_EARNED=true
+RUN_STEWARD=true
+
+################# DEBUGGING AND JITO USE ONLY #################
+
+# Interval to update Validator History Accounts (in seconds)
+# VALIDATOR_HISTORY_INTERVAL=300
+
+# Interval to run steward (in seconds)
+# STEWARD_INTERVAL=301
+
+# Interval to emit metrics (in seconds)
+# METRICS_INTERVAL=60
+
+# For Jito Use Only ( For now )
+# RUN_STAKE_UPLOAD=false
+# RUN_GOSSIP_UPLOAD=false
+
+# Run with the startup flag set to true
+# FULL_STARTUP=true
+
+# Running with no_pack set to true skips packing the instructions and will cost more
+# NO_PACK=false
+
+# Pay for new accounts when necessary
+# PAY_FOR_NEW_ACCOUNTS=false
+
+# Max time in minutes to wait after any fire cycle
+# COOL_DOWN_RANGE=20
+
+# Gossip entrypoint in the form of URL:PORT
+# GOSSIP_ENTRYPOINT=
+
+# Metrics upload config
+# For Jito Use Only ( For now )
+# SOLANA_METRICS_CONFIG=
+
+# Path to keypair used specifically for submitting permissioned transactions
+# For Jito Use Only ( For now )
+# ORACLE_AUTHORITY_KEYPAIR=
+```
+
+## Running Docker
+
+Once the setup is complete use the following commands to run/manage the docker container:
+
+> Note: We are running `Docker version 24.0.5, build ced0996`
+
+### Start Docker
+
+```bash
+docker compose --env-file config/.env up -d --build  validator-keeper --remove-orphans
+```
+
+### Stop Docker**
+
+```bash
+docker stop validator-keeper; docker rm validator-keeper;
+```
+
+### View Logs
+
+```bash
+docker logs validator-keeper -f
+```
+
+## Running Raw
+
+To run the keeper in terminal, build for release and run the program.
+
+### Build for Release
+
+```bash
+cargo build --release --bin validator-keeper
+```
+
+### Run Keeper
+
+```bash
+RUST_LOG=info cargo run --bin validator-keeper --
+```
+
+To see all available parameters run:
+
+```bash
+RUST_LOG=info cargo run --bin validator-keeper -- -h
+```