ethereum-optimism / docs

Optimism Developer Docs
https://docs.optimism.io
94 stars 174 forks source link

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

Closed astro44 closed 1 month ago

astro44 commented 8 months ago

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: https://github.com/ethereum-optimism/optimism/commit/082d075dcef809ebb940129ff17de8b0f5ec3451 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.

sbvegan commented 7 months ago

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

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

luleigreat commented 7 months ago

@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 commented 7 months ago

@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 commented 7 months ago

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?

sbvegan commented 1 month ago

closing in favor of https://github.com/ethereum-optimism/docs/issues/917