Le programme Rewards distribue des tokens depuis un vault appartenant au programme à un ensemble de destinataires, chacun soumis à un calendrier de vesting. Une autorité alimente le vault et définit qui reçoit quoi. Les destinataires réclament leurs tokens acquis au fil du temps, et l'autorité peut révoquer des destinataires ou récupérer les tokens restants lorsque la distribution le permet. Le programme est développé avec Pinocchio, maintenu par la Solana Foundation, et fonctionne avec les mints SPL Token comme Token-2022, à l'exception des mints Token-2022 utilisant l'extension transfer hook.
ID du programme (mainnet et devnet) :
REWArDioXgQJ2fZKkfu9LCLjQfRwYWVVfsvcsR5hoXi
Le programme a été audité par OtterSec. Consultez AUDIT_STATUS.md pour connaître le commit couvert par l'audit.
Choisir un type de distribution
Le programme prend en charge deux types de distribution. Les deux utilisent les mêmes calendriers de vesting et les mêmes modes de révocation.
| Directe | Merkle | |
|---|---|---|
| Fonctionnement | Crée un compte onchain par destinataire | Stocke une seule racine Merkle onchain ; les destinataires fournissent des preuves pour réclamer |
| Coût initial | Le payeur finance le rent de chaque compte destinataire | Aucun compte par destinataire tant que personne ne réclame |
| Échelle | Pratique jusqu'à quelques milliers de destinataires | Passe à l'échelle de millions de destinataires ; le stockage n'augmente qu'au fur et à mesure des réclamations |
| Modifiabilité | Des destinataires peuvent être ajoutés après la création | L'ensemble des destinataires est figé à la création |
| Cas d'usage | Petites distributions qui évoluent dans le temps | Distributions volumineuses et figées, comme les airdrops |
Calendriers de vesting
Chaque allocation suit l'un des quatre calendriers suivants. Les horodatages sont en secondes Unix.
| Calendrier | Comportement |
|---|---|
Immediate | Tous les tokens sont immédiatement réclamables |
Linear | Les tokens se débloquent proportionnellement entre startTs et endTs |
Cliff | Rien n'est débloqué avant cliffTs, puis tout est débloqué d'un coup |
CliffLinear | Vesting linéaire de startTs à endTs, sans rien de réclamable avant cliffTs ; les droits accumulés auparavant sont débloqués au cliff |
Comptes
| Compte | PDA seeds | Contenu |
|---|---|---|
DirectDistribution | ["direct_distribution", mint, authority, seed] | Autorité, mint et totaux des allocations |
DirectRecipient | ["direct_recipient", distribution, recipient] | Allocation et vesting d'un destinataire |
MerkleDistribution | ["merkle_distribution", mint, authority, seed] | Autorité, mint, totaux et racine Merkle |
MerkleClaim | ["merkle_claim", distribution, claimant] | Montant déjà réclamé par un réclamant |
Revocation | ["revocation", distribution, user] | Marqueur qui bloque un réclamant Merkle révoqué |
Le seed est l'adresse d'un signataire supplémentaire transmise à la création, afin qu'une même
autorité puisse gérer plusieurs distributions pour le même mint. Le vault de chaque distribution
est l'associated token account du PDA de la distribution pour son mint.
Instructions
Distribution directe
- L'autorité appelle
CreateDirectDistributionpour créer le PDA de la distribution et son vault. - L'autorité appelle
AddDirectRecipientune fois par destinataire, avec un montant et un calendrier de vesting. Chaque appel transfère ce montant depuis le token account de l'autorité vers le vault. - Les destinataires appellent
ClaimDirectpour retirer les tokens acquis. Passezamount: 0pour réclamer tout ce qui est actuellement acquis. - Une fois qu'un destinataire a tout réclamé, ou que la distribution est clôturée,
CloseDirectRecipientferme le compte du destinataire et rembourse le rent au compte qui l'a payé. - L'autorité appelle
CloseDirectDistributionpour récupérer le solde restant du vault et le rent. SiclawbackTsest défini, la clôture n'est autorisée qu'après cette date.
Distribution Merkle
- L'autorité construit un arbre de Merkle offchain. Chaque feuille engage un réclamant, le montant total de ce réclamant et un calendrier de vesting.
- L'autorité appelle
CreateMerkleDistributionavec la racine, le montant total réclamable et unclawbackTs, et alimente le vault dans la même instruction. - Les réclamants appellent
ClaimMerkleavec les données de leur feuille et leur preuve. La première réclamation crée le compteMerkleClaimdu réclamant. Passezamount: 0pour réclamer tout ce qui est actuellement acquis. - Après
clawbackTs, l'autorité appelleCloseMerkleDistributionpour récupérer le solde restant du vault et le rent. - Une fois la distribution clôturée, les réclamants appellent
CloseMerkleClaimpour récupérer le rent de leur compte de réclamation.
Le programme hache les feuilles avec Keccak-256 sous la forme
keccak256(0x00 || keccak256(claimant || totalAmount || schedule)), où
totalAmount est un u64 en little-endian et schedule utilise le même encodage que
l'argument VestingSchedule de l'instruction. Les nœuds de preuve sont hachés par
paires triées, le plus petit hash en premier.
Révocation
La révocation est optionnelle. Le bitmask revocable défini à la création détermine quels
modes l'autorité peut utiliser : le bit 0 active NonVested, le bit 1 active Full,
et 0 désactive la révocation.
| Mode | Instruction | Résultat |
|---|---|---|
NonVested | RevokeDirectRecipient ou RevokeMerkleClaim | Les tokens acquis non réclamés vont à l'utilisateur ; les tokens non acquis retournent à l'autorité |
Full | RevokeDirectRecipient ou RevokeMerkleClaim | Tous les tokens non réclamés, acquis ou non, retournent à l'autorité |
La révocation d'un réclamant Merkle crée un marqueur Revocation qui bloque toute
réclamation future, même s'il n'a jamais rien réclamé. La révocation d'un destinataire direct ferme
son compte DirectRecipient et rembourse son rent.
Clients
Le dépôt inclut des clients @solana/kit et
Rust générés à partir de l'IDL du programme avec Codama, dans
clients/.
Le client n'est pas encore publié sur npm. Compilez-le depuis les sources avec
just generate-clients.
Ressources
- Code source
- Rapport d'audit OtterSec
- Signaler un problème
- Solana StackExchange, tag
rewards-program
Is this page helpful?