Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WEB3-164: added new Steel readme + relevant docs #275

Merged
merged 34 commits into from
Oct 7, 2024
Merged

Conversation

sashaaldrick
Copy link
Contributor

@sashaaldrick sashaaldrick commented Oct 3, 2024

This cleans up the README to add a new introduction, documentation for a Steel walkthrough, and getting started with Steel using create-steel-app for erc20-counter.

@github-actions github-actions bot changed the title draft: added new Steel readme + relevant docs WEB3-164: draft: added new Steel readme + relevant docs Oct 3, 2024
@sashaaldrick sashaaldrick marked this pull request as ready for review October 4, 2024 10:16
@sashaaldrick sashaaldrick changed the title WEB3-164: draft: added new Steel readme + relevant docs WEB3-164: added new Steel readme + relevant docs Oct 4, 2024
steel/docs/how-does-steel-work.md Outdated Show resolved Hide resolved

The second method allows validation using the [EIP-4788] beacon roots contract. This technique extends the time window in which the proof can be validated on-chain to just over a day, making it suitable for scenarios requiring more extensive computation. It requires access to a beacon API endpoint and can be enabled by calling `EvmEnv::into_beacon_input`. However, this approach is specific to Ethereum Steel proofs and depends on the implementation of EIP-4788.

Note that EIP-4788 only provides access to the parent beacon root, requiring iterative queries in Solidity to retrieve the target beacon root for validation. This iterative process can result in slightly higher gas costs compared to using the `blockhash` opcode. Overall, it is suitable for environments where longer proof generation times are required.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be adapted according to #265

Copy link
Contributor

@nategraf nategraf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As of right now, forge build with the new create-steel-app fails

Compiler run failed:
Error (9582): Member "blockRoot" not found or not visible after argument-dependent lookup in type(library Beacon).
  --> contracts/test/Counter.t.sol:76:30:
   |
76 |         bytes32 beaconRoot = Beacon.blockRoot(beaconTimestamp);
   |                              ^^^^^^^^^^^^^^^^

Error:
Compilation failed

steel/docs/how-does-steel-work.md Outdated Show resolved Hide resolved
steel/docs/how-does-steel-work.md Outdated Show resolved Hide resolved
steel/docs/how-does-steel-work.md Outdated Show resolved Hide resolved
steel/docs/what-is-steel.md Outdated Show resolved Hide resolved
steel/docs/what-is-steel.md Outdated Show resolved Hide resolved
steel/README.md Outdated Show resolved Hide resolved
steel/README.md Outdated Show resolved Hide resolved
steel/docs/create-steel-app/README.md Outdated Show resolved Hide resolved
steel/docs/create-steel-app/README.md Outdated Show resolved Hide resolved
steel/docs/create-steel-app/README.md Outdated Show resolved Hide resolved
steel/docs/create-steel-app/create-steel-app Show resolved Hide resolved
steel/docs/create-steel-app/create-steel-app Outdated Show resolved Hide resolved
steel/docs/how-does-steel-work.md Outdated Show resolved Hide resolved
steel/docs/how-does-steel-work.md Outdated Show resolved Hide resolved
steel/docs/how-does-steel-work.md Outdated Show resolved Hide resolved
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
steel/README.md Outdated Show resolved Hide resolved
@nategraf nategraf requested a review from a team as a code owner October 7, 2024 13:35
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
steel/docs/steel-commitments.md Outdated Show resolved Hide resolved
@nategraf nategraf merged commit 1f7c71c into main Oct 7, 2024
9 of 10 checks passed
@nategraf nategraf deleted the sasha/steel-1.0-docs branch October 7, 2024 14:19
Wollac added a commit that referenced this pull request Oct 7, 2024
This cleans up the README to add a new introduction, documentation for a
Steel walkthrough, and getting started with Steel using
`create-steel-app` for erc20-counter.

---------

Co-authored-by: Victor Graf <victor@risczero.com>
Co-authored-by: Wolfgang Welz <welzwo@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants