substrate-docs icon indicating copy to clipboard operation
substrate-docs copied to clipboard

[docs] Add XCM / XCMP article

Open sacha-l opened this issue 3 years ago • 7 comments

Add an article for parachain builders. Work in progress.

sacha-l avatar Sep 30 '21 13:09 sacha-l

<@olanod:virto.community> Is there some source to read more information about the barriers, queries&subscriptions and other newer XCM related topics?

https://polkadot.network/blog/xcm-part-three-execution-and-error-management/

https://github.com/paritytech/xcm-format

all three parts are a good start. subscribe to the format repo for any changes. More docs soon on this.

nuke-web3 avatar Nov 25 '21 10:11 nuke-web3

Add info on using public good parachains. Tracking:

  • [ ] https://github.com/paritytech/polkadot-sdk/issues/107

nuke-web3 avatar Jan 17 '22 16:01 nuke-web3

Add info on using public good parachains.

I wouldn't quite characterize it in that way. It's reserve backed transfer of assets via the chain acting as reserve. The reserve chain of a particular asset may or may not be a common good chain. Likewise, other common good chains could send cross-chain messages that are not asset-related (although may use some asset to buy execution in a block).

joepetrowski avatar Jan 17 '22 20:01 joepetrowski

any estimations on when will this be available?

bernardoaraujor avatar Feb 15 '22 19:02 bernardoaraujor

I think the best we can do is have a page that explains basic XCM principles and how to use them, and link to all other current resources on XCM. For more advanced things, we could maintain a Q&A list - what do you think @NukeManDan @shawntabrizi ?

sacha-l avatar Feb 18 '22 16:02 sacha-l

Truth is that XCM is still too much in development for us to write any kind of deep technical documentation. I understand that parachain builders want more docs, but practically speaking, I dont think we have the capacity or ability to do this well.

Instead, we should point users to the source code, numerous tests, and high level documentation which explains concepts which are unlikely to change from xcm version to version.

shawntabrizi avatar Feb 18 '22 18:02 shawntabrizi

stub is included in paritytech/cumulus#1140 , still at this time not in a place I would consider user facing

nuke-web3 avatar Jun 25 '22 03:06 nuke-web3

this Audit Report on XCMv2 could be a really good reference for XCM documentation.

bernardoaraujor avatar Nov 19 '22 04:11 bernardoaraujor