You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+95-1Lines changed: 95 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,8 @@ Migration passes that take place with direct or indirect access to all other lev
45
45
46
46
## Environments
47
47
48
+
Environments are the different contexts in which **[Migrations](#migrations)** are expected to run.
49
+
48
50
> [!WARNING]
49
51
> Currently, this and its subcategories are suggestive. All **[Strategies](#strategies)**, **[Migrations](#migrations)**, and **[Checks](#checks)** have been written ad hoc and are mostly concerned with a local testing environment.
50
52
>
@@ -82,7 +84,7 @@ At the time of writing, we have planned or developed the following `node` migrat
82
84
83
85
`mtma-node-null` is a migration that does not attempt to make any changes to the the existing databases. It is a copying of node state files.
@@ -136,14 +138,106 @@ Runs the [`post-l1-merge`](https://github.com/movementlabsxyz/movement-migration
136
138
137
139
## Contexts
138
140
141
+
Contexts are the contexts in which checks are expected to run.
142
+
143
+
> ![WARNING]
144
+
> This category and its subcategories are currently suggestive.
145
+
146
+
> [!ERROR]
147
+
> Not all **[Checks](#checks)** are intended to run in all Contexts.
148
+
149
+
### `snapshot`
150
+
The context wherein the migration and its checks have access to a safe version of the node which they may modify.
151
+
152
+
### `tracking`
153
+
The context wherein the migration is presumed to already have run and the checks will continue to track a certain set of criteria against live traffic.
154
+
139
155
## Checks
140
156
157
+
Checks are the criteria for migration correctness. Ultimately, they are intended to be used under `mtma checked-migration` to ensure a performed migration satisfies correctness as defined by the criteria described in the Checks.
158
+
141
159
> [!WARNING]
142
160
> This section is a **WIP** in progress. Its contents are intended as aspirational. However, links below to CLIs and documentation should ultimately be valid and currently link to informative material.
143
161
144
162
> [!INFO]
145
163
> Multiple CLI paths are often shared for usability. Owing to the compositional approach this repository uses to CLI development, the logic should assumed be the same at each CLI path unless otherwise noted below or in the CLI documentation itself.
146
164
165
+
166
+
> [!INFO]
167
+
> Several checks from [`primata/e2e-criteria`](https://github.com/movementlabsxyz/movement-migration/pull/47) are omitted here as they are still in fairly early development.
168
+
169
+
### `snapshot`
170
+
171
+
> [!WARNING]
172
+
> We would like to pull each of these out into a separate unit-test written crate a la [`balances-equal`](./checks/migrator/checks/balances-equal/) and generally reorganize the [`checks`](./checks/) to better match the updated ontology described herein.
173
+
>
174
+
> The need for separate crates is driven by some awkward Tokio behavior when dropping various runtimes associated with the `movement` and `movement-aptos` embedded runners.
Checks that both `movement` and `movement-aptos` accounts are equivalent in `bcs` representation. Amongst other things, this should ensure that asymmetric cryptography for accounts is preserved.
0 commit comments