program / cli / js / py: Port everything from spl

README.md

@@ -1,2 +1,14 @@
-# stake-pool
-The SPL Stake Pool program and its clients
+# stake-pool program
+
+Full documentation is available at https://spl.solana.com/stake-pool
+
+The command-line interface tool is available in the `./cli` directory.
+
+Javascript bindings are available in the `./js` directory.
+
+Python bindings are available in the `./py` directory.
+
+## Audit
+
+The repository [README](https://github.com/solana-labs/solana-program-library#audits)
+contains information about program audits.

clients/cli/Cargo.toml

@@ -0,0 +1,41 @@
+[package]
+authors = ["Solana Labs Maintainers <[email protected]>"]
+description = "SPL-Stake-Pool Command-line Utility"
+edition = "2021"
+homepage = "https://spl.solana.com/stake-pool"
+license = "Apache-2.0"
+name = "spl-stake-pool-cli"
+repository = "https://github.com/solana-labs/solana-program-library"
+version = "2.0.0"
+
+[dependencies]
+borsh = "1.5.3"
+clap = "2.33.3"
+serde = "1.0.215"
+serde_derive = "1.0.130"
+serde_json = "1.0.133"
+solana-account-decoder = "2.1.0"
+solana-clap-utils = "2.1.0"
+solana-cli-config = "2.1.0"
+solana-cli-output = "2.1.0"
+solana-client = "2.1.0"
+solana-logger = "2.1.0"
+solana-program = "2.1.0"
+solana-remote-wallet = "2.1.0"
+solana-sdk = "2.1.0"
+spl-associated-token-account = { version = "=6.0.0", path = "../../associated-token-account/program", features = [
+  "no-entrypoint",
+] }
+spl-associated-token-account-client = { version = "=2.0.0", path = "../../associated-token-account/client" }
+spl-stake-pool = { version = "=2.0.1", path = "../program", features = [
+  "no-entrypoint",
+] }
+spl-token = { version = "=7.0", path = "../../token/program", features = [
+  "no-entrypoint",
+] }
+bs58 = "0.5.1"
+bincode = "1.3.1"
+
+[[bin]]
+name = "spl-stake-pool"
+path = "src/main.rs"

clients/cli/README.md

@@ -0,0 +1,7 @@
+# SPL Stake Pool program command-line utility
+
+A basic command-line for creating and using SPL Stake Pools.  See https://spl.solana.com/stake-pool for more details.
+
+Under `./scripts`, there are helpful Bash scripts for setting up and running a
+stake pool. More information at the
+[stake pool quick start guide](https://spl.solana.com/stake-pool/quickstart).

clients/cli/scripts/add-validators.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# Script to add new validators to a stake pool, given the stake pool keyfile and
+# a file listing validator vote account pubkeys
+
+cd "$(dirname "$0")" || exit
+stake_pool_keyfile=$1
+validator_list=$2  # File containing validator vote account addresses, each will be added to the stake pool after creation
+
+add_validator_stakes () {
+  stake_pool=$1
+  validator_list=$2
+  while read -r validator
+  do
+    $spl_stake_pool add-validator "$stake_pool" "$validator"
+  done < "$validator_list"
+}
+
+spl_stake_pool=spl-stake-pool
+# Uncomment to use a local build
+#spl_stake_pool=../../../target/debug/spl-stake-pool
+
+stake_pool_pubkey=$(solana-keygen pubkey "$stake_pool_keyfile")
+echo "Adding validator stake accounts to the pool"
+add_validator_stakes "$stake_pool_pubkey" "$validator_list"

clients/cli/scripts/deposit.sh

@@ -0,0 +1,71 @@
+#!/usr/bin/env bash
+
+# Script to deposit stakes and SOL into a stake pool, given the stake pool keyfile
+# and a path to a file containing a list of validator vote accounts
+
+cd "$(dirname "$0")" || exit
+stake_pool_keyfile=$1
+validator_list=$2
+sol_amount=$3
+
+create_keypair () {
+  if test ! -f "$1"
+  then
+    solana-keygen new --no-passphrase -s -o "$1"
+  fi
+}
+
+create_user_stakes () {
+  validator_list=$1
+  sol_amount=$2
+  authority=$3
+  while read -r validator
+  do
+    create_keypair "$keys_dir/stake_$validator".json
+    solana create-stake-account "$keys_dir/stake_$validator.json" "$sol_amount" --withdraw-authority "$authority" --stake-authority "$authority"
+  done < "$validator_list"
+}
+
+delegate_user_stakes () {
+  validator_list=$1
+  authority=$2
+  while read -r validator
+  do
+    solana delegate-stake --force "$keys_dir/stake_$validator.json" "$validator" --stake-authority "$authority"
+  done < "$validator_list"
+}
+
+deposit_stakes () {
+  stake_pool_pubkey=$1
+  validator_list=$2
+  authority=$3
+  while read -r validator
+  do
+    stake=$(solana-keygen pubkey "$keys_dir/stake_$validator.json")
+    $spl_stake_pool deposit-stake "$stake_pool_pubkey" "$stake" --withdraw-authority "$authority"
+  done < "$validator_list"
+}
+
+keys_dir=keys
+stake_pool_pubkey=$(solana-keygen pubkey "$stake_pool_keyfile")
+
+spl_stake_pool=spl-stake-pool
+# Uncomment to use a locally build CLI
+#spl_stake_pool=../../../target/debug/spl-stake-pool
+
+echo "Setting up keys directory $keys_dir"
+mkdir -p $keys_dir
+authority=$keys_dir/authority.json
+echo "Setting up authority for deposited stake accounts at $authority"
+create_keypair $authority
+
+echo "Creating user stake accounts to deposit into the pool"
+create_user_stakes "$validator_list" "$sol_amount" $authority
+echo "Delegating user stakes so that deposit will work"
+delegate_user_stakes "$validator_list" $authority
+
+echo "Waiting for stakes to activate, this may take awhile depending on the network!"
+echo "If you are running on localnet with 32 slots per epoch, wait 12 seconds..."
+sleep 12
+echo "Depositing stakes into stake pool"
+deposit_stakes "$stake_pool_pubkey" "$validator_list" $authority

clients/cli/scripts/rebalance.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+# Script to add a certain amount of SOL into a stake pool, given the stake pool
+# keyfile and a path to a file containing a list of validator vote accounts
+
+cd "$(dirname "$0")" || exit
+stake_pool_keyfile=$1
+validator_list=$2
+sol_amount=$3
+
+spl_stake_pool=spl-stake-pool
+# Uncomment to use a locally build CLI
+#spl_stake_pool=../../../target/debug/spl-stake-pool
+
+increase_stakes () {
+  stake_pool_pubkey=$1
+  validator_list=$2
+  sol_amount=$3
+  while read -r validator
+  do
+    $spl_stake_pool increase-validator-stake "$stake_pool_pubkey" "$validator" "$sol_amount"
+  done < "$validator_list"
+}
+
+stake_pool_pubkey=$(solana-keygen pubkey "$stake_pool_keyfile")
+echo "Increasing amount delegated to each validator in stake pool"
+increase_stakes "$stake_pool_pubkey" "$validator_list" "$sol_amount"

clients/cli/scripts/setup-stake-pool.sh

@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+
+# Script to setup a stake pool from scratch.  Please modify the parameters to
+# create a stake pool to your liking!
+
+cd "$(dirname "$0")" || exit
+command_args=()
+sol_amount=$1
+
+###################################################
+### MODIFY PARAMETERS BELOW THIS LINE FOR YOUR POOL
+###################################################
+
+# Epoch fee, assessed as a percentage of rewards earned by the pool every epoch,
+# represented as `numerator / denominator`
+command_args+=( --epoch-fee-numerator 1 )
+command_args+=( --epoch-fee-denominator 100 )
+
+# Withdrawal fee for SOL and stake accounts, represented as `numerator / denominator`
+command_args+=( --withdrawal-fee-numerator 2 )
+command_args+=( --withdrawal-fee-denominator 100 )
+
+# Deposit fee for SOL and stake accounts, represented as `numerator / denominator`
+command_args+=( --deposit-fee-numerator 3 )
+command_args+=( --deposit-fee-denominator 100 )
+
+command_args+=( --referral-fee 0 ) # Percentage of deposit fee that goes towards the referrer (a number between 0 and 100, inclusive)
+
+command_args+=( --max-validators 2350 ) # Maximum number of validators in the stake pool, 2350 is the current maximum possible
+
+# (Optional) Deposit authority, required to sign all deposits into the pool.
+# Setting this variable makes the pool "private" or "restricted".
+# Uncomment and set to a valid keypair if you want the pool to be restricted.
+#command_args+=( --deposit-authority keys/authority.json )
+
+###################################################
+### MODIFY PARAMETERS ABOVE THIS LINE FOR YOUR POOL
+###################################################
+
+keys_dir=keys
+spl_stake_pool=spl-stake-pool
+# Uncomment to use a local build
+#spl_stake_pool=../../../target/debug/spl-stake-pool
+
+mkdir -p $keys_dir
+
+create_keypair () {
+  if test ! -f "$1"
+  then
+    solana-keygen new --no-passphrase -s -o "$1"
+  fi
+}
+
+echo "Creating pool"
+stake_pool_keyfile=$keys_dir/stake-pool.json
+validator_list_keyfile=$keys_dir/validator-list.json
+mint_keyfile=$keys_dir/mint.json
+reserve_keyfile=$keys_dir/reserve.json
+create_keypair $stake_pool_keyfile
+create_keypair $validator_list_keyfile
+create_keypair $mint_keyfile
+create_keypair $reserve_keyfile
+
+set -ex
+$spl_stake_pool \
+  create-pool \
+  "${command_args[@]}" \
+  --pool-keypair "$stake_pool_keyfile" \
+  --validator-list-keypair "$validator_list_keyfile" \
+  --mint-keypair "$mint_keyfile" \
+  --reserve-keypair "$reserve_keyfile"
+
+set +ex
+stake_pool_pubkey=$(solana-keygen pubkey "$stake_pool_keyfile")
+set -ex
+
+echo "Creating token metadata"
+$spl_stake_pool \
+  create-token-metadata \
+  "$stake_pool_pubkey" \
+  NAME \
+  SYMBOL \
+  URI
+
+echo "Depositing SOL into stake pool"
+$spl_stake_pool deposit-sol "$stake_pool_pubkey" "$sol_amount"

clients/cli/scripts/setup-test-validator.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+
+# Script to setup a local solana-test-validator with the stake pool program
+# given a maximum number of validators and a file path to store the list of
+# test validator vote accounts.
+
+cd "$(dirname "$0")" || exit
+max_validators=$1
+validator_file=$2
+
+create_keypair () {
+  if test ! -f "$1"
+  then
+    solana-keygen new --no-passphrase -s -o "$1"
+  fi
+}
+
+setup_test_validator() {
+  solana-test-validator \
+    --clone-upgradeable-program SPoo1Ku8WFXoNDMHPsrGSTSG1Y47rzgn41SLUNakuHy \
+    --clone-upgradeable-program metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s \
+    --url mainnet-beta \
+    --slots-per-epoch 32 \
+    --quiet --reset &
+  # Uncomment to use a locally built stake program
+  #solana-test-validator \
+  #  --bpf-program SPoo1Ku8WFXoNDMHPsrGSTSG1Y47rzgn41SLUNakuHy ../../../target/deploy/spl_stake_pool.so \
+  #  --bpf-program metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s ../../program/tests/fixtures/mpl_token_metadata.so \
+  #  --slots-per-epoch 32 \
+  #  --quiet --reset &
+  pid=$!
+  solana config set --url http://127.0.0.1:8899
+  solana config set --commitment confirmed
+  echo "waiting for solana-test-validator, pid: $pid"
+  sleep 15
+}
+
+create_vote_accounts () {
+  max_validators=$1
+  validator_file=$2
+  for number in $(seq 1 "$max_validators")
+  do
+    create_keypair "$keys_dir/identity_$number.json"
+    create_keypair "$keys_dir/vote_$number.json"
+    create_keypair "$keys_dir/withdrawer_$number.json"
+    solana create-vote-account "$keys_dir/vote_$number.json" "$keys_dir/identity_$number.json" "$keys_dir/withdrawer_$number.json" --commission 1
+    vote_pubkey=$(solana-keygen pubkey "$keys_dir/vote_$number.json")
+    echo "$vote_pubkey" >> "$validator_file"
+  done
+}
+
+
+echo "Setup keys directory and clear old validator list file if found"
+keys_dir=keys
+mkdir -p $keys_dir
+if test -f "$validator_file"
+then
+  rm "$validator_file"
+fi
+
+echo "Setting up local test validator"
+setup_test_validator
+
+echo "Creating vote accounts, these accounts be added to the stake pool"
+create_vote_accounts "$max_validators" "$validator_file"
+
+echo "Done adding $max_validators validator vote accounts, their pubkeys can be found in $validator_file"