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

XCM Doc Restructure: Covering pallet-xcm #4578

Merged
merged 16 commits into from
Mar 23, 2023
Merged

XCM Doc Restructure: Covering pallet-xcm #4578

merged 16 commits into from
Mar 23, 2023

Conversation

CrackTheCode016
Copy link
Contributor

@CrackTheCode016 CrackTheCode016 commented Mar 14, 2023

As part of issue #4541, this PR covers and documents pallet-xcm:

TODO

  • What pallet-xcm does
  • How pallet-xcm handles fees
  • What extrinsics are important to note in pallet-xcm (and what they do)
  • How pallet-xcm defines interfaces for XcmConfig
  • Transfer Reserve vs Teleport difference

@CrackTheCode016 CrackTheCode016 added the A1 - In Progress Not ready for review yet. label Mar 14, 2023
@CrackTheCode016 CrackTheCode016 self-assigned this Mar 14, 2023
Comment on lines 77 to 79
- **Transferring** or **reserving** an asset implies the movement of funds from one authority to
another, in this case, from the Origin of the sender's chain and into the sovereign account (who
will ultimately benefit from the assets) on the destination chain.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not really clear

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • Transferring or reserving an asset implies that equivalent assets (i.e, native currency) are withdrawn from the ownership of the current origin and deposited into the sovereign account on the destination chain. Unlike teleporting an asset, it is not destroyed, rather a trusted entity is used (i.e., Statemint on Polkadot) to reserve the assets, wherein the sovereign account on the destination chain obtains ownership of them.

Is this clearer? Might be worth creating a diagram for to show the difference.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is the term equivalent asset defined anywhere else other than here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Under the xcm-format repo, it's used a few times: https://github.com/paritytech/xcm-format#transferreserveasset

Is it worth noting that this asset is representative of the origin chain? i.e, DOT becoming known as "wrapped" DOT on the destination chain, or is that inaccurate?

@CrackTheCode016
Copy link
Contributor Author

Just a sidenote - the goal of this portion is to cover some concepts that will be covered in more depth later in the wiki, (example: Trader is mentioned but not explained in depth quite yet). Generally, I think it's good to showcase pallet-xcm initially as an example of where to start when looking into the more technical aspects of understanding XCM.

@CrackTheCode016
Copy link
Contributor Author

@KiChjang @joepetrowski Thank you both for the review!

If it looks good, I think it would be ready to polish slightly and merge. In subsequent XCM sections, more content and detail can be provided.

@CrackTheCode016 CrackTheCode016 added A2 - Please Review Pull request is ready for review. and removed A1 - In Progress Not ready for review yet. labels Mar 23, 2023
@DrW3RK DrW3RK merged commit 05e3fa2 into master Mar 23, 2023
@DrW3RK DrW3RK deleted the xcm-pallet-docs branch March 23, 2023 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Please Review Pull request is ready for review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants