solana: add sender option (#118)

Co-authored-by: A5 Pickle <a5-pickle@users.noreply.github.com>

Author: a5-pickle

solana/programs/token-router/src/error.rs

@@ -25,6 +25,8 @@ pub enum TokenRouterError {
     AlreadyOwner = 0x204,
     NoTransferOwnershipRequest = 0x206,
     NotPendingOwner = 0x208,
+    MissingAuthority = 0x20a,
+    TooManyAuthorities = 0x20b,
 
     InsufficientAmount = 0x400,
     MinAmountOutTooHigh = 0x402,

solana/programs/token-router/src/processor/market_order/prepare.rs

@@ -17,7 +17,8 @@ pub struct PrepareMarketOrder<'info> {
 
     custodian: CheckedCustodian<'info>,
 
-    /// The auction participant needs to set approval to this PDA.
+    /// The auction participant needs to set approval to this PDA if the sender (signer) is not
+    /// provided.
     ///
     /// CHECK: Seeds must be \["transfer-authority", prepared_order.key(), args.hash()\].
     #[account(
@@ -28,7 +29,11 @@ pub struct PrepareMarketOrder<'info> {
         ],
         bump,
     )]
-    transfer_authority: UncheckedAccount<'info>,
+    program_transfer_authority: Option<UncheckedAccount<'info>>,
+
+    /// Sender, who has the authority to transfer assets from the sender token account. If this
+    /// account is not provided, the program transfer authority account must be some account.
+    sender: Option<Signer<'info>>,
 
     #[account(
         init,
@@ -164,22 +169,41 @@ pub fn prepare_market_order(
         redeemer_message,
     });
 
-    // Finally transfer amount to custody token account.
-    token::transfer(
-        CpiContext::new_with_signer(
-            ctx.accounts.token_program.to_account_info(),
-            token::Transfer {
-                from: ctx.accounts.sender_token.to_account_info(),
-                to: ctx.accounts.prepared_custody_token.to_account_info(),
-                authority: ctx.accounts.transfer_authority.to_account_info(),
-            },
-            &[&[
-                TRANSFER_AUTHORITY_SEED_PREFIX,
-                ctx.accounts.prepared_order.key().as_ref(),
-                &hashed_args.0,
-                &[ctx.bumps.transfer_authority],
-            ]],
+    // Finally transfer amount to custody token account. We perform exclusive or because we do not
+    // want to allow specifying more than one authority.
+    match (
+        ctx.accounts.sender.as_ref(),
+        ctx.accounts.program_transfer_authority.as_ref(),
+    ) {
+        (Some(sender), None) => token::transfer(
+            CpiContext::new(
+                ctx.accounts.token_program.to_account_info(),
+                token::Transfer {
+                    from: ctx.accounts.sender_token.to_account_info(),
+                    to: ctx.accounts.prepared_custody_token.to_account_info(),
+                    authority: sender.to_account_info(),
+                },
+            ),
+            amount_in,
         ),
-        amount_in,
-    )
+        (None, Some(program_transfer_authority)) => token::transfer(
+            CpiContext::new_with_signer(
+                ctx.accounts.token_program.to_account_info(),
+                token::Transfer {
+                    from: ctx.accounts.sender_token.to_account_info(),
+                    to: ctx.accounts.prepared_custody_token.to_account_info(),
+                    authority: program_transfer_authority.to_account_info(),
+                },
+                &[&[
+                    TRANSFER_AUTHORITY_SEED_PREFIX,
+                    ctx.accounts.prepared_order.key().as_ref(),
+                    &hashed_args.0,
+                    &[ctx.bumps.program_transfer_authority.unwrap()],
+                ]],
+            ),
+            amount_in,
+        ),
+        (None, None) => err!(TokenRouterError::MissingAuthority),
+        (Some(_), Some(_)) => err!(TokenRouterError::TooManyAuthorities),
+    }
 }

solana/target/idl/token_router.json

@@ -522,11 +522,22 @@
           ]
         },
         {
-          "name": "transfer_authority",
+          "name": "program_transfer_authority",
           "docs": [
-            "The auction participant needs to set approval to this PDA.",
+            "The auction participant needs to set approval to this PDA if the sender (signer) is not",
+            "provided.",
             ""
-          ]
+          ],
+          "optional": true
+        },
+        {
+          "name": "sender",
+          "docs": [
+            "Sender, who has the authority to transfer assets from the sender token account. If this",
+            "account is not provided, the program transfer authority account must be some account."
+          ],
+          "signer": true,
+          "optional": true
         },
         {
           "name": "prepared_order",
@@ -1123,6 +1134,14 @@
       "code": 6520,
       "name": "NotPendingOwner"
     },
+    {
+      "code": 6522,
+      "name": "TooManyAuthorities"
+    },
+    {
+      "code": 6524,
+      "name": "MissingAuthority"
+    },
     {
       "code": 7024,
       "name": "InsufficientAmount"

solana/target/types/token_router.ts

@@ -528,11 +528,22 @@ export type TokenRouter = {
           ]
         },
         {
-          "name": "transferAuthority",
+          "name": "programTransferAuthority",
           "docs": [
-            "The auction participant needs to set approval to this PDA.",
+            "The auction participant needs to set approval to this PDA if the sender (signer) is not",
+            "provided.",
             ""
-          ]
+          ],
+          "optional": true
+        },
+        {
+          "name": "sender",
+          "docs": [
+            "Sender, who has the authority to transfer assets from the sender token account. If this",
+            "account is not provided, the program transfer authority account must be some account."
+          ],
+          "signer": true,
+          "optional": true
         },
         {
           "name": "preparedOrder",
@@ -1129,6 +1140,14 @@ export type TokenRouter = {
       "code": 6520,
       "name": "notPendingOwner"
     },
+    {
+      "code": 6522,
+      "name": "tooManyAuthorities"
+    },
+    {
+      "code": 6524,
+      "name": "missingAuthority"
+    },
     {
       "code": 7024,
       "name": "insufficientAmount"

solana/ts/src/tokenRouter/index.ts

@@ -324,15 +324,15 @@ export class TokenRouterProgram {
         accounts: {
             preparedOrder: PublicKey;
             senderToken: PublicKey;
-            sender?: PublicKey;
+            senderTokenAuthority?: PublicKey;
         },
         args: PrepareMarketOrderArgs,
     ): Promise<{ transferAuthority: PublicKey; ix: TransactionInstruction }> {
         const { preparedOrder, senderToken } = accounts;
         const { amountIn } = args;
 
-        let { sender } = accounts;
-        sender ??= await (async () => {
+        let { senderTokenAuthority } = accounts;
+        senderTokenAuthority ??= await (async () => {
             const tokenAccount = await splToken.getAccount(
                 this.program.provider.connection,
                 senderToken,
@@ -344,7 +344,12 @@ export class TokenRouterProgram {
 
         return {
             transferAuthority,
-            ix: splToken.createApproveInstruction(senderToken, transferAuthority, sender, amountIn),
+            ix: splToken.createApproveInstruction(
+                senderToken,
+                transferAuthority,
+                senderTokenAuthority,
+                amountIn,
+            ),
         };
     }
 
@@ -353,19 +358,39 @@ export class TokenRouterProgram {
             payer: PublicKey;
             preparedOrder: PublicKey;
             senderToken: PublicKey;
+            senderTokenAuthority?: PublicKey;
             refundToken?: PublicKey;
-            sender?: PublicKey;
+            programTransferAuthority?: PublicKey | null;
+            sender?: PublicKey | null;
         },
-        args: PrepareMarketOrderArgs,
-    ): Promise<[approveIx: TransactionInstruction, prepareIx: TransactionInstruction]> {
-        const { payer, preparedOrder, senderToken, sender } = accounts;
-        let { refundToken } = accounts;
+        args: { useTransferAuthority?: boolean } & PrepareMarketOrderArgs,
+    ): Promise<[approveIx: TransactionInstruction | null, prepareIx: TransactionInstruction]> {
+        const { payer, preparedOrder, senderToken, senderTokenAuthority } = accounts;
+
+        let { refundToken, programTransferAuthority, sender } = accounts;
         refundToken ??= senderToken;
 
-        const { transferAuthority, ix: approveIx } = await this.approveTransferAuthorityIx(
-            { preparedOrder, senderToken, sender },
-            args,
-        );
+        let { useTransferAuthority } = args;
+        useTransferAuthority ??= true;
+
+        let approveIx: TransactionInstruction | null = null;
+
+        if (sender === undefined) {
+            sender = null;
+        }
+
+        if (programTransferAuthority === undefined) {
+            if (useTransferAuthority) {
+                const approveResult = await this.approveTransferAuthorityIx(
+                    { preparedOrder, senderToken, senderTokenAuthority },
+                    args,
+                );
+                programTransferAuthority = approveResult.transferAuthority;
+                approveIx = approveResult.ix;
+            } else {
+                programTransferAuthority = null;
+            }
+        }
 
         const prepareIx = await this.program.methods
             .prepareMarketOrder({
@@ -376,7 +401,9 @@ export class TokenRouterProgram {
             .accounts({
                 payer,
                 custodian: this.checkedCustodianComposite(),
-                transferAuthority,
+                programTransferAuthority,
+                // @ts-ignore Sender can be null.
+                sender,
                 preparedOrder,
                 senderToken,
                 refundToken,