refactor: ContextInterface trait for private and public contexts (#4808)

Adds a small ContextInterface trait with methods shared between both
private and public context. To be used for initialization handling later
down the road.

noir-projects/aztec-nr/aztec/src/context.nr

@@ -3,9 +3,11 @@ mod inputs;
 
 mod private_context;
 mod public_context;
+mod interface;
 mod avm;
 
 use private_context::PrivateContext;
+use interface::ContextInterface;
 use public_context::PublicContext;
 use avm::AVMContext;
 

noir-projects/aztec-nr/aztec/src/context/interface.nr

@@ -0,0 +1,15 @@
+use dep::protocol_types::{
+  abis::function_selector::FunctionSelector,
+  address::{AztecAddress, EthAddress},
+};
+
+trait ContextInterface {
+    fn push_new_note_hash(&mut self, note_hash: Field);
+    fn push_new_nullifier(&mut self, nullifier: Field, nullified_commitment: Field);
+    fn msg_sender(self) -> AztecAddress;
+    fn this_address(self) -> AztecAddress;
+    fn this_portal_address(self) -> EthAddress;
+    fn chain_id(self) -> Field;
+    fn version(self) -> Field;
+    fn selector(self) -> FunctionSelector;
+}

noir-projects/aztec-nr/aztec/src/context/private_context.nr

@@ -1,5 +1,6 @@
 use crate::{
-    context::inputs::PrivateContextInputs, key::nullifier_key::validate_nullifier_key_against_address,
+    context::{inputs::PrivateContextInputs, interface::ContextInterface},
+    key::nullifier_key::validate_nullifier_key_against_address,
     messaging::process_l1_to_l2_message,
     oracle::{
     arguments, call_private_function::call_private_function_internal,
@@ -10,14 +11,14 @@ use crate::{
 };
 use dep::protocol_types::{
     abis::{
-    call_context::CallContext, function_data::FunctionData, function_selector::FunctionSelector,
-    nullifier_key_validation_request::NullifierKeyValidationRequest,
-    private_call_stack_item::PrivateCallStackItem,
-    private_circuit_public_inputs::PrivateCircuitPublicInputs,
-    public_call_stack_item::PublicCallStackItem,
-    public_circuit_public_inputs::PublicCircuitPublicInputs,
-    side_effect::{SideEffect, SideEffectLinkedToNoteHash}
-},
+        call_context::CallContext, function_data::FunctionData, function_selector::FunctionSelector,
+        nullifier_key_validation_request::NullifierKeyValidationRequest,
+        private_call_stack_item::PrivateCallStackItem,
+        private_circuit_public_inputs::PrivateCircuitPublicInputs,
+        public_call_stack_item::PublicCallStackItem,
+        public_circuit_public_inputs::PublicCircuitPublicInputs,
+        side_effect::{SideEffect, SideEffectLinkedToNoteHash}
+    },
     address::{AztecAddress, EthAddress},
     constants::{
     MAX_NEW_NOTE_HASHES_PER_CALL, MAX_NEW_L2_TO_L1_MSGS_PER_CALL, MAX_NEW_NULLIFIERS_PER_CALL,
@@ -67,6 +68,44 @@ struct PrivateContext {
     nullifier_key: Option<NullifierKeyPair>,
 }
 
+impl ContextInterface for PrivateContext {
+    fn msg_sender(self) -> AztecAddress {
+        self.inputs.call_context.msg_sender
+    }
+
+    fn this_address(self) -> AztecAddress {
+        self.inputs.call_context.storage_contract_address
+    }
+
+    fn this_portal_address(self) -> EthAddress {
+        self.inputs.call_context.portal_contract_address
+    }
+
+    fn chain_id(self) -> Field {
+        self.inputs.private_global_variables.chain_id
+    }
+
+    fn version(self) -> Field {
+        self.inputs.private_global_variables.version
+    }
+
+    fn selector(self) -> FunctionSelector {
+        self.inputs.call_context.function_selector
+    }
+
+    fn push_new_note_hash(&mut self, note_hash: Field) {
+        let side_effect = SideEffect { value: note_hash, counter: self.side_effect_counter };
+        self.new_note_hashes.push(side_effect);
+        self.side_effect_counter = self.side_effect_counter + 1;
+    }
+
+    fn push_new_nullifier(&mut self, nullifier: Field, nullified_commitment: Field) {
+        let side_effect = SideEffectLinkedToNoteHash { value: nullifier, note_hash: nullified_commitment, counter: self.side_effect_counter };
+        self.new_nullifiers.push(side_effect);
+        self.side_effect_counter = self.side_effect_counter + 1;
+    }
+}
+
 impl PrivateContext {
     pub fn new(inputs: PrivateContextInputs, args_hash: Field) -> PrivateContext {
         let side_effect_counter = inputs.call_context.start_side_effect_counter;
@@ -100,30 +139,6 @@ impl PrivateContext {
         false
     }
 
-    pub fn msg_sender(self) -> AztecAddress {
-        self.inputs.call_context.msg_sender
-    }
-
-    pub fn this_address(self) -> AztecAddress {
-        self.inputs.call_context.storage_contract_address
-    }
-
-    pub fn this_portal_address(self) -> EthAddress {
-        self.inputs.call_context.portal_contract_address
-    }
-
-    pub fn chain_id(self) -> Field {
-        self.inputs.private_global_variables.chain_id
-    }
-
-    pub fn version(self) -> Field {
-        self.inputs.private_global_variables.version
-    }
-
-    pub fn selector(self) -> FunctionSelector {
-        self.inputs.call_context.function_selector
-    }
-
     // Returns the header of a block whose state is used during private execution (not the block the transaction is
     // included in).
     pub fn get_header(self) -> Header {
@@ -181,19 +196,7 @@ impl PrivateContext {
         let side_effect = SideEffect { value: read_request, counter: self.side_effect_counter };
         self.read_requests.push(side_effect);
         self.side_effect_counter = self.side_effect_counter + 1;
-    }
-
-    pub fn push_new_note_hash(&mut self, note_hash: Field) {
-        let side_effect = SideEffect { value: note_hash, counter: self.side_effect_counter };
-        self.new_note_hashes.push(side_effect);
-        self.side_effect_counter = self.side_effect_counter + 1;
-    }
-
-    pub fn push_new_nullifier(&mut self, nullifier: Field, nullified_commitment: Field) {
-        let side_effect = SideEffectLinkedToNoteHash { value: nullifier, note_hash: nullified_commitment, counter: self.side_effect_counter };
-        self.new_nullifiers.push(side_effect);
-        self.side_effect_counter = self.side_effect_counter + 1;
-    }
+    }    
 
     pub fn request_nullifier_secret_key(&mut self, account: AztecAddress) -> GrumpkinPrivateKey {
         let key_pair = if self.nullifier_key.is_none() {

noir-projects/aztec-nr/aztec/src/context/public_context.nr

@@ -1,5 +1,6 @@
 use crate::{
-    context::inputs::PublicContextInputs, messaging::process_l1_to_l2_message,
+    context::{inputs::PublicContextInputs, interface::ContextInterface}, 
+    messaging::process_l1_to_l2_message,
     oracle::{arguments, public_call::call_public_function_internal}
 };
 use dep::protocol_types::{
@@ -46,6 +47,49 @@ struct PublicContext {
     prover_address: AztecAddress,
 }
 
+impl ContextInterface for PublicContext {
+    fn msg_sender(self) -> AztecAddress {
+        self.inputs.call_context.msg_sender
+    }
+
+    fn this_address(self) -> AztecAddress {
+        self.inputs.call_context.storage_contract_address
+    }
+
+    fn this_portal_address(self) -> EthAddress {
+        self.inputs.call_context.portal_contract_address
+    }
+
+    fn chain_id(self) -> Field {
+        self.inputs.public_global_variables.chain_id
+    }
+
+    fn version(self) -> Field {
+        self.inputs.public_global_variables.version
+    }
+
+    fn selector(self) -> FunctionSelector {
+        self.inputs.call_context.function_selector
+    }
+
+    fn push_new_note_hash(&mut self, note_hash: Field) {
+        let side_effect = SideEffect { value: note_hash, counter: self.side_effect_counter };
+        self.new_note_hashes.push(side_effect);
+        self.side_effect_counter = self.side_effect_counter + 1;
+    }
+
+    fn push_new_nullifier(&mut self, nullifier: Field, _nullified_commitment: Field) {
+        let side_effect = SideEffectLinkedToNoteHash {
+            value: nullifier,
+            note_hash: 0, // cannot nullify pending notes in public context
+            counter: self.side_effect_counter
+        };
+        self.new_nullifiers.push(side_effect);
+        self.side_effect_counter = self.side_effect_counter + 1;
+    }
+
+}
+
 impl PublicContext {
     pub fn new(inputs: PublicContextInputs, args_hash: Field) -> PublicContext {
         let empty_storage_read = StorageRead::empty();
@@ -75,30 +119,6 @@ impl PublicContext {
         false
     }
 
-    pub fn msg_sender(self) -> AztecAddress {
-        self.inputs.call_context.msg_sender
-    }
-
-    pub fn this_address(self) -> AztecAddress {
-        self.inputs.call_context.storage_contract_address
-    }
-
-    pub fn this_portal_address(self) -> EthAddress {
-        self.inputs.call_context.portal_contract_address
-    }
-
-    pub fn chain_id(self) -> Field {
-        self.inputs.public_global_variables.chain_id
-    }
-
-    pub fn version(self) -> Field {
-        self.inputs.public_global_variables.version
-    }
-
-    pub fn selector(self) -> FunctionSelector {
-        self.inputs.call_context.function_selector
-    }
-
     pub fn block_number(self) -> Field {
         self.inputs.public_global_variables.block_number
     }
@@ -139,22 +159,6 @@ impl PublicContext {
         pub_circuit_pub_inputs
     }
 
-    pub fn push_new_note_hash(&mut self, note_hash: Field) {
-        let side_effect = SideEffect { value: note_hash, counter: self.side_effect_counter };
-        self.new_note_hashes.push(side_effect);
-        self.side_effect_counter = self.side_effect_counter + 1;
-    }
-
-    pub fn push_new_nullifier(&mut self, nullifier: Field, _nullified_commitment: Field) {
-        let side_effect = SideEffectLinkedToNoteHash {
-            value: nullifier,
-            note_hash: 0, // cannot nullify pending notes in public context
-            counter: self.side_effect_counter
-        };
-        self.new_nullifiers.push(side_effect);
-        self.side_effect_counter = self.side_effect_counter + 1;
-    }
-
     pub fn message_portal(&mut self, recipient: EthAddress, content: Field) {
         let message = L2ToL1Message { recipient, content };
         self.new_l2_to_l1_msgs.push(message);