Clarify a3p-integration #8886
Clarify a3p-integration #8886
Conversation
a3p-integration/README.md
Outdated
|
|
||
| The only proposal in this end-to-end `a3p-integration` test is named `a:upgrade-next` and performs a chain software upgrade proposal. | ||
|
|
||
| The details of a proposal are configured through the `agoricProposal` field of its `package.json`. For a chain software upgrade, the `type` is `"Software Upgrade Proposal"`, and the relevant fields are `sdkImageTag`, `planName` and `upgradeInfo`. The first, `sdkImageTag`, is the docker image tag to use that contains the upgraded chain software, and has a value of `unreleased`, which is expected to have been built from the enclosing `agoric-sdk` repository. The other 2 are details of the proposed chain software upgrade. The `planName` is `UNRELEASED_UPGRADE` in the `master` branch, or `agoric-upgrade-*` in release branches. The `upgradeInfo` can be configured to include a `coreProposal` field to run any core proposals not otherwise configured in the chain software's upgrade handler (see `CoreProposalSteps` in `golang/cosmos/app/app.go`). |
There was a problem hiding this comment.
This is getting into the basic mechanics of @agoric/synthetic-chain. I think it would be better to direct the reader to that documentation and expect they understand it.
https://github.com/Agoric/agoric-3-proposals/
https://github.com/Agoric/agoric-3-proposals/tree/main/packages/synthetic-chain
Insofar as that documentation is lacking, let's improve it there. Having it duplicated here isn't awful but it's bound to get stale.
There was a problem hiding this comment.
I wanted this to document the integration with the tool, but did extend on how the tool works since the doc is lacking there, and couldn't make references.
There was a problem hiding this comment.
To not slow this down, I'm fine with accepting refactoring to there as future work
|
|
||
| For each proposal, their package.json is also separate and can't access the SDK code. There is an issue to automatically build proposals from scripts declared in the proposal package.json: https://github.com/Agoric/agoric-3-proposals/issues/87 . Until that is resolved, use `agoric run` on the proposal and copy the outputs to a `submission` directory within the proposals package, to be checked in. | ||
| ## Hooks |
There was a problem hiding this comment.
imo this section belongs in @agoric/synthetic-chain docs instead
|
Updated to merge latest master changes, and address remaining feedback. PTAL |
|
Reworked some of the text, and more importantly, made the sdk image rebuilding automatic as it's a foot gun currently |
mhofman
force-pushed
the
mhofman/clarify-a3p
branch
from
ebd65fb
to
482af43
Compare
mhofman
force-pushed
the
mhofman/clarify-a3p
branch
from
a69ebef
to
22e12fe
Compare
mhofman
force-pushed
the
mhofman/clarify-a3p
branch
from
22e12fe
to
66ab6c3
Compare
Description
Clarifies the structure of
a3p-integrationand its role inagoric-sdk.Testing & Upgrade Considerations
Maintainer documentation only