feat: add account recovery functionality

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 node_modules
+.idea/

staking/app/StakeConnection.ts

@@ -1178,6 +1178,21 @@ export class StakeConnection {
 
     await this.provider.sendAndConfirm(tx);
   }
+
+  public async buildRecoverAccountInstruction(
+    stakeAccountAddress: PublicKey,
+    governanceAuthorityAddress: PublicKey
+  ): Promise<TransactionInstruction> {
+    const stakeAccount = await this.loadStakeAccount(stakeAccountAddress);
+    return await this.program.methods
+      .recoverAccount()
+      .accounts({
+        payer: governanceAuthorityAddress,
+        payerTokenAccount: stakeAccount.stakeAccountPositionsJs.owner,
+        stakeAccountPositions: stakeAccountAddress,
+      })
+      .instruction();
+  }
 }
 
 export interface BalanceSummary {

staking/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/staking",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Pyth Network Staking SDK",
   "main": "lib/app/index.js",
   "types": "lib/app/index.d.ts",

staking/programs/staking/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pyth-staking-program"
-version = "1.0.0"
+version = "1.2.0"
 description = "Created with Anchor"
 edition = "2018"
 

staking/programs/staking/src/context.rs

@@ -405,3 +405,38 @@ pub struct AdvanceClock<'info> {
     #[account(mut, seeds = [CONFIG_SEED.as_bytes()], bump = config.bump)]
     pub config: Account<'info, global_config::GlobalConfig>,
 }
+
+#[derive(Accounts)]
+pub struct RecoverAccount<'info> {
+    // Native payer:
+    #[account(address = config.governance_authority)]
+    pub payer: Signer<'info>,
+
+    // Token account:
+    #[account(address = stake_account_metadata.owner)]
+    pub payer_token_account: Account<'info, TokenAccount>,
+
+    // Stake program accounts:
+    #[account(mut)]
+    pub stake_account_positions: AccountLoader<'info, positions::PositionData>,
+
+    #[account(
+        mut,
+        seeds = [
+            STAKE_ACCOUNT_METADATA_SEED.as_bytes(),
+            stake_account_positions.key().as_ref()
+        ],
+        bump = stake_account_metadata.metadata_bump
+    )]
+    pub stake_account_metadata: Account<'info, stake_account::StakeAccountMetadataV2>,
+
+    #[account(
+        mut,
+        seeds = [VOTER_RECORD_SEED.as_bytes(), stake_account_positions.key().as_ref()],
+        bump = stake_account_metadata.voter_bump
+    )]
+    pub voter_record: Account<'info, voter_weight_record::VoterWeightRecord>,
+
+    #[account(seeds = [CONFIG_SEED.as_bytes()], bump = config.bump)]
+    pub config: Account<'info, global_config::GlobalConfig>,
+}

staking/programs/staking/src/error.rs

@@ -74,6 +74,8 @@ pub enum ErrorCode {
     SplitWithStake,
     #[msg("The approval arguments do not match the split request.")] // 6034
     InvalidApproval,
-    #[msg("Other")] //6035
+    #[msg("Can't recover account with staking positions. Unstake your tokens first.")] // 6035
+    RecoverWithStake,
+    #[msg("Other")] //6036
     Other,
 }

staking/programs/staking/src/lib.rs

@@ -566,7 +566,7 @@ pub mod staking {
 
 
     /**
-     * A split request can only be accepted by the `pda_authority`` from
+     * A split request can only be accepted by the `pda_authority` from
      * the config account. If accepted, `amount` tokens are transferred to a new stake account
      * owned by the `recipient` and the split request is reset (by setting `amount` to 0).
      * The recipient of a transfer can't vote during the epoch of the transfer.
@@ -706,4 +706,28 @@ pub mod staking {
             Some(ctx.accounts.config.agreement_hash);
         Ok(())
     }
+
+    /** Recovers a user's `stake account` ownership by transferring ownership
+     * from a token account to the `owner` of that token account.
+     *
+     * This functionality addresses the scenario where a user mistakenly
+     * created a stake account using their token account address as the owner.
+     */
+    pub fn recover_account(ctx: Context<RecoverAccount>) -> Result<()> {
+        // Check that there aren't any positions (i.e., staked tokens) in the account.
+        // Transferring accounts with staked tokens might lead to double voting
+        require!(
+            ctx.accounts.stake_account_metadata.next_index == 0,
+            ErrorCode::SplitWithStake
+        );
+
+        let new_owner = ctx.accounts.payer_token_account.owner;
+
+        ctx.accounts.stake_account_metadata.owner = new_owner;
+        let stake_account_positions = &mut ctx.accounts.stake_account_positions.load_mut()?;
+        stake_account_positions.owner = new_owner;
+        ctx.accounts.voter_record.governing_token_owner = new_owner;
+
+        Ok(())
+    }
 }

staking/target/idl/staking.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0",
+  "version": "1.2.0",
   "name": "staking",
   "instructions": [
     {
@@ -915,7 +915,7 @@
     {
       "name": "acceptSplit",
       "docs": [
-        "* A split request can only be accepted by the `pda_authority`` from\n     * the config account. If accepted, `amount` tokens are transferred to a new stake account\n     * owned by the `recipient` and the split request is reset (by setting `amount` to 0).\n     * The recipient of a transfer can't vote during the epoch of the transfer.\n     *\n     * The `pda_authority` must explicitly approve both the amount of tokens and recipient, and\n     * these parameters must match the request (in the `split_request` account)."
+        "* A split request can only be accepted by the `pda_authority` from\n     * the config account. If accepted, `amount` tokens are transferred to a new stake account\n     * owned by the `recipient` and the split request is reset (by setting `amount` to 0).\n     * The recipient of a transfer can't vote during the epoch of the transfer.\n     *\n     * The `pda_authority` must explicitly approve both the amount of tokens and recipient, and\n     * these parameters must match the request (in the `split_request` account)."
       ],
       "accounts": [
         {
@@ -1198,6 +1198,82 @@
           }
         }
       ]
+    },
+    {
+      "name": "recoverAccount",
+      "docs": [
+        "Recovers a user's `stake account` ownership by transferring ownership\n     * from a token account to the `owner` of that token account.\n     *\n     * This functionality addresses the scenario where a user mistakenly\n     * created a stake account using their token account address as the owner."
+      ],
+      "accounts": [
+        {
+          "name": "payer",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "payerTokenAccount",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "stakeAccountPositions",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "stakeAccountMetadata",
+          "isMut": true,
+          "isSigner": false,
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "type": "string",
+                "value": "stake_metadata"
+              },
+              {
+                "kind": "account",
+                "type": "publicKey",
+                "path": "stake_account_positions"
+              }
+            ]
+          }
+        },
+        {
+          "name": "voterRecord",
+          "isMut": true,
+          "isSigner": false,
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "type": "string",
+                "value": "voter_weight"
+              },
+              {
+                "kind": "account",
+                "type": "publicKey",
+                "path": "stake_account_positions"
+              }
+            ]
+          }
+        },
+        {
+          "name": "config",
+          "isMut": false,
+          "isSigner": false,
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "type": "string",
+                "value": "config"
+              }
+            ]
+          }
+        }
+      ],
+      "args": []
     }
   ],
   "accounts": [
@@ -1963,6 +2039,11 @@
     },
     {
       "code": 6035,
+      "name": "RecoverWithStake",
+      "msg": "Can't recover account with staking positions. Unstake your tokens first."
+    },
+    {
+      "code": 6036,
       "name": "Other",
       "msg": "Other"
     }