docs: add currency field guidance for non-vanilla stablecoins and crypto-native assets#367
Open
docs: add currency field guidance for non-vanilla stablecoins and crypto-native assets#367
Conversation
…native assets Add prominent warnings across three docs pages explaining how to set the currency field for yield-bearing stablecoins (sUSDe, BUIDL, USDs) and crypto-native assets (cbBTC, WETH). This is the most common deployment mistake — 5+ issuers have had to redeploy tokens due to incorrect values. Changes: - protocol/tip20/overview.mdx: new danger callout with examples table - protocol/tip20/spec.mdx: danger callout in Currencies and Quote Tokens - guide/issuance/create-a-stablecoin.mdx: upgraded warning to danger with explicit yield-bearing and crypto-native examples Amp-Thread-ID: https://ampcode.com/threads/T-019de3a3-77f7-7532-9e5a-da789d870d1c Co-authored-by: Amp <amp@ampcode.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…er as currency Per feedback — sUSDe, BUIDL, USDs, cbBTC, WETH etc. should all use their own ticker as the currency field, not ISO 4217 codes. Only vanilla 1:1 fiat-pegged stablecoins use ISO codes. Amp-Thread-ID: https://ampcode.com/threads/T-019de3a3-77f7-7532-9e5a-da789d870d1c Co-authored-by: Amp <amp@ampcode.com>
decofe
force-pushed
the
docs/currency-field-guidance
branch
from
6d8e03d to
8cf303b
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The
currencyfield on TIP-20 tokens is immutable after deployment. Asset issuers are repeatedly misconfiguring it for non-vanilla stablecoins (sUSDe, BUIDL, USDs) and crypto-native assets (cbBTC, WETH) — 5+ issuers have had to redeploy their tokens due to this mistake.Changes
Adds prominent
:::dangercallouts with concrete examples across the three docs pages asset issuers encounter:protocol/tip20/overview.mdx(Currency Declaration section) — full examples table covering yield-bearing stables, tokenized treasuries, and crypto-native assets with correct vs incorrectcurrencyvalues and a rule-of-thumb.protocol/tip20/spec.mdx(Currencies and Quote Tokens section) — concise danger callout with bullet guidance for each asset category.guide/issuance/create-a-stablecoin.mdx— upgraded the existing warning to a danger callout with explicit yield-bearing and crypto-native examples, plus a link back to the full reference.Key guidance
currency: "USD"— yield mechanics don't change the denomination"BTC","ETH") — not"USD"cc @samczsun