WEB3-329: chore: Add op-steel readme #425
Conversation
github-actions
bot
changed the title
crates/op-steel/README.md
Outdated
|
|
||
| ## Overview | ||
|
|
||
| op-steel extends [Steel](https://github.com/risc0/risc0-ethereum/tree/main/crates/steel) to work with Optimism's Layer 2 blockchain. Steel enables EVM apps to run offchain while preserving onchain security through execution proofs. op-steel brings these capabilities to the Optimism ecosystem. |
There was a problem hiding this comment.
op-steel brings these capabilities to the Optimism ecosystem.
If someone wants to query an OP chain can verify on the same chain, they can use base Steel, ya? Do we want to clarify that this is primarily for cross-chain queries? Or do you need op-steel to query an OP stack chain in the first place.
crates/op-steel/README.md
Outdated
|
|
||
| ## Overview | ||
|
|
||
| op-steel extends [Steel](https://github.com/risc0/risc0-ethereum/tree/main/crates/steel) to work with Optimism's Layer 2 blockchain. Steel enables EVM apps to run offchain while preserving onchain security through execution proofs. op-steel brings these capabilities to the Optimism ecosystem. |
There was a problem hiding this comment.
Should it be op-steel, op-steel, or OP-Steel? In prose, my intuition is for the last one (OP-Steel)
| @@ -0,0 +1,78 @@ | |||
| # op-steel | |||
|
|
|||
| A Rust library for integrating Optimism's Layer 2 blockchain with Steel, RISC Zero's production-ready smart contract execution prover. | |||
There was a problem hiding this comment.
Do we want to say "OP Stack Later 2 blockchain", or is that not accurate? "Optimism's" might make people think its only for OP Mainnet. But maybe this is not a real concern.
There was a problem hiding this comment.
This README does a good job of discussing mechanics. It may not be immediately clear to the reader they can use this for cross-chain Steel queries / cross-chain communication. It might be good to highlight that, as I think its the most common use case for this work.
No description provided.