feat(cli,world): add user defined salt in WorldFactory.deployWorld()

packages/world/src/IWorldFactory.sol

@@ -13,17 +13,10 @@ interface IWorldFactory {
    */
   event WorldDeployed(address indexed newContract);
 
-  /**
-   * @notice Returns the total count of deployed World contracts per account.
-   * @param account The account.
-   * @return The total number of World contracts deployed by this factory per account.
-   */
-  function worldCounts(address account) external view returns (uint256);
-
   /**
    * @notice Deploys a new World contract.
    * @dev The deployment of the World contract will result in the `WorldDeployed` event being emitted.
    * @return worldAddress The address of the newly deployed World contract.
    */
-  function deployWorld() external returns (address worldAddress);
+  function deployWorld(bytes memory _salt) external returns (address worldAddress);
 }

packages/world/src/WorldFactory.sol

@@ -17,9 +17,6 @@ contract WorldFactory is IWorldFactory {
   /// @notice Address of the init module to be set in the World instances.
   IModule public immutable initModule;
 
-  /// @notice Counters to keep track of the number of World instances deployed per address.
-  mapping(address creator => uint256 worldCount) public worldCounts;
-
   /// @param _initModule The address of the init module.
   constructor(IModule _initModule) {
     initModule = _initModule;
@@ -28,12 +25,14 @@ contract WorldFactory is IWorldFactory {
   /**
    * @notice Deploys a new World instance, installs the InitModule and transfers ownership to the caller.
    * @dev Uses the Create2 for deterministic deployment.
+   * @param _salt User defined salt for deterministic world addresses across chains
    * @return worldAddress The address of the newly deployed World contract.
    */
-  function deployWorld() public returns (address worldAddress) {
+  function deployWorld(bytes memory _salt) public returns (address worldAddress) {
     // Deploy a new World and increase the WorldCount
     bytes memory bytecode = type(World).creationCode;
-    uint256 salt = uint256(keccak256(abi.encode(msg.sender, worldCounts[msg.sender]++)));
+    uint256 salt = uint256(keccak256(abi.encode(msg.sender, _salt)));
+
     worldAddress = Create2.deploy(bytecode, salt);
     IBaseWorld world = IBaseWorld(worldAddress);
 

packages/world/test/Factories.t.sol

@@ -48,24 +48,24 @@ contract FactoriesTest is Test, GasReporter {
     startGasReport("deploy contract via Create2");
     create2Factory.deployContract(combinedBytes, uint256(0));
     endGasReport();
-
-    // Confirm worldFactory was deployed correctly
-    IWorldFactory worldFactory = IWorldFactory(calculatedAddress);
-    assertEq(uint256(worldFactory.worldCounts(address(0))), uint256(0));
   }
 
-  function testWorldFactory(address account) public {
+  function testWorldFactory(address account, uint256 salt1, uint256 salt2) public {
+    vm.assume(salt1 != salt2);
     vm.startPrank(account);
 
     // Deploy WorldFactory with current InitModule
     InitModule initModule = createInitModule();
     address worldFactoryAddress = address(new WorldFactory(initModule));
     IWorldFactory worldFactory = IWorldFactory(worldFactoryAddress);
 
-    // Address we expect for World
+    // User defined bytes for create2
+    bytes memory _salt1 = abi.encode(salt1);
+
+    // Address we expect for first World
     address calculatedAddress = calculateAddress(
       worldFactoryAddress,
-      keccak256(abi.encode(account, 0)),
+      keccak256(abi.encode(account, _salt1)),
       type(World).creationCode
     );
 
@@ -77,27 +77,28 @@ contract FactoriesTest is Test, GasReporter {
     vm.expectEmit(true, false, false, false);
     emit WorldDeployed(calculatedAddress);
     startGasReport("deploy world via WorldFactory");
-    worldFactory.deployWorld();
+    worldFactory.deployWorld(_salt1);
     endGasReport();
 
     // Set the store address manually
     StoreSwitch.setStoreAddress(calculatedAddress);
 
-    // Confirm accountCount (which is salt) has incremented
-    assertEq(uint256(worldFactory.worldCounts(account)), uint256(1));
-
     // Confirm correct Core is installed
     assertTrue(InstalledModules.get(address(initModule), keccak256(new bytes(0))));
 
     // Confirm the msg.sender is owner of the root namespace of the new world
     assertEq(NamespaceOwner.get(ROOT_NAMESPACE_ID), account);
 
-    // Deploy another world
+    // Deploy a second world
 
-    // Address we expect for World
+    // User defined bytes for create2
+    // unchecked for the fuzzing test
+    bytes memory _salt2 = abi.encode(salt2);
+
+    // Address we expect for second World
     calculatedAddress = calculateAddress(
       worldFactoryAddress,
-      keccak256(abi.encode(account, 1)),
+      keccak256(abi.encode(account, _salt2)),
       type(World).creationCode
     );
 
@@ -108,10 +109,7 @@ contract FactoriesTest is Test, GasReporter {
     // Check for WorldDeployed event from Factory
     vm.expectEmit(true, false, false, false);
     emit WorldDeployed(calculatedAddress);
-    worldFactory.deployWorld();
-
-    // Confirm accountCount (which is salt) has incremented
-    assertEq(uint256(worldFactory.worldCounts(account)), uint256(2));
+    worldFactory.deployWorld(_salt2);
 
     // Set the store address manually
     StoreSwitch.setStoreAddress(calculatedAddress);
@@ -121,9 +119,13 @@ contract FactoriesTest is Test, GasReporter {
 
     // Confirm the msg.sender is owner of the root namespace of the new world
     assertEq(NamespaceOwner.get(ROOT_NAMESPACE_ID), account);
+
+    // Expect revert when deploying world with same bytes salt as already deployed world
+    vm.expectRevert();
+    worldFactory.deployWorld(_salt1);
   }
 
   function testWorldFactoryGas() public {
-    testWorldFactory(address(this));
+    testWorldFactory(address(this), 0, 1);
   }
 }