Scaled UI Amount -laajennuksen tukeminen Solanassa

Tausta

Scaled UI Amount -laajennus mahdollistaa token-liikkeeseenlaskijoille kertoimien määrittämisen, joita käytetään laskettaessa käyttäjän token-saldon käyttöliittymäsummaa. Tämä mahdollistaa liikkeeseenlaskijoille rebasing-tokenien luomisen ja asioiden kuten osakkeiden splittauksen. Tämä laajennus, kuten korkoa tuottava token-laajennus, tarjoaa puhtaasti kosmeettisen käyttöliittymäsumman, mikä tarkoittaa, että tiimien on tehtävä lisätyötä hyvän käyttökokemuksen tarjoamiseksi. Taustalla olevat laskelmat ja siirrot tapahtuvat kaikki käyttäen raakasummia ohjelmassa.

Resurssit:

• Kehittäjädokumentaatio
• Laajennuksen Rust-koodi
• Amount to UI Amount Rust-koodi

TL;DR

• Loppukäyttäjien tulisi olla vuorovaikutuksessa UIAmount-arvon (raakasumma * kerroin) kanssa token-hinnan, token-saldon ja token-summien osalta aina kun mahdollista
• dApp-sovellusten ja palveluntarjoajien tulisi käyttää raakasummaa ja skaalaamattomia hintoja kaikissa laskelmissa ja muuntaa ne käyttäjille vasta lopussa
• Historiallisia hintatietoja on tarjottava sekä skaalattuina että skaalaamattomina summina helpompaa integrointia varten
• Historiallisten kerrointen arvojen on oltava saatavilla tarkkoja historiallisia tietoja varten

Termien määritelmät

• Kerroin: staattinen päivitettävä kerroin, jota käytetään UI Amount -laskelmissa
• UIAmount: kerroin * raakasumma (tunnetaan myös nimellä: skaalattu summa)
• Raakasumma: summa (tunnetaan myös nimellä: skaalaamaton summa)

Nykyinen saldo

Nykyinen summa näytettäväksi

• Aina kun näytät loppukäyttäjille summia tokeneista, jotka käyttävät skaalattua käyttöliittymäsumma-laajennusta, sinun tulisi käyttää joko:
  • UIAmount/UIAmountString (suositeltu)
  • Manuaalista laskelmaa raakasumma * kerroin
  • Suosittelemme katkaisemaan tämän arvon tokenin desimaalien määrän perusteella.
    • Esim: jos yUSD:llä on 6 desimaalia ja käyttäjällä on UIAmount 1.123456789, sinun tulisi näyttää "1.123456"

Mistä tämä data saadaan:

• Käyttäjän reaaliaikaisen saldon päivitetyt tiedot yllä olevista määristä saat kutsumalla joko getTokenAccountBalance tai getAccountInfo -toimintoa
• Jos tarvitset tietää käyttöliittymämäärän (UI Amount) mielivaltaiselle määrälle, voit saada tämän laskelman kutsumalla amountToUiAmountForMintWithoutSimulation (web3.js v1) -funktiota tai simuloimalla transaktiota käyttäen amountToUiAmount-toimintoa.
  • Huomaa: amountToUiAmount vaatii transaktiosimulaation, mikä tarkoittaa, että se tarvitsee myös kelvollisen maksajan, jolla on saldo. Tämän vuoksi tätä ei pitäisi käyttää oletustapana saldon hakemiseen.

RPC-kutsut

• getTokenAccountBalance
  • Palauttaa token account -saldon ja mint-tiedot

$ curl http://localhost:8899 -s -X POST -H "Content-Type: application/json" -d '
{"jsonrpc": "2.0", "id": 1, "method": "getTokenAccountBalance", "params": ["2uuvxpnEKw52aTqNerHiQ3WeSqZriCMNVt8LhWfrkbPk"]}' | jq .

{
  "jsonrpc": "2.0",
  "result": {
    "context": {
      "apiVersion": "2.2.14",
      "slot": 381130751
    },
    "value": {
      "amount": "10000000",
      "decimals": 6,
      "uiAmount": 20.0,
      "uiAmountString": "20"
    }
  },
  "id": 1
}

• getAccountInfo
  • Palauttaa tilin tiedot ja mint-tiedot

$ curl http://localhost:8899 -s -X POST -H "Content-Type: application/json" -d '
{"jsonrpc": "2.0", "id": 1, "method": "getAccountInfo", "params": ["2uuvxpnEKw52aTqNerHiQ3WeSqZriCMNVt8LhWfrkbPk", {"encoding": "jsonParsed"}]}' | jq .

{
  "jsonrpc": "2.0",
  "result": {
    "context": {
      "apiVersion": "2.2.14",
      "slot": 381131001
    },
    "value": {
      "data": {
        "parsed": {
          "info": {
            "extensions": [
              {
                "extension": "immutableOwner"
              },
              {
                "extension": "pausableAccount"
              }
            ],
            "isNative": false,
            "mint": "BZCd6HfTbb5ZYJ8hQsm8282tG4QzLyeqFR6tdgQA9EAG",
            "owner": "G7ARQSUCwNrfvTDUCZvM5xdiRdBJiN3qVw2PryD8Wnib",
            "state": "initialized",
            "tokenAmount": {
              "amount": "10000000",
              "decimals": 6,
              "uiAmount": 20.0,
              "uiAmountString": "20"
            }
          },
          "type": "account"
        },
        "program": "spl-token-2022",
        "space": 174
      },
      "executable": false,
      "lamports": 2101920,
      "owner": "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb",
      "rentEpoch": 18446744073709551615,
      "space": 174
    }
  },
  "id": 1
}

Nykyisen määrän päivittäminen

Koska liikkeeseenlaskijat voivat päivittää kerrointa milloin tahansa, voit harkita ajoittaista kyselyä tilin saldon päivittämiseksi. Liikkeeseenlaskijat tuskin päivittävät tätä kerrointa useammin kuin kerran päivässä. Jos kerroin on asetettu tulevalle päivämäärälle, voit automaattisesti tehdä kyselyn tänä päivitysajankohtana

Token-määrät transaktioissa (siirrot / vaihdot jne.)

• Käyttäjien tulisi syöttää määrät, jotka tulkitaan skaalatuksi "UIAmount"-arvoksi. Sovelluksen, joka käsittelee tätä, tulisi muuntaa se raakatokenmääräksi transaktiota varten.
  • Jos pyöristysongelmia ilmenee, pyöristä alaspäin ja jätä mieluummin pieni määrä pölyä kuin riskeeraa transaktion epäonnistuminen
  • Tämän muunnoksen tekemiseen voit käyttää uiAmountToAmountForMintWithoutSimulation (web3.js v1) -funktiota tai simuloida transaktiota käyttäen amountToUiAmount-toimintoa.

import { uiAmountToAmountForMintWithoutSimulation } from "@solana/web3.js";
import { Connection, PublicKey, clusterApiUrl } from "@solana/web3.js";

const connection = new Connection(clusterApiUrl("devnet"), "confirmed");
const mint = new PublicKey("BZCd6HfTbb5ZYJ8hQsm8282tG4QzLyeqFR6tdgQA9EAG");
const uiAmount = "20.2";

const rawAmount = await uiAmountToAmountForMintWithoutSimulation(
  connection as unknown as Connection,
  mint,
  uiAmount
);
console.log("Raw Amount:", rawAmount);
/* Raw Amount: 20200000 */

• Sovellusten tulisi käyttää kokonaisraakamäärää, kun käyttäjä pyytää toimintoa "maksimi" tai "kaikki" saldostaan. Tämä varmistaa, ettei jäljelle jää pölyä.
  • Valinnainen: Voit harkita tilin automaattista sulkemista, kun "maksimi" käytetään palauttamaan käyttäjälle heidän talletuksensa

Tokenin hinta

• Tokenin hinta tulisi aina näyttää skaalattuna hintana aina kun mahdollista.
• Jos olet hintatietopalvelun tarjoaja, kuten oraakkeli, sinun tulisi tarjota sekä skaalattu että skaalaamaton hinta.
  • Tarjoa mahdollisuuksien mukaan SDK/API, joka abstrahoi skaalatun käyttöliittymämäärän laajennuksen monimutkaisuudet pois.

Nykyinen kerroin

• Nykyinen kerroin voidaan lukea token-mintistä milloin tahansa kutsumalla getAccountInfo. Lisäksi, jos tuleva kerroin on asetettu, tämä tieto on myös saatavilla token-mintistä. Suosittelemme, ettei tätä kerrointa näytetä, sillä se voi sekoittaa käyttökokemusta.

import { address, createSolanaRpc } from "@solana/kit";

const rpc_url = "https://api.devnet.solana.com";
const rpc = createSolanaRpc(rpc_url);

const publicKey = address("BZCd6HfTbb5ZYJ8hQsm8282tG4QzLyeqFR6tdgQA9EAG");
const accountInfo = await rpc
  .getAccountInfo(publicKey, { encoding: "jsonParsed" })
  .send();

const mintData = accountInfo.value?.data as Readonly<{
  parsed: {
    info?: {
      extensions: {
        extension: string;
        state: object;
      }[];
    };
    type: string;
  };
  program: string;
  space: bigint;
}>;

const scaledUiAmountConfig = mintData.parsed.info?.extensions?.find(
  (extension) => extension.extension === "scaledUiAmountConfig"
) as Readonly<{
  state: {
    newMultiplierEffectiveTimestamp: number;
    newMultiplier: number;
    multiplier: number;
  };
}>;

const currentMultiplier =
  scaledUiAmountConfig?.state &&
  Date.now() / 1000 >=
    scaledUiAmountConfig.state.newMultiplierEffectiveTimestamp
    ? scaledUiAmountConfig.state.newMultiplier
    : scaledUiAmountConfig.state.multiplier;

console.log("Scaled UI Amount Config:", scaledUiAmountConfig);
console.log("Current Multiplier:", currentMultiplier);
/*
Scaled UI Amount Config: {
  extension: 'scaledUiAmountConfig',
  state: {
    authority: 'G7ARQSUCwNrfvTDUCZvM5xdiRdBJiN3qVw2PryD8Wnib',
    multiplier: '2',
    newMultiplier: '2',
    newMultiplierEffectiveTimestamp: 1743000000n
  }
}
Current Multiplier: 2
*/

Historialliset tiedot

Historialliset tiedot hintatiedoille

• Palveluiden, jotka tarjoavat historiallista dataa, tulisi tallentaa ja näyttää sekä skaalatut että skaalaamattomat hinnat skaalattua käyttöliittymän määrälaajennusta varten.
• Odotamme, että skaalattuja määriä käytetään useimmiten, sillä tämä vastaa sitä, miten perinteinen rahoitusmaailma käsittelee tokeneihin liittyviä kaavioita osakkeiden splitin yhteydessä.
• Kerroinpäivitykset voivat sisältää aikaleiman, joka on menneisyydessä. Suosittelemme lohkon aikaleiman käyttöä historiallisessa datassa.
• Huomaa, että aktiivinen kerroin voi olla joko "multiplier" tai "newMultiplier" riippuen nykyisestä aikaleimauksesta ja siitä, milloin uuden kertoimen on määrä aktivoitua.

Historialliset tiedot määrille

• Jos haluat näyttää aiemmin siirretyn saldon, tarvitset pääsyn kertoimeen kyseisessä slotissa. Voit myös tallentaa UiAmount-arvon siirroille käsitellessäsi transaktioita välttääksesi tämän laskutoimituksen tulevaisuudessa.

Taaksepäin yhteensopivuus

• Oletusarvoisesti lompakot ja sovellukset, jotka eivät ymmärrä skaalattua UI-määrän laajennusta, näyttävät toiminnon oikean kokonaishinnan kertomalla skaalaamattoman hinnan * raakamäärän.
• Ne kuitenkin näyttäisivät skaalaamattoman hinnan, mikä voi aiheuttaa käyttäjille hämmennystä.
• Toivomme tämän kannustavan tiimejä päivittämään dappinsa yhteensopiviksi sellaisten tokenien kanssa, jotka käyttävät skaalattua UI-määrän laajennusta, ja autamme mielellämme tässä prosessissa.

Suositellut integraatioprioriteetit alustoittain

Yleiset vaatimukset

Lompakot

Tutkijat

Markkinadatan kokoajat (Esim: CoinGecko, Birdeye)

Hintasyötteiden tarjoajat

DEXit

CEXit