feat(transaction_approve): implement instruction, test and sdk

Author: vovacodes

programs/multisig/src/errors.rs

@@ -20,4 +20,12 @@ pub enum MultisigError {
     NotAMember,
     #[msg("TransactionMessage is malformed.")]
     InvalidTransactionMessage,
+    #[msg("Transaction is stale.")]
+    StaleTransaction,
+    #[msg("Invalid transaction status.")]
+    InvalidTransactionStatus,
+    #[msg("Transaction does not belong to the multisig.")]
+    TransactionNotForMultisig,
+    #[msg("Member already approved the transaction.")]
+    AlreadyApproved,
 }

programs/multisig/src/events.rs

@@ -44,3 +44,15 @@ pub struct TransactionCreatedEvent {
     /// Memo that was added by the creator.
     pub memo: Option<String>,
 }
+
+/// New multisig transaction account is created.
+#[event]
+pub struct TransactionApprovedEvent {
+    /// The multisig account.
+    pub multisig: Pubkey,
+    /// The transaction account.
+    pub transaction: Pubkey,
+    #[index]
+    /// Memo that was added by the creator.
+    pub memo: Option<String>,
+}

programs/multisig/src/instructions/mod.rs

@@ -1,7 +1,9 @@
 pub use multisig_config::*;
 pub use multisig_create::*;
 pub use transaction_create::*;
+pub use transaction_vote::*;
 
 mod multisig_config;
 mod multisig_create;
 mod transaction_create;
+mod transaction_vote;

programs/multisig/src/instructions/transaction_vote.rs

@@ -0,0 +1,76 @@
+use anchor_lang::prelude::*;
+
+use crate::errors::*;
+use crate::events::*;
+use crate::state::*;
+
+#[derive(AnchorSerialize, AnchorDeserialize)]
+pub struct TransactionVoteArgs {
+    pub memo: Option<String>,
+}
+
+#[derive(Accounts)]
+pub struct TransactionVote<'info> {
+    #[account(
+        seeds = [SEED_PREFIX, multisig.create_key.as_ref(), SEED_MULTISIG],
+        bump = multisig.bump,
+    )]
+    pub multisig: Account<'info, Multisig>,
+
+    #[account(
+        mut,
+        seeds = [
+            SEED_PREFIX,
+            multisig.key().as_ref(),
+            &transaction.transaction_index.to_le_bytes(),
+            b"transaction"
+        ],
+        bump = transaction.bump,
+        constraint = transaction.status == TransactionStatus::Active @ MultisigError::InvalidTransactionStatus,
+        constraint = transaction.transaction_index > multisig.stale_transaction_index @ MultisigError::StaleTransaction,
+        constraint = transaction.multisig == multisig.key() @ MultisigError::TransactionNotForMultisig
+    )]
+    pub transaction: Account<'info, MultisigTransaction>,
+
+    #[account(
+        mut,
+        constraint = multisig.is_member(member.key()).is_some() @ MultisigError::NotAMember,
+        constraint = multisig.member_has_permission(member.key(), Permission::Vote) @MultisigError::Unauthorized,
+    )]
+    pub member: Signer<'info>,
+}
+
+impl TransactionVote<'_> {
+    /// Approve the transaction on behalf of the `member`.
+    /// The transaction must be `Active`.
+    pub fn transaction_approve(ctx: Context<Self>, args: TransactionVoteArgs) -> Result<()> {
+        let multisig = &mut ctx.accounts.multisig;
+        let transaction = &mut ctx.accounts.transaction;
+        let member = &mut ctx.accounts.member;
+
+        require!(
+            transaction.has_voted_approve(member.key()).is_none(),
+            MultisigError::AlreadyApproved
+        );
+
+        // If `member` has previously voted to reject, remove that vote.
+        if let Some(vote_index) = transaction.has_voted_reject(member.key()) {
+            transaction.remove_rejection_vote(vote_index);
+        }
+
+        transaction.approve(member.key());
+
+        // If current number of approvals reaches threshold, mark the transaction as `ExecuteReady`.
+        if transaction.approved.len() >= usize::from(multisig.threshold) {
+            transaction.status = TransactionStatus::ExecuteReady;
+        }
+
+        emit!(TransactionApprovedEvent {
+            multisig: multisig.key(),
+            transaction: transaction.key(),
+            memo: args.memo,
+        });
+
+        Ok(())
+    }
+}

programs/multisig/src/lib.rs

@@ -35,6 +35,15 @@ pub mod multisig {
         TransactionCreate::transaction_create(ctx, args)
     }
 
+    /// Approve the transaction on behalf of the `member`.
+    /// The transaction must be `Active`.
+    pub fn transaction_approve(
+        ctx: Context<TransactionVote>,
+        args: TransactionVoteArgs,
+    ) -> Result<()> {
+        TransactionVote::transaction_approve(ctx, args)
+    }
+
     // // instruction to remove a member/key from the multisig
     // pub fn remove_member(ctx: Context<MsAuth>, old_member: Pubkey) -> Result<()> {
     //     // if there is only one key in this multisig, reject the removal

programs/multisig/src/state.rs

@@ -189,24 +189,21 @@ impl MultisigTransaction {
     }
 
     /// Approve the transaction.
-    pub fn approve(&mut self, member: Pubkey) -> Result<()> {
+    pub fn approve(&mut self, member: Pubkey) {
         self.approved.push(member);
         self.approved.sort();
-        Ok(())
     }
 
     /// Reject the transaction.
-    pub fn reject(&mut self, member: Pubkey) -> Result<()> {
+    pub fn reject(&mut self, member: Pubkey) {
         self.rejected.push(member);
         self.rejected.sort();
-        Ok(())
     }
 
     /// Cancel the transaction if execute_ready.
-    pub fn cancel(&mut self, member: Pubkey) -> Result<()> {
+    pub fn cancel(&mut self, member: Pubkey) {
         self.cancelled.push(member);
         self.cancelled.sort();
-        Ok(())
     }
 
     /// Check if the member has already voted.
@@ -217,30 +214,31 @@ impl MultisigTransaction {
     }
 
     /// Check if the member approved the transaction.
+    /// Returns `Some(index)` if `member` has approved the transaction, with `index` into the `approved` vec.
     pub fn has_voted_approve(&self, member: Pubkey) -> Option<usize> {
         self.approved.binary_search(&member).ok()
     }
 
     /// Check if the member rejected the transaction.
+    /// Returns `Some(index)` if `member` has rejected the transaction, with `index` into the `rejected` vec.
     pub fn has_voted_reject(&self, member: Pubkey) -> Option<usize> {
         self.rejected.binary_search(&member).ok()
     }
 
     /// Check if a user has signed to cancel
+    /// Returns `Some(index)` if `member` has cancelled the transaction, with `index` into the `cancelled` vec.
     pub fn has_cancelled(&self, member: Pubkey) -> Option<usize> {
         self.cancelled.binary_search(&member).ok()
     }
 
     /// Delete the vote of rejection at the `index`.
-    pub fn remove_rejection_vote(&mut self, index: usize) -> Result<()> {
+    pub fn remove_rejection_vote(&mut self, index: usize) {
         self.rejected.remove(index);
-        Ok(())
     }
 
     /// Delete the vote of approval at the `index`.
-    pub fn remove_approval_vote(&mut self, index: usize) -> Result<()> {
+    pub fn remove_approval_vote(&mut self, index: usize) {
         self.approved.remove(index);
-        Ok(())
     }
 }
 

programs/multisig/src/utils/small_vec.rs

@@ -62,7 +62,7 @@ mod test {
             0x09, // vec[1]
         ][..];
 
-        let small_vec: SmallVec<u8, u8> = AnchorDeserialize::deserialize(&mut input).unwrap();
+        let small_vec: SmallVec<u8, u8> = SmallVec::deserialize(&mut input).unwrap();
 
         assert_eq!(small_vec.0, vec![5, 9]);
     }
@@ -75,7 +75,7 @@ mod test {
             0x09, 0x00, 0x00, 0x00, // vec[1]
         ][..];
 
-        let small_vec: SmallVec<u8, u32> = AnchorDeserialize::deserialize(&mut input).unwrap();
+        let small_vec: SmallVec<u8, u32> = SmallVec::deserialize(&mut input).unwrap();
 
         assert_eq!(small_vec.0, vec![5, 9]);
     }
@@ -91,7 +91,7 @@ mod test {
         ]
         .concat()[..];
 
-        let small_vec: SmallVec<u8, Pubkey> = AnchorDeserialize::deserialize(&mut input).unwrap();
+        let small_vec: SmallVec<u8, Pubkey> = SmallVec::deserialize(&mut input).unwrap();
 
         assert_eq!(small_vec.0, vec![pubkey1, pubkey2]);
     }
@@ -104,7 +104,7 @@ mod test {
             0x09, // vec[1]
         ][..];
 
-        let small_vec: SmallVec<u16, u8> = AnchorDeserialize::deserialize(&mut input).unwrap();
+        let small_vec: SmallVec<u16, u8> = SmallVec::deserialize(&mut input).unwrap();
 
         assert_eq!(small_vec.0, vec![5, 9]);
     }
@@ -120,7 +120,7 @@ mod test {
         ]
         .concat()[..];
 
-        let small_vec: SmallVec<u16, Pubkey> = AnchorDeserialize::deserialize(&mut input).unwrap();
+        let small_vec: SmallVec<u16, Pubkey> = SmallVec::deserialize(&mut input).unwrap();
 
         assert_eq!(small_vec.0, vec![pubkey1, pubkey2]);
     }

sdk/multisig/idl/multisig.json

@@ -105,6 +105,38 @@
           }
         }
       ]
+    },
+    {
+      "name": "transactionApprove",
+      "docs": [
+        "Approve the transaction on behalf of the `member`.",
+        "The transaction must be `Active`."
+      ],
+      "accounts": [
+        {
+          "name": "multisig",
+          "isMut": false,
+          "isSigner": false
+        },
+        {
+          "name": "transaction",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "member",
+          "isMut": true,
+          "isSigner": true
+        }
+      ],
+      "args": [
+        {
+          "name": "args",
+          "type": {
+            "defined": "TransactionVoteArgs"
+          }
+        }
+      ]
     }
   ],
   "accounts": [
@@ -397,6 +429,20 @@
         ]
       }
     },
+    {
+      "name": "TransactionVoteArgs",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "memo",
+            "type": {
+              "option": "string"
+            }
+          }
+        ]
+      }
+    },
     {
       "name": "Member",
       "type": {
@@ -679,6 +725,28 @@
           "index": true
         }
       ]
+    },
+    {
+      "name": "TransactionApprovedEvent",
+      "fields": [
+        {
+          "name": "multisig",
+          "type": "publicKey",
+          "index": false
+        },
+        {
+          "name": "transaction",
+          "type": "publicKey",
+          "index": false
+        },
+        {
+          "name": "memo",
+          "type": {
+            "option": "string"
+          },
+          "index": true
+        }
+      ]
     }
   ],
   "errors": [
@@ -726,6 +794,26 @@
       "code": 6008,
       "name": "InvalidTransactionMessage",
       "msg": "TransactionMessage is malformed."
+    },
+    {
+      "code": 6009,
+      "name": "StaleTransaction",
+      "msg": "Transaction is stale."
+    },
+    {
+      "code": 6010,
+      "name": "InvalidTransactionStatus",
+      "msg": "Invalid transaction status."
+    },
+    {
+      "code": 6011,
+      "name": "TransactionNotForMultisig",
+      "msg": "Transaction does not belong to the multisig."
+    },
+    {
+      "code": 6012,
+      "name": "AlreadyApproved",
+      "msg": "Member already approved the transaction."
     }
   ],
   "metadata": {