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

[TUTORIAL] Docs tutorials out of sync on/after v1.7.0 #549

Open
astro44 opened this issue Mar 9, 2024 · 4 comments
Open

[TUTORIAL] Docs tutorials out of sync on/after v1.7.0 #549

astro44 opened this issue Mar 9, 2024 · 4 comments
Labels
community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation tutorial new tutorial request or revision to existing tutorial

Comments

@astro44
Copy link

astro44 commented Mar 9, 2024

Please update docs to reflect latest changes in new builds.
since version 1.7.0 hardhat artifacts are no longer used in a few places in the build / run process:
ethereum-optimism/optimism@082d075
main.go call will need to be changed... currently in the tutorial:
image

but should look more like:
go run cmd/main.go genesis l2
--deploy-config ../packages/contracts-bedrock/deploy-config/getting-started.json
--l1-deployments ../packages/contracts-bedrock/deployments/getting-started/.deploy
--outfile.l2 genesis.json
--outfile.rollup rollup.json
--l1-rpc $L1_RPC_URL

also any references to json files in getting-started should likely require the contents of .deploy.
so for running proposer:
image

should look more like:
for -l2oo-address... in ()
cat ../packages/contracts-bedrock/deployments/getting-started/.deploy | jq -r '.L2OutputOracleProxy'

and also:
image

again... we'll find the address in the .deploy file mentioned above.

@astro44 astro44 added community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation labels Mar 9, 2024
@sbvegan
Copy link
Collaborator

sbvegan commented Mar 11, 2024

@luleigreat
Copy link

luleigreat commented Mar 20, 2024

@astro44 was this done on the tutorials/chain branch?

https://docs.optimism.io/builders/chain-operators/tutorials/create-l2-rollup#build-the-optimism-monorepo

I found the same problem, the link you send was done on tutorials/chan branch,the problem is on v1.7.0, there's a lot of difference.

I think the tutorials/chain branch should keep up with the latest stable version.

On v1.7.0 branch ,there are several points not consistent with the current tutorials/chain branch:

  1. When deploy contracts on L1, we just need the the deploy step,no need for the "sync()" step any more
  2. When generating the genesis and rollup files, we should use --l1-deployments ../packages/contracts-bedrock/deployments/getting-started/.deploy instead of --deployment-dir
  3. When start op-node, we should add the --l1.beacon=xxx
  4. When running the op-proposer, should change the way to get --l2oo-address,like --l2oo-address= $(cat ../packages/contracts-bedrock/deployments/getting-started/.deploy | jq -r '.L2OutputOracleProxy')

@luleigreat
Copy link

@astro44 was this done on the tutorials/chain branch?

https://docs.optimism.io/builders/chain-operators/tutorials/create-l2-rollup#build-the-optimism-monorepo

I have another question:

I think the contracts on branch op-contracts/xxx was audited, right ?
How about the contracts on branch tutorials/chain ?

@astro44
Copy link
Author

astro44 commented Mar 24, 2024

Sorry @luleigreat, @sbvegan somehow didn't see this thread,
I didn't actually make any changes so this isn't on any branch, I just made the "suggestion" here in the ticket.
@luleigreat:
I don't know if they were audited, I would assume so.... but thats a question for someone within Optimisim to answer... maybe @sbvegan can help?

@astro44 astro44 changed the title [DOCS] Docs tutorials out of sync after v1.7.0 [DOCS] Docs tutorials out of sync on/after v1.7.0 Mar 24, 2024
@cpengilly cpengilly changed the title [DOCS] Docs tutorials out of sync on/after v1.7.0 [TUTORIAL] Docs tutorials out of sync on/after v1.7.0 May 1, 2024
@cpengilly cpengilly added the tutorial new tutorial request or revision to existing tutorial label May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation tutorial new tutorial request or revision to existing tutorial
Projects
None yet
Development

No branches or pull requests

4 participants