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

[DOCS] Action Items for Plasma to Alt-da Renaming #882

Closed
3 tasks done
brokewhale opened this issue Sep 4, 2024 · 0 comments · Fixed by #886
Closed
3 tasks done

[DOCS] Action Items for Plasma to Alt-da Renaming #882

brokewhale opened this issue Sep 4, 2024 · 0 comments · Fixed by #886
Assignees
Labels
community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation

Comments

@brokewhale
Copy link
Contributor

brokewhale commented Sep 4, 2024

Action Items for Plasma to Alt-da Renaming

  • Make it clear that the Alt-da feature is still in beta.
  • Update the documentation to reference the latest version of the OP-stack software.
  • Add information to this page about breaking changes in the configuration and instructions for manual updates.

Description

  1. Make it Clear That the Alt-da Feature is Still in Beta

    • Add a prominent beta flag in the Alt-da section of the documentation example (here).
  2. Update the Documentation to Reference the Latest Version of the OP-stack Software

  3. Add Information to This Page About Breaking Changes and Manual Updates

    • Include a section on this page discussing the breaking changes and providing instructions for manual updates.

Below are the steps required to update a previous chain:

Migrating plasma users —> altda

Modify rollup.json config file:

The plasma config could have been specified in one of two ways:

  1. legacy plasma config:
"use_plasma": true,
"da_commitment_type": "GenericCommitment",
"da_challenge_contract_address": "0xAAA",
"da_challenge_window": 1000,
"da_resolve_window": 2000,
  1. recent plasma config:
"plasma_config": {
	"da_commitment_type": "GenericCommitment",
	"da_challenge_contract_address": "0xAAA",
	"da_challenge_window": 1000,
	"da_resolve_window": 2000
}

Remove those fields and instead create the new altda config (omitting any fields not present in the old config):

"alt_da": {
	"da_commitment_type": "GenericCommitment",
	"da_challenge_contract_address": "0xAAA",
	"da_challenge_window": 1000,
	"da_resolve_window": 2000
}

Repo commits to use

Use the commits below (or any one more recent) to pull in the latest op-stack code that is compatible with the new altda config.

Update op-stack runtime config params

CLI params (for both op-node and op-batcher)

Former CLI param Current CLI param
—plasma.enabled —altda.enabled
—plasma.da-server —altda.da-server
—plasma.verify-on-read —altda.verify-on-read
—plasma.da-service —altda.da-service

op-node env vars

Former env var Current env var
OP_NODE_PLASMA_ENABLED OP_NODE_ALTDA_ENABLED
OP_NODE_PLASMA_DA_SERVER OP_NODE_ALTDA_DA_SERVER
OP_NODE_PLASMA_VERIFY_ON_READ OP_NODE_ALTDA_VERIFY_ON_READ
OP_NODE_PLASMA_DA_SERVICE OP_NODE_ALTDA_DA_SERVICE

op-batcher env vars

Former env var Current env var
OP_BATCHER_PLASMA_ENABLED OP_BATCHER_ALTDA_ENABLED
OP_BATCHER_PLASMA_DA_SERVER OP_BATCHER_ALTDA_DA_SERVER
OP_BATCHER_PLASMA_VERIFY_ON_READ OP_BATCHER_ALTDA_VERIFY_ON_READ
OP_BATCHER_PLASMA_DA_SERVICE OP_BATCHER_ALTDA_DA_SERVICE

op-alt-da (formerly op-plasma) daserver env vars

Former env var Current env var
OP_PLASMA_DA_SERVER_ADDR OP_ALTDA_SERVER_ADDR
OP_PLASMA_DA_SERVER_PORT OP_ALTDA_SERVER_PORT
OP_PLASMA_DA_SERVER_FILESTORE_PATH OP_ALTDA_SERVER_FILESTORE_PATH
OP_PLASMA_DA_SERVER_GENERIC_COMMITMENT OP_ALTDA_SERVER_GENERIC_COMMITMENT
OP_PLASMA_DA_SERVER_S3_BUCKET OP_ALTDA_SERVER_S3_BUCKET
OP_PLASMA_DA_SERVER_S3_ENDPOINT OP_ALTDA_SERVER_S3_ENDPOINT
OP_PLASMA_DA_SERVER_S3_ACCESS_KEY_ID OP_ALTDA_SERVER_S3_ACCESS_KEY_ID
OP_PLASMA_DA_SERVER_S3_ACCESS_KEY_SECRET OP_ALTDA_SERVER_S3_ACCESS_KEY_SECRET
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants