FUN-1527 Add updateFromPrevious method to Functions ToS (#13795)

* Add updateFromPrevious method to Functions ToS contract * Update test * Update gethwrappers * Added test * prettier * Address feedback * Added tag to changeset * Addressed feedback on tests * Updated gas snapshot * Add missing deployment arg to ToS in core tests * New approach which enables batching * Add require * prettier, gas snapshot & wrappers * update snapshot * addressed feedback * prettier --------- Co-authored-by: app-token-issuer-infra-releng[bot] <120227048+app-token-issuer-infra-releng[bot]@users.noreply.github.com>
smartcontractkit · Jul 28, 2024 · 683a12e · 683a12e
1 parent d6ebada
commit 683a12e
Show file tree

Hide file tree

Showing 10 changed files with 224 additions and 126 deletions.
diff --git a/.changeset/kind-garlics-smash.md b/.changeset/kind-garlics-smash.md
@@ -0,0 +1,5 @@
+---
+"chainlink": patch
+---
+
+Updated Functions ToS contract wrappers #internal
diff --git a/contracts/.changeset/empty-ants-suffer.md b/contracts/.changeset/empty-ants-suffer.md
@@ -0,0 +1,5 @@
+---
+'@chainlink/contracts': patch
+---
+
+Added updateFromPrevious method to Functions ToS contract
diff --git a/contracts/gas-snapshots/functions.gas-snapshot b/contracts/gas-snapshots/functions.gas-snapshot
diff --git a/contracts/src/v0.8/functions/dev/v1_X/accessControl/TermsOfServiceAllowList.sol b/contracts/src/v0.8/functions/dev/v1_X/accessControl/TermsOfServiceAllowList.sol
@@ -16,7 +16,8 @@ contract TermsOfServiceAllowList is ITermsOfServiceAllowList, IAccessController,
   using EnumerableSet for EnumerableSet.AddressSet;
 
   /// @inheritdoc ITypeAndVersion
-  string public constant override typeAndVersion = "Functions Terms of Service Allow List v1.1.0";
+  string public constant override typeAndVersion = "Functions Terms of Service Allow List v1.1.1";
+  address private s_previousToSContract;
 
   EnumerableSet.AddressSet private s_allowedSenders;
   EnumerableSet.AddressSet private s_blockedSenders;
@@ -29,6 +30,7 @@ contract TermsOfServiceAllowList is ITermsOfServiceAllowList, IAccessController,
   error InvalidUsage();
   error RecipientIsBlocked();
   error InvalidCalldata();
+  error NoPreviousToSContract();
 
   TermsOfServiceAllowListConfig private s_config;
 
@@ -41,7 +43,8 @@ contract TermsOfServiceAllowList is ITermsOfServiceAllowList, IAccessController,
   constructor(
     TermsOfServiceAllowListConfig memory config,
     address[] memory initialAllowedSenders,
-    address[] memory initialBlockedSenders
+    address[] memory initialBlockedSenders,
+    address previousToSContract
   ) ConfirmedOwner(msg.sender) {
     updateConfig(config);
 
@@ -56,6 +59,8 @@ contract TermsOfServiceAllowList is ITermsOfServiceAllowList, IAccessController,
       }
       s_blockedSenders.add(initialBlockedSenders[j]);
     }
+
+    s_previousToSContract = previousToSContract;
   }
 
   // ================================================================
@@ -197,4 +202,19 @@ contract TermsOfServiceAllowList is ITermsOfServiceAllowList, IAccessController,
 
     return blockedSenders;
   }
+
+  /// @inheritdoc ITermsOfServiceAllowList
+  function migratePreviouslyAllowedSenders(address[] memory previousSendersToAdd) external override onlyOwner {
+    if (s_previousToSContract == address(0)) {
+      revert NoPreviousToSContract();
+    }
+    IAccessController previousToSContract = IAccessController(s_previousToSContract);
+    for (uint256 i = 0; i < previousSendersToAdd.length; ++i) {
+      if (previousToSContract.hasAccess(previousSendersToAdd[i], "")) {
+        if (!s_blockedSenders.contains(previousSendersToAdd[i])) {
+          s_allowedSenders.add(previousSendersToAdd[i]);
+        }
+      }
+    }
+  }
 }
diff --git a/contracts/src/v0.8/functions/dev/v1_X/accessControl/interfaces/ITermsOfServiceAllowList.sol b/contracts/src/v0.8/functions/dev/v1_X/accessControl/interfaces/ITermsOfServiceAllowList.sol
@@ -69,6 +69,10 @@ interface ITermsOfServiceAllowList {
     uint64 blockedSenderIdxStart,
     uint64 blockedSenderIdxEnd
   ) external view returns (address[] memory blockedSenders);
+
+  /// @notice Enables migrating any previously allowed senders to the new contract
+  /// @param previousSendersToAdd - List of addresses to migrate. These address must be allowed on the previous ToS contract and not blocked
+  function migratePreviouslyAllowedSenders(address[] memory previousSendersToAdd) external;
 }
 
 // ================================================================

diff --git a/contracts/src/v0.8/functions/tests/v1_X/FunctionsTermsOfServiceAllowList.t.sol b/contracts/src/v0.8/functions/tests/v1_X/FunctionsTermsOfServiceAllowList.t.sol
@@ -11,7 +11,7 @@ import "forge-std/Vm.sol";
 /// @notice #constructor
 contract FunctionsTermsOfServiceAllowList_Constructor is FunctionsRoutesSetup {
   function test_Constructor_Success() public {
-    assertEq(s_termsOfServiceAllowList.typeAndVersion(), "Functions Terms of Service Allow List v1.1.0");
+    assertEq(s_termsOfServiceAllowList.typeAndVersion(), "Functions Terms of Service Allow List v1.1.1");
     assertEq(s_termsOfServiceAllowList.owner(), OWNER_ADDRESS);
   }
 }
@@ -511,3 +511,47 @@ contract FunctionsTermsOfServiceAllowList_GetBlockedSendersInRange is FunctionsR
     s_termsOfServiceAllowList.getBlockedSendersInRange(1, BlockedSendersCount + 1);
   }
 }
+
+/// @notice #migratePreviouslyAllowedSenders
+contract FunctionsTermsOfServiceAllowList_MigratePreviouslyAllowedSenders is FunctionsRoutesSetup {
+  function setUp() public virtual override {
+    FunctionsRoutesSetup.setUp();
+  }
+
+  function test_MigratePreviouslyAllowedSenders_RevertIfNotOwner() public {
+    // Send as stranger
+    vm.stopPrank();
+    vm.startPrank(STRANGER_ADDRESS);
+
+    vm.expectRevert("Only callable by owner");
+    address[] memory empty = new address[](0);
+    s_termsOfServiceAllowList.migratePreviouslyAllowedSenders(empty);
+  }
+
+  function test_MigratePreviouslyAllowedSenders_Success() public {
+    address previouslyAllowedSender1 = 0x1000000000000000000000000000000000000000;
+    address previouslyAllowedSender2 = 0x2000000000000000000000000000000000000000;
+    address currentlyBlockedSender = 0xB000000000000000000000000000000000000000;
+
+    address[] memory mockPreviousAllowlist = new address[](3);
+    mockPreviousAllowlist[0] = previouslyAllowedSender1;
+    mockPreviousAllowlist[1] = currentlyBlockedSender;
+    mockPreviousAllowlist[2] = previouslyAllowedSender2;
+
+    s_termsOfServiceAllowList.blockSender(currentlyBlockedSender);
+
+    vm.mockCall(
+      MOCK_PREVIOUS_TOS_ADDRESS,
+      abi.encodeWithSelector(TermsOfServiceAllowList.hasAccess.selector),
+      abi.encode(true)
+    );
+    s_termsOfServiceAllowList.migratePreviouslyAllowedSenders(mockPreviousAllowlist);
+
+    address[] memory currentlyAllowedSenders = s_termsOfServiceAllowList.getAllAllowedSenders();
+
+    address[] memory expectedAllowedSenders = new address[](2);
+    expectedAllowedSenders[0] = previouslyAllowedSender1;
+    expectedAllowedSenders[1] = previouslyAllowedSender2;
+    assertEq(currentlyAllowedSenders, expectedAllowedSenders);
+  }
+}
diff --git a/contracts/src/v0.8/functions/tests/v1_X/Setup.t.sol b/contracts/src/v0.8/functions/tests/v1_X/Setup.t.sol
@@ -37,6 +37,7 @@ contract FunctionsRouterSetup is BaseTest {
   int256 internal LINK_USD_RATE = 1_500_000_000;
   uint8 internal LINK_USD_DECIMALS = 8;
 
+  address public MOCK_PREVIOUS_TOS_ADDRESS = 0x746f730000000000000000000000000000000000;
   uint256 internal TOS_SIGNER_PRIVATE_KEY = 0x3;
   address internal TOS_SIGNER = vm.addr(TOS_SIGNER_PRIVATE_KEY);
 
@@ -57,7 +58,8 @@ contract FunctionsRouterSetup is BaseTest {
     s_termsOfServiceAllowList = new TermsOfServiceAllowList(
       getTermsOfServiceConfig(),
       initialAllowedSenders,
-      initialBlockedSenders
+      initialBlockedSenders,
+      MOCK_PREVIOUS_TOS_ADDRESS
     );
   }
 

diff --git a/core/gethwrappers/functions/generated/functions_allow_list/functions_allow_list.go b/core/gethwrappers/functions/generated/functions_allow_list/functions_allow_list.go
diff --git a/core/gethwrappers/functions/generation/generated-wrapper-dependency-versions-do-not-edit.txt b/core/gethwrappers/functions/generation/generated-wrapper-dependency-versions-do-not-edit.txt
@@ -1,6 +1,6 @@
 GETH_VERSION: 1.13.8
 functions: ../../../contracts/solc/v0.8.19/functions/v1_X/FunctionsRequest.abi ../../../contracts/solc/v0.8.19/functions/v1_X/FunctionsRequest.bin 3c972870b0afeb6d73a29ebb182f24956a2cebb127b21c4f867d1ecf19a762db
-functions_allow_list: ../../../contracts/solc/v0.8.19/functions/v1_X/TermsOfServiceAllowList.abi ../../../contracts/solc/v0.8.19/functions/v1_X/TermsOfServiceAllowList.bin 268de8b3c061b53a1a2a1ccc0149eff68545959e29cd41b5f2e9f5dab19075cf
+functions_allow_list: ../../../contracts/solc/v0.8.19/functions/v1_X/TermsOfServiceAllowList.abi ../../../contracts/solc/v0.8.19/functions/v1_X/TermsOfServiceAllowList.bin 6581a3e82c8a6b5532addb8278ff520d18f38c2be4ac07ed0ad9ccc2e6825e48
 functions_billing_registry_events_mock: ../../../contracts/solc/v0.8.6/functions/v0_0_0/FunctionsBillingRegistryEventsMock.abi ../../../contracts/solc/v0.8.6/functions/v0_0_0/FunctionsBillingRegistryEventsMock.bin 50deeb883bd9c3729702be335c0388f9d8553bab4be5e26ecacac496a89e2b77
 functions_client: ../../../contracts/solc/v0.8.19/functions/v1_X/FunctionsClient.abi ../../../contracts/solc/v0.8.19/functions/v1_X/FunctionsClient.bin 2368f537a04489c720a46733f8596c4fc88a31062ecfa966d05f25dd98608aca
 functions_client_example: ../../../contracts/solc/v0.8.19/functions/v1_X/FunctionsClientExample.abi ../../../contracts/solc/v0.8.19/functions/v1_X/FunctionsClientExample.bin abf32e69f268f40e8530eb8d8e96bf310b798a4c0049a58022d9d2fb527b601b

diff --git a/core/services/ocr2/plugins/functions/integration_tests/v1/internal/testutils.go b/core/services/ocr2/plugins/functions/integration_tests/v1/internal/testutils.go
@@ -217,7 +217,9 @@ func StartNewChainWithContracts(t *testing.T, nClients int) (*bind.TransactOpts,
 	}
 	var initialAllowedSenders []common.Address
 	var initialBlockedSenders []common.Address
-	allowListAddress, _, allowListContract, err := functions_allow_list.DeployTermsOfServiceAllowList(owner, b, allowListConfig, initialAllowedSenders, initialBlockedSenders)
+	// The allowlist requires a pointer to the previous allowlist. If none exists, use the null address.
+	var nullPreviousAllowlist common.Address
+	allowListAddress, _, allowListContract, err := functions_allow_list.DeployTermsOfServiceAllowList(owner, b, allowListConfig, initialAllowedSenders, initialBlockedSenders, nullPreviousAllowlist)
 	require.NoError(t, err)
 
 	// Deploy Coordinator contract (matches updateConfig() in FunctionsBilling.sol)