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: update Permissionless ICS ADR to capture latest changes #2261

Merged
merged 1 commit into from
Sep 12, 2024

Conversation

insumity
Copy link
Contributor

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

@insumity insumity marked this pull request as ready for review September 12, 2024 12:57
@insumity insumity requested a review from a team as a code owner September 12, 2024 12:57
@github-actions github-actions bot added C:Docs Assigned automatically by the PR labeler C:ADR Assigned automatically by the PR labeler labels Sep 12, 2024
@mpoke mpoke merged commit 04b6de4 into main Sep 12, 2024
12 checks passed
@mpoke mpoke deleted the insumity/update-ADR-019 branch September 12, 2024 15:17

#### Initialize a Consumer Chain
To move an Opt In consumer chain to its initialized phase, we issue a `MsgInitializeConsumer` message that is as follows:
Note that `metadata` is a required field, while the `initialization_parameterrs` and `power_shaping_parameters` are optional and can later be set using `MsgUpdateConsumer`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Note that `metadata` is a required field, while the `initialization_parameterrs` and `power_shaping_parameters` are optional and can later be set using `MsgUpdateConsumer`.
Note that `metadata` is a required field, while the `initialization_parameters` and `power_shaping_parameters` are optional and can later be set using `MsgUpdateConsumer`.

}
```

#### Examples of Launching a Consumer Chain
The figures below depict some examples of some of the phases a consumer chain resides in to launch.
The figures below depict some examples of some of the phases a consumer chain resides before launching.

![Examples of a launching consumer chain](./figures/adr19_flows_of_launching_a_consumer_chain.png)


### Additional Modifications
We need to perform multiple migrations. All state needs to be reindex based on a `consumerId` instead of the `chainId`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
We need to perform multiple migrations. All state needs to be reindex based on a `consumerId` instead of the `chainId`.
We need to perform multiple migrations. All state needs to be reindexed based on a `consumerId` instead of the `chainId`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:ADR Assigned automatically by the PR labeler C:Docs Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants