Skip to content

getting_started.md

Latest commit

 

History

History
198 lines (136 loc) · 5.09 KB

getting_started.md

File metadata and controls

198 lines (136 loc) · 5.09 KB

NCN Program CLI

Official Accounts

Account Address
Test NCN Program ID HDdd3ATbccVPoFs9aXtZKqXMSvehsgt8UFQdJnyCyYb8
Test NCN 5zqy3uyXMi5Uurup7S5kKUUuwHGnGcykVwwUik37fm6i

Setup CLIs

Install the NCN Program CLI

cargo build --release
cargo install --path ./cli --bin ncn-program-cli --locked

Ensure it has been installed

ncn-program-cli --help

Clone and Install the Restaking and Vault CLI in a different directory

cd ..
git clone https://github.com/jito-foundation/restaking.git
cd restaking
cargo build --release
cargo install --path ./cli --bin jito-restaking-cli

Ensure it works

jito-restaking-cli --help

CLI Configuration

The CLI supports the following configuration options:

# Set RPC URL (defaults to Mainnet)
export RPC_URL="https://api.devnet.solana.com"

# Set commitment level
export COMMITMENT="confirmed"

# Set NCN Program ID (if different from default)
export NCN_PROGRAM_ID="HDdd3ATbccVPoFs9aXtZKqXMSvehsgt8UFQdJnyCyYb8"


# Set Jito Restaking and Vault Program IDs
export RESTAKING_PROGRAM_ID=RestkWeAVL8fRGgzhfeoqFhsqKRchg6aa1XrcH96z4Q
export VAULT_PROGRAM_ID=Vau1t6sLNxnzB7ZDsef8TLbPLfyZMYXH8WTNqUdm9g8

# Set keypair path
export KEYPAIR_PATH="~/.config/solana/id.json"

# Set NCN address
export NCN="5zqy3uyXMi5Uurup7S5kKUUuwHGnGcykVwwUik37fm6i"

Or you can set them using a .env file, refer to .env.example to learn more

Basic Usage Flow

Setting up and using the NCN program follows this general workflow:

  1. Setup Prerequisites:

    # Fund your payer account if needed
ncn-program-cli admin-fund-account-payer --amount-in-sol 10

  2. Initialize the NCN Program:

    # Create program configuration with tie-breaker admin
ncn-program-cli admin-create-config --tie-breaker-admin <ADMIN_ADDRESS> --ncn-fee-wallet <FEE_WALLET_ADDRESS> --ncn-fee-bps <FEE_BPS>

# Create the vault registry
ncn-program-cli create-vault-registry

  3. Register Tokens and Vaults:

    # Register a stake token mint with specified weight
ncn-program-cli admin-register-st-mint --vault <VAULT_ADDRESS> --weight <WEIGHT> --keypair-path <NCN_ADMIN_KEYPAIR_PATH>

# Register vaults
ncn-program-cli crank-register-vaults

  4. Running the keeper command to automate epoch management:

    ncn-program-cli run-keeper

Keeper command will run these commands internally:

  1. Setup Epochs and Consensus Cycle:

    # Create epoch state
ncn-program-cli create-epoch-state

# Create weight table
ncn-program-cli create-weight-table

# Set epoch weights
ncn-program-cli set-epoch-weights

  2. Create Snapshots:

    # Create epoch snapshot
ncn-program-cli create-epoch-snapshot

# Create operator snapshot
ncn-program-cli create-operator-snapshot --operator <OPERATOR_ADDRESS>

# Snapshot vault-operator delegations
ncn-program-cli snapshot-vault-operator-delegation

  3. Voting Process:

    # Create ballot box
ncn-program-cli create-ballot-box

  4. Post-Vote Cooldown:

    After voting completes and consensus is reached, there's a cooldown period before rewards can be distributed.

  5. Reward Distribution:

    # Create reward routers
ncn-program-cli create-ncn-reward-router
ncn-program-cli create-operator-vault-reward-router --operator <OPERATOR_ADDRESS>

# Route and distribute rewards
ncn-program-cli route-ncn-rewards
ncn-program-cli route-operator-vault-rewards --operator <OPERATOR_ADDRESS>

  6. Clean Up:

    # Close epoch accounts
ncn-program-cli crank-close-epoch-accounts

Command Groups

The CLI provides the following command categories:

  • Admin Commands: Configuration and administration
  • Crank Functions: Update and maintain system state
  • Getters: Query on-chain state
  • Instructions: Core program interactions
  • Keeper Command: Automated epoch management

Refer to ncn-program-cli --help for a complete list of available commands.

Keeper Command

The keeper command is responsible for automating various epoch-related tasks, such as creating epoch states, snapshotting, managing votes, and distributing rewards. It runs as a continuous process, monitoring the chain and executing necessary actions based on the current epoch state.

The keeper progresses through these states:

  • SetWeight: Establish stake weights for the epoch
  • Snapshot: Capture operator and vault state snapshots
  • Vote: Monitor operator votes on consensus
  • PostVoteCooldown: Wait period after voting completes
  • Distribute: Distribute rewards to stakeholders
  • Close: Close and finalize epoch accounts

Example Usage:

ncn-program-cli run-keeper

This command starts the keeper process with default settings:

  • Loop timeout: 10 minutes
  • Error timeout: 10 seconds

For detailed usage instructions and examples, refer to the API documentation.