BM-216: Rename requestor_private_key to generalize as the only key (github#48)

nuke-web3 · web-flow · commit 2e9cb04f36ff · 2024-10-12T23:30:50.000Z
We use one key for any wallet &amp; signing operations presently.
diff --git a/.env b/.env
@@ -14,5 +14,4 @@ PROOF_MARKET_ADDRESS="0xb3e579794B6ce24bC7233713289790d9bBEB656c"
 
 ### Wallets private keys ###
 
-PROVER_PRIVATE_KEY="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
-REQUESTOR_PRIVATE_KEY="0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6"
+PRIVATE_KEY="0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6"
diff --git a/.env-compose b/.env-compose
@@ -19,7 +19,7 @@ MINIO_BUCKET=workflow
 
 GRAFANA_IMG=grafana/grafana:11.0.0
 
-PRIV_KEY=0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba
+PRIVATE_KEY=0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba
 
 PROOF_MARKET_ADDR=0x261D8c5e9742e6f7f1076Fa1F560894524e19cad
 SET_VERIFIER_ADDR=0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0
diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ ANVIL_PORT = 8545
 ANVIL_BLOCK_TIME = 2
 RISC0_DEV_MODE = 1
 RUST_LOG = info,broker=debug,boundless_market=debug
-PRIV_KEY = 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+PRIVATE_KEY = 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
 DEPOSIT_AMOUNT = 10
 
 LOGS_DIR = logs
@@ -47,7 +47,7 @@ devnet-up: check-deps
 		echo ".env file updated successfully."; \
 		echo "Starting Broker service..."; \
 		RISC0_DEV_MODE=$(RISC0_DEV_MODE) RUST_LOG=$(RUST_LOG) ./target/debug/broker \
-			--priv-key $(PRIV_KEY) \
+			--private-key $(PRIVATE_KEY) \
 			--proof-market-addr $$PROOF_MARKET_ADDRESS \
 			--set-verifier-addr $$SET_VERIFIER_ADDRESS \
 			--deposit-amount $(DEPOSIT_AMOUNT) > $(LOGS_DIR)/broker.txt 2>&1 & echo $$! >> $(PID_FILE); \
diff --git a/compose.yml b/compose.yml
@@ -251,7 +251,7 @@ services:
     environment:
       RUST_LOG: ${RUST_LOG},broker=debug,boundless_market=debug
       # RUST_BACKTRACE: 1
-      PRIV_KEY: ${PRIV_KEY}
+      PRIVATE_KEY: ${PRIVATE_KEY}
       RPC_URL: ${RPC_URL}
 
     entrypoint: /app/broker --db-url 'sqlite:///db/broker.db' --set-verifier-addr ${SET_VERIFIER_ADDR} --proof-market-addr ${PROOF_MARKET_ADDR} --config-file /app/broker.toml --bento-api-url http://localhost:8081
diff --git a/contracts/scripts/Deploy.s.sol b/contracts/scripts/Deploy.s.sol
@@ -19,7 +19,7 @@ import {ImageID as SetBuidlerId} from "../src/SetBuilderImageID.sol";
 contract Deploy is Script, RiscZeroCheats {
     function run() external {
         // load ENV variables first
-        uint256 adminKey = vm.envUint("REQUESTOR_PRIVATE_KEY");
+        uint256 adminKey = vm.envUint("PRIVATE_KEY");
 
         vm.startBroadcast(adminKey);
 
diff --git a/crates/boundless-market/src/bin/cli.rs b/crates/boundless-market/src/bin/cli.rs
@@ -147,7 +147,7 @@ struct MainArgs {
     #[clap(short, long, env, default_value = "http://localhost:8545")]
     rpc_url: Url,
     #[clap(long, env)]
-    requestor_private_key: PrivateKeySigner,
+    private_key: PrivateKeySigner,
     #[clap(short, long, env)]
     proof_market_address: Address,
     #[clap(short, long, env)]
@@ -164,9 +164,9 @@ async fn main() -> Result<()> {
     dotenvy::dotenv()?;
     let args = MainArgs::try_parse()?;
 
-    let caller = args.requestor_private_key.address();
-    let signer = args.requestor_private_key.clone();
-    let wallet = EthereumWallet::from(args.requestor_private_key.clone());
+    let caller = args.private_key.address();
+    let signer = args.private_key.clone();
+    let wallet = EthereumWallet::from(args.private_key.clone());
     let provider =
         ProviderBuilder::new().with_recommended_fillers().wallet(wallet).on_http(args.rpc_url);
     let market = ProofMarketService::new(args.proof_market_address, provider.clone(), caller);
diff --git a/crates/boundless-market/src/sdk/client.rs b/crates/boundless-market/src/sdk/client.rs
@@ -161,15 +161,14 @@ impl Client<Http<HttpClient>, ProviderWallet, BuiltinStorageProvider> {
     /// Create a new client from environment variables
     ///
     /// The following environment variables are required:
-    /// - REQUESTOR_PRIVATE_KEY: The private key of the wallet
+    /// - PRIVATE_KEY: The private key of the wallet
     /// - RPC_URL: The URL of the RPC server
     /// - PROOF_MARKET_ADDRESS: The address of the proof market contract
     /// - SET_VERIFIER_ADDRESS: The address of the set verifier contract
     pub async fn from_env() -> Result<Self, ClientError> {
-        let requestor_private_key_str =
-            env::var("requestor_private_key").context("requestor_private_key not set")?;
-        let requestor_private_key = PrivateKeySigner::from_str(&requestor_private_key_str)
-            .context("Invalid requestor_private_key")?;
+        let private_key_str = env::var("private_key").context("private_key not set")?;
+        let private_key =
+            PrivateKeySigner::from_str(&private_key_str).context("Invalid private_key")?;
         let rpc_url_str = env::var("RPC_URL").context("RPC_URL not set")?;
         let rpc_url = Url::parse(&rpc_url_str).context("Invalid RPC_URL")?;
         let proof_market_address_str =
@@ -181,9 +180,9 @@ impl Client<Http<HttpClient>, ProviderWallet, BuiltinStorageProvider> {
         let set_verifier_address =
             Address::from_str(&set_verifier_address_str).context("Invalid SET_VERIFIER_ADDRESS")?;
 
-        let caller = requestor_private_key.address();
-        let signer = requestor_private_key.clone();
-        let wallet = EthereumWallet::from(requestor_private_key.clone());
+        let caller = private_key.address();
+        let signer = private_key.clone();
+        let wallet = EthereumWallet::from(private_key.clone());
         let provider =
             ProviderBuilder::new().with_recommended_fillers().wallet(wallet).on_http(rpc_url);
 
@@ -202,14 +201,14 @@ impl Client<Http<HttpClient>, ProviderWallet, BuiltinStorageProvider> {
     /// The proof market address is the address of the proof market contract.
     /// The set verifier address is the address of the set verifier contract.
     pub async fn from_parts(
-        requestor_private_key: PrivateKeySigner,
+        private_key: PrivateKeySigner,
         rpc_url: Url,
         proof_market_address: Address,
         set_verifier_address: Address,
     ) -> Result<Self, ClientError> {
-        let caller = requestor_private_key.address();
-        let signer = requestor_private_key.clone();
-        let wallet = EthereumWallet::from(requestor_private_key.clone());
+        let caller = private_key.address();
+        let signer = private_key.clone();
+        let wallet = EthereumWallet::from(private_key.clone());
         let provider =
             ProviderBuilder::new().with_recommended_fillers().wallet(wallet).on_http(rpc_url);
 
diff --git a/crates/broker/src/bin/broker.rs b/crates/broker/src/bin/broker.rs
@@ -17,7 +17,7 @@ async fn main() -> Result<()> {
 
     let args = Args::try_parse()?;
 
-    let wallet = EthereumWallet::from(args.priv_key.clone());
+    let wallet = EthereumWallet::from(args.private_key.clone());
 
     let provider = ProviderBuilder::new()
         .with_recommended_fillers()
diff --git a/crates/broker/src/lib.rs b/crates/broker/src/lib.rs
@@ -51,7 +51,7 @@ pub struct Args {
 
     /// wallet key
     #[clap(long, env)]
-    pub priv_key: PrivateKeySigner,
+    pub private_key: PrivateKeySigner,
 
     /// Proof market address
     #[clap(long, env)]
@@ -662,7 +662,7 @@ pub mod test_utils {
             proof_market_addr: ctx.proof_market_addr,
             set_verifier_addr: ctx.set_verifier_addr,
             rpc_url,
-            priv_key: ctx.prover_signer.clone(),
+            private_key: ctx.prover_signer.clone(),
             bento_api_url: None,
             bonsai_api_key: None,
             bonsai_api_url: None,
diff --git a/crates/broker/src/tests/e2e.rs b/crates/broker/src/tests/e2e.rs
@@ -60,7 +60,7 @@ async fn simple_e2e() {
         proof_market_addr: ctx.proof_market_addr,
         set_verifier_addr: ctx.set_verifier_addr,
         rpc_url: anvil.endpoint_url(),
-        priv_key: ctx.prover_signer,
+        private_key: ctx.prover_signer,
         bento_api_url: None,
         bonsai_api_key: None,
         bonsai_api_url: None,
diff --git a/docs/src/README.md b/docs/src/README.md
@@ -8,7 +8,7 @@
 This Book's goal is to:
 
 - Enable everyone to _understand_ [Boundless][term-boundless] via the [Market Section][page-market-overview]
-- Act as a User Manual for the two key _actors_ in the [Boundless Market][term-boundless-market]:
+- Act as a User Manual for the two _actors_ in the [Boundless Market][term-boundless-market]:
   - [Requestors][term-requestor] - using the [Requestor Manual][page-requestor-manual]
   - [Provers][term-prover] - using the [Prover Manual][page-prover-manual]
 
diff --git a/docs/src/market/local-development.md b/docs/src/market/local-development.md
@@ -90,7 +90,7 @@ If instead you prefer setting up a local devnet step by step, you can run the fo
    Setting the `--deposit-amount` flag below has the Broker deposit 10 ETH to the market upon startup.
 
    ```console
-   RISC0_DEV_MODE=1 RUST_LOG=info cargo run --bin broker -- --priv-key ${PROVER_PRIVATE_KEY:?} --proof-market-addr ${PROOF_MARKET_ADDRESS:?} --set-verifier-addr ${SET_VERIFIER_ADDRESS:?} --deposit-amount 10
+   RISC0_DEV_MODE=1 RUST_LOG=info cargo run --bin broker -- --private-key ${PRIVATE_KEY:?} --proof-market-addr ${PROOF_MARKET_ADDRESS:?} --set-verifier-addr ${SET_VERIFIER_ADDRESS:?} --deposit-amount 10
    ```
 
 6. Test your deployment with the boundless CLI.
diff --git a/docs/src/requestor-manual/broadcasting.md b/docs/src/requestor-manual/broadcasting.md
@@ -63,7 +63,7 @@ To interact with [Sepolia's Boundless contracts][id-deployments-sepolia-testnet]
 Make sure to export the env variable:
 
 ```bash
-export REQUESTOR_PRIVATE_KEY="<YOUR-WALLET-PRIVATE_KEY>"
+export PRIVATE_KEY="<YOUR-WALLET-PRIVATE_KEY>"
 ```
 
 Or just modify the .env file and then run `source .env`
diff --git a/examples/counter/apps/src/main.rs b/examples/counter/apps/src/main.rs
@@ -43,7 +43,7 @@ struct Args {
     rpc_url: Url,
     /// Private key used to interact with the Counter contract.
     #[clap(long, env)]
-    requestor_private_key: PrivateKeySigner,
+    private_key: PrivateKeySigner,
     /// Address of the Counter contract.
     #[clap(short, long, env)]
     counter_address: Address,
@@ -66,7 +66,7 @@ async fn main() -> Result<()> {
 
     // NOTE: Using a separate `run` function to facilitate testing below.
     run(
-        args.requestor_private_key,
+        args.private_key,
         args.rpc_url,
         args.proof_market_address,
         args.set_verifier_address,
@@ -78,20 +78,16 @@ async fn main() -> Result<()> {
 }
 
 async fn run(
-    requestor_private_key: PrivateKeySigner,
+    private_key: PrivateKeySigner,
     rpc_url: Url,
     proof_market_address: Address,
     set_verifier_address: Address,
     counter_address: Address,
 ) -> Result<()> {
     // Create a Boundless client from the provided parameters.
-    let boundless_client = Client::from_parts(
-        requestor_private_key,
-        rpc_url,
-        proof_market_address,
-        set_verifier_address,
-    )
-    .await?;
+    let boundless_client =
+        Client::from_parts(private_key, rpc_url, proof_market_address, set_verifier_address)
+            .await?;
 
     // Upload the ECHO ELF to the storage provider so that it can be fetched by the market.
     let image_url = boundless_client.upload_image(ECHO_ELF).await?;
diff --git a/examples/counter/contracts/scripts/Deploy.s.sol b/examples/counter/contracts/scripts/Deploy.s.sol
@@ -11,7 +11,7 @@ import {Counter} from "../src/Counter.sol";
 contract Deploy is Script {
     function run() external payable {
         // load ENV variables first
-        uint256 key = vm.envUint("REQUESTOR_PRIVATE_KEY");
+        uint256 key = vm.envUint("PRIVATE_KEY");
         address verifierAddress = vm.envAddress("SET_VERIFIER_ADDRESS");
         vm.startBroadcast(key);
 
