fix: burn folio tokens when user pending basket does not exist (#115)

Author: SushantChandla

programs/folio/src/instructions/user/redeem_folio/burn_folio_token.rs

@@ -30,6 +30,7 @@ use shared::{check_condition, constants::PendingBasketType};
 /// * `user_folio_token_account` - The user folio token account (PDA) (mut, not signer).
 #[derive(Accounts)]
 pub struct BurnFolioToken<'info> {
+    pub system_program: Program<'info, System>,
     pub token_program: Interface<'info, TokenInterface>,
     pub associated_token_program: Program<'info, AssociatedToken>,
 
@@ -63,7 +64,9 @@ pub struct BurnFolioToken<'info> {
     )]
     pub folio_basket: AccountLoader<'info, FolioBasket>,
 
-    #[account(mut,
+    #[account(init_if_needed,
+        payer = user,
+        space = UserPendingBasket::SIZE,
         seeds = [USER_PENDING_BASKET_SEEDS, folio.key().as_ref(), user.key().as_ref()],
         bump
     )]

tests-ts/bankrun/tests/tests-folio-redeeming.ts

@@ -121,6 +121,7 @@ describe("Bankrun - Folio redeeming", () => {
     expectedFolioTokenBalanceChange: BN;
     expectedTokenBalanceChanges: BN[];
     minimumOutForTokenAmounts: { mint: PublicKey; minimumOut: BN }[];
+    user_pending_basket_not_initalized: boolean;
   } = {
     alreadyIncludedTokens: [],
     tokens: [],
@@ -140,6 +141,7 @@ describe("Bankrun - Folio redeeming", () => {
     expectedFolioTokenBalanceChange: new BN(0),
     expectedTokenBalanceChanges: Array(MINTS.length).fill(new BN(0)),
     minimumOutForTokenAmounts: [],
+    user_pending_basket_not_initalized: false,
   };
 
   const TEST_CASES_BURN_FOLIO_TOKEN = [
@@ -261,6 +263,28 @@ describe("Bankrun - Folio redeeming", () => {
         new BN(1_000_000_000),
       ],
     },
+
+    {
+      desc: "(users burns max amount of shares, even when his alreadyIncludedTokens is empty)",
+      expectedError: null,
+      folioBasketTokens: [
+        new FolioTokenAmount(MINTS[0].publicKey, new BN(1_000).mul(D9)),
+        new FolioTokenAmount(MINTS[1].publicKey, new BN(1_000).mul(D9)),
+      ],
+      alreadyIncludedTokens: [],
+      user_pending_basket_not_initalized: true,
+      tokens: [
+        { mint: MINTS[0].publicKey, amount: new BN(0) },
+        { mint: MINTS[1].publicKey, amount: new BN(0) },
+      ],
+      initialUserShares: new BN(1_000_000_000),
+      shares: new BN(1_000_000_000),
+      expectedFolioTokenBalanceChange: new BN(1_000_000_000),
+      expectedTokenBalanceChanges: [
+        new BN(1_000_000_000),
+        new BN(1_000_000_000),
+      ],
+    },
   ];
 
   const TEST_CASES_REDEEM_FROM_PENDING_BASKET = [
@@ -551,6 +575,7 @@ describe("Bankrun - Folio redeeming", () => {
             customFolioTokenMint,
             customFolioFeeConfig,
             minimumOutForTokenAmounts,
+            user_pending_basket_not_initalized,
           } = {
             ...DEFAULT_PARAMS,
             ...restOfParams,
@@ -575,13 +600,15 @@ describe("Bankrun - Folio redeeming", () => {
               customFolioFeeConfig
             );
 
-            await createAndSetUserPendingBasket(
-              context,
-              programFolio,
-              folioPDA,
-              userKeypair.publicKey,
-              alreadyIncludedTokens
-            );
+            if (!user_pending_basket_not_initalized) {
+              await createAndSetUserPendingBasket(
+                context,
+                programFolio,
+                folioPDA,
+                userKeypair.publicKey,
+                alreadyIncludedTokens
+              );
+            }
 
             await travelFutureSlot(context);