polkadot-fellows / xcm-format

Polkadot Cross Consensus-system Message format.
Apache License 2.0
181 stars 43 forks source link

Update xcm-format with v3 Instructions and Registers #31

Closed CrackTheCode016 closed 1 year ago

CrackTheCode016 commented 1 year ago

In an effort to sync, update, and expand the documentation around XCM in the Polkadot Wiki, I propose adding the newly added instructions and registers.

Most of the definitions for the instructions came from the XCM v3 commit code in the Polkadot repo.

Instructions Added:

Registers Added:

TODO

CrackTheCode016 commented 1 year ago

Thank you for catching that!! Let me know if there is anything else you think would be wise to include/changed.

KiChjang commented 1 year ago

For reference, the XCM v3 PR is here: https://github.com/paritytech/polkadot/pull/4097, make sure that every new feature mentioned in the description there is reflected on this PR.

gavofyork commented 1 year ago

Junction also changed more than this diff would imply: GeneralKey and all items which contained a network field also changed.

vstam1 commented 1 year ago

@gavofyork Currently we describe most of the errors of the xcvm instructions as fallible or infallible. Do we want to change these error descriptions to the actual errors mentioned in the 8 The types of error in XCM section based on the implementation in the xcm-executor?

CrackTheCode016 commented 1 year ago

Maybe not relevant for this PR, but would including hyperlinks to the xcm code in the Polkadot repo be interesting? I feel it would bring the spec more cohesion.

i.e., to specific instructions, or interfaces like XcmContext etc

gavofyork commented 1 year ago

@gavofyork Currently we describe most of the errors of the xcvm instructions as fallible or infallible. Do we want to change these error descriptions to the actual errors mentioned in the 8 The types of error in XCM section based on the implementation in the xcm-executor?

Yes - that could be helpful.

gavofyork commented 1 year ago

Maybe not relevant for this PR, but would including hyperlinks to the xcm code in the Polkadot repo be interesting? I feel it would bring the spec more cohesion.

i.e., to specific instructions, or interfaces like XcmContext etc

Sounds sensible.