feat(BundleRegistry): add trustedBatchRegister for faster migrations (#149)

* feat(BundleRegistry): add trustedBatchRegister for faster migrations

* test(BundleRegistry): remove unnecessary warps

* fix: add comment to explain deploy script behavior

Author: varunsrin

script/BundleRegistry.s.sol

@@ -15,8 +15,8 @@ contract BundleRegistryScript is Script {
     address constant GOERLI_FORWARDER = address(0x7A95fA73250dc53556d264522150A940d4C50238);
     bytes32 constant ADMIN_ROLE = keccak256("ADMIN_ROLE");
 
-    // TODO: Always update this to the address of the private key used to deploy the contracts
-    address constant DEPLOYER = address(0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266);
+    // TODO: Always update this to the address of the private key used to deploy the contracts on the network
+    address constant DEPLOYER = address(0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266); // anvil deployer
 
     // TODO: Update the vault and pool addresses every time
     address constant VAULT = DEPLOYER;

src/BundleRegistry.sol

@@ -14,12 +14,33 @@ import {NameRegistry} from "./NameRegistry.sol";
  *         reducing complexity for the caller.
  */
 contract BundleRegistry is Ownable {
+    /*//////////////////////////////////////////////////////////////
+                                 ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    /// @dev Revert when the caller does not have the authority to perform the action
     error Unauthorized();
+
+    /// @dev Revert when excess funds could not be sent back to the caller
     error CallFailed();
 
+    /*//////////////////////////////////////////////////////////////
+                                 EVENTS
+    //////////////////////////////////////////////////////////////*/
+
     /// @dev Emit when the trustedCaller is changed by the owner after the contract is deployed
     event ChangeTrustedCaller(address indexed trustedCaller, address indexed owner);
 
+    /*//////////////////////////////////////////////////////////////
+                                 STORAGE
+    //////////////////////////////////////////////////////////////*/
+
+    /// @notice The data required to trustedBatchRegister a single user
+    struct BatchUser {
+        address to;
+        bytes16 username;
+    }
+
     /// @dev The only address that can call trustedRegister and partialTrustedRegister
     address internal trustedCaller;
 
@@ -29,6 +50,13 @@ contract BundleRegistry is Ownable {
     /// @dev The address of the NameRegistry UUPS Proxy contract
     NameRegistry internal immutable nameRegistry;
 
+    /*//////////////////////////////////////////////////////////////
+                                CONSTANTS
+    //////////////////////////////////////////////////////////////*/
+
+    /// @dev The default homeUrl value for the IdRegistry call, to be used until Hubs are launched
+    string internal constant DEFAULT_URL = "https://www.farcaster.xyz/";
+
     /**
      * @notice Configure the addresses of the Registry contracts and the trusted caller which is
      *        allowed to register during the invitation phase.
@@ -72,10 +100,11 @@ contract BundleRegistry is Ownable {
     }
 
     /**
-     * @notice Register an fid and an fname during the Goerli phase, where registration can only be
-     *         performed by the Farcaster Invite Server (trustedCaller)
+     * @notice Register an fid and an fname during the first Mainnet phase, where registration of
+     *         the fid is available to all, but registration of the fname can only be performed by
+     *         the Farcaster Invite Server (trustedCaller)
      */
-    function trustedRegister(
+    function partialTrustedRegister(
         address to,
         address recovery,
         string calldata url,
@@ -86,16 +115,15 @@ contract BundleRegistry is Ownable {
         if (msg.sender != trustedCaller) revert Unauthorized();
 
         // Audit: is it possible to end up in a state where one passes but the other fails?
-        idRegistry.trustedRegister(to, recovery, url);
+        idRegistry.register(to, recovery, url);
         nameRegistry.trustedRegister(username, to, recovery, inviter, idRegistry.idOf(to));
     }
 
     /**
-     * @notice Register an fid and an fname during the first Mainnet phase, where registration of
-     *         the fid is available to all, but registration of the fname can only be performed by
-     *         the Farcaster Invite Server (trustedCaller)
+     * @notice Register an fid and an fname during the Goerli phase, where registration can only be
+     *         performed by the Farcaster Invite Server (trustedCaller)
      */
-    function partialTrustedRegister(
+    function trustedRegister(
         address to,
         address recovery,
         string calldata url,
@@ -106,10 +134,26 @@ contract BundleRegistry is Ownable {
         if (msg.sender != trustedCaller) revert Unauthorized();
 
         // Audit: is it possible to end up in a state where one passes but the other fails?
-        idRegistry.register(to, recovery, url);
+        idRegistry.trustedRegister(to, recovery, url);
         nameRegistry.trustedRegister(username, to, recovery, inviter, idRegistry.idOf(to));
     }
 
+    /**
+     * @notice Register multiple fids and fname during a migration to a new network, where
+     *         registration can only be performed by the Farcaster Invite Server (trustedCaller).
+     *         Recovery address, inviter, invitee and homeUrl are initialized to default values
+     *         during this migration.
+     */
+    function trustedBatchRegister(BatchUser[] calldata users) external {
+        // Do not allow anyone except the Farcaster Invite Server (trustedCaller) to call this
+        if (msg.sender != trustedCaller) revert Unauthorized();
+
+        for (uint256 i = 0; i < users.length; i++) {
+            idRegistry.trustedRegister(users[i].to, address(0), DEFAULT_URL);
+            nameRegistry.trustedRegister(users[i].username, users[i].to, address(0), 0, 0);
+        }
+    }
+
     /**
      * @notice Change the trusted caller that can call trustedRegister and partialTrustedRegister
      */

src/NameRegistry.sol

@@ -55,6 +55,7 @@ contract NameRegistry is
 
     /// @dev Revert if the caller does not have TREASURER_ROLE
     error NotTreasurer();
+
     /// @dev Revert when excess funds could not be sent back to the caller
     error CallFailed();