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

RFC: Universal Asset Notation #335

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

Conversation

janx
Copy link
Member

@janx janx commented Apr 23, 2022

@janx janx requested a review from a team as a code owner April 23, 2022 13:40
@janx janx requested a review from xxuejie April 23, 2022 13:40
@janx janx mentioned this pull request Apr 23, 2022
13 tasks
- `<chain-symbol>` is a lower-case abbreviation of the source chain where the asset resided before came through the path, e.g. `eth` for the Ethereum chain, `ckb` for the CKB chain. Note the source chain may be different from the issuance chain of the asset.
- `<bridge-symbol>` is a lower-case abbreviation of the bridge through which the asset came, e.g. `fb` for assets moved by Forcebridge.

Examples:
Copy link
Member

Choose a reason for hiding this comment

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

The method of translating | to via and . to from helps readers to understand the notation and read the symbol in human language. I think it worths a section here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Could you suggest the change with a PR?

e00dan
e00dan previously approved these changes May 5, 2022
…on.md

Co-authored-by: Flouse <flouse@gmail.com>
…on.md

Co-authored-by: Flouse <flouse@gmail.com>
…on.md

Co-authored-by: Flouse <flouse@gmail.com>
- `<path>` is a pair of bridge symbol and chain symbol, connected by a single dot `.`.
- `<asset-symbol>` is a upper-case abbreviation of the asset, e.g. `BTC` for bitcoin, `CKB` for CKByte.
- `<chain-symbol>` is a lower-case abbreviation of the source chain where the asset resided before came through the path, e.g. `eth` for the Ethereum chain, `ckb` for the CKB chain. Note the source chain may be different from the issuance chain of the asset.
- `<bridge-symbol>` is a lower-case abbreviation of the bridge through which the asset came, e.g. `fb` for assets moved by Forcebridge.
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe "Forcebridge" should be written as "Force Bridge"

- `<asset>` is the first component of UAN. It is a pair of `<asset-symbol>` and `<chain-symbol>` connected by a dot `.`, e.g. `BTC.ckb` for bitcoin resides on the CKB chain, `CKB.gw` for CKByte resides on the Godwoken chain.
- `<route>` is the route through which the asset come to Nervos Network, it's the second component of UAN. `<route>` is only required when the asset's chain of residence is different from its chain of issuance. `<route>` may consist of one or many `<path>`. If it's a multi-paths route, all paths are connected by `|`.
- `<path>` is a pair of bridge symbol and chain symbol, connected by a single dot `.`.
- `<asset-symbol>` is a upper-case abbreviation of the asset, e.g. `BTC` for bitcoin, `CKB` for CKByte.
Copy link
Contributor

Choose a reason for hiding this comment

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

The asset symbol should not be case restricted, since some ERC20 do have a lowercase symbol, like stETH (staked ETH), and some wrapped tokens, like wETH, wMANA

Keith-CY added a commit to Magickbase/godwoken_explorer that referenced this pull request Jul 5, 2022
1. use display name instead of token name
2. use uan instead of symbol

Ref: nervosnetwork/rfcs#335

```
// CKByte on the CKB chain
CKB.ckb
Copy link
Contributor

Choose a reason for hiding this comment

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

So CKB in CKB DApps should be renamed to CKB.ckb? or we can make a convention that <asset-symbol> without any annotation indicates that it is born on the current chain backing the DApp.

@Keith-CY
Copy link
Contributor

Keith-CY commented Jul 7, 2022

Officially confirmed abbreviation could be appended in the RFC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants