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

op-viem docs need to be updated to work with the Fault Proof System #2929

Closed
sbvegan opened this issue Oct 25, 2024 · 2 comments
Closed

op-viem docs need to be updated to work with the Fault Proof System #2929

sbvegan opened this issue Oct 25, 2024 · 2 comments
Labels
A: Docs Area: Documentation

Comments

@sbvegan
Copy link

sbvegan commented Oct 25, 2024

What is the type of issue?

Documentation is incorrect

What is the issue?

The OP Stack documentation needs a once over so all the fault proof parameters are documented. We're deprecating the Optimism SDK and are pushing folks to use viem. You'll probably see an influx of developers taking a look at these docs over the next quarter.

For example, https://viem.sh/op-stack/actions/getGame#usage, has the incorrect parameters for fault proof systems. It should include:

await parentClient.getGame({
          l2BlockNumber,
          disputeGameFactoryAddress,
          portalAddress,
          chain,
        });

Where did you find it?

https://viem.sh/op-stack

@sbvegan sbvegan added the A: Docs Area: Documentation label Oct 25, 2024
@jxom
Copy link
Member

jxom commented Oct 25, 2024

Portal address, dispute game address and chain are all inferred from the Client, so consumers don’t need to explicitly pass them.

@jxom jxom closed this as not planned Won't fix, can't repro, duplicate, stale Oct 25, 2024
Copy link
Contributor

github-actions bot commented Nov 9, 2024

This issue has been locked since it has been closed for more than 14 days.

If you found a concrete bug or regression related to it, please open a new bug report with a reproduction against the latest Viem version. If you have any questions or comments you can create a new discussion thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: Docs Area: Documentation
Projects
None yet
Development

No branches or pull requests

2 participants