xcm: Change TypeInfo::path to not include staging
#1948
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `xcm` crate was renamed to `staging-xcm` to be able to publish it to crates.io as someone as squatted `xcm`. The problem with this rename is that the `TypeInfo` includes the crate name which ultimately lands in the metadata. The metadata is consumed by downstream users like `polkadot-js` or people building on top of `polkadot-js`. These people are using the entire `path` to find the type in the type registry. Thus, their code would break as the type path would now be [`staging_xcm`, `VersionedXcm`] instead of [`xcm`, `VersionedXcm`]. This pull request fixes this by renaming the path segment `staging_xcm` to `xcm`. This requires: paritytech/scale-info#197
franciscoaguirre
approved these changes
Oct 19, 2023
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
KiChjang
approved these changes
Oct 19, 2023
|
The CI pipeline was cancelled due to failure one of the required jobs. |
acatangiu
approved these changes
Oct 20, 2023
lexnv
approved these changes
Oct 20, 2023
bkchr
requested review from
athei,
andresilva,
jsidorenko and
cheme
as code owners
|
does this means we should avoid using polkadot-sdk until this is merged? |
It will be merged in some minutes and we will backport it. |
acatangiu
pushed a commit
to acatangiu/polkadot-sdk
that referenced
this pull request
Oct 30, 2023
) The `xcm` crate was renamed to `staging-xcm` to be able to publish it to crates.io as someone as squatted `xcm`. The problem with this rename is that the `TypeInfo` includes the crate name which ultimately lands in the metadata. The metadata is consumed by downstream users like `polkadot-js` or people building on top of `polkadot-js`. These people are using the entire `path` to find the type in the type registry. Thus, their code would break as the type path would now be [`staging_xcm`, `VersionedXcm`] instead of [`xcm`, `VersionedXcm`]. This pull request fixes this by renaming the path segment `staging_xcm` to `xcm`. This requires: paritytech/scale-info#197 --------- Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Morganamilo
pushed a commit
that referenced
this pull request
Nov 14, 2023
The `xcm` crate was renamed to `staging-xcm` to be able to publish it to crates.io as someone as squatted `xcm`. The problem with this rename is that the `TypeInfo` includes the crate name which ultimately lands in the metadata. The metadata is consumed by downstream users like `polkadot-js` or people building on top of `polkadot-js`. These people are using the entire `path` to find the type in the type registry. Thus, their code would break as the type path would now be [`staging_xcm`, `VersionedXcm`] instead of [`xcm`, `VersionedXcm`]. This pull request fixes this by renaming the path segment `staging_xcm` to `xcm`. This requires: paritytech/scale-info#197 --------- Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
bgallois
pushed a commit
to duniter/duniter-polkadot-sdk
that referenced
this pull request
Mar 25, 2024
) The `xcm` crate was renamed to `staging-xcm` to be able to publish it to crates.io as someone as squatted `xcm`. The problem with this rename is that the `TypeInfo` includes the crate name which ultimately lands in the metadata. The metadata is consumed by downstream users like `polkadot-js` or people building on top of `polkadot-js`. These people are using the entire `path` to find the type in the type registry. Thus, their code would break as the type path would now be [`staging_xcm`, `VersionedXcm`] instead of [`xcm`, `VersionedXcm`]. This pull request fixes this by renaming the path segment `staging_xcm` to `xcm`. This requires: paritytech/scale-info#197 --------- Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
xcmcrate was renamed tostaging-xcmto be able to publish it to crates.io as someone as squattedxcm. The problem with this rename is that theTypeInfoincludes the crate name which ultimately lands in the metadata. The metadata is consumed by downstream users likepolkadot-jsor people building on top ofpolkadot-js. These people are using the entirepathto find the type in the type registry. Thus, their code would break as the type path would now be [staging_xcm,VersionedXcm] instead of [xcm,VersionedXcm]. This pull request fixes this by renaming the path segmentstaging_xcmtoxcm.This requires: paritytech/scale-info#197