getTokenSupply возвращает общее предложение для указанного минта SPL-токена. Это необходимо для определения общего количества созданных токенов.
Распространенные сценарии использования
- Отображение информации о токене: Отображение общего предложения токена в обозревателе или интерфейсе кошелька.
- Анализ токеномики: Определение максимального или текущего общего объема эмиссии токена.
- Проверка: Проверка предложения токена на основе данных самого аккаунта минта.
- Отслеживание изменений предложения: Если можно выпускать дополнительные токены, этот метод позволяет отслеживать изменение их общего предложения с течением времени. Однако для взаимозаменяемых токенов предложение обычно фиксировано или контролируется правом выпуска.
Параметры запроса
-
mintAddress(строка, обязательный): Публичный ключ минта токена в кодировке base-58, общее предложение которого требуется запросить. -
options(объект, необязательный): Необязательный объект конфигурации, который может содержать:commitment(строка, необязательный): Указывает уровень подтверждения для запроса (например,"finalized","confirmed","processed").
Структура ответа
Полеresult.value в ответе JSON-RPC представляет собой объект с подробными данными о предложении токена:
amount(строка): Общее предложение токена в наименьших единицах (исходное значение), представленное строкой. В этом значении не учтено количество знаков после десятичной запятой.decimals(u8): Количество знаков после десятичной запятой, заданное для этого минта токена. Это необходимо для преобразования исходного значенияamountв удобный для восприятия формат.uiAmount(число | null): Общее предложение токена в виде числа с плавающей точкой с учетом значенияdecimalsтокена. Это поле может иметь значение null или быть менее точным. Для отображения обычно рекомендуется использоватьuiAmountString.uiAmountString(строка): Общее предложение токена в виде строки с учетом значенияdecimalsтокена. Это наиболее удобное для пользователя представление общего предложения.
Примеры кода
Рекомендации для разработчиков
- Неизменяемое предложение (обычно): Для большинства SPL-токенов после выпуска общее предложение с точки зрения самого аккаунта минта остается фиксированным, если только у минта нет специального права выпуска, позволяющего создавать дополнительные токены или сжигать их. При этом сжигание обычно выполняется со счетов токенов, а не непосредственно из предложения минта.
decimals— ключевой параметр: Всегда используйте полеdecimals, чтобы правильно интерпретироватьamountилиuiAmountString.- Источник данных: Этот метод запрашивает информацию о предложении непосредственно из аккаунта минта.
getTokenSupply при запросе предложения SPL-токенов в Solana.