Lockbox per pool (#1485)

local lockbox

Author: 0xsuryansh

ccv/chains/evm/gobindings/generated/latest/erc20_lock_box/erc20_lock_box.go

@@ -86,25 +86,15 @@ CommitteeVerifier_verifyMessage:test_verifyMessage_ForwardCompatibilityWithExtra
 CommitteeVerifier_withdrawFeeTokens:test_withdrawFeeTokens() (gas: 215582)
 CommitteeVerifier_withdrawFeeTokens:test_withdrawFeeTokens_MultipleTokens() (gas: 1493095)
 DefensiveExampleTest:test_HappyPath() (gas: 203303)
-DefensiveExampleTest:test_Recovery() (gas: 428649)
+DefensiveExampleTest:test_Recovery() (gas: 428623)
 ERC165CheckerReverting_supportsInterfaceReverting:test__supportsInterfaceReverting() (gas: 10673)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_AddAlreadyAllowedCaller() (gas: 32992)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_AddAndRemoveInSameCall() (gas: 71065)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_AddMultipleCallers() (gas: 128026)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_AddSingleCaller() (gas: 57264)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_ReAddRemovedCaller() (gas: 78277)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_RemoveAllCallers() (gas: 94645)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_RemoveNonExistentCaller() (gas: 32707)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_RemoveSingleCaller() (gas: 49924)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_ZeroAddress() (gas: 53199)
-ERC20LockBox_configureAllowedCallers:test_ConfigureAllowedCallers_ZeroTokenAddress() (gas: 11266)
-ERC20LockBox_constructor:test_Constructor_Success() (gas: 575716)
-ERC20LockBox_deposit:test_Deposit_FromDifferentCallers() (gas: 486012)
-ERC20LockBox_deposit:test_Deposit_MultipleDeposits() (gas: 88456)
-ERC20LockBox_withdraw:test_Withdraw_EventEmission() (gas: 97975)
-ERC20LockBox_withdraw:test_Withdraw_MultipleWithdrawals() (gas: 142149)
-ERC20LockBox_withdraw:test_Withdraw_PartialAmount() (gas: 113230)
-ERC20LockBox_withdraw:test_Withdraw_ToDifferentRecipients() (gas: 130182)
+ERC20LockBox_constructor:test_constructor() (gas: 731898)
+ERC20LockBox_deposit:test_deposit_FromDifferentCallers() (gas: 511291)
+ERC20LockBox_deposit:test_deposit_MultipleDeposits() (gas: 76246)
+ERC20LockBox_withdraw:test_withdraw_EventEmission() (gas: 87982)
+ERC20LockBox_withdraw:test_withdraw_MultipleWithdrawals() (gas: 128924)
+ERC20LockBox_withdraw:test_withdraw_PartialAmount() (gas: 100978)
+ERC20LockBox_withdraw:test_withdraw_ToDifferentRecipients() (gas: 118284)
 EtherSenderReceiverTest_ccipReceive:test_ccipReceive_fallbackToWethTransfer() (gas: 98080)
 EtherSenderReceiverTest_ccipReceive:test_ccipReceive_happyPath() (gas: 48430)
 EtherSenderReceiverTest_ccipReceive:test_ccipReceive_wrongToken() (gas: 18138)
@@ -178,7 +168,7 @@ FeeQuoter_applyDestChainConfigUpdates:test_applyDestChainConfigUpdates() (gas: 1
 FeeQuoter_applyDestChainConfigUpdates:test_applyDestChainConfigUpdates_ZeroInputDoesNotEmitLog() (gas: 13182)
 FeeQuoter_applyFeeTokensUpdates:test_applyFeeTokensUpdates() (gas: 68608)
 FeeQuoter_applyTokenTransferFeeConfigUpdates:test_applyTokenTransferFeeConfigUpdates() (gas: 82019)
-FeeQuoter_constructor:test_constructor() (gas: 4382361)
+FeeQuoter_constructor:test_constructor() (gas: 4382328)
 FeeQuoter_convertTokenAmount:test_convertTokenAmount() (gas: 68235)
 FeeQuoter_getTokenAndGasPrices:test_getTokenAndGasPrices() (gas: 71199)
 FeeQuoter_getTokenAndGasPrices:test_getTokenAndGasPrices_ZeroGasPrice() (gas: 82259)
@@ -265,13 +255,12 @@ Internal_validateEVMAddress:test_validateEVMAddress_ValidAddress() (gas: 586)
 Internal_validateTVMAddress:test_validateTVMAddress_BasechainAddress() (gas: 287)
 Internal_validateTVMAddress:test_validateTVMAddress_MasterchainAddress() (gas: 595)
 Internal_validateTVMAddress:test_validateTVMAddress_MinimalNonZeroAccountId() (gas: 857)
-LockReleaseTokenPool_lockOrBurn:test_lockOrBurnV2_WithFee() (gas: 278395)
-LockReleaseTokenPool_lockOrBurn:test_lockOrBurn_LockOrBurnWithAllowList() (gas: 283739)
-LockReleaseTokenPool_releaseOrMint:test_releaseOrMint() (gas: 234516)
-LockReleaseTokenPool_releaseOrMint:test_releaseOrMintV2() (gas: 247028)
-LockReleaseTokenPool_setRebalancer:test_SetRebalancer() (gas: 21953)
+LockReleaseTokenPool_constructor:test_constructor() (gas: 5908382)
+LockReleaseTokenPool_lockOrBurn:test_lockOrBurnV2_WithFee() (gas: 277867)
+LockReleaseTokenPool_lockOrBurn:test_lockOrBurn_LockOrBurnWithAllowList() (gas: 281110)
+LockReleaseTokenPool_releaseOrMint:test_releaseOrMint() (gas: 234112)
+LockReleaseTokenPool_releaseOrMint:test_releaseOrMintV2() (gas: 246587)
 LockReleaseTokenPool_supportsInterface:test_SupportsInterface() (gas: 10100)
-LockReleaseTokenPool_transferLiquidity:test_transferLiquidity() (gas: 96529)
 LombardTokenPool_constructor:test_constructor() (gas: 4492381)
 LombardTokenPool_constructor:test_constructor_RevertsWhen_InvalidMessageVersion() (gas: 101872)
 LombardTokenPool_constructor:test_constructor_RevertsWhen_ZeroBridge() (gas: 97521)
@@ -460,9 +449,9 @@ Router_ccipSend:test_NonLinkFeeToken() (gas: 245932)
 Router_ccipSend:test_WrappedNativeFeeToken() (gas: 276460)
 Router_ccipSend:test_ccipSend_nativeFeeNoTokenSuccess_gas() (gas: 191329)
 Router_ccipSend:test_ccipSend_nativeFeeOneTokenSuccess_gas() (gas: 340764)
-Router_constructor:test_Constructor() (gas: 13312)
+Router_constructor:test_Constructor() (gas: 13279)
 Router_getArmProxy:test_getArmProxy() (gas: 10647)
-Router_getFee:test_GetFeeSupportedChain() (gas: 82316)
+Router_getFee:test_GetFeeSupportedChain() (gas: 82283)
 Router_recoverTokens:test_RecoverTokens() (gas: 51647)
 Router_routeMessage:test_routeMessage_AutoExec() (gas: 41935)
 Router_routeMessage:test_routeMessage_ExecutionEvent() (gas: 157877)
@@ -491,55 +480,60 @@ SignatureQuorumValidator_getSignatureConfig:test_getSignatureConfig_MultipleUpda
 SignatureQuorumValidator_getSignatureConfig:test_getSignatureConfig_SingleSigner() (gas: 68231)
 SignatureQuorumValidator_validateSignatures:test_validateSignatures_ExtraSignatures() (gas: 103451)
 SignatureQuorumValidator_validateSignatures:test_validateSignatures_MultipleSignatures() (gas: 107585)
-SiloedLockReleaseTokenPool_getAvailableTokens:test_getAvailableTokens_SiloedChain() (gas: 92935)
-SiloedLockReleaseTokenPool_getAvailableTokens:test_getAvailableTokens_UnsiloedChain() (gas: 96901)
-SiloedLockReleaseTokenPool_lockOrBurn:test_lockOrBurn_SiloedFunds() (gas: 269660)
-SiloedLockReleaseTokenPool_lockOrBurn:test_lockOrBurn_UnsiloedFunds() (gas: 268735)
-SiloedLockReleaseTokenPool_provideLiquidity:test_provideLiquidity() (gas: 261216)
-SiloedLockReleaseTokenPool_provideSiloedLiquidity:test_provideSiloedLiquidity() (gas: 252312)
-SiloedLockReleaseTokenPool_releaseOrMint:test_ReleaseOrMint_RevertsWhen_InsufficientLiquidity_SiloedChain() (gas: 110687)
-SiloedLockReleaseTokenPool_releaseOrMint:test_ReleaseOrMint_RevertsWhen_InsufficientLiquidity_UnsiloedChain() (gas: 114891)
-SiloedLockReleaseTokenPool_releaseOrMint:test_ReleaseOrMint_SiloedChain() (gas: 292101)
-SiloedLockReleaseTokenPool_releaseOrMint:test_ReleaseOrMint_UnsiloedChain() (gas: 293748)
-SiloedLockReleaseTokenPool_setRebalancer:test_setRebalancer_UnsiloedChains() (gas: 24971)
-SiloedLockReleaseTokenPool_setRebalancer:test_setSiloRebalancer() (gas: 28998)
-SiloedLockReleaseTokenPool_updateSiloDesignations:test_updateSiloDesignations() (gas: 181096)
-SiloedLockReleaseTokenPool_withdrawLiqudity:test_withdrawLiquidity_SiloedFunds() (gas: 108237)
-SiloedLockReleaseTokenPool_withdrawLiqudity:test_withdrawLiquidity_UnsiloedFunds_LegacyFunctionSelector() (gas: 109932)
-SiloedUSDCTokenPool_burnLockedUSDC:test_burnLockedUSDC() (gas: 413352)
+SiloedLockReleaseTokenPool_configureChainLockBoxes:test_configureChainLockBoxes() (gas: 976525)
+SiloedLockReleaseTokenPool_constructor:test_constructor() (gas: 6815165)
+SiloedLockReleaseTokenPool_getAvailableTokens:test_getAvailableTokens_SiloedChain() (gas: 73508)
+SiloedLockReleaseTokenPool_getAvailableTokens:test_getAvailableTokens_UnsiloedChain() (gas: 77606)
+SiloedLockReleaseTokenPool_lockOrBurn:test_lockOrBurn_SiloedFunds() (gas: 253875)
+SiloedLockReleaseTokenPool_lockOrBurn:test_lockOrBurn_UnsiloedFunds() (gas: 253412)
+SiloedLockReleaseTokenPool_provideLiquidity:test_provideLiquidity() (gas: 249761)
+SiloedLockReleaseTokenPool_provideSiloedLiquidity:test_provideSiloedLiquidity() (gas: 181908)
+SiloedLockReleaseTokenPool_releaseOrMint:test_ReleaseOrMint_RevertsWhen_InsufficientLiquidity_SiloedChain() (gas: 108391)
+SiloedLockReleaseTokenPool_releaseOrMint:test_ReleaseOrMint_RevertsWhen_InsufficientLiquidity_UnsiloedChain() (gas: 112636)
+SiloedLockReleaseTokenPool_releaseOrMint:test_ReleaseOrMint_SiloedChain() (gas: 291520)
+SiloedLockReleaseTokenPool_releaseOrMint:test_ReleaseOrMint_UnsiloedChain() (gas: 298136)
+SiloedLockReleaseTokenPool_setRebalancer:test_setRebalancer_UnsiloedChains() (gas: 24932)
+SiloedLockReleaseTokenPool_setRebalancer:test_setSiloRebalancer() (gas: 28896)
+SiloedLockReleaseTokenPool_updateSiloDesignations:test_updateSiloDesignations() (gas: 210904)
+SiloedLockReleaseTokenPool_withdrawLiqudity:test_withdrawLiquidity_SiloedFunds() (gas: 99599)
+SiloedLockReleaseTokenPool_withdrawLiqudity:test_withdrawLiquidity_UnsiloedFunds_LegacyFunctionSelector() (gas: 99570)
+SiloedUSDCTokenPool_burnLockedUSDC:test_burnLockedUSDC() (gas: 391466)
 SiloedUSDCTokenPool_cancelExistingCCTPMigrationProposal:test_cancelExistingCCTPMigrationProposal() (gas: 30708)
 SiloedUSDCTokenPool_cancelExistingCCTPMigrationProposal:test_cancelExistingCCTPMigrationProposal_EmitsEvent() (gas: 30011)
-SiloedUSDCTokenPool_cancelExistingCCTPMigrationProposal:test_cancelExistingCCTPMigrationProposal_ResetsExcludedTokens() (gas: 184689)
-SiloedUSDCTokenPool_excludeTokensFromBurn:test_excludeTokensFromBurn() (gas: 190690)
-SiloedUSDCTokenPool_excludeTokensFromBurn:test_excludeTokensFromBurn_EmitsEvent() (gas: 190494)
-SiloedUSDCTokenPool_lockOrBurn:test_lockOrBurn_MultipleLocks() (gas: 159383)
-SiloedUSDCTokenPool_lockOrBurn:test_lockOrBurn_Success() (gas: 134691)
-SiloedUSDCTokenPool_lockOrBurn:test_lockOrBurn_UpdatesLockedTokensAccounting() (gas: 131781)
-SiloedUSDCTokenPool_lockOrBurn:test_lockOrBurn_UpdatesSiloedTokensAccounting() (gas: 133767)
+SiloedUSDCTokenPool_cancelExistingCCTPMigrationProposal:test_cancelExistingCCTPMigrationProposal_ResetsExcludedTokens() (gas: 167372)
+SiloedUSDCTokenPool_excludeTokensFromBurn:test_excludeTokensFromBurn() (gas: 169021)
+SiloedUSDCTokenPool_excludeTokensFromBurn:test_excludeTokensFromBurn_EmitsEvent() (gas: 168803)
+SiloedUSDCTokenPool_lockOrBurn:test_lockOrBurn_MultipleLocks() (gas: 130418)
+SiloedUSDCTokenPool_lockOrBurn:test_lockOrBurn_Success() (gas: 107677)
+SiloedUSDCTokenPool_lockOrBurn:test_lockOrBurn_UpdatesLockedTokensAccounting() (gas: 104767)
+SiloedUSDCTokenPool_lockOrBurn:test_lockOrBurn_UpdatesSiloedTokensAccounting() (gas: 106747)
 SiloedUSDCTokenPool_proposeCCTPMigration:test_proposeCCTPMigration() (gas: 38080)
 SiloedUSDCTokenPool_proposeCCTPMigration:test_proposeCCTPMigration_AfterCancellation() (gas: 50832)
-SiloedUSDCTokenPool_releaseOrMint:test_releaseOrMint_SubtractsFromExcludedTokens() (gas: 379874)
-SiloedUSDCTokenPool_releaseOrMint:test_releaseOrMint_Success() (gas: 175372)
+SiloedUSDCTokenPool_releaseOrMint:test_releaseOrMint_SubtractsFromExcludedTokens() (gas: 373474)
+SiloedUSDCTokenPool_releaseOrMint:test_releaseOrMint_Success() (gas: 157583)
+SiloedUSDCTokenPool_typeAndVersion:test_typeAndVersion() (gas: 9927)
 TokenAdminRegistry_acceptAdminRole:test_acceptAdminRole() (gas: 45424)
 TokenAdminRegistry_addRegistryModule:test_addRegistryModule() (gas: 67792)
 TokenAdminRegistry_getAllConfiguredTokens:test_getAllConfiguredTokens_outOfBounds() (gas: 11754)
 TokenAdminRegistry_getPool:test_getPool() (gas: 17951)
 TokenAdminRegistry_getPools:test_getPools() (gas: 40701)
-TokenAdminRegistry_isAdministrator:test_isAdministrator() (gas: 107880)
+TokenAdminRegistry_isAdministrator:test_isAdministrator() (gas: 107814)
 TokenAdminRegistry_proposeAdministrator:test_proposeAdministrator_module() (gas: 114714)
 TokenAdminRegistry_proposeAdministrator:test_proposeAdministrator_owner() (gas: 109226)
 TokenAdminRegistry_proposeAdministrator:test_proposeAdministrator_reRegisterWhileUnclaimed() (gas: 117826)
 TokenAdminRegistry_removeRegistryModule:test_removeRegistryModule() (gas: 55228)
 TokenAdminRegistry_setPool:test_setPool() (gas: 36792)
 TokenAdminRegistry_setPool:test_setPool_ZeroAddressRemovesPool() (gas: 31885)
 TokenAdminRegistry_transferAdminRole:test_transferAdminRole() (gas: 50684)
-TokenPoolFactory_createTokenPool:test_createTokenPoolLockRelease_ExistingToken_predict() (gas: 14209167)
-TokenPoolFactory_createTokenPool:test_createTokenPool_BurnFromMintTokenPool() (gas: 7667130)
-TokenPoolFactory_createTokenPool:test_createTokenPool_ExistingRemoteToken_AndPredictPool() (gas: 15447280)
-TokenPoolFactory_createTokenPool:test_createTokenPool_RemoteTokenHasDifferentDecimals() (gas: 15455018)
-TokenPoolFactory_createTokenPool:test_createTokenPool_WithNoExistingRemoteContracts_predict() (gas: 15820648)
-TokenPoolFactory_createTokenPool:test_createTokenPool_WithNoExistingTokenOnRemoteChain() (gas: 7469936)
-TokenPoolFactory_createTokenPool:test_createTokenPool_WithRemoteTokenAndRemotePool() (gas: 7666874)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenAndTokenPool_BurnFromMintTokenPool() (gas: 7667829)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenAndTokenPool_LockRelease_AuthorizesPoolForLockBox() (gas: 6828977)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenAndTokenPool_RemoteTokenHasDifferentDecimals() (gas: 16668770)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenAndTokenPool_WithNoExistingRemoteContracts_Predict() (gas: 17034658)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenAndTokenPool_WithNoExistingTokenOnRemoteChain() (gas: 7469717)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenAndTokenPool_WithRemoteTokenAndRemotePool() (gas: 7667178)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenPoolWithExistingToken_ExistingRemoteToken_AndPredictPool() (gas: 16661186)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenPoolWithExistingToken_LockRelease_ExistingToken_Predict() (gas: 16630008)
+TokenPoolFactory_deployTokenAndTokenPool:test_deployTokenPoolWithExistingToken_LockRelease_UserLockBoxOwnershipPreserved() (gas: 6062387)
 TokenPoolV2_applyFee:test_applyFee_CustomFinality() (gas: 62367)
 TokenPoolV2_applyFee:test_applyFee_DefaultFinality() (gas: 55476)
 TokenPoolV2_applyTokenTransferFeeConfigUpdates:test_applyTokenTransferFeeConfigUpdates() (gas: 46172)
@@ -622,5 +616,5 @@ USDCTokenPool_supportsInterface:test_SupportsInterface() (gas: 10100)
 VersionedVerifierResolver_applyInboundImplementationUpdates:test_applyInboundImplementationUpdates() (gas: 109230)
 VersionedVerifierResolver_applyOutboundImplementationUpdates:test_applyOutboundImplementationUpdates() (gas: 108154)
 cctp_e2e:test_cctp_e2e() (gas: 662407)
-e2e:test_e2e() (gas: 553021)
+e2e:test_e2e() (gas: 548513)
 e2e_lombard:test_e2e_Lombard() (gas: 731267)

ccv/chains/evm/gobindings/generated/latest/lock_release_token_pool/lock_release_token_pool.go

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+
+interface ILockBox {
+  /// @notice Deposits the token into the lockbox.
+  /// @param token The address of the token to deposit.
+  /// @param remoteChainSelector The chain selector of the remote chain.
+  /// @param amount The amount of tokens to deposit.
+  function deposit(
+    address token,
+    uint64 remoteChainSelector,
+    uint256 amount
+  ) external;
+
+  /// @notice Withdraws tokens to a specific recipient.
+  /// @param token The address of the token to withdraw.
+  /// @param remoteChainSelector The chain selector of the remote chain.
+  /// @param amount The amount of tokens to withdraw.
+  /// @param recipient The address of the recipient to receive the withdrawn tokens.
+  function withdraw(
+    address token,
+    uint64 remoteChainSelector,
+    uint256 amount,
+    address recipient
+  ) external;
+
+  /// @notice Returns whether the lockbox supports a token.
+  /// @param token The address of the token.
+  /// @return supported True if the token is supported.
+  function isTokenSupported(
+    address token
+  ) external view returns (bool);
+}