Skip to content

Docs: update README.md #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aoikurokawa wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: update README.md #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 40 additions & 4 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,29 @@ cargo r -p stake-deposit-interceptor-cli -- \

#### Deposit Stake Whitelisted

Deposits an active stake account into the stake pool via the interceptor program.
The stake account must be delegated to a validator that is in the pool's validator list, and must be fully active (not activating).

**Arguments:**

| Argument | Description |
|---|---|
| `--whitelist` | The whitelist account that authorizes this deposit |
| `--stake-deposit-authority` | The `StakePoolDepositStakeAuthority` PDA that the interceptor program uses to manage deposits |
| `--deposit-stake` | The stake account to deposit. Must be fully active and delegated to a validator in the pool |
| `--validator-stake` | The pool's validator stake account for the same validator your stake is delegated to (find this in the pool's validator list) |
| `--spl-stake-pool-program-id` | The program ID of the SPL stake pool program |
| `--rpc-url` | Solana RPC endpoint URL |
| `--signer` | Path to the keypair file used to sign the transaction |
| `--commitment` | Transaction commitment level (`processed`, `confirmed`, or `finalized`) |
| `--stake-deposit-interceptor-program-id` | The program ID of the stake deposit interceptor program |

```bash
cargo r -p stake-deposit-interceptor-cli -- \
stake-deposit-interceptor \
interceptor \
deposit-stake-whitelisted \
--whitelist 7Qh3p1FpSAAeZer9kLXMyT8dS5PZatLgF9dxBd1BEoKV \
--whitelist 9KsQ7Wj99tz3ZayVXEEGSGCC2ZYb7CAyJn1GF94CyymS \
--stake-deposit-authority Ne9DQUbAfSuFSfzwgGms3f1AZvGipcmnpj29YRqJqCN \
--deposit-stake 8JWkyisNoErjT28uYahdo9o1GfPxunMSW9Vyj99rtz7F \
--validator-stake 6jDDM4Agc9sKq5JT1phcBSFCxCJPyjbusk6RmG5WEphT \
Expand All @@ -150,12 +167,31 @@ cargo r -p stake-deposit-interceptor-cli -- \

#### Withdraw Stake Whitelisted

Withdraws stake from the stake pool via the interceptor program. Splits stake from a validator's stake account in the pool and assigns it to a new stake account with the specified authority.

**Arguments:**

| Argument | Description |
|---|---|
| `--whitelist` | The whitelist account that authorizes this withdrawal |
| `--stake-deposit-authority` | The `StakePoolDepositStakeAuthority` PDA that the interceptor program uses to manage withdrawals |
| `--stake-split-from` | The pool's validator stake account to split stake from |
| `--stake-split-to` | Path to a keypair file for the new stake account that will receive the withdrawn stake |
| `--user-stake-authority` | The authority to set on the newly created stake account (both stake and withdraw authority) |
| `--fee-rebate-recipient` | The account that receives any fee rebate from the withdrawal |
| `--spl-stake-pool-program-id` | The program ID of the SPL stake pool program |
| `--amount` | Amount of pool tokens to withdraw (in SOL equivalent) |
| `--rpc-url` | Solana RPC endpoint URL |
| `--signer` | Path to the keypair file used to sign the transaction |
| `--commitment` | Transaction commitment level (`processed`, `confirmed`, or `finalized`) |
| `--stake-deposit-interceptor-program-id` | The program ID of the stake deposit interceptor program |

```bash
cargo r -p stake-deposit-interceptor-cli -- \
stake-deposit-interceptor \
interceptor \
withdraw-stake-whitelisted \
--whitelist 7Qh3p1FpSAAeZer9kLXMyT8dS5PZatLgF9dxBd1BEoKV \
--whitelist 9KsQ7Wj99tz3ZayVXEEGSGCC2ZYb7CAyJn1GF94CyymS \
--stake-deposit-authority Ne9DQUbAfSuFSfzwgGms3f1AZvGipcmnpj29YRqJqCN \
--stake-split-from 6jDDM4Agc9sKq5JT1phcBSFCxCJPyjbusk6RmG5WEphT \
--stake-split-to ./target/deploy/stake_e.json \
Expand All @@ -176,7 +212,7 @@ cargo r -p stake-deposit-interceptor-cli -- \
stake-deposit-interceptor \
interceptor \
fund-hopper \
--whitelist 7Qh3p1FpSAAeZer9kLXMyT8dS5PZatLgF9dxBd1BEoKV \
--whitelist 9KsQ7Wj99tz3ZayVXEEGSGCC2ZYb7CAyJn1GF94CyymS \
--stake-deposit-authority Ne9DQUbAfSuFSfzwgGms3f1AZvGipcmnpj29YRqJqCN \
--lamports 1 \
--rpc-url https://api.devnet.solana.com \
Expand All @@ -192,7 +228,7 @@ cargo r -p stake-deposit-interceptor-cli -- \
stake-deposit-interceptor \
interceptor \
hopper-balance \
--whitelist 7Qh3p1FpSAAeZer9kLXMyT8dS5PZatLgF9dxBd1BEoKV \
--whitelist 9KsQ7Wj99tz3ZayVXEEGSGCC2ZYb7CAyJn1GF94CyymS \
--stake-deposit-authority Ne9DQUbAfSuFSfzwgGms3f1AZvGipcmnpj29YRqJqCN \
--rpc-url https://api.devnet.solana.com \
--signer ~/.config/solana/id.json \
Expand Down
Loading