Программа Rewards распределяет токены из хранилища, принадлежащего программе, среди набора получателей, у каждого из которых свой график вестинга. Authority пополняет хранилище и определяет, кто и что получает. Получатели со временем забирают свои вестнутые токены, а authority может отозвать получателей или вернуть оставшиеся токены, если распределение это допускает. Программа написана на Pinocchio, поддерживается Solana Foundation и работает с минтами как SPL Token, так и Token-2022, за исключением минтов Token-2022 с расширением transfer hook.
ID программы (mainnet и devnet):
REWArDioXgQJ2fZKkfu9LCLjQfRwYWVVfsvcsR5hoXi
Программа прошла аудит OtterSec. Коммит, до которого проведён аудит, указан в AUDIT_STATUS.md.
Выберите тип распределения
Программа поддерживает два типа распределения. Оба используют одни и те же графики вестинга и режимы отзыва.
| Прямое | Merkle | |
|---|---|---|
| Как это работает | Создаёт ончейн-аккаунт для каждого получателя | Хранит ончейн единственный корень Merkle; для получения токенов получатели предоставляют доказательства |
| Первоначальные затраты | Плательщик оплачивает rent для аккаунта каждого получателя | Аккаунты для каждого получателя не создаются, пока кто-то не заберёт токены |
| Масштаб | Практично до нескольких тысяч получателей | Масштабируется до миллионов получателей; объём хранимых данных растёт только по мере получения токенов |
| Изменяемость | Получателей можно добавлять после создания | Набор получателей фиксируется при создании |
| Для чего подходит | Небольшие распределения, которые меняются со временем | Крупные фиксированные распределения, например эйрдропы |
Графики вестинга
У каждой аллокации один из четырёх графиков. Временные метки указываются в секундах Unix.
| График | Поведение |
|---|---|
Immediate | Все токены доступны для получения сразу |
Linear | Токены разблокируются пропорционально между startTs и endTs |
Cliff | Ничего не разблокируется до cliffTs, затем всё разблокируется сразу |
CliffLinear | Линейный вестинг от startTs до endTs, при этом ничего нельзя забрать до cliffTs; ранее накопленное разблокируется в момент клиффа |
Аккаунты
| Аккаунт | PDA seeds | Хранит |
|---|---|---|
DirectDistribution | ["direct_distribution", mint, authority, seed] | Authority, минт и суммарные объёмы аллокаций |
DirectRecipient | ["direct_recipient", distribution, recipient] | Аллокация и вестинг одного получателя |
MerkleDistribution | ["merkle_distribution", mint, authority, seed] | Authority, минт, суммарные объёмы и корень Merkle |
MerkleClaim | ["merkle_claim", distribution, claimant] | Сумма, уже полученная одним claimant |
Revocation | ["revocation", distribution, user] | Маркер, блокирующий отозванного claimant в Merkle-распределении |
seed — это адрес дополнительного подписанта, передаваемый при создании, благодаря чему один
authority может запускать несколько распределений для одного и того же минта. Хранилище каждого
распределения — это associated token account для PDA распределения и его минта.
Инструкции
Прямое распределение
- Authority вызывает
CreateDirectDistribution, чтобы создать PDA распределения и его хранилище. - Authority вызывает
AddDirectRecipientодин раз для каждого получателя, указывая сумму и график вестинга. Каждый вызов переводит эту сумму из token account authority в хранилище. - Получатели вызывают
ClaimDirect, чтобы вывести вестнутые токены. Передайтеamount: 0, чтобы забрать всё, что на данный момент вестнуто. - Когда получатель забрал всё или распределение закрыто,
CloseDirectRecipientзакрывает аккаунт получателя и возвращает rent тому аккаунту, который за него заплатил. - Authority вызывает
CloseDirectDistribution, чтобы вернуть оставшийся баланс хранилища и rent. Если заданclawbackTs, закрытие разрешено только после этого момента.
Распределение Merkle
- Authority строит дерево Меркла офчейн. Каждый лист фиксирует claimant, его общую сумму и график вестинга.
- Authority вызывает
CreateMerkleDistribution, передавая корень, общую сумму для получения иclawbackTs, и пополняет хранилище в той же инструкции. - Claimants вызывают
ClaimMerkle, передавая данные своего листа и доказательство. Первый клейм создаёт аккаунтMerkleClaimдля claimant. Передайтеamount: 0, чтобы забрать всё, что на данный момент вестнуто. - После
clawbackTsauthority вызываетCloseMerkleDistribution, чтобы вернуть оставшийся баланс хранилища и rent. - После закрытия распределения claimants вызывают
CloseMerkleClaim, чтобы вернуть rent за свой claim-аккаунт.
Программа хеширует листья с помощью Keccak-256 по формуле
keccak256(0x00 || keccak256(claimant || totalAmount || schedule)), где
totalAmount — это u64 в порядке little-endian, а schedule использует ту же кодировку, что и
аргумент VestingSchedule инструкции. Узлы доказательства хешируются как отсортированные
пары, сначала меньший хеш.
Отзыв
Отзыв включается по желанию. Битовая маска revocable, заданная при создании, определяет, какие
режимы может использовать authority: бит 0 включает NonVested, бит 1 включает Full,
а 0 отключает отзыв.
| Режим | Инструкция | Результат |
|---|---|---|
NonVested | RevokeDirectRecipient или RevokeMerkleClaim | Вестнутые, но не полученные токены уходят пользователю; невестнутые токены возвращаются authority |
Full | RevokeDirectRecipient или RevokeMerkleClaim | Все не полученные токены, как вестнутые, так и невестнутые, возвращаются authority |
Отзыв claimant в Merkle-распределении создаёт маркер Revocation, который блокирует будущие
клеймы, даже если claimant ещё ни разу не забирал токены. Отзыв получателя в прямом распределении закрывает
его аккаунт DirectRecipient и возвращает rent за него.
Клиенты
Репозиторий включает клиенты @solana/kit и
Rust, сгенерированные из IDL программы с помощью Codama, в
clients/.
Клиент пока не опубликован в npm. Соберите его из исходного кода с помощью
just generate-clients.
Ресурсы
- Исходный код
- Отчёт об аудите OtterSec
- Сообщить о проблеме
- Solana StackExchange, тег
rewards-program
Is this page helpful?