Merge branch 'release/2.17.0-ccip1.5' into sish/log-index-cherrypick

Author: stackman27

.github/e2e-tests.yml

@@ -962,6 +962,32 @@ runner-test-matrix:
       E2E_TEST_SELECTED_NETWORK: SIMULATED_1,SIMULATED_2
     test_config_override_path: integration-tests/ccip-tests/testconfig/tomls/usdc_mock_deployment.toml
 
+  - id: ccip-smoke-lbtc-32bytes-destination-pool-data
+    path: integration-tests/ccip-tests/smoke/ccip_test.go
+    test_env_type: docker
+    runs_on: ubuntu-latest
+    triggers:
+      - PR E2E CCIP Tests
+      - Merge Queue E2E CCIP Tests
+      - Nightly E2E Tests
+    test_cmd: cd integration-tests/ccip-tests/smoke && go test ccip_test.go -test.run ^TestSmokeCCIPForBidirectionalLane$ -timeout 30m -count=1 -test.parallel=1 -json
+    test_env_vars:
+      E2E_TEST_SELECTED_NETWORK: SIMULATED_1,SIMULATED_2
+    test_config_override_path: integration-tests/ccip-tests/testconfig/tomls/lbtc_mock_deployment_with_32bytes_data.toml
+
+  - id: ccip-smoke-lbtc-non32bytes-destination-pool-data
+    path: integration-tests/ccip-tests/smoke/ccip_test.go
+    test_env_type: docker
+    runs_on: ubuntu-latest
+    triggers:
+      - PR E2E CCIP Tests
+      - Merge Queue E2E CCIP Tests
+      - Nightly E2E Tests
+    test_cmd: cd integration-tests/ccip-tests/smoke && go test ccip_test.go -test.run ^TestSmokeCCIPForBidirectionalLane$ -timeout 30m -count=1 -test.parallel=1 -json
+    test_env_vars:
+      E2E_TEST_SELECTED_NETWORK: SIMULATED_1,SIMULATED_2
+    test_config_override_path: integration-tests/ccip-tests/testconfig/tomls/lbtc_mock_deployment_with_non32bytes_data.toml
+
   - id: ccip-smoke-db-compatibility
     path: integration-tests/ccip-tests/smoke/ccip_test.go
     test_env_type: docker

contracts/scripts/native_solc_compile_all_ccip

@@ -96,6 +96,7 @@ compileContract ccip/test/helpers/receivers/MaybeRevertMessageReceiver.sol
 compileContract ccip/test/helpers/MultiOCR3Helper.sol
 compileContract ccip/test/mocks/MockE2EUSDCTokenMessenger.sol
 compileContract ccip/test/mocks/MockE2EUSDCTransmitter.sol
+compileContract ccip/test/mocks/MockLBTCTokenPool.sol
 compileContract ccip/test/WETH9.sol
 
 

contracts/src/v0.8/ccip/test/mocks/MockLBTCTokenPool.sol

@@ -0,0 +1,66 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity 0.8.24;
+
+import {ITypeAndVersion} from "../../../shared/interfaces/ITypeAndVersion.sol";
+import {IBurnMintERC20} from "../../../shared/token/ERC20/IBurnMintERC20.sol";
+
+import {Pool} from "../../libraries/Pool.sol";
+import {TokenPool} from "../../pools/TokenPool.sol";
+
+import {IERC20} from "../../../vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/IERC20.sol";
+import {SafeERC20} from "../../../vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/utils/SafeERC20.sol";
+
+/// @notice This mock contract facilitates testing of LBTC token transfers by burning and minting tokens.
+contract MockLBTCTokenPool is TokenPool, ITypeAndVersion {
+    using SafeERC20 for IERC20;
+
+    string public constant override typeAndVersion = "MockLBTCTokenPool 1.5.1";
+
+    // This variable i_destPoolData will have either a 32-byte or non-32-byte value, which will change the off-chain behavior.
+    // If it is 32 bytes, the off-chain will consider it as attestation enabled and call the attestation API.
+    // If it is non-32 bytes, the off-chain will consider it as attestation disabled.
+    bytes public i_destPoolData;
+
+    constructor(
+        IERC20 token,
+        address[] memory allowlist,
+        address rmnProxy,
+        address router,
+        bytes memory destPoolData
+    ) TokenPool(token, allowlist, rmnProxy, router) {
+        i_destPoolData = destPoolData;
+    }
+
+    function lockOrBurn(
+        Pool.LockOrBurnInV1 calldata lockOrBurnIn
+    ) public virtual override returns (Pool.LockOrBurnOutV1 memory) {
+        IBurnMintERC20(address(i_token)).burn(lockOrBurnIn.amount);
+        emit Burned(msg.sender, lockOrBurnIn.amount);
+
+        return
+            Pool.LockOrBurnOutV1({
+            destTokenAddress: getRemoteToken(
+                lockOrBurnIn.remoteChainSelector
+            ),
+            destPoolData: i_destPoolData
+        });
+    }
+
+    function releaseOrMint(
+        Pool.ReleaseOrMintInV1 calldata releaseOrMintIn
+    ) public virtual override returns (Pool.ReleaseOrMintOutV1 memory) {
+        IBurnMintERC20(address(i_token)).mint(releaseOrMintIn.receiver, releaseOrMintIn.amount);
+
+        emit Minted(
+            msg.sender,
+            releaseOrMintIn.receiver,
+            releaseOrMintIn.amount
+        );
+
+        return
+            Pool.ReleaseOrMintOutV1({
+            destinationAmount: releaseOrMintIn.amount
+        });
+    }
+}
+

core/chains/evm/client/errors.go

@@ -263,9 +263,11 @@ var aStar = ClientErrors{
 }
 
 var mantle = ClientErrors{
-	InsufficientEth: regexp.MustCompile(`(: |^)'*insufficient funds for gas \* price \+ value`),
-	Fatal:           regexp.MustCompile(`(: |^)'*invalid sender`),
-	NonceTooLow:     regexp.MustCompile(`(: |^)'*nonce too low`),
+	InsufficientEth:                   regexp.MustCompile(`(: |^)'*insufficient funds for gas \* price \+ value`),
+	Fatal:                             regexp.MustCompile(`(: |^)'*invalid sender`),
+	NonceTooLow:                       regexp.MustCompile(`(: |^)'*nonce too low`),
+	ReplacementTransactionUnderpriced: regexp.MustCompile(`(: |^)'*replacement transaction underpriced`),
+	TransactionAlreadyInMempool:       regexp.MustCompile(`(: |^)'*already known`),
 }
 
 var hederaFatal = regexp.MustCompile(`(: |^)(execution reverted)(:|$) | ^Transaction gas limit '(\d+)' exceeds block gas limit '(\d+)' | ^Transaction gas limit provided '(\d+)' is insufficient of intrinsic gas required '(\d+)' | ^Oversized data:|status INVALID_SIGNATURE`)

core/chains/evm/client/errors_test.go

@@ -110,6 +110,7 @@ func Test_Eth_Errors(t *testing.T) {
 			{"gas price too low", false, "Arbitrum"},
 			{"client error replacement underpriced", true, "tomlConfig"},
 			{"", false, "tomlConfig"},
+			{"failed to forward tx to sequencer, please try again. Error message: 'replacement transaction underpriced'", true, "Mantle"},
 		}
 
 		for _, test := range tests {
@@ -143,6 +144,7 @@ func Test_Eth_Errors(t *testing.T) {
 			{"client error transaction already in mempool", true, "tomlConfig"},
 			{"alreadyknown", true, "Gnosis"},
 			{"tx already exists in cache", true, "Sei"},
+			{"failed to forward tx to sequencer, please try again. Error message: 'already known'", true, "Mantle"},
 		}
 		for _, test := range tests {
 			err = evmclient.NewSendErrorS(test.message)

core/chains/evm/config/toml/defaults/BOB_Testnet.toml

@@ -1,13 +1,13 @@
 ChainID = '808813'
 # OP stack https://docs.gobob.xyz/learn/introduction/stack-overview#rollup-layer
 ChainType = 'optimismBedrock'
-# finality_depth was: ~850
-FinalityDepth = 900
+# FinalityDepth in mainnet showed more than 3k
+FinalityDepth = 3150
 # block_time was:  2s, adding 1 second buffer 
 LogPollInterval = '3s'  
 
-# finality_depth * block_time / 60 secs = ~30  min (finality time)
-NoNewFinalizedHeadsThreshold = '35m'
+# finality_depth * block_time / 60 secs = ~105  min (finality time)
+NoNewFinalizedHeadsThreshold = '110m'
 
 FinalityTagEnabled = true
 

core/chains/evm/config/toml/defaults/Bitlayer_Mainnet.toml

@@ -0,0 +1,11 @@
+ChainID = '200901'
+FinalityTagEnabled = false
+FinalityDepth = 21         # confirmed with Bitlayer team and recommended by docs: https://docs.bitlayer.org/docs/Learn/BitlayerNetwork/AboutFinality/#about-finality-at-stage-bitlayer-pos-bitlayer-mainnet-v1
+
+[GasEstimator]
+Mode = 'FeeHistory'
+EIP1559DynamicFees = false
+PriceMax = '1 gwei'        # DS&A recommended value
+PriceMin = '40 mwei'       # During testing, we saw minimum gas prices ~50 mwei
+PriceDefault = '1 gwei'    # As we set PriceMax to '1 gwei' and PriceDefault must be less than or equal to PriceMax
+FeeCapDefault = '1 gwei'   # As we set PriceMax to '1 gwei' and FeeCapDefault must be less than or equal to PriceMax

core/chains/evm/config/toml/defaults/Bitlayer_Testnet.toml

@@ -0,0 +1,11 @@
+ChainID = '200810'
+FinalityTagEnabled = false
+FinalityDepth = 21 # confirmed with Bitlayer team and recommended by docs: https://docs.bitlayer.org/docs/Learn/BitlayerNetwork/AboutFinality/#about-finality-at-stage-bitlayer-pos-bitlayer-mainnet-v1
+
+[GasEstimator]
+Mode='FeeHistory'
+EIP1559DynamicFees = false
+PriceMax = '1 gwei' # DS&A recommended value
+PriceMin = '40 mwei' # During testing, we saw minimum gas prices ~50 mwei
+PriceDefault = '1 gwei' # As we set PriceMax to '1 gwei' and PriceDefault must be less than or equal to PriceMax
+FeeCapDefault = '1 gwei' # As we set PriceMax to '1 gwei' and FeeCapDefault must be less than or equal to PriceMax

core/chains/evm/config/toml/defaults/Mantle_Mainnet.toml

@@ -0,0 +1,33 @@
+ChainID = '5000'
+FinalityTagEnabled = true
+FinalityDepth = 1200
+ChainType = 'optimismBedrock'
+LogPollInterval = '2s'
+MinIncomingConfirmations = 1
+NoNewFinalizedHeadsThreshold = '40m0s'
+
+[HeadTracker]
+HistoryDepth = 1250
+
+[GasEstimator]
+PriceMax = '120 gwei'
+# Limit values are high as Mantle's GasPrice is in native token (MNT) instead of ETH. Their proprietary TokenRatio parameter is used to adjust fees
+LimitDefault = 80_000_000_000
+LimitMax = 100_000_000_000
+BumpMin = '100 wei'
+BumpThreshold = 60
+EIP1559DynamicFees = true
+FeeCapDefault = '120 gwei'
+# Mantle recommends setting Priority Fee to 0 in their docs linked here: https://docs-v2.mantle.xyz/devs/concepts/tx-fee/eip-1559#application-of-eip-1559-in-mantle-v2-tectonic
+TipCapDefault = '0 wei'
+TipCapMin = '0 wei'
+
+[GasEstimator.BlockHistory]
+# Default is 24, which leads to bumpy gas prices. In CCIP
+# we want to smooth out the gas prices, so we increase the sample size.
+BlockHistorySize = 200
+# The formula for FeeCap is (current block base fee * (1.125 ^ EIP1559FeeCapBufferBlocks) + tipcap)
+# where tipcap is managed by the block history estimators. In the context of CCIP,
+# the gas price is relayed to other changes for quotes so we want accurate/avg not pessimistic values.
+# So we set this to zero so FeeCap = baseFee + tipcap.
+EIP1559FeeCapBufferBlocks = 0

core/chains/evm/config/toml/defaults/Mantle_Sepolia.toml

@@ -1,23 +1,34 @@
 ChainID = '5003'
-ChainType = 'optimismBedrock'
-# FT and FD are both present here because the dev effort rely only on FinalityTagEnabled are still in progress.
-# We expect to be able to rely only on FinalityTagEnabled=true in the short future.
-# https://chainlink-core.slack.com/archives/C05CS33N08N/p1715102940763339?thread_ts=1715102478.537529&cid=C05CS33N08N
-FinalityDepth = 1200
 FinalityTagEnabled = true
+FinalityDepth = 1200
+ChainType = 'optimismBedrock'
 LogPollInterval = '2s'
-NoNewHeadsThreshold = '0'
 MinIncomingConfirmations = 1
+NoNewFinalizedHeadsThreshold = '60m0s'
 
 [HeadTracker]
-HistoryDepth = 600
+HistoryDepth = 1250
 
 [GasEstimator]
-Mode = 'L2Suggested'
-PriceMax = '200 gwei'
-LimitDefault = 100000000
-FeeCapDefault = '200 gwei'
+PriceMax = '120 gwei'
+# Limit values are high as Mantle's GasPrice is in native token (MNT) instead of ETH. Their proprietary TokenRatio parameter is used to adjust fees
+LimitDefault = 80000000000
+LimitMax = 100000000000
+BumpMin = '100 wei'
+BumpPercent = 20
+BumpThreshold = 60
+EIP1559DynamicFees = true
+FeeCapDefault = '120 gwei'
+# Mantle reccomends setting Priority Fee to 0 in their docs linked here: https://docs-v2.mantle.xyz/devs/concepts/tx-fee/eip-1559#application-of-eip-1559-in-mantle-v2-tectonic
+TipCapDefault = '0 wei'
+TipCapMin = '0 wei'
 
 [GasEstimator.BlockHistory]
+# Default is 24, which leads to bumpy gas prices. In CCIP
+# we want to smooth out the gas prices, so we increase the sample size.
 BlockHistorySize = 200
+# The formula for FeeCap is (current block base fee * (1.125 ^ EIP1559FeeCapBufferBlocks) + tipcap)
+# where tipcap is managed by the block history estimators. In the context of CCIP,
+# the gas price is relayed to other changes for quotes so we want accurate/avg not pessimistic values.
+# So we set this to zero so FeeCap = baseFee + tipcap.
 EIP1559FeeCapBufferBlocks = 0