docs: ADR-40 Migration spec (#10891)
## Description Iterative update to the ADR-40 --- ### 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 [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation 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 [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
This commit is contained in:
parent
cff9e9ae24
commit
9455474855
|
@ -206,6 +206,29 @@ Some objects may be saved with key, which contains a Protobuf message type. Such
|
|||
|
||||
TODO: finalize this or move to another ADR.
|
||||
|
||||
## Migration
|
||||
|
||||
Using the new store will require a migration. 2 Migrations are proposed:
|
||||
1. Genesis export -- it will reset the blockchain history.
|
||||
2. In place migration: we can reuse `UpgradeKeeper.SetUpgradeHandler` to provide the migration logic:
|
||||
|
||||
```go
|
||||
app.UpgradeKeeper.SetUpgradeHandler("adr-40", func(ctx sdk.Context, plan upgradetypes.Plan, vm module.VersionMap) (module.VersionMap, error) {
|
||||
|
||||
storev2.Migrate(iavlstore, v2.store)
|
||||
|
||||
// RunMigrations returns the VersionMap
|
||||
// with the updated module ConsensusVersions
|
||||
return app.mm.RunMigrations(ctx, vm)
|
||||
})
|
||||
```
|
||||
|
||||
The `Migrate` function will read all entries from a store/v1 DB and save them to the AD-40 combined KV store.
|
||||
Cache layer should not be used and the operation must finish with a single Commit call.
|
||||
|
||||
Inserting records to the `SC` (SMT) component is the bottleneck. Unfortunately SMT doesn't support batch transactions.
|
||||
Adding batch transactions to `SC` layer is considered as a feature after the main release.
|
||||
|
||||
## Consequences
|
||||
|
||||
### Backwards Compatibility
|
||||
|
|
Loading…
Reference in New Issue