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.

Sign up for GitHub

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

Jump to bottom

Add documentation on customizing the Orbit STF #668

Merged
merged 10 commits into from
Oct 13, 2023
Merged

Add documentation on customizing the Orbit STF #668

merged 10 commits into from
Oct 13, 2023

Conversation

PlasmaPower
Copy link
Contributor

No description provided.

@cla-bot cla-bot bot added the s label Oct 12, 2023
@vercel
Copy link

vercel bot commented Oct 12, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nitro-docs ✅ Ready (Inspect) Visit Preview Oct 13, 2023 0:16am

@github-actions
Copy link

Hey there!
It looks like your changes are not well formatted. You can merge this PR, but we recommend to format your code with:

cd website && yarn format

Thanks!💙🧡

1 similar comment
@github-actions
Copy link

Hey there!
It looks like your changes are not well formatted. You can merge this PR, but we recommend to format your code with:

cd website && yarn format

Thanks!💙🧡

@github-actions
Copy link

Hey there!
It looks like your changes are not well formatted. You can merge this PR, but we recommend to format your code with:

cd website && yarn format

Thanks!💙🧡

@github-actions
Copy link

Hey there!
It looks like your changes are not well formatted. You can merge this PR, but we recommend to format your code with:

cd website && yarn format

Thanks!💙🧡

@PlasmaPower PlasmaPower mentioned this pull request Oct 12, 2023
Merged
hkalodner
hkalodner reviewed Oct 13, 2023
View reviewed changes
Copy link
Contributor

@hkalodner hkalodner left a comment

Choose a reason for hiding this comment

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

Technical content all looks solidly covered to me

arbitrum-docs/launch-orbit-chain/how-tos/customize-stf.mdx

- The STF must be deterministic. For instance, if you gave an address a random balance using the Go randomness library,
every node would disagree on the correct amount of balance and the blockchain would not function correctly.
However, it is acceptable to take a non-deterministic path to a deterministic output.
Copy link
Contributor

Choose a reason for hiding this comment

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

Pedantic point, but this made me think of the non-deterministic preimages issue caused by iteration over a map in the go-ethereum code that we solved :D

Jason-W123
Jason-W123 approved these changes Oct 13, 2023
View reviewed changes
arbitrum-docs/launch-orbit-chain/how-tos/customize-precompile.mdx Outdated
```shell
docker run --rm -it -v /some/local/dir/arbitrum:/home/user/.arbitrum -p 0.0.0.0:8547:8547 -p 0.0.0.0:8548:8548 @latestNitroNodeImage@ --parent-chain.connection.url=<YourParentChainUrl> --chain.id=<YourOrbitChainId> --http.api=net,web3,eth,debug --http.corsdomain=* --http.addr=0.0.0.0 --http.vhosts=*
```
Next, follow the steps in [How to customize your Orbit chain's behavior](./customize-stf.mdx) to build a modified Arbitrum Nitro node docker image and run it.
Copy link
Contributor

Choose a reason for hiding this comment

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

How about we redirect to ./customize-stf.mdx#Building-a-Dev-Image ?

arbitrum-docs/launch-orbit-chain/how-tos/customize-precompile.mdx Outdated
```shell
docker run --rm -it -v /some/local/dir/arbitrum:/home/user/.arbitrum -p 0.0.0.0:8547:8547 -p 0.0.0.0:8548:8548 @latestNitroNodeImage@ --parent-chain.connection.url=<YourParentChainUrl> --chain.id=<YourOrbitChainId> --http.api=net,web3,eth,debug --http.corsdomain=* --http.addr=0.0.0.0 --http.vhosts=*
```
Next, follow the steps in [How to customize your Orbit chain's behavior](./customize-stf.mdx) to build a modified Arbitrum Nitro node docker image and run it.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above

@github-actions
Copy link

Hey there!
It looks like your changes are not well formatted. You can merge this PR, but we recommend to format your code with:

cd website && yarn format

Thanks!💙🧡

@TucksonDev
Copy link
Contributor

Format warning refers to the Quickstart for Solidity, which currently has a minor formatting issue. I will leave it out of this PR to focus the changes on the affected pages.

@github-actions
Copy link

Hey there!
It looks like your changes are not well formatted. You can merge this PR, but we recommend to format your code with:

cd website && yarn format

Thanks!💙🧡

@github-actions
Copy link

Hey there!
It looks like your changes are not well formatted. You can merge this PR, but we recommend to format your code with:

cd website && yarn format

Thanks!💙🧡

@symbolpunk symbolpunk merged commit 23c1131 into master Oct 13, 2023
4 checks passed
@symbolpunk symbolpunk deleted the customize-stf branch October 13, 2023 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hkalodner hkalodner hkalodner left review comments

@symbolpunk symbolpunk symbolpunk approved these changes

@Jason-W123 Jason-W123 Jason-W123 approved these changes

@mahsamoosavi mahsamoosavi Awaiting requested review from mahsamoosavi

Assignees
No one assigned
Labels
s
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@PlasmaPower @TucksonDev @hkalodner @symbolpunk @Jason-W123