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

New XC Asset Registration Process #1013

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

Conversation

themacexpert
Copy link
Contributor

Description

Adds Documentation on the New XC Asset Registration process, which has two main components: evmForeignAssets.createForeignAsset and xcmWeightTrader.addAsset. This guide also goes into how you can programmatically submit the preimage hash and the proposal to take these actions.

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@themacexpert themacexpert added the A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) label Oct 23, 2024
Copy link
Collaborator

@albertov19 albertov19 left a comment

Choose a reason for hiding this comment

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

I think we are on the right track, but tbh I would take this opportunity to simplify a bi this page:

  • Remove all the sections about submitting the stuff and just point them to our page of how to generate a preimage and submit a proposal
  • Make steps a bit more straight to the point and remove a bit some repetitive ideas, the entire section feels a bit "wordy" (too many words
  • We should make changes to xcm-tools so that they can use it to generate the calls, instead of using the snippets that you created
  • We need to also understand how to get the relative price, what does it mean, so that we can explain it better and modify xcm-tools accordingly

@themacexpert
Copy link
Contributor Author

I think we are on the right track, but tbh I would take this opportunity to simplify a bi this page:

  • Remove all the sections about submitting the stuff and just point them to our page of how to generate a preimage and submit a proposal
  • Make steps a bit more straight to the point and remove a bit some repetitive ideas, the entire section feels a bit "wordy" (too many words
  • We should make changes to xcm-tools so that they can use it to generate the calls, instead of using the snippets that you created
  • We need to also understand how to get the relative price, what does it mean, so that we can explain it better and modify xcm-tools accordingly

This is ready for another look! I've addressed everything but bullet point #3 and created a jira to add that to XCM tools.

@themacexpert themacexpert added the B0 - Needs Review Pull request is ready for review label Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) B0 - Needs Review Pull request is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants