MultiOffRamp - merge MultiCommitStore (#987)

## Motivation Directly merges the MultiOffRamp with the MultiCommitStore to benefit from the locality of the commit & execution reporting in one contract ## Solution * Copies over the functions and tests from the MultiCommitStore * Simplifies shared configuration * `_verify` is now an internal function only used locally in execution * Fix: Implements a `_afterOCR3ConfigSet` to clear the `s_latestPriceEpochAndRound` for the CommitStore - since this was previously only done on the `_beforeConfigSet` hook, which is no longer present Current size margin is -2.604KB. Optimizations are out of scope for this PR.
smartcontractkit · Jun 13, 2024 · 974da41 · 974da41
1 parent b8ad704
commit 974da41
Show file tree

Hide file tree

Showing 23 changed files with 2,270 additions and 3,926 deletions.
diff --git a/contracts/.changeset/stale-cows-try.md b/contracts/.changeset/stale-cows-try.md
@@ -0,0 +1,5 @@
+---
+"@chainlink/contracts-ccip": minor
+---
+
+#updated Merge MultiCommitStore into MultiOffRamp
diff --git a/contracts/gas-snapshots/ccip.gas-snapshot b/contracts/gas-snapshots/ccip.gas-snapshot
diff --git a/contracts/scripts/native_solc_compile_all_ccip b/contracts/scripts/native_solc_compile_all_ccip
@@ -55,7 +55,6 @@ compileContract ccip/applications/EtherSenderReceiver.sol
 compileContract ccip/onRamp/EVM2EVMMultiOnRamp.sol
 compileContract ccip/onRamp/EVM2EVMOnRamp.sol
 compileContract ccip/CommitStore.sol
-compileContract ccip/MultiCommitStore.sol
 compileContract ccip/MultiAggregateRateLimiter.sol
 compileContract ccip/Router.sol
 compileContract ccip/PriceRegistry.sol

diff --git a/contracts/src/v0.8/ccip/CommitStore.sol b/contracts/src/v0.8/ccip/CommitStore.sol
@@ -76,7 +76,7 @@ contract CommitStore is ICommitStore, ITypeAndVersion, OCR2Base {
   uint64 private s_minSeqNr = 1;
   /// @dev The epoch and round of the last report
   uint40 private s_latestPriceEpochAndRound;
-  /// @dev Whether this OnRamp is paused or not
+  /// @dev Whether this CommitStore is paused or not
   bool private s_paused = false;
   // merkleRoot => timestamp when received
   mapping(bytes32 merkleRoot => uint256 timestamp) private s_roots;

diff --git a/contracts/src/v0.8/ccip/MultiCommitStore.sol b/contracts/src/v0.8/ccip/MultiCommitStore.sol
diff --git a/contracts/src/v0.8/ccip/interfaces/IMultiCommitStore.sol b/contracts/src/v0.8/ccip/interfaces/IMultiCommitStore.sol
diff --git a/contracts/src/v0.8/ccip/ocr/MultiOCR3Base.sol b/contracts/src/v0.8/ccip/ocr/MultiOCR3Base.sol
@@ -184,8 +184,13 @@ abstract contract MultiOCR3Base is ITypeAndVersion, OwnerIsCreator {
     emit ConfigSet(
       ocrPluginType, ocrConfigArgs.configDigest, ocrConfig.signers, ocrConfigArgs.transmitters, ocrConfigArgs.F
     );
+    _afterOCR3ConfigSet(ocrPluginType);
   }
 
+  /// @notice Hook that is called after a plugin's OCR3 config changes
+  /// @param ocrPluginType Plugin type for which the config changed
+  function _afterOCR3ConfigSet(uint8 ocrPluginType) internal virtual {}
+
   /// @notice Clears oracle roles for the provided oracle addresses
   /// @param ocrPluginType OCR plugin type to clear roles for
   /// @param oracleAddresses Oracle addresses to clear roles for

diff --git a/contracts/src/v0.8/ccip/offRamp/EVM2EVMMultiOffRamp.sol b/contracts/src/v0.8/ccip/offRamp/EVM2EVMMultiOffRamp.sol
diff --git a/contracts/src/v0.8/ccip/test/BaseTest.t.sol b/contracts/src/v0.8/ccip/test/BaseTest.t.sol
@@ -39,12 +39,6 @@ contract BaseTest is Test {
   uint32 internal constant DEFAULT_TOKEN_DEST_GAS_OVERHEAD = 34_000;
   uint32 internal constant DEFAULT_TOKEN_BYTES_OVERHEAD = 50;
 
-  // OCR
-  // Signer private keys used for these test
-  uint256 internal constant PRIVATE0 = 0x7b2e97fe057e6de99d6872a2ef2abf52c9b4469bc848c2465ac3fcd8d336e81d;
-  uint64 internal constant s_offchainConfigVersion = 3;
-  bytes internal constant REPORT = abi.encode("testReport");
-
   bool private s_baseTestInitialized;
 
   // Use 16 gas per data availability byte in our tests.