clean up and polishing

cali-jumptrading · cali-jumptrading · commit a114adf5140f · 2025-03-24T15:11:24.000Z
diff --git a/src/flamenco/runtime/context/fd_exec_instr_ctx.c b/src/flamenco/runtime/context/fd_exec_instr_ctx.c
@@ -81,6 +81,17 @@ fd_exec_instr_ctx_delete( void * mem ) {
   return mem;
 }
 
+int
+fd_exec_instr_ctx_find_idx_of_instr_account( fd_exec_instr_ctx_t const * ctx,
+                                             fd_pubkey_t const *         pubkey ) {
+  for( int i = 0; i < ctx->instr->acct_cnt; i++ ) {
+    if( memcmp( pubkey->uc, ctx->instr->acct_pubkeys[i].uc, sizeof(fd_pubkey_t) )==0 ) {
+      return i;
+    }
+  }
+  return -1;
+}
+
 int
 fd_exec_instr_ctx_try_borrow_account( fd_exec_instr_ctx_t const * ctx,
                                       ulong                       idx,
@@ -105,8 +116,8 @@ fd_exec_instr_ctx_try_borrow_account( fd_exec_instr_ctx_t const * ctx,
 
 int
 fd_exec_instr_ctx_try_borrow_instr_account( fd_exec_instr_ctx_t const * ctx,
-                                                  ulong                       idx,
-                                                  fd_borrowed_account_t *     account ) {
+                                            ulong                       idx,
+                                            fd_borrowed_account_t *     account ) {
   /* Return a NotEnoughAccountKeys error if the idx is out of bounds.
      https://github.com/anza-xyz/agave/blob/v2.1.14/sdk/src/transaction_context.rs#L603 */
   if( FD_UNLIKELY( idx >= ctx->instr->acct_cnt ) ) {
@@ -115,30 +126,26 @@ fd_exec_instr_ctx_try_borrow_instr_account( fd_exec_instr_ctx_t const * ctx,
 
   fd_txn_account_t * instr_account = ctx->instr->accounts[idx];
 
-  return fd_exec_instr_ctx_try_borrow_account( ctx, idx, instr_account, account );
+  return fd_exec_instr_ctx_try_borrow_account( ctx,
+                                               idx,
+                                               instr_account,
+                                               account );
 }
 
 int
 fd_exec_instr_ctx_try_borrow_instr_account_with_key( fd_exec_instr_ctx_t *   ctx,
-                                               fd_pubkey_t const *     pubkey,
-                                               fd_borrowed_account_t * account ) {
+                                                     fd_pubkey_t const *     pubkey,
+                                                     fd_borrowed_account_t * account ) {
   for( ulong i = 0; i < ctx->instr->acct_cnt; i++ ) {
     if( memcmp( pubkey->uc, ctx->instr->acct_pubkeys[i].uc, sizeof(fd_pubkey_t) )==0 ) {
       return fd_exec_instr_ctx_try_borrow_instr_account( ctx, i, account );
     }
   }
-  return FD_EXECUTOR_INSTR_ERR_MISSING_ACC;
-}
 
-int
-fd_exec_instr_ctx_find_idx_of_instr_account( fd_exec_instr_ctx_t const * ctx,
-                                             fd_pubkey_t const *         pubkey ) {
-  for( int i = 0; i < ctx->instr->acct_cnt; i++ ) {
-    if( memcmp( pubkey->uc, ctx->instr->acct_pubkeys[i].uc, sizeof(fd_pubkey_t) )==0 ) {
-      return i;
-    }
-  }
-  return -1;
+  /* Return a NotEnoughAccountKeys error if the account is not found
+     in the instruction context to match the error code returned by
+     fd_exec_instr_ctx_try_borrow_instr_account. */
+  return FD_EXECUTOR_INSTR_ERR_NOT_ENOUGH_ACC_KEYS;
 }
 
 int
@@ -147,7 +154,7 @@ fd_exec_instr_ctx_try_borrow_last_program_account( fd_exec_instr_ctx_t const * c
   fd_txn_account_t * program_account = NULL;
   fd_exec_txn_ctx_get_account_at_index( ctx->txn_ctx, 
                                         ctx->instr->program_id,
-                                        &program_account, 
+                                        &program_account,
                                         NULL );
 
   return fd_exec_instr_ctx_try_borrow_account( ctx, 
diff --git a/src/flamenco/runtime/context/fd_exec_instr_ctx.h b/src/flamenco/runtime/context/fd_exec_instr_ctx.h
@@ -40,9 +40,9 @@ struct __attribute__((aligned(8UL))) fd_exec_instr_ctx {
 
 /* Be careful when using this macro. There may be places where the error
    will need to be handled differently. */
-#define FD_TRY_BORROW_INSTR_ACCOUNT_DEFAULT_ERR_CHECK( ctx, idx, acc ) do {    \
-  int err = fd_exec_instr_ctx_try_borrow_instr_account( ctx, idx, acc );       \
-  if( FD_UNLIKELY( err ) ) return err;                                         \
+#define FD_TRY_BORROW_INSTR_ACCOUNT_DEFAULT_ERR_CHECK( ctx, idx, acc ) do { \
+  int err = fd_exec_instr_ctx_try_borrow_instr_account( ctx, idx, acc );    \
+  if( FD_UNLIKELY( err ) ) return err;                                      \
 } while (0)
 
 FD_PROTOTYPES_BEGIN
@@ -80,6 +80,17 @@ fd_exec_instr_ctx_check_num_insn_accounts( fd_exec_instr_ctx_t * ctx,
   return FD_EXECUTOR_INSTR_SUCCESS;
 }
 
+/* Mirrors Agave function solana_sdk::transaction_context::InstructionContext::find_index_of_instruction_account.
+
+   Returns the index of the the instruction account given the account pubkey
+   or -1 if the account is not found.
+
+   https://github.com/anza-xyz/agave/blob/v2.1.14/sdk/src/transaction_context.rs#L524-L538 */
+
+int
+fd_exec_instr_ctx_find_idx_of_instr_account( fd_exec_instr_ctx_t const * ctx,
+                                             fd_pubkey_t const *         pubkey );
+
 /* Mirrors Agave function solana_sdk::transaction_context::InstructionContext::try_borrow_account.
 
    Borrows an account from the instruction context with a given account index.
@@ -100,17 +111,6 @@ fd_exec_instr_ctx_try_borrow_instr_account_with_key( fd_exec_instr_ctx_t *   ctx
                                                      fd_pubkey_t const *     pubkey,
                                                      fd_borrowed_account_t * account );
 
-/* Mirrors Agave function solana_sdk::transaction_context::InstructionContext::find_index_of_instruction_account.
-
-   Returns the index of the the instruction account given the account pubkey
-   or -1 if the account is not found.
-
-   https://github.com/anza-xyz/agave/blob/v2.1.14/sdk/src/transaction_context.rs#L524-L538 */
-
-int
-fd_exec_instr_ctx_find_idx_of_instr_account( fd_exec_instr_ctx_t const * ctx,
-                                             fd_pubkey_t const *         pubkey );
-
 /* Mirrors Agave function solana_sdk::transaction_context::InstructionContext::try_borrow_last_program_account
 
    Borrows the instruction's program account. Since there is only one program account per
diff --git a/src/flamenco/runtime/context/fd_exec_txn_ctx.c b/src/flamenco/runtime/context/fd_exec_txn_ctx.c
@@ -98,7 +98,7 @@ fd_exec_txn_ctx_get_account_at_index( fd_exec_txn_ctx_t *  ctx,
   *account = txn_account;
 
   if( condition != NULL ) {
-    if( FD_UNLIKELY( !condition( ctx, idx, *account ) ) ) 
+    if( FD_UNLIKELY( !condition( ctx, idx, *account ) ) )
       return FD_ACC_MGR_ERR_UNKNOWN_ACCOUNT;
   }
 
@@ -146,7 +146,7 @@ fd_exec_txn_ctx_get_executable_account( fd_exec_txn_ctx_t *  ctx,
       *account = txn_account;
 
       if( condition != NULL ) {
-        if( FD_UNLIKELY( !condition( ctx, (int)i, *account ) ) ) 
+        if( FD_UNLIKELY( !condition( ctx, (int)i, *account ) ) )
           return FD_ACC_MGR_ERR_UNKNOWN_ACCOUNT;
       }
 
@@ -310,3 +310,30 @@ fd_exec_txn_ctx_account_is_writable_idx( fd_exec_txn_ctx_t const * txn_ctx, int
 
   return 1;
 }
+
+/* Account pre-condition filtering functions */
+
+int
+fd_txn_account_exists( fd_exec_txn_ctx_t * ctx,
+                       int                 idx,
+                       fd_txn_account_t * acc ) {
+  (void) ctx;
+  (void) idx;
+  return fd_acc_exists( acc->const_meta );
+}
+
+int
+fd_txn_account_is_writable( fd_exec_txn_ctx_t * ctx,
+                            int                 idx,
+                            fd_txn_account_t * acc ) {
+  (void) acc;
+  return fd_exec_txn_ctx_account_is_writable_idx( ctx, idx );
+}
+
+int
+fd_txn_account_fee_payer_writable( fd_exec_txn_ctx_t * ctx,
+                                   int                 idx,
+                                   fd_txn_account_t * acc ) {
+  (void) acc;
+  return fd_txn_is_writable( ctx->txn_descriptor, idx );
+}
diff --git a/src/flamenco/runtime/context/fd_exec_txn_ctx.h b/src/flamenco/runtime/context/fd_exec_txn_ctx.h
@@ -248,15 +248,19 @@ fd_exec_txn_ctx_find_index_of_account( fd_exec_txn_ctx_t * ctx,
 
 /* Mirrors Agave function solana_sdk::transaction_context::get_account_at_index
 
+   Takes a function pointer to a condition function to check pre-conditions on the
+   obtained account. If the condition function is NULL, the account is returned without
+   any pre-condition checks.
+
    https://github.com/anza-xyz/agave/blob/v2.1.14/sdk/src/transaction_context.rs#L223-L230 */
 
 int
 fd_exec_txn_ctx_get_account_at_index( fd_exec_txn_ctx_t *  ctx,
                                       uchar                idx,
                                       fd_txn_account_t * * account,
-                                      int (*condition)( fd_exec_txn_ctx_t * ctx,
-                                                        int                 idx,
-                                                        fd_txn_account_t *  acc) );
+                                      int (*condition) ( fd_exec_txn_ctx_t * ctx,
+                                                         int                 idx,
+                                                         fd_txn_account_t *  acc) );
 
 int
 fd_exec_txn_ctx_get_account_with_key( fd_exec_txn_ctx_t *  ctx,
@@ -289,34 +293,35 @@ fd_exec_txn_ctx_reset_return_data( fd_exec_txn_ctx_t * txn_ctx );
    2. If the account is the program id AND the upgradeable loader account is in
       the set of transaction accounts. */
 /* https://github.com/anza-xyz/agave/blob/v2.1.1/sdk/program/src/message/versions/v0/loaded.rs#L137-L150 */
+
 int
 fd_exec_txn_ctx_account_is_writable_idx( fd_exec_txn_ctx_t const * txn_ctx, int idx );
 
-/* Conditional filter functions */
-static inline int
+/* Account pre-condition filtering functions
+
+   Used to filter accounts based on pre-conditions such as existence, is_writable, etc.
+   when obtaining accounts from the transaction context. Passed as a function pointer. */
+
+int
 fd_txn_account_exists( fd_exec_txn_ctx_t * ctx,
                        int                 idx,
-                       fd_txn_account_t * acc ) {
-  (void) ctx;
-  (void) idx;
-  return fd_acc_exists( acc->const_meta );
-}
+                       fd_txn_account_t * acc );
 
-static inline int
+int
 fd_txn_account_is_writable( fd_exec_txn_ctx_t * ctx,
                             int                 idx,
-                            fd_txn_account_t * acc ) {
-  (void) acc;
-  return fd_exec_txn_ctx_account_is_writable_idx( ctx, idx );
-}
+                            fd_txn_account_t * acc );
 
-static inline int
+/* The fee payer is a valid modifiable account if it is passed in as writable
+   in the message via a valid signature. We ignore if the account has been
+   demoted or not (see fd_exec_txn_ctx_account_is_writable_idx) for more details.
+   Agave and Firedancer will reject the fee payer if the transaction message
+   doesn't have a writable signature. */
+
+int
 fd_txn_account_fee_payer_writable( fd_exec_txn_ctx_t * ctx,
                                    int                 idx,
-                                   fd_txn_account_t * acc ) {
-  (void) acc;
-  return fd_txn_is_writable( ctx->txn_descriptor, idx );
-}
+                                   fd_txn_account_t * acc );
 
 FD_PROTOTYPES_END
 
diff --git a/src/flamenco/runtime/fd_executor.c b/src/flamenco/runtime/fd_executor.c
@@ -444,7 +444,7 @@ fd_executor_load_transaction_accounts( fd_exec_txn_ctx_t * txn_ctx ) {
   /* https://github.com/anza-xyz/agave/blob/v2.2.0/svm/src/account_loader.rs#L429-L443 */
   for( ulong i=0UL; i<txn_ctx->accounts_cnt; i++ ) {
     fd_txn_account_t * acct = &txn_ctx->accounts[i];
-    uchar unknown_acc = !!( fd_exec_txn_ctx_get_account_at_index( txn_ctx, (uchar)i, &acct, &fd_txn_account_exists ) ||
+    uchar unknown_acc = !!( fd_exec_txn_ctx_get_account_at_index( txn_ctx, (uchar)i, &acct, fd_txn_account_exists ) ||
                             acct->const_meta->info.lamports==0UL );
     ulong acc_size    = unknown_acc ? 0UL : acct->const_meta->dlen;
     uchar is_writable = !!( fd_exec_txn_ctx_account_is_writable_idx( txn_ctx, (int)i ) );
@@ -493,7 +493,10 @@ fd_executor_load_transaction_accounts( fd_exec_txn_ctx_t * txn_ctx ) {
     /* Mimicking `load_account()` here with 0-lamport check as well.
        https://github.com/anza-xyz/agave/blob/v2.2.0/svm/src/account_loader.rs#L455-L462 */
     fd_txn_account_t * program_account = NULL;
-    int err = fd_exec_txn_ctx_get_account_at_index( txn_ctx, instr->program_id, &program_account, &fd_txn_account_exists );
+    int err = fd_exec_txn_ctx_get_account_at_index( txn_ctx,
+                                                    instr->program_id,
+                                                    &program_account,
+                                                    &fd_txn_account_exists );
     if( FD_UNLIKELY( err!=FD_ACC_MGR_SUCCESS || program_account->const_meta->info.lamports==0UL ) ) {
       return FD_RUNTIME_TXN_ERR_PROGRAM_ACCOUNT_NOT_FOUND;
     }
@@ -785,14 +788,12 @@ fd_executor_validate_transaction_fee_payer( fd_exec_txn_ctx_t * txn_ctx ) {
     return err;
   }
 
-  /* The fee payer is a valid modifiable account if it is passed in as writable
-   in the message via a valid signature. We ignore if the account has been
-   demoted or not (see fd_txn_account_is_writable_idx) for more details.
-   Agave and Firedancer will reject the fee payer if the transaction message
-   doesn't have a writable signature.
-   https://github.com/anza-xyz/agave/blob/16de8b75ebcd57022409b422de557dd37b1de8db/svm/src/transaction_processor.rs#L431-L436 */
+  /* https://github.com/anza-xyz/agave/blob/16de8b75ebcd57022409b422de557dd37b1de8db/svm/src/transaction_processor.rs#L431-L436 */
   fd_txn_account_t * fee_payer_rec = NULL;
-  err = fd_exec_txn_ctx_get_account_at_index( txn_ctx,  FD_FEE_PAYER_TXN_IDX, &fee_payer_rec, &fd_txn_account_fee_payer_writable );
+  err = fd_exec_txn_ctx_get_account_at_index( txn_ctx,  
+                                              FD_FEE_PAYER_TXN_IDX, 
+                                              &fee_payer_rec, 
+                                              fd_txn_account_fee_payer_writable );
   if( FD_UNLIKELY( err!=FD_ACC_MGR_SUCCESS ) ) {
     return FD_RUNTIME_TXN_ERR_ACCOUNT_NOT_FOUND;
   }
diff --git a/src/flamenco/runtime/fd_system_ids.h b/src/flamenco/runtime/fd_system_ids.h
@@ -60,7 +60,7 @@ extern const fd_pubkey_t fd_solana_stake_program_buffer_address;
    not be writable.
 
    Whenever Agave changes the reserved account keys set, new feature-gated checks will need to be implemented in
-   `fd_txn_account_is_writable_idx()`, and additional functions will need to be added here.
+   `fd_exec_txn_ctx_account_is_writable_idx()`, and additional functions will need to be added here.
 
    Instead of maintaining a map of sysvars and builtins, Agave recommends checking the sysvar owner account, or checking
    the reserved keys below.
diff --git a/src/flamenco/runtime/program/fd_bpf_loader_program.c b/src/flamenco/runtime/program/fd_bpf_loader_program.c
@@ -130,7 +130,10 @@ read_bpf_upgradeable_loader_state_for_program( fd_exec_txn_ctx_t *
                                                uchar                               program_id,
                                                int *                               opt_err ) {
   fd_txn_account_t * rec = NULL;
-  int err = fd_exec_txn_ctx_get_account_at_index( txn_ctx, program_id, &rec, &fd_txn_account_exists );
+  int err = fd_exec_txn_ctx_get_account_at_index( txn_ctx,
+                                                  program_id,
+                                                  &rec,
+                                                  fd_txn_account_exists );
   if( FD_UNLIKELY( err ) ) {
     *opt_err = err;
     return NULL;
@@ -1897,7 +1900,6 @@ fd_bpf_loader_program_execute( fd_exec_instr_ctx_t * ctx ) {
 
       Every error that comes out of this block is mapped to an InvalidAccountData instruction error in Agave. */
 
-      /* use try_borrow_last_program_account */
     fd_account_meta_t const * metadata = program_account.acct->const_meta;
     uchar is_deprecated = !memcmp( metadata->info.owner, &fd_solana_bpf_loader_deprecated_program_id, sizeof(fd_pubkey_t) );
 
@@ -1923,7 +1925,10 @@ fd_bpf_loader_program_execute( fd_exec_instr_ctx_t * ctx ) {
 
       fd_txn_account_t * program_data_account = NULL;
       fd_pubkey_t *      programdata_pubkey   = (fd_pubkey_t *)&program_account_state->inner.program.programdata_address;
-      err = fd_exec_txn_ctx_get_executable_account( ctx->txn_ctx, programdata_pubkey, &program_data_account, &fd_txn_account_exists );
+      err = fd_exec_txn_ctx_get_executable_account( ctx->txn_ctx,
+                                                    programdata_pubkey,
+                                                    &program_data_account,
+                                                    fd_txn_account_exists );
       if( FD_UNLIKELY( err!=FD_ACC_MGR_SUCCESS ) ) {
         return FD_EXECUTOR_INSTR_ERR_INVALID_ACC_DATA;
       }
diff --git a/src/flamenco/runtime/program/fd_loader_v4_program.c b/src/flamenco/runtime/program/fd_loader_v4_program.c
@@ -774,17 +774,14 @@ fd_loader_v4_program_execute( fd_exec_instr_ctx_t * instr_ctx ) {
         }
       }
     } else {
-      /* try borrow last program account */
       /* https://github.com/anza-xyz/agave/blob/v2.1.4/programs/loader-v4/src/lib.rs#L489 */
-      fd_txn_account_t * program = NULL;
-      rc = fd_exec_txn_ctx_get_account_at_index( instr_ctx->txn_ctx, instr_ctx->instr->program_id, &program, &fd_txn_account_exists );
-      if( FD_UNLIKELY( rc ) ) {
-        return rc;
-      }
+      fd_guarded_borrowed_account_t program;
+      rc = fd_exec_instr_ctx_try_borrow_last_program_account( instr_ctx, &program );
+      if( FD_UNLIKELY( rc ) ) return rc;
 
       /* https://github.com/anza-xyz/agave/blob/v2.1.4/programs/loader-v4/src/lib.rs#L490 */
       fd_loader_v4_state_t state = {0};
-      rc = fd_loader_v4_get_state( program, &state );
+      rc = fd_loader_v4_get_state( program.acct, &state );
       if( FD_UNLIKELY( rc ) ) {
         return rc;
       }
diff --git a/src/flamenco/runtime/sysvar/fd_sysvar_instructions.c b/src/flamenco/runtime/sysvar/fd_sysvar_instructions.c
@@ -39,7 +39,10 @@ fd_sysvar_instructions_serialize_account( fd_exec_txn_ctx_t *      txn_ctx,
   ulong serialized_sz = instructions_serialized_size( instrs, instrs_cnt );
 
   fd_txn_account_t * rec = NULL;
-  int err = fd_exec_txn_ctx_get_account_with_key( txn_ctx, &fd_sysvar_instructions_id, &rec, &fd_txn_account_exists );
+  int err = fd_exec_txn_ctx_get_account_with_key( txn_ctx,
+                                                  &fd_sysvar_instructions_id,
+                                                  &rec,
+                                                  fd_txn_account_exists );
   if( FD_UNLIKELY( err != FD_ACC_MGR_SUCCESS && rec == NULL ) ) {
     /* The way we use this, this should NEVER hit since the borrowed accounts should be set up
        before this is called, and this is only called if the sysvar instructions account is in
@@ -131,15 +134,12 @@ fd_sysvar_instructions_update_current_instr_idx( fd_exec_txn_ctx_t * txn_ctx,
                                                  ushort              current_instr_idx ) {
   fd_txn_account_t * rec = NULL;
 
-  /* Find the index of the sysvar account.
-     https://github.com/anza-xyz/agave/blob/v2.1.14/svm/src/message_processor.rs#L49-L51 */
-  int index = fd_exec_txn_ctx_find_index_of_account( txn_ctx, &fd_sysvar_instructions_id );
-  if( FD_UNLIKELY( index==-1 ) ) {
-    return FD_ACC_MGR_ERR_READ_FAILED;
-  }
-
-  /* https://github.com/anza-xyz/agave/blob/v2.1.14/svm/src/message_processor.rs#L53-L55 */
-  int err = fd_exec_txn_ctx_get_account_at_index( txn_ctx, (uchar)index, &rec, NULL );
+  /* Obtain the sysvar instruction account
+     https://github.com/anza-xyz/agave/blob/v2.1.14/svm/src/message_processor.rs#L53-L55 */
+  int err = fd_exec_txn_ctx_get_account_with_key( txn_ctx,
+                                                  &fd_sysvar_instructions_id,
+                                                  &rec,
+                                                  NULL );
   if( FD_UNLIKELY( err != FD_ACC_MGR_SUCCESS ) ) {
     return FD_ACC_MGR_ERR_READ_FAILED;
   }
diff --git a/src/flamenco/runtime/tests/fd_exec_instr_test.c b/src/flamenco/runtime/tests/fd_exec_instr_test.c
