refactor: Rename contracts appropriately

Author: deluca-mike

README.md

@@ -1,36 +1,34 @@
 # XMTP Contracts
 
 -   [XMTP Contracts](#xmtp-contracts)
-    -   [Messages Contracts](#messages-contracts)
-    -   [XMTP Node Registry](#xmtp-node-registry)
+    -   [Messaging Contracts](#messaging-contracts)
+    -   [Node Registry](#node-registry)
     -   [Usage](#usage)
         -   [Prerequisites](#prerequisites)
         -   [Install](#install)
         -   [Test](#test)
         -   [Run static analysis](#run-static-analysis)
     -   [Scripts](#scripts)
-        -   [Messages contracts](#messages-contracts-1)
+        -   [Messages contracts](#messaging-contracts-1)
         -   [Node registry](#node-registry)
 
 **⚠️ Experimental:** This software is in early development. Expect frequent changes and unresolved issues.
 
 This repository contains all the smart contracts that underpin the XMTP decentralized network.
 
-## Messages Contracts
+## Messaging Contracts
 
-The messages contracts manage the blockchain state for `GroupMessages` and `IdentityUpdates` sent by clients to the network.
+The messaging contracts `GroupMessageBroadcaster` and `IdentityUpdateBroadcaster` respectively manage the broadcasting for `GroupMessages` and `IdentityUpdates` sent by clients to the network.
 
-These contracts ensure transparency and provide a historical record of state changes.
+## Node Registry
 
-## XMTP Node Registry
-
-The `XMTP Node Registry` maintains a blockchain-based record of all node operators participating in the XMTP network. This registry serves as a source of truth for the network's active node participants, contributing to the network's integrity.
+The `NodeRegistry` maintains a record of all node operators participating in the XMTP network. This registry serves as a source of truth for the network's active node participants, contributing to the network's integrity.
 
 The registry is currently implemented following the [ERC721](https://eips.ethereum.org/EIPS/eip-721) standard.
 
 ## Usage
 
-The project is built with the `Foundry` framework, and dependency management is handled using `soldeer`.
+The project is built with the `Foundry` framework, and dependency management is handled using native git submodules.
 
 Additionally, it uses `slither` for static analysis.
 
@@ -74,7 +72,7 @@ slither .
 
 The project includes deployer and upgrade scripts.
 
-### Messages contracts
+### Messaging contracts
 
 -   Configure the environment by creating an `.env` file, with this content:
 
@@ -83,8 +81,8 @@ The project includes deployer and upgrade scripts.
 PRIVATE_KEY=0xYourPrivateKey # Private key of the EOA deploying the contracts
 
 ### XMTP deployment configuration
-XMTP_GROUP_MESSAGES_ADMIN_ADDRESS=0x12345abcdf # the EOA assuming the admin role in the GroupMessages contract.
-XMTP_IDENTITY_UPDATES_ADMIN_ADDRESS=0x12345abcdf # the EOA assuming the admin role in the IdentityUpdates contract.
+XMTP_GROUP_MESSAGE_BROADCASTER_ADMIN_ADDRESS=0x12345abcdf # the EOA assuming the admin role in the GroupMessageBroadcaster contract.
+XMTP_IDENTITY_UPDATE_BROADCASTER_ADMIN_ADDRESS=0x12345abcdf # the EOA assuming the admin role in the IdentityUpdateBroadcaster contract.
 ```
 
 -   Run the desired script with:
@@ -108,5 +106,5 @@ The scripts output the deployment and upgrade in the `output` folder.
 -   Deploy with `forge create`:
 
 ```shell
-forge create --broadcast --legacy --json --rpc-url $RPC_URL --private-key $PRIVATE_KEY "src/Nodes.sol:Nodes"
+forge create --broadcast --legacy --json --rpc-url $RPC_URL --private-key $PRIVATE_KEY "src/NodeRegistry.sol:NodeRegistry"
 ```

script/DeployGroupMessages.s.sol script/DeployGroupMessageBroadcaster.s.sol

@@ -3,21 +3,21 @@ pragma solidity 0.8.28;
 
 import { ERC1967Proxy } from "../lib/oz/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 
-import { GroupMessages } from "../src/GroupMessages.sol";
+import { GroupMessageBroadcaster } from "../src/GroupMessageBroadcaster.sol";
 
 import { Utils } from "./utils/Utils.sol";
 import { Environment } from "./utils/Environment.sol";
 
-contract DeployGroupMessages is Utils, Environment {
-    GroupMessages groupMessagesImpl;
+contract DeployGroupMessageBroadcaster is Utils, Environment {
+    GroupMessageBroadcaster implementation;
     ERC1967Proxy proxy;
 
     address admin;
     address deployer;
 
     function run() external {
-        admin = vm.envAddress("XMTP_GROUP_MESSAGES_ADMIN_ADDRESS");
-        require(admin != address(0), "XMTP_GROUP_MESSAGES_ADMIN_ADDRESS not set");
+        admin = vm.envAddress("XMTP_GROUP_MESSAGE_BROADCASTER_ADMIN_ADDRESS");
+        require(admin != address(0), "XMTP_GROUP_MESSAGE_BROADCASTER_ADMIN_ADDRESS not set");
 
         uint256 privateKey = vm.envUint("PRIVATE_KEY");
         require(privateKey != 0, "PRIVATE_KEY not set");
@@ -26,13 +26,13 @@ contract DeployGroupMessages is Utils, Environment {
         vm.startBroadcast(privateKey);
 
         // Deploy the implementation contract.
-        groupMessagesImpl = new GroupMessages();
-        require(address(groupMessagesImpl) != address(0), "Implementation deployment failed");
+        implementation = new GroupMessageBroadcaster();
+        require(address(implementation) != address(0), "Implementation deployment failed");
 
         // Deploy the proxy contract.
         proxy = new ERC1967Proxy(
-            address(groupMessagesImpl),
-            abi.encodeWithSelector(GroupMessages.initialize.selector, admin)
+            address(implementation),
+            abi.encodeWithSelector(GroupMessageBroadcaster.initialize.selector, admin)
         );
 
         vm.stopBroadcast();
@@ -49,13 +49,13 @@ contract DeployGroupMessages is Utils, Environment {
         addressesOutput = vm.serializeAddress(addresses, "deployer", deployer);
         addressesOutput = vm.serializeAddress(addresses, "proxyAdmin", admin);
         addressesOutput = vm.serializeAddress(addresses, "proxy", address(proxy));
-        addressesOutput = vm.serializeAddress(addresses, "implementation", address(groupMessagesImpl));
+        addressesOutput = vm.serializeAddress(addresses, "implementation", address(implementation));
 
         string memory finalJson;
         finalJson = vm.serializeString(parent_object, addresses, addressesOutput);
         finalJson = vm.serializeUint(parent_object, "deploymentBlock", block.number);
         finalJson = vm.serializeUint(parent_object, "latestUpgradeBlock", block.number);
 
-        writeOutput(finalJson, XMTP_GROUP_MESSAGES_OUTPUT_JSON);
+        writeOutput(finalJson, XMTP_GROUP_MESSAGE_BROADCASTER_OUTPUT_JSON);
     }
 }

script/DeployIdentityUpdates.s.sol script/DeployIdentityUpdateBroadcaster.s.sol

@@ -3,21 +3,21 @@ pragma solidity 0.8.28;
 
 import { ERC1967Proxy } from "../lib/oz/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 
-import { IdentityUpdates } from "../src/IdentityUpdates.sol";
+import { IdentityUpdateBroadcaster } from "../src/IdentityUpdateBroadcaster.sol";
 
 import { Utils } from "./utils/Utils.sol";
 import { Environment } from "./utils/Environment.sol";
 
-contract DeployIdentityUpdates is Utils, Environment {
-    IdentityUpdates idUpdatesImpl;
+contract DeployIdentityUpdateBroadcaster is Utils, Environment {
+    IdentityUpdateBroadcaster implementation;
     ERC1967Proxy proxy;
 
     address admin;
     address deployer;
 
     function run() external {
-        admin = vm.envAddress("XMTP_IDENTITY_UPDATES_ADMIN_ADDRESS");
-        require(admin != address(0), "XMTP_IDENTITY_UPDATES_ADMIN_ADDRESS not set");
+        admin = vm.envAddress("XMTP_IDENTITY_UPDATE_BROADCASTER_ADMIN_ADDRESS");
+        require(admin != address(0), "XMTP_IDENTITY_UPDATE_BROADCASTER_ADMIN_ADDRESS not set");
 
         uint256 privateKey = vm.envUint("PRIVATE_KEY");
         require(privateKey != 0, "PRIVATE_KEY not set");
@@ -26,13 +26,13 @@ contract DeployIdentityUpdates is Utils, Environment {
         vm.startBroadcast(privateKey);
 
         // Deploy the implementation contract.
-        idUpdatesImpl = new IdentityUpdates();
-        require(address(idUpdatesImpl) != address(0), "Implementation deployment failed");
+        implementation = new IdentityUpdateBroadcaster();
+        require(address(implementation) != address(0), "Implementation deployment failed");
 
         // Deploy the proxy contract.
         proxy = new ERC1967Proxy(
-            address(idUpdatesImpl),
-            abi.encodeWithSelector(IdentityUpdates.initialize.selector, admin)
+            address(implementation),
+            abi.encodeWithSelector(IdentityUpdateBroadcaster.initialize.selector, admin)
         );
 
         vm.stopBroadcast();
@@ -49,13 +49,13 @@ contract DeployIdentityUpdates is Utils, Environment {
         addressesOutput = vm.serializeAddress(addresses, "deployer", deployer);
         addressesOutput = vm.serializeAddress(addresses, "proxyAdmin", admin);
         addressesOutput = vm.serializeAddress(addresses, "proxy", address(proxy));
-        addressesOutput = vm.serializeAddress(addresses, "implementation", address(idUpdatesImpl));
+        addressesOutput = vm.serializeAddress(addresses, "implementation", address(implementation));
 
         string memory finalJson;
         finalJson = vm.serializeString(parent_object, addresses, addressesOutput);
         finalJson = vm.serializeUint(parent_object, "deploymentBlock", block.number);
         finalJson = vm.serializeUint(parent_object, "latestUpgradeBlock", block.number);
 
-        writeOutput(finalJson, XMTP_IDENTITY_UPDATES_OUTPUT_JSON);
+        writeOutput(finalJson, XMTP_IDENTITY_UPDATE_BROADCASTER_OUTPUT_JSON);
     }
 }

script/DeployNodeRegistry.s.sol

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.28;
 
-import { Nodes } from "../src/Nodes.sol";
+import { NodeRegistry } from "../src/NodeRegistry.sol";
 
 import { Utils } from "./utils/Utils.sol";
 import { Environment } from "./utils/Environment.sol";
 
-contract DeployXMTPNodeRegistry is Utils, Environment {
-    Nodes nodes;
+contract DeployNodeRegistry is Utils, Environment {
+    NodeRegistry nodes;
 
     address admin;
     address deployer;
@@ -22,8 +22,8 @@ contract DeployXMTPNodeRegistry is Utils, Environment {
         deployer = vm.addr(privateKey);
         vm.startBroadcast(privateKey);
 
-        nodes = new Nodes(admin);
-        require(address(nodes) != address(0), "Nodes deployment failed");
+        nodes = new NodeRegistry(admin);
+        require(address(nodes) != address(0), "NodeRegistry deployment failed");
 
         vm.stopBroadcast();
 

script/DeployRatesManager.s.sol

@@ -3,21 +3,21 @@ pragma solidity 0.8.28;
 
 import { ERC1967Proxy } from "../lib/oz/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 
-import { RatesManager } from "../src/RatesManager.sol";
+import { RateRegistry } from "../src/RateRegistry.sol";
 
 import { Utils } from "./utils/Utils.sol";
 import { Environment } from "./utils/Environment.sol";
 
-contract DeployRatesManager is Utils, Environment {
-    RatesManager ratesManagerImpl;
+contract DeployRateRegistry is Utils, Environment {
+    RateRegistry implementation;
     ERC1967Proxy proxy;
 
     address admin;
     address deployer;
 
     function run() external {
-        admin = vm.envAddress("XMTP_RATES_MANAGER_ADMIN_ADDRESS");
-        require(admin != address(0), "XMTP_RATES_MANAGER_ADMIN_ADDRESS not set");
+        admin = vm.envAddress("XMTP_RATE_REGISTRY_ADMIN_ADDRESS");
+        require(admin != address(0), "XMTP_RATE_REGISTRY_ADMIN_ADDRESS not set");
 
         uint256 privateKey = vm.envUint("PRIVATE_KEY");
         require(privateKey != 0, "PRIVATE_KEY not set");
@@ -26,13 +26,13 @@ contract DeployRatesManager is Utils, Environment {
         vm.startBroadcast(privateKey);
 
         // Deploy the implementation contract.
-        ratesManagerImpl = new RatesManager();
-        require(address(ratesManagerImpl) != address(0), "Implementation deployment failed");
+        implementation = new RateRegistry();
+        require(address(implementation) != address(0), "Implementation deployment failed");
 
         // Deploy the proxy contract.
         proxy = new ERC1967Proxy(
-            address(ratesManagerImpl),
-            abi.encodeWithSelector(RatesManager.initialize.selector, admin)
+            address(implementation),
+            abi.encodeWithSelector(RateRegistry.initialize.selector, admin)
         );
 
         vm.stopBroadcast();
@@ -49,13 +49,13 @@ contract DeployRatesManager is Utils, Environment {
         addressesOutput = vm.serializeAddress(addresses, "deployer", deployer);
         addressesOutput = vm.serializeAddress(addresses, "proxyAdmin", admin);
         addressesOutput = vm.serializeAddress(addresses, "proxy", address(proxy));
-        addressesOutput = vm.serializeAddress(addresses, "implementation", address(ratesManagerImpl));
+        addressesOutput = vm.serializeAddress(addresses, "implementation", address(implementation));
 
         string memory finalJson;
         finalJson = vm.serializeString(parent_object, addresses, addressesOutput);
         finalJson = vm.serializeUint(parent_object, "deploymentBlock", block.number);
         finalJson = vm.serializeUint(parent_object, "latestUpgradeBlock", block.number);
 
-        writeOutput(finalJson, XMTP_RATES_MANAGER_OUTPUT_JSON);
+        writeOutput(finalJson, XMTP_RATE_REGISTRY_OUTPUT_JSON);
     }
 }

script/upgrades/UpgradeGroupMessages.s.sol script/upgrades/UpgradeGroupMessageBroadcaster.s.sol

@@ -4,14 +4,14 @@ pragma solidity 0.8.28;
 import { stdJson } from "../../lib/forge-std/src/StdJson.sol";
 import { ERC1967Proxy } from "../../lib/oz/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 
-import { GroupMessages } from "../../src/GroupMessages.sol";
+import { GroupMessageBroadcaster } from "../../src/GroupMessageBroadcaster.sol";
 
 import { Utils } from "../utils/Utils.sol";
 import { Environment } from "../utils/Environment.sol";
 
-contract UpgradeGroupMessages is Utils, Environment {
-    GroupMessages newImplementation;
-    GroupMessages proxy;
+contract UpgradeGroupMessageBroadcaster is Utils, Environment {
+    GroupMessageBroadcaster newImplementation;
+    GroupMessageBroadcaster proxy;
 
     address upgrader;
 
@@ -24,7 +24,7 @@ contract UpgradeGroupMessages is Utils, Environment {
         _initializeProxy();
 
         // Deploy the new implementation contract.
-        newImplementation = new GroupMessages();
+        newImplementation = new GroupMessageBroadcaster();
         require(address(newImplementation) != address(0), "Implementation deployment failed");
 
         // Upgrade the proxy pointer to the new implementation.
@@ -36,18 +36,22 @@ contract UpgradeGroupMessages is Utils, Environment {
     }
 
     function _initializeProxy() internal {
-        string memory fileContent = readOutput(XMTP_GROUP_MESSAGES_OUTPUT_JSON);
-        proxy = GroupMessages(stdJson.readAddress(fileContent, ".addresses.proxy"));
+        string memory fileContent = readOutput(XMTP_GROUP_MESSAGE_BROADCASTER_OUTPUT_JSON);
+        proxy = GroupMessageBroadcaster(stdJson.readAddress(fileContent, ".addresses.proxy"));
         require(address(proxy) != address(0), "proxy address not set");
         require(proxy.hasRole(proxy.DEFAULT_ADMIN_ROLE(), upgrader), "Upgrader must have admin role");
     }
 
     function _serializeUpgradeData() internal {
         vm.writeJson(
             vm.toString(address(newImplementation)),
-            getOutputPath(XMTP_GROUP_MESSAGES_OUTPUT_JSON),
+            getOutputPath(XMTP_GROUP_MESSAGE_BROADCASTER_OUTPUT_JSON),
             ".addresses.implementation"
         );
-        vm.writeJson(vm.toString(block.number), getOutputPath(XMTP_GROUP_MESSAGES_OUTPUT_JSON), ".latestUpgradeBlock");
+        vm.writeJson(
+            vm.toString(block.number),
+            getOutputPath(XMTP_GROUP_MESSAGE_BROADCASTER_OUTPUT_JSON),
+            ".latestUpgradeBlock"
+        );
     }
 }

script/upgrades/UpgradeIdentityUpdates.s.sol script/upgrades/UpgradeIdentityUpdateBroadcaster.s.sol

@@ -4,14 +4,14 @@ pragma solidity 0.8.28;
 import { stdJson } from "../../lib/forge-std/src/StdJson.sol";
 import { ERC1967Proxy } from "../../lib/oz/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 
-import { IdentityUpdates } from "../../src/IdentityUpdates.sol";
+import { IdentityUpdateBroadcaster } from "../../src/IdentityUpdateBroadcaster.sol";
 
 import { Utils } from "../utils/Utils.sol";
 import { Environment } from "../utils/Environment.sol";
 
-contract UpgradeIdentityUpdates is Utils, Environment {
-    IdentityUpdates newImplementation;
-    IdentityUpdates proxy;
+contract UpgradeIdentityUpdateBroadcaster is Utils, Environment {
+    IdentityUpdateBroadcaster newImplementation;
+    IdentityUpdateBroadcaster proxy;
 
     address upgrader;
 
@@ -24,7 +24,7 @@ contract UpgradeIdentityUpdates is Utils, Environment {
         _initializeProxy();
 
         // Deploy the new implementation contract.
-        newImplementation = new IdentityUpdates();
+        newImplementation = new IdentityUpdateBroadcaster();
         require(address(newImplementation) != address(0), "Implementation deployment failed");
 
         // Upgrade the proxy pointer to the new implementation.
@@ -36,21 +36,21 @@ contract UpgradeIdentityUpdates is Utils, Environment {
     }
 
     function _initializeProxy() internal {
-        string memory fileContent = readOutput(XMTP_IDENTITY_UPDATES_OUTPUT_JSON);
-        proxy = IdentityUpdates(stdJson.readAddress(fileContent, ".addresses.proxy"));
+        string memory fileContent = readOutput(XMTP_IDENTITY_UPDATE_BROADCASTER_OUTPUT_JSON);
+        proxy = IdentityUpdateBroadcaster(stdJson.readAddress(fileContent, ".addresses.proxy"));
         require(address(proxy) != address(0), "proxy address not set");
         require(proxy.hasRole(proxy.DEFAULT_ADMIN_ROLE(), upgrader), "Upgrader must have admin role");
     }
 
     function _serializeUpgradeData() internal {
         vm.writeJson(
             vm.toString(address(newImplementation)),
-            getOutputPath(XMTP_IDENTITY_UPDATES_OUTPUT_JSON),
+            getOutputPath(XMTP_IDENTITY_UPDATE_BROADCASTER_OUTPUT_JSON),
             ".addresses.implementation"
         );
         vm.writeJson(
             vm.toString(block.number),
-            getOutputPath(XMTP_IDENTITY_UPDATES_OUTPUT_JSON),
+            getOutputPath(XMTP_IDENTITY_UPDATE_BROADCASTER_OUTPUT_JSON),
             ".latestUpgradeBlock"
         );
     }