Integrationsanleitung für skalierte UI-Beträge
Unterstützung der Scaled UI Amount-Erweiterung auf Solana
Hintergrund
Die Scaled UI Amount-Erweiterung ermöglicht es Token-Emittenten, einen Multiplikator festzulegen, der bei der Berechnung des UI-Betrags des Token-Guthabens eines Benutzers verwendet wird. Dies ermöglicht Emittenten, Rebasing-Token zu erstellen und Dinge wie Aktiensplits zu ermöglichen. Diese Erweiterung bietet, ähnlich wie die Interest Bearing Token-Erweiterung, einen rein kosmetischen UI-Betrag, was bedeutet, dass Teams zusätzliche Arbeit leisten müssen, um eine gute Benutzererfahrung zu bieten. Zugrundeliegende Berechnungen und Überweisungen erfolgen alle mit den Rohbeträgen im Programm.
Ressourcen:
Zusammenfassung
- Endbenutzer sollten wann immer möglich mit dem UIAmount (Rohbetrag * Multiplikator) für den Token-Preis, Token-Guthaben und Token-Beträge interagieren
- dApps und Dienstanbieter sollten für alle Berechnungen den Rohbetrag und nicht-skalierte Preise verwenden und diese nur an der Schnittstelle zum Benutzer umrechnen
- Historische Preisfeeds müssen sowohl für skalierte als auch für nicht-skalierte Beträge bereitgestellt werden, um die Integration zu erleichtern
- Historische Multiplikatorwerte müssen zugänglich sein, um genaue historische Daten zu gewährleisten
Begriffsdefinitionen
- Multiplikator: statischer, aktualisierbarer Multiplikator, der für UI-Betragsberechnungen verwendet wird
- UIAmount: Multiplikator * Rohbetrag (auch bekannt als: skalierter Betrag)
- Rohbetrag: Betrag (auch bekannt als: nicht-skalierter Betrag)
Aktuelles Guthaben
Aktueller Betrag zur Anzeige
- Wann immer Sie Beträge für Token anzeigen, die die Scaled UI
Amount-Erweiterung verwenden, sollten Sie für Endbenutzer entweder Folgendes
verwenden:
- UIAmount/UIAmountString (bevorzugt)
- Eine manuelle Berechnung von Rohbetrag * Multiplikator
- Wir empfehlen, diesen Wert basierend auf der Anzahl der Dezimalstellen des
Tokens zu kürzen.
- Beispiel: Wenn yUSD 6 Dezimalstellen hat und ein Benutzer einen UIAmount von 1,123456789 hat, sollten Sie "1,123456" anzeigen
Woher diese Daten beziehen:
- Für das aktuelle Guthaben eines Nutzers können Sie aktualisierte Informationen zu den oben genannten Beträgen durch Aufruf von entweder getTokenAccountBalance oder getAccountInfo erhalten
- Wenn Sie den UI-Betrag für einen beliebigen Betrag benötigen, können Sie diese
Berechnung durch Aufruf der
amountToUiAmountForMintWithoutSimulation
(web3.js v1) Funktion oder durch Simulation einer Transaktion mit amountToUiAmount erhalten.- Hinweis: amountToUiAmount erfordert eine Transaktionssimulation, was bedeutet, dass es auch einen gültigen Gebührenzahler mit Guthaben benötigt. Aus diesem Grund sollte dies nicht der Standardweg sein, um ein Guthaben abzurufen.
Aktualisierung des aktuellen Betrags
Da Emittenten den Multiplikator jederzeit aktualisieren können, sollten Sie in Betracht ziehen, gelegentlich abzufragen, um den Kontostand aktuell zu halten. Emittenten werden diesen Multiplikator wahrscheinlich nicht öfter als einmal pro Tag aktualisieren. Wenn ein Multiplikator für ein zukünftiges Datum festgelegt ist, können Sie zu diesem Aktualisierungszeitpunkt automatisch abfragen
Token-Beträge in Transaktionen (Überweisungen / Swaps usw.)
- Nutzer sollten Beträge eingeben, die als skalierter "UIAmount" interpretiert
werden. Die App, die dies verarbeiten muss, sollte in den rohen Token-Betrag
für die Transaktion umrechnen.
- Bei Rundungsproblemen sollte abgerundet werden und es ist besser, einen winzigen Betrag als Staub zu hinterlassen, als zu riskieren, dass die Transaktion fehlschlägt
- Für diese Umrechnung können Sie die
uiAmountToAmountForMintWithoutSimulation
(web3.js v1) Funktion verwenden oder eine Transaktion mit amountToUiAmount simulieren.
- Apps sollten den gesamten Rohbetrag verwenden, wenn ein Nutzer eine Aktion mit
"max" oder "all" seines Guthabens anfordert. Dies stellt sicher, dass kein
Staub übrig bleibt.
- Optional: Sie können in Betracht ziehen, ein Konto automatisch zu schließen, wenn "max" verwendet wird, um dem Nutzer seine Speichereinlage zurückzuerstatten
Token-Preis
- Der Token-Preis sollte, wo immer möglich, als skalierter Preis angezeigt werden.
- Wenn Sie ein Preisfeed-Dienstanbieter sind, wie beispielsweise ein Oracle,
sollten Sie sowohl den skalierten als auch den nicht-skalierten Preis
bereitstellen.
- Bieten Sie nach Möglichkeit ein SDK/API an, das die Komplexitäten der skalierten UI-Betrags- erweiterung abstrahiert.
Aktueller Multiplikator
- Der aktuelle Multiplikator kann jederzeit aus dem Token-Mint abgerufen werden,
indem
getAccountInfo
aufgerufen wird. Wenn ein zukünftiger Multiplikator festgelegt ist, ist diese Information ebenfalls aus dem Token-Mint verfügbar. Wir empfehlen, diesen Multiplikator nicht anzuzeigen, da er die Benutzerführung verwirren kann.
Historische Daten
Historische Daten für Preisfeed
- Dienste, die historische Daten bereitstellen, sollten sowohl die skalierten als auch die nicht-skalierten Preise für die skalierte UI-Betragserweiterung speichern und anzeigen.
- Wir erwarten, dass skalierte Beträge am häufigsten verwendet werden, da dies der Art entspricht, wie die traditionelle Finanzwelt mit Diagrammen zu Tokens mit Aktiensplits umgeht.
Historische Daten für Beträge
- Wenn Sie den in der Vergangenheit übertragenen Saldo anzeigen möchten, benötigen Sie Zugriff auf den Multiplikator zu diesem bestimmten slot. Sie können auch den UiAmount für Überweisungen speichern, während Sie Transaktionen verarbeiten, um diese Berechnung in der Zukunft zu vermeiden.
Rückwärtskompatibilität
- Standardmäßig zeigen Wallets und Anwendungen, die die skalierte UI-Betragserweiterung nicht verstehen, den korrekten Gesamtpreis einer Aktivität an, indem sie den nicht-skalierten Preis * Rohbetrag multiplizieren.
- Sie würden jedoch den nicht-skalierten Preis anzeigen, was zu Benutzerverwirrung führen könnte.
- Wir hoffen, dass dies Teams dazu ermutigt, ihre dApps zu aktualisieren, um mit Tokens kompatibel zu sein, die die skalierte UI-Betragserweiterung verwenden, und wir bieten gerne Unterstützung während dieses Prozesses an.
Empfohlene Integrationsprioritäten pro Plattform
Allgemeine Anforderungen
Anforderung | Beschreibung | Priorität |
---|---|---|
Unterstützung von Benutzeraktionen mit UiAmount | Alle Benutzeraktionen sollten in UiAmount eingegeben werden, wenn UiAmount in der gesamten App aktiviert ist. Wenn UiAmount in der App nicht sichtbar ist, sollten Rohbeträge verwendet werden, bis die App aktualisiert wird. | P0 |
Wallets
Anforderung | Beschreibung | Priorität |
---|---|---|
Skalierte Guthaben anzeigen | Zeigen Sie den skalierten Betrag (uiAmount) als primäres Guthaben an. | P0 |
Unterstützung für Token-Transfers | Endbenutzer sollten Überweisungsbeträge mit ihren skalierten Guthaben eingeben (Rohbetrag * Guthaben). | P0 |
Spot-Preis anzeigen | Zeigen Sie den skalierten Spot-Preis für Benutzer an | P0 |
Transaktionsverlauf-Metadaten | Zeigen Sie den skalierten Betrag (UIAmount) für jede Überweisung an, wo immer möglich. | P1 |
Multiplikator-Updates im Transaktionsverlauf anzeigen | Wenn Multiplikator-Updates auftreten, zeigen Sie dies als Ereignis im Transaktionsverlauf des Benutzers an, einschließlich des gewonnenen Betrags | P2 |
Preisverlaufsgrafik anzeigen | Die skalierten Preise in der Preisgrafik widerspiegeln | P1 |
Onboarding/Tooltips | Bieten Sie Tooltips oder Onboarding an, um Benutzer über Tokens zu informieren, die die skalierte UI-Amount-Erweiterung verwenden | P2 |
Explorers
Anforderung | Beschreibung | Priorität |
---|---|---|
Verbesserungen der Token-Detailseite | Metadaten wie skalierte Marktkapitalisierung und aktuellen Multiplikator anzeigen | P0 |
Skalierte Guthaben für Kontostände anzeigen | Skalierte Guthaben (UiAmount) für aktuelle Kontostände anzeigen. | P0 |
Skalierte Guthaben für Transaktionen anzeigen | Skalierte Guthaben (UiAmount) für Überweisungsbeträge bei historischen Transaktionen anzeigen. | P0 |
Skalierten Preis für Transaktionen anzeigen | Skalierte Preise für frühere Transaktionen anzeigen | P1 |
Multiplikator-Update-Transaktionen korrekt analysieren und anzeigen | Details zum Multiplikator-Update korrekt anzeigen | P2 |
Marktdaten-Aggregatoren (z.B.: CoinGecko)
Anforderung | Beschreibung | Priorität |
---|---|---|
API-Updates für skalierte Daten | Erweiterung der API-Funktionalität, um Multiplikatoränderungen im Zeitverlauf sowie den skalierten Preisfeed einzubeziehen. | P0 |
Gesamtangebot mit skalierter Anpassung | Bei der Anzeige des Gesamtangebots und der Gesamtmarktkapitalisierung die skalierten Salden berücksichtigen | P0 |
Historische Preisverfolgung | Bereitstellung eines historischen Diagramms der Preise unter Verwendung des skalierten Preises im Zeitverlauf. | P1 |
Historische Multiplikatorverfolgung | Bereitstellung historischer Marker für Multiplikator-Updates für zinstragende Token. | P2 |
Bildungsinhalte oder Erklärungen | Kurze Beschreibungen oder Tooltips einfügen, die erklären, wie skalierte Token funktionieren. | P2 |
Preisfeed-Anbieter
Anforderung | Beschreibung | Priorität |
---|---|---|
Skalierte & nicht-skalierte Preisfeeds | Bereitstellung von Preisfeeds für sowohl skalierte als auch nicht-skalierte Preise. | P0 |
Historische Multiplikatordaten | Angebot von APIs mit historischen Multiplikatoränderungen. | P0 |
Historische Preisdaten | Angebot von APIs mit historischen Preisen basierend auf skalierten und nicht-skalierten Beträgen. | P0 |
DEXes
Anforderung | Beschreibung | Priorität |
---|---|---|
Anzeige von rebasierten Token-Salden | Anzeige skalierter Salden für Handel oder Liquiditätsbereitstellung in der UI. (Backend kann weiterhin Rohbeträge verwenden) | P0 |
Unterstützung für Token-Aktionen | Endbenutzer sollten Aktionsbeträge mit ihren UiAmount-Salden eingeben (Multiplikator × Rohbetrag). | P0 |
Preisfeed-Anpassung | Überall, wo ein Preisfeed zur Anzeige des aktuellen Preises verwendet wird, den skalierten Preis für Endbenutzer bereitstellen. | P1 |
Anzeige des Preisverlaufsdiagramms | Die skalierten Preise im Preisdiagramm widerspiegeln | P1 |
Is this page helpful?