feat: Add access control to measure + docs

README.md

@@ -52,10 +52,25 @@ This deployment method requires manual insertion of a private key and is not rec
 NOTE: Deployment using forge CLI often errors out on Filecoin networks even though the transaction goes through (Foundry
 is configured for EVM's block time, not FVM's). Use a block explorer to find the address of the contract.
 
+Make sure the following env vars are defined as follows:
 ```bash
-forge create --rpc-url https://api.calibration.node.glif.io/rpc/v1 --private-key <your_private_key> src/Measure.sol:Measure
+export RPC_URL="..."
+export ADMIN_ADDRESS="..."
+export MNEMONIC_PATH="{path to mnemonic secret file}"
 ```
 
+To deploy using a private key, run:
+
+```bash
+forge create --rpc-url $RPC_URL --private-key <your_private_key> src/Measure.sol:Measure --constructor-args $ADMIN_ADDRESS
+```
+
+To deploy using a local mnemonic secret, run:
+```bash
+forge create --rpc-url $RPC_URL --mnemonic $MNEMONIC_PATH src/Measure.sol:Measure --constructor-args $ADMIN_ADDRESS
+```
+
+
 ### Deployment Rust Script
 
 The deployment relies on contract bindings generated in the `/contract-bindings` directory. If you make changes to the contracts, run:

contract-utils/src/lib.rs

@@ -22,12 +22,13 @@ pub mod measure {
         client: Arc<S>,
         retries: usize,
         provider: Provider<Http>,
+        address: H160,
     ) -> Result<H160, Box<dyn std::error::Error>> {
         let gas_price = provider.get_gas_price().await?;
         println!("current gas price: {:#?}", gas_price);
         println!("using {} retries", retries);
 
-        let mut contract = Measure::deploy(client.clone(), ())?;
+        let mut contract = Measure::deploy(client.clone(), address)?;
         let tx = contract.deployer.tx.clone();
         set_tx_gas(
             &mut contract.deployer.tx,

contract-utils/src/main.rs

@@ -21,7 +21,7 @@ async fn main() {
                 .await
                 .unwrap();
             let client = Arc::new(ledger_client);
-            deploy_factory_contract(client.clone(), RETRIES, provider)
+            deploy_factory_contract(client.clone(), RETRIES, provider, client.address())
                 .await
                 .unwrap();
         }
@@ -32,7 +32,7 @@ async fn main() {
                 .await
                 .unwrap();
             let client = Arc::new(local_client);
-            deploy_factory_contract(client.clone(), RETRIES, provider)
+            deploy_factory_contract(client.clone(), RETRIES, provider, client.address())
                 .await
                 .unwrap();
         }

contract-utils/tests/integration_tests.rs

@@ -30,7 +30,7 @@ async fn deploy() -> Result<(), Box<dyn std::error::Error>> {
         .await
         .unwrap();
     let client = Arc::new(local_client);
-    let address = deploy_factory_contract(client.clone(), 15, provider)
+    let address = deploy_factory_contract(client.clone(), 15, provider, client.address())
         .await
         .unwrap();
 

foundry.toml

@@ -3,9 +3,9 @@ src = 'src'
 out = 'out'
 libs = ['lib']
 fs_permissions = [{ access = "read", path = "./"}]
-solc-version = "0.8.17"
+solc-version = "0.8.21"
 optimizer = true
 optimizer-runs = 10_000_000
 
 [rpc_endpoints]
-hyperspace = "${HYPERSPACE_RPC_URL}"
+calibration = "https://api.calibration.node.glif.io/rpc/v1"

src/Measure.sol

@@ -1,11 +1,31 @@
 // SPDX-License-Identifier: (MIT or Apache-2.0)
 
-pragma solidity ^0.8.17;
+import "../lib/openzeppelin-contracts/contracts/access/AccessControl.sol";
+pragma solidity ^0.8.19;
 
-contract Measure {
-  event Measurement(string data);
+/**
+ * @title Measure Contract
+ * @dev This contract submits commitments of arbitrary data on chain.
+ */
+contract Measure is AccessControl {
+    event Measurement(string dataCommitment);
+    bytes32 public constant COMMITMENT_ROLE = keccak256("COMMITMENT_ROLE");
 
-  function measure(string memory data) public {
-    emit Measurement(data);
-  }
+    /**
+     * @dev Creates a measure contract with an admin
+     * @param admin The address of the factory admin.
+     **/
+    constructor(address admin) {
+        _grantRole(DEFAULT_ADMIN_ROLE, admin);
+        _grantRole(COMMITMENT_ROLE, admin);
+    }
+
+    /**
+     * @dev Emmits a Measurement event with a commitment to some arbitrary data.
+     * @param dataCommitment An arbitrary commitment to some data (eg. Merkle Root, KZG Commitment, etc.)
+     **/
+    function measure(string memory dataCommitment) public {
+        require(hasRole(COMMITMENT_ROLE, msg.sender));
+        emit Measurement(dataCommitment);
+    }
 }