BM-197: Update Sepolia Requestor docs (github#36)

First pass as updating the Book to discuss using public deployments of
the Boundless Market.

Before merge, it would be best to do these, but should not block if we
need docs surfaced ASAP:

- [ ] Test the local CLI workflow works on Sepolia manually
- [ ] Test a github#31 style workflow

Also includes a nit to replace `WALLET_PRIVATE_KEY` with
`REQUESTOR_PRIVATE_KEY` to avoid ambiguity as multiple accounts may be
at play for various parties in testing and deployment soon.

---------

Co-authored-by: capossele <angelocapossele@gmail.com>

Author: nuke-web3

.env

@@ -1,12 +1,18 @@
 # URL RPC node
+
 RPC_URL="http://localhost:8545"
 
+# Sepolia (https://www.alchemy.com/chain-connect/chain/sepolia)
+#RPC_URL="https://rpc.sepolia.org"
+
 ### Contracts ###
 
-SET_VERIFIER_ADDRESS="0x261D8c5e9742e6f7f1076Fa1F560894524e19cad"
-PROOF_MARKET_ADDRESS="0xCE3478A9E0167a6Bc5716DC39DbbbfAc38F27623"
+# Defaults to Sepolia, more details in 
+
+SET_VERIFIER_ADDRESS="0x6860e6cC6E4705309b3e946947706b4a346422DB"
+PROOF_MARKET_ADDRESS="0xb3e579794B6ce24bC7233713289790d9bBEB656c"
 
 ### Wallets private keys ###
 
 PROVER_PRIVATE_KEY="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
-WALLET_PRIVATE_KEY="0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6"
+REQUESTOR_PRIVATE_KEY="0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6"

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("WALLET_PRIVATE_KEY");
+        uint256 adminKey = vm.envUint("REQUESTOR_PRIVATE_KEY");
 
         vm.startBroadcast(adminKey);
 

crates/boundless-market/src/bin/cli.rs

@@ -146,8 +146,8 @@ struct SubmitOfferRequirements {
 struct MainArgs {
     #[clap(short, long, env, default_value = "http://localhost:8545")]
     rpc_url: Url,
-    #[clap(short, long, env)]
-    wallet_private_key: PrivateKeySigner,
+    #[clap(long, env)]
+    requestor_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.wallet_private_key.address();
-    let signer = args.wallet_private_key.clone();
-    let wallet = EthereumWallet::from(args.wallet_private_key.clone());
+    let caller = args.requestor_private_key.address();
+    let signer = args.requestor_private_key.clone();
+    let wallet = EthereumWallet::from(args.requestor_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);

crates/boundless-market/src/sdk/client.rs

@@ -161,15 +161,15 @@ impl Client<Http<HttpClient>, ProviderWallet, BuiltinStorageProvider> {
     /// Create a new client from environment variables
     ///
     /// The following environment variables are required:
-    /// - WALLET_PRIVATE_KEY: The private key of the wallet
+    /// - REQUESTOR_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 wallet_private_key_str =
-            env::var("WALLET_PRIVATE_KEY").context("WALLET_PRIVATE_KEY not set")?;
-        let wallet_private_key = PrivateKeySigner::from_str(&wallet_private_key_str)
-            .context("Invalid WALLET_PRIVATE_KEY")?;
+        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 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 +181,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 = wallet_private_key.address();
-        let signer = wallet_private_key.clone();
-        let wallet = EthereumWallet::from(wallet_private_key.clone());
+        let caller = requestor_private_key.address();
+        let signer = requestor_private_key.clone();
+        let wallet = EthereumWallet::from(requestor_private_key.clone());
         let provider =
             ProviderBuilder::new().with_recommended_fillers().wallet(wallet).on_http(rpc_url);
 
@@ -202,14 +202,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(
-        wallet_private_key: PrivateKeySigner,
+        requestor_private_key: PrivateKeySigner,
         rpc_url: Url,
         proof_market_address: Address,
         set_verifier_address: Address,
     ) -> Result<Self, ClientError> {
-        let caller = wallet_private_key.address();
-        let signer = wallet_private_key.clone();
-        let wallet = EthereumWallet::from(wallet_private_key.clone());
+        let caller = requestor_private_key.address();
+        let signer = requestor_private_key.clone();
+        let wallet = EthereumWallet::from(requestor_private_key.clone());
         let provider =
             ProviderBuilder::new().with_recommended_fillers().wallet(wallet).on_http(rpc_url);
 

docs/src/SUMMARY.md

@@ -8,7 +8,8 @@
 
   - [Boundless Market RFC](./market/rfc.md)
   - [Market Matching](./market/matching.md)
-  - [Local Development Configuration](./market/local-development.md)
+  - [Local Development](./market/local-development.md)
+  - [Public Deployments](./market/deployments.md)
 
 - [🙋 Requestor Manual](./requestor-manual/README.md)
 

docs/src/market/deployments.md

@@ -0,0 +1,19 @@
+# Boundless Market Contract Deployments
+
+The Boundless Market's contracts are deployed only on [Sepolia](#sepolia) so far, with more to be determined.
+
+## Sepolia ⚠TESTNET⚠
+
+| Contract Name            | Contract Address                                                                                                              |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
+| `ProofMarket`            | [0xb3e579794B6ce24bC7233713289790d9bBEB656c](https://sepolia.etherscan.io/address/0xb3e579794B6ce24bC7233713289790d9bBEB656c) |
+| `SetVerifier`            | [0x6860e6cC6E4705309b3e946947706b4a346422DB](https://sepolia.etherscan.io/address/0x6860e6cC6E4705309b3e946947706b4a346422DB) |
+| `RiscZeroVerifierRouter` | [0x925d8331ddc0a1F0d96E68CF073DFE1d92b69187](https://sepolia.etherscan.io/address/0x925d8331ddc0a1F0d96E68CF073DFE1d92b69187) |
+| `Counter` example        | [0x830aC8703F9735BF728517fB8946DbDcC222b9f9](https://sepolia.etherscan.io/address/0x830aC8703F9735BF728517fB8946DbDcC222b9f9) |
+
+## Interactions
+
+To interact with Boundless on any network see:
+
+- The [requestor broadcasting guide](../requestor-manual/broadcasting.md#public-networks)
+- The [prover running Bento guide](../prover-manual/bento/running_bento.md)

docs/src/prover-manual/broker/sepolia.md

@@ -1,19 +1,80 @@
-# Broadcasting Proof Requests
+# Broadcast a Proof Request
 
 Programmatic interaction with the market is accomplished through `boundless-market` crate, using the `ProofMarketService` struct.
 An example is provided in the `examples/counter` directory.
 
-You can also interact with the market via a CLI, built with the `boundless_market::contracts` library.
+You can also interact with the market via a market client CLI.
+It builds upon the `boundless_market::contracts` library.
 
-## CLI Usage
+## Local Devnet
+
+To setup a local devnet follow the [local development][local-development] instructions.
+
+You can override settings found in `.env` and more to use local devnet settings with by exporting or prefixing commands:
+
+```bash
+# Use dev mode in this terminal session
+export RISC0_DEV_MODE=1
+# Use dev mode for this command only
+RISC0_DEV_MODE=1 <ANY BOUNDLESS CLI COMMAND>
+```
+
+Notably, Developer Mode will:
+
+- Use a storage provider that interacts with temporary files.
+- Use `anvil` default dev wallets to deploy and interact with contracts.
+
+See the [CLI usage](#cli-usage) section or `examples/counter`'s `ProofMarketService` for further instructions.
+
+## Public Networks
+
+The Boundless Market is officially deployed only on [the Sepolia Testnet][id-deployments-sepolia-testnet] so far, with more networks to be announced.
+Before you can interact with any network, you will need to configure an EVM RPC, Funds to pay for gas, and Image Storage Provider.
+
+#### Configure an EVM RPC Provider
+
+You need an RPC provider to interact with any EVM network. [Alchemy](https://www.alchemy.com/) supports various EVM networks, so creating a free account there is recommended, but many other options exist. Set the following environment variables according to your chosen RPC:
+
+```bash
+export RPC_URL="<SEPOLIA-URL>"
+```
+
+Or just modify the .env file and finally run `source .env`.
 
-> **NOTE**: all the following commands can be run with the environment variable `RISC0_DEV_MODE` set;
-> this should be done only while testing within a [local devnet][page-local-development] as the
-> default storage provider will use temporary files.
+#### Configure a Storage Provider
+
+Boundless requires that ELF Image of the program requested, and optionally the input, to be proven be accessible to provers.
+
+<!-- TODO: link to rustdocs and document how one might create a storage provider (perhaps via a DA?) -->
+
+The best supported options are listed in the `boundless-market::BuiltinStorageProvider` enum.
+IPFS storage is presently the best supported, specifically through [Pinata](https://www.pinata.cloud/) which offers a free tier sufficient for most Boundless use cases.
+To use Pinata, [fetch the JWT credentials](https://docs.pinata.cloud/account-management/api-keys) and set the `PINATA_JWT` environment variable.
+
+### Sepolia Testnet
+
+To interact with [Sepolia's Boundless contracts][id-deployments-sepolia-testnet] you will need:
+
+- A Sepolia Ethereum account with at least 0.5 Sepolia ETH for gas.
+  - The tooling presently requires the use of raw private key in scripting, although there are [better ways to do this](https://book.getfoundry.sh/tutorials/best-practices#private-key-management) that one could implement.
+  <!-- TODO: need better ways to get funds for boundless users! faucets are a HUGE pain, considering the round trip gas costs! -->
+  - Faucets exist to obtain 0.1 ETH at a time, but almost all require an account
+
+Make sure to export the env variable:
+
+```bash
+export REQUESTOR_PRIVATE_KEY="<YOUR-WALLET-PRIVATE_KEY>"
+```
+
+Or just modify the .env file and then run `source .env`
+
+See the [CLI usage](#cli-usage) section for further instructions.
+
+## CLI Usage
 
-The boundless `cli` allows to:
+The `cli` allows to:
 
-1. Submit proving request via a YAML file, an example can be found `request.yaml`.
+1. Submit proving request via a YAML file, an example can be found in `request.yaml`.
 
    ```console
    RUST_LOG=info,boundless_market=debug cargo run --bin cli -- submit-request request.yaml
@@ -101,7 +162,7 @@ The boundless `cli` allows to:
    and the Pinata one will be ignored.
 
    ```console
-   PINATA_JWT="YOUR_PINATA_JWT" RUST_LOG=info,boundless_market=debug cargo run --bin cli -- submit-offer offer.yaml --wait --input "hello" --encode-input --journal-prefix ""
+   PINATA_JWT="YOUR_PINATA_JWT" RUST_LOG=info cargo run --bin cli -- submit-offer --input "Hello world!" --inline-input --encode-input --journal-prefix "" offer.yaml
    ```
 
 6. Slash a request and get back funds
@@ -112,4 +173,5 @@ The boundless `cli` allows to:
    RUST_LOG=info,boundless_market=debug cargo run --bin cli -- slash 3554585979324098154284013313896898623039163403618679259143
    ```
 
-[page-local-development]: ../market/local-development.md
+[id-deployments-sepolia-testnet]: ../market/deployments.md#sepolia-testnet
+[local-development]: ../market/local-development.md

docs/src/requestor-manual/broadcasting.md

@@ -42,8 +42,8 @@ struct Args {
     #[clap(short, long, env)]
     rpc_url: Url,
     /// Private key used to interact with the Counter contract.
-    #[clap(short, long, env)]
-    wallet_private_key: PrivateKeySigner,
+    #[clap(long, env)]
+    requestor_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.wallet_private_key,
+        args.requestor_private_key,
         args.rpc_url,
         args.proof_market_address,
         args.set_verifier_address,
@@ -78,16 +78,20 @@ async fn main() -> Result<()> {
 }
 
 async fn run(
-    wallet_private_key: PrivateKeySigner,
+    requestor_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(wallet_private_key, rpc_url, proof_market_address, set_verifier_address)
-            .await?;
+    let boundless_client = Client::from_parts(
+        requestor_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?;
@@ -98,7 +102,7 @@ async fn run(
     let timestamp = format! {"{:?}", SystemTime::now()};
 
     // Encode the input and upload it to the storage provider.
-    let input = encode_input(&timestamp.as_bytes())?;
+    let input = encode_input(timestamp.as_bytes())?;
     let input_url = boundless_client.upload_input(&input).await?;
     tracing::info!("Uploaded input to {}", input_url);
 

examples/counter/apps/src/main.rs

@@ -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("WALLET_PRIVATE_KEY");
+        uint256 key = vm.envUint("REQUESTOR_PRIVATE_KEY");
         address verifierAddress = vm.envAddress("SET_VERIFIER_ADDRESS");
         vm.startBroadcast(key);