Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Create a README for XCMv1 detailing notable changes #4058

Merged
10 commits merged into from
Oct 13, 2021
Merged

Conversation

KiChjang
Copy link
Contributor

In order to prevent something similar to #4056 happening, I've created a README file to document the notable changes that XCM authors should be aware of when they're upgrading from v0.

A README for XCMv2 changes will follow in another PR.

@KiChjang KiChjang added A0-please_review Pull request needs code review. B1-releasenotes C1-low PR touches the given topic and has a low impact on builders. D2-notlive 💤 PR contains changes in a runtime directory that is not deployed to a chain that requires an audit. labels Oct 12, 2021
xcm/src/v1/README.md Outdated Show resolved Hide resolved
xcm/src/v1/README.md Outdated Show resolved Hide resolved
xcm/src/v1/README.md Outdated Show resolved Hide resolved
xcm/src/v1/README.md Outdated Show resolved Hide resolved
xcm/src/v1/README.md Outdated Show resolved Hide resolved
@apopiak
Copy link
Contributor

apopiak commented Oct 12, 2021

Do we want to add this to the module level rust docs as well?


### Order
- `v1::Order::DepositAsset` and `v1::Order::DepositReserveAsset` both introduced a new `max_asset` field that limits the maximum classes of assets that can be deposited. During conversion from v0, the `max_asset` field defaults to 1.
- v1 Orders that contain `MultiAsset` as argument(s) will need to explicitly specify the amount and details of assets. This is to prevent accidental misuse of `All` to possibly transfer, spend or otherwise perform unintended operations on `All` assets.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- v1 Orders that contain `MultiAsset` as argument(s) will need to explicitly specify the amount and details of assets. This is to prevent accidental misuse of `All` to possibly transfer, spend or otherwise perform unintended operations on `All` assets.
- v1 Orders that contain `MultiAsset`(s) as argument(s) will need to explicitly specify the amount and details of assets. This is to prevent accidental misuse of `All` to possibly transfer, spend or otherwise perform unintended operations on `All` assets.

@KiChjang
Copy link
Contributor Author

bot merge

@ghost
Copy link

ghost commented Oct 13, 2021

Trying merge.

@ghost ghost merged commit 2ebabce into master Oct 13, 2021
@ghost ghost deleted the kckyeung/xcm-v1-readme branch October 13, 2021 11:17
ordian added a commit that referenced this pull request Oct 14, 2021
* master: (40 commits)
  use pipeline-scripts for dependent projects script (#4017)
  companion for substrate/10013 (#4078)
  fix restart issue of staking miner (#4073)
  use `WEIGHT_PER_SECOND` (#4077)
  Switch to compressed runtimes (#4061)
  Create a README for XCMv1 detailing notable changes (#4058)
  Bump proc-macro2 from 1.0.29 to 1.0.30 (#4071)
  Move runtime to with_transaction in order to Rollback state changes (#4067)
  Update wasmtime config to match new version in substrate (#4063)
  Fix XCM Weights on Westend (#4066)
  Dispatchable XCMs should translate to v0 (#4062)
  Add xcm fuzzer (#3869)
  Bump trybuild from 1.0.49 to 1.0.50 (#4060)
  Companion PR for ss58 crate (#3953)
  overseer: simplify debugging some more (#4053)
  Bump thiserror from 1.0.29 to 1.0.30 (#4048)
  Bump strum from 0.21.0 to 0.22.0 (#4047)
  Add para pallets to polkadot benchmarks (#4045)
  Fixes broken docker link in docker descriptiob (#4043)
  Bump trybuild from 1.0.48 to 1.0.49 (#4039)
  ...
ordian added a commit that referenced this pull request Oct 14, 2021
…lkadot

* master:
  use pipeline-scripts for dependent projects script (#4017)
  companion for substrate/10013 (#4078)
  fix restart issue of staking miner (#4073)
  use `WEIGHT_PER_SECOND` (#4077)
  Switch to compressed runtimes (#4061)
  Create a README for XCMv1 detailing notable changes (#4058)
  Bump proc-macro2 from 1.0.29 to 1.0.30 (#4071)
emostov pushed a commit that referenced this pull request Nov 1, 2021
* Create a README for XCMv1 detailing notable changes

* Update xcm/src/v1/README.md

Co-authored-by: Gavin Wood <[email protected]>

* Update xcm/src/v1/README.md

Co-authored-by: David <[email protected]>

* Update xcm/src/v1/README.md

Co-authored-by: David <[email protected]>

* Update xcm/src/v1/README.md

Co-authored-by: David <[email protected]>

* Update xcm/src/v1/README.md

Co-authored-by: David <[email protected]>

* Link to relevant PR for a full list of changes

* Typo

* Add notable changes to top-level XCM rustdoc

* Appease spellchecker

Co-authored-by: Gavin Wood <[email protected]>
Co-authored-by: David <[email protected]>
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. C1-low PR touches the given topic and has a low impact on builders. D2-notlive 💤 PR contains changes in a runtime directory that is not deployed to a chain that requires an audit.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants