From aac0842f17056e5343f66de7df44020c1637e8b7 Mon Sep 17 00:00:00 2001 From: CHAMI Rachid Date: Tue, 30 Apr 2024 05:49:10 +0200 Subject: [PATCH] docs: add the deployed contracts section to the README (#166) * docs: add the deployed contracts section to the README * Update README.md --- README.md | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 572efe5b..0cb5c3b4 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,8 @@ Run `BlobstreamX` script to request updates to the specified light client contin In `/`, run -``` - +```shell cargo run --bin blobstreamx --release - ``` ### [Generate & Relay Proofs Locally](https://hackmd.io/@succinctlabs/HJE7XRrup) @@ -34,20 +32,20 @@ To deploy the `BlobstreamX` contract: 1. Get the genesis parameters for a `BlobstreamX` contract from a specific Celestia block. - ```shell - cargo run --bin genesis -- --block - ``` +```shell +cargo run --bin genesis -- --block +``` 2. Add .env variables to `contracts/.env`, following `contracts/.env.example`. 3. Initialize `BlobstreamX` contract with genesis parameters. In `contracts`, run - ```shell - forge install +```shell +forge install - source .env +source .env - forge script script/Deploy.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast --verify --verifier etherscan --etherscan-api-key $ETHERSCAN_API_KEY - ``` +forge script script/Deploy.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast --verify --verifier etherscan --etherscan-api-key $ETHERSCAN_API_KEY +``` ### Succinct Gateway Prover Whitelist @@ -66,3 +64,20 @@ Add a custom prover for a specific functionID. ```shell cast calldata "addCustomProver(bytes32,address)" ``` + +### Deployed contracts + +You can interact with the Blobstream X contracts today. The +Blobstream X Solidity smart contracts are currently deployed on +the following chains: + +| Contract | EVM network | Contract address | Attested data on Celestia | +| ------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------- | +| Blobstream X | Ethereum Mainnet | [`Not yet deployed`](https://etherscan.io/address/0xTODO) | [Mainnet Beta](https://docs.celestia.org/nodes/mainnet) | +| Blobstream X | Arbitrum One | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://arbiscan.io/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](https://docs.celestia.org/nodes/mainnet) | +| Blobstream X | Base | [`0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794`](https://basescan.org/address/0xA83ca7775Bc2889825BcDeDfFa5b758cf69e8794#events) | [Mainnet Beta](https://docs.celestia.org/nodes/mainnet) | +| Blobstream X | Sepolia | [`0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e`](https://sepolia.etherscan.io/address/0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e#events) | [Mocha testnet](https://docs.celestia.org/nodes/mocha-testnet) | +| Blobstream X | Arbitrum Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.arbiscan.io/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](https://docs.celestia.org/nodes/mocha-testnet) | +| Blobstream X | Base Sepolia | [`0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2`](https://sepolia.basescan.org/address/0xc3e209eb245Fd59c8586777b499d6A665DF3ABD2#events) | [Mocha testnet](https://docs.celestia.org/nodes/mocha-testnet) | + +For more information, please refer to the [documentation](https://docs.celestia.org/developers/blobstream). And if you're planning on building a rollup that uses Blobstream, check out the [blobstream rollups](https://docs.celestia.org/developers/blobstream-rollups) docs.