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

Foreign assets creation via token reserve #3104

Open
wants to merge 41 commits into
base: master
Choose a base branch
from

Conversation

gonzamontiel
Copy link
Contributor

@gonzamontiel gonzamontiel commented Dec 13, 2024

What does it do?

  • Introduces a new origin ForeignAssetOwnerOrigin. It validates that the origin is an XCM location, that contains another location. This is useful to validate that a parachain can create or modify an asset only if it contains the asset. It's based on an implementation of xcm_simulator.
  • The allowed XCM origins are defined by LocationToAccountId
  • The above origin affects all extrinsics inside the moonbeam foreign assets pallet
  • create_foreign_asset now reserves a deposit from the caller (i.e. parachain sovereign accounts)
  • The deposit amount is configurable (ForeignAssetCreationDeposit) and can be changed with pallet_parameters
  • A new storage maps the asset creator, and the amount reserved at creation, by asset id. The creator is an enum that allows to be Governance (for old or migrated assets), and any account for new assets.

⚠️ Breaking Changes ⚠️

  • The extrinsics create_foreign_asset, change_xcm_location, freeze_foreign_asset, unfreeze_foreign_asset can only be called by an XCM origin
  • The account belonging to the caller of create_foreign_asset will need a deposit of funds that is configurable in the pallet.
  • The initial deposit values are:
    • Moonbase: 100 DEV
    • Moonriver: 1000 MOVR
    • Moonbeam: 10000 GLMR

Disclaimer: the pallet is not in use and the functionality wasn't exposed publicly AFAIK. The changes are still breaking, but most likely harmless.

TODO

  • Make deposit amount configurable (and changable with pallet parameters)
  • Modify foreign assets migration to add the old assets to the new storage
  • Add tests

What important points reviewers should know?

Some assumptions were made considering the current state of the pallet:

  • There are no foreign assets yet created in live chains
  • The AssetOwner was meant initially to be a descriptive enum of the possible sources of creation of an asset, but since there were no assets yet created, we only need to distinguish between migrated assets, and the ones created from now on (any account). Naming in this enum might be improved.
  • The Foreign assets migration was modified to mark the migrated assets in the storage and distinguish them from the newly created ones.

Is there something left for follow-up PRs?

What alternative implementations were considered?

Using Fungibles was investigated, but the implementation uses ReservableCurrency, following the same pattern as pallet assets.

Are there relevant PRs or issues in other repositories (Substrate, Polkadot, Frontier, Cumulus)?

We should run the migration added here #3020 after this PR is merged.

What value does it bring to the blockchain users?

It should be easier for Parachain teams to register their assets natively in Moonbeam

@gonzamontiel gonzamontiel changed the title Gonza/foreign assets via token lock Foreign assets creation via token reserve Dec 13, 2024
@gonzamontiel gonzamontiel added D9-needsaudit👮 PR contains changes to fund-managing logic that should be properly reviewed and externally audited breaking Needs to be mentioned in breaking changes B7-runtimenoteworthy Changes should be noted in any runtime-upgrade release notes D1-runtime-migration PR introduces code that might require downstream chains to run a runtime upgrade. and removed D1-runtime-migration PR introduces code that might require downstream chains to run a runtime upgrade. labels Dec 13, 2024
Copy link
Contributor

github-actions bot commented Dec 13, 2024

WASM runtime size check:

Compared to target branch

Moonbase runtime: 2280 KB (no changes) ✅

Moonbeam runtime: 2256 KB (no changes) ✅

Moonriver runtime: 2248 KB (no changes) ✅

Compared to latest release (runtime-3400)

Moonbase runtime: 2280 KB (+252 KB compared to latest release) ⚠️

Moonbeam runtime: 2256 KB (+244 KB compared to latest release) ⚠️

Moonriver runtime: 2248 KB (+236 KB compared to latest release) ⚠️

@gonzamontiel gonzamontiel marked this pull request as ready for review January 7, 2025 12:47
@gonzamontiel gonzamontiel marked this pull request as draft January 7, 2025 14:27
@gonzamontiel gonzamontiel requested a review from librelois January 8, 2025 04:06
Copy link
Contributor

@RomarQ RomarQ left a comment

Choose a reason for hiding this comment

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

I still need to get more context about this feature, will probably ping you later.

Added a few remarks for now.

pallets/moonbeam-foreign-assets/src/lib.rs Show resolved Hide resolved
pallets/moonbeam-foreign-assets/src/weights.rs Outdated Show resolved Hide resolved
test/helpers/assets.ts Outdated Show resolved Hide resolved
Comment on lines +331 to +337
AssetsCreationDetails::<T>::insert(
&asset_id,
AssetCreationDetails {
owner,
deposit: None,
},
);
Copy link
Contributor

Choose a reason for hiding this comment

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

How important is this storage for assets that were created with governance? Asking because the assets were already migrated on stagenet, and I do not see it being breaking if we don't fix the storage there.

Seems only important for assets created by normal accounts.

@RomarQ
Copy link
Contributor

RomarQ commented Jan 9, 2025

@albertov19, is it expected that the asset creation deposit will be reserved forever?

@albertov19
Copy link
Contributor

@albertov19, is it expected that the asset creation deposit will be reserved forever?

Yes, this is fine. @stiiifff and I discussed of initially rolling this feature enforcing origins to be another parachain

@RomarQ RomarQ marked this pull request as draft January 9, 2025 16:18
@gonzamontiel
Copy link
Contributor Author

The PR is ready to be reviewed, only tests are missing. I have updated the description to help reviewers and describe the changes.

@gonzamontiel gonzamontiel marked this pull request as ready for review January 14, 2025 01:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B7-runtimenoteworthy Changes should be noted in any runtime-upgrade release notes breaking Needs to be mentioned in breaking changes D9-needsaudit👮 PR contains changes to fund-managing logic that should be properly reviewed and externally audited
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants