From 3322ded8e5318c5e2c622ea6549760b909bd49b4 Mon Sep 17 00:00:00 2001 From: CODe <71spates.bravest@icloud.com> Date: Tue, 18 Feb 2025 18:56:56 +0100 Subject: [PATCH 1/3] Fix typos in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a35dc56c..2b09599c 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ anchor test --skip-build anchor build -- --features mocks anchor deploy ``` -- If you want to retain the local state once the tests are run, you would have to run a local validator. A local validator should run in the background and while running the test `skip-local-validator` flag has to be passed so that the program doesnt spin up its only validator. -Below is the command to run local validator ( run it in a seperate terminal). +- If you want to retain the local state once the tests are run, you would have to run a local validator. A local validator should run in the background and while running the test `skip-local-validator` flag has to be passed so that the program doesn't, does not spin up its only validator. +Below is the command to run local validator ( run it in a separate terminal). ``` solana-test-validator -r ``` From c841b02bf0f68389f63d0e8c71e4941097ad4f77 Mon Sep 17 00:00:00 2001 From: CODe <71spates.bravest@icloud.com> Date: Tue, 18 Feb 2025 18:56:57 +0100 Subject: [PATCH 2/3] Fix typos in solana/restaking/querying.md --- solana/restaking/querying.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/solana/restaking/querying.md b/solana/restaking/querying.md index b8201714..2c6a030f 100644 --- a/solana/restaking/querying.md +++ b/solana/restaking/querying.md @@ -34,7 +34,7 @@ let stakeParameters = ## Account Structure We have 2 storage accounts -1. **StakingParams**: `StakingParams` contains the paramters required +1. **StakingParams**: `StakingParams` contains the parameters required for staking. They are as follows. - Whitelisted Tokens: The tokens which can be staked. - Guest chain Program Id: If `None` or `null`, it means that the guest From 2e0916ba27bb08f6b9355fc9efea3686b6c9ec9b Mon Sep 17 00:00:00 2001 From: CODe <71spates.bravest@icloud.com> Date: Tue, 18 Feb 2025 18:56:59 +0100 Subject: [PATCH 3/3] Fix typos in solana/restaking/README.md --- solana/restaking/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/solana/restaking/README.md b/solana/restaking/README.md index 44d57c84..b92a5e2d 100644 --- a/solana/restaking/README.md +++ b/solana/restaking/README.md @@ -12,7 +12,7 @@ The high level flow of the program is given in the image below. has to go through the smart contract. - Receipt Token Mint: The receipt token mint is a NFT which is the - seed for the PDA storing information about stake amout, validator + seed for the PDA storing information about stake amount, validator and rewards. For more information, refer: https://docs.composable.finance/technology/solana-restaking/vaults/#receipt-token @@ -28,7 +28,7 @@ The high level flow of the program is given in the image below. When the contract is deployed, the `initialize` method is called where the whitelisted tokens, admin key and the rewards token mint is set. Initially the `guest_chain_initialization` is set to -false. Any update to the staking paramters can only be +false. Any update to the staking parameters can only be done by the admin key. A token account is also created for the rewards token mint which would distribute the rewards. Since the authority is PDA, any debit from the account will happen only through @@ -44,7 +44,7 @@ can start staking. unbonding period gets over, the tokens would be withdrawn. In this method, the receipt NFT would be transferred to an escrow account and the receipt NFT token account would be closed. All the pending rewards are transferred - in this method and users wont be eligible for rewards during the unbonding + in this method and users won't be eligible for rewards during the unbonding period. - `Cancel Withdrawal Request`: Withdrawal request set by the user can be @@ -64,7 +64,7 @@ can start staking. - `Set Service`: Once the bridge is live, users who had deposited before can call this method to delegate their stake to the validator. Users cannot withdraw or claim any rewards until they delegate their stake - to the validator. But this method wont be needed after the bridge is + to the validator. But this method won't be needed after the bridge is live and would panic if called otherwise. - `Update Guest chain Initialization`: The admin would call this method @@ -82,10 +82,10 @@ can start staking. - `Change admin Proposal`: A proposal set by the current admin for changing the admin. A new admin is proposed by the existing admin and the until the new admin approves it in `accept_admin_change`, - the admin wont be changed. + the admin won't be changed. - `Accept admin change`: The new admin set by the existing admin is - exepected to call this method. When the new admin calls this method, + expected to call this method. When the new admin calls this method, the admin is changed. - `Update Staking Cap`: Method which sets the staking cap which limits