Merge pull request #51 from flashbots/add-single-command-deploy-all

Add additional deployment and view scripts, and deploy flashtestation…

Author: Melvillian

README.md

@@ -85,11 +85,25 @@ cp env.sample .env
 Then, provide correct values for the following env vars, which all the forge scripts below will use:
 
 - ETHERSCAN_API_KEY
-- UNICHAIN_SEPOLIA_RPC_URL
+- RPC_URL
 
-### Unichain Sepolia
+### DeployAll
 
-#### FlashtestationsRegistry
+Deploys both the FlashtestationsRegistry and the BlockBuilderPolicy. This is the simplest and best way to deploy the necessary contracts in the flashtestations repository
+
+```bash
+# add the RPC_URL and ETHERSCAN_API_KEY's to your environment. Make sure RPC_URL is set to the intended network (e.g. unichain sepolia)
+source .env
+
+# Deploy script/DeployAll.s.sol:DeployAllScript expects run(address owner, address automataAttestationContract)
+# See https://github.com/automata-network/automata-dcap-attestation/tree/4c579aff71562afe254de4009f5235873fdcc953?tab=readme-ov-file#deployment
+# for the appropriate `AutomataDcapAttestationFee.sol` contract that matches your $RPC_URL's network
+forge script script/DeployAll.s.sol:DeployAllScript \
+  --sig "run(address,address)" <FLASHTESTATIONS CONTRACT OWNER ADDRESS> <AutomataDcapAttestationFee CONTRACT ADDRESS> \
+  --rpc-url $RPC_URL --interactives 1 -vvvv --broadcast --verify
+```
+
+### FlashtestationsRegistry
 
 This is the primary contract of this repository. It allows TDX v4 devices to register themselves onchain with an Ethereum address/public key, such that later transactions from that address can be trusted to originate from a TEE.
 
@@ -106,10 +120,10 @@ FLASHTESTATION_REGISTRY_OWNER=0x0000000000000000000000000000000000000042
 Then, to deploy, run:
 
 ```
-forge script --chain 1301 script/FlashtestationRegistry.s.sol:FlashtestationRegistryScript --rpc-url $UNICHAIN_SEPOLIA_RPC_URL --broadcast --verify --interactives 1 -vvvv
+forge script --chain 1301 script/FlashtestationRegistry.s.sol:FlashtestationRegistryScript --rpc-url $RPC_URL --broadcast --verify --interactives 1 -vvvv
 ```
 
-#### BlockBuilderPolicy
+### BlockBuilderPolicy
 
 A simple contract that allows your organization (e.g. Flashbots) to permission TEE's and their registered Ethereum addresses + workloadIds
 
@@ -126,12 +140,12 @@ OWNER_BLOCK_BUILDER_POLICY=0x0000000000000000000000000000000000000042
 Then, to deploy, run:
 
 ```
-forge script --chain 1301 script/BlockBuilderPolicy.s.sol:BlockBuilderPolicyScript --rpc-url $UNICHAIN_SEPOLIA_RPC_URL --broadcast --verify --interactives 1 -vvvv
+forge script --chain 1301 script/BlockBuilderPolicy.s.sol:BlockBuilderPolicyScript --rpc-url $RPC_URL --broadcast --verify --interactives 1 -vvvv
 ```
 
-#### MockQuotes
+### MockQuotes
 
-**FetchRemoteQuote**
+#### FetchRemoteQuote
 
 Create a raw attestation quote and store it in `script/raw_tdx_quotes/`. This is needed for the `RegisterTEEScript` script for its $PATH_TO_ATTESTATION_QUOTE argument
 
@@ -149,12 +163,12 @@ TEE_ADDRESS=0x0000000000000000000000000000000000000042
 Then, to fetch the quote, run:
 
 ```
-forge script script/MockQuotes.s.sol:FetchRemoteQuote --rpc-url $UNICHAIN_SEPOLIA_RPC_URL -vvvv
+forge script script/MockQuotes.s.sol:FetchRemoteQuote --rpc-url $RPC_URL -vvvv
 ```
 
-#### Interactions
+### Interactions
 
-**RegisterTEEScript**
+#### RegisterTEEScript
 
 This registers a TEE-controlled address using a quote generated by a v4 TDX device
 
@@ -175,15 +189,15 @@ Then, to execute, run:
 # Note: we pass '--skip-simulation' because of a bug where the forge EVM does not contain the precompiles necessary
 # to execute the FlashtestationRegistry.registerTEEService, and so we need to skip simulating it locally
 #
-# Note: we need to use a RPC provider like Alchemy for the $UNICHAIN_SEPOLIA_RPC_URL argument, and we can't
+# Note: we need to use a RPC provider like Alchemy for the $RPC_URL argument, and we can't
 # use https://sepolia.unichain.org, because this script makes so many gas-heavy calls that it will last
 # longer than 128 blocks worth of time, at which point the full nodes at sepolia.unichain.org will start
 # to return errors. We must use RPC provider like Alchemy because they can service calls to archive nodes,
 # which get around this problem.
-forge script --chain 1301 script/Interactions.s.sol:RegisterTEEScript --rpc-url $UNICHAIN_SEPOLIA_RPC_URL --broadcast --verify --interactives 1 -vvvv --skip-simulation
+forge script --chain 1301 script/Interactions.s.sol:RegisterTEEScript --rpc-url $RPC_URL --broadcast --verify --interactives 1 -vvvv --skip-simulation
 ```
 
-**ComputeWorkloadIdScript**
+#### ComputeWorkloadIdScript
 
 Prints out the WorkloadId for a TEE registered by TEE-controlled address (like in the `RegisterTEEScript` above).
 
@@ -207,10 +221,10 @@ ADDRESS_BLOCK_BUILDER_POLICY=0x0000000000000000000000000000000000000042
 Then, to execute, run:
 
 ```
-forge script --chain 1301 script/Interactions.s.sol:ComputeWorkloadIdScript --rpc-url $UNICHAIN_SEPOLIA_RPC_URL
+forge script --chain 1301 script/Interactions.s.sol:ComputeWorkloadIdScript --rpc-url $RPC_URL
 ```
 
-**AddWorkloadToPolicyScript**
+#### AddWorkloadToPolicyScript
 
 Add a workloadId computed from the `ComputeWorkloadIdScript` script above
 
@@ -243,5 +257,5 @@ RECORD_LOCATORS="https://github.com/flashbots/flashbots-images/commit/a5aa6c75fb
 Then, to execute, run:
 
 ```
-forge script --chain 1301 script/Interactions.s.sol:AddWorkloadToPolicyScript --rpc-url $UNICHAIN_SEPOLIA_RPC_URL --broadcast --verify --interactives 1 -vvvv
+forge script --chain 1301 script/Interactions.s.sol:AddWorkloadToPolicyScript --rpc-url $RPC_URL --broadcast --verify --interactives 1 -vvvv
 ```