2021-10-20 12:38:47 -07:00
|
|
|
use access_control::*;
|
2021-10-19 15:51:13 -07:00
|
|
|
use account::*;
|
2021-10-05 13:40:01 -07:00
|
|
|
use anchor_lang::prelude::*;
|
2021-10-19 15:51:13 -07:00
|
|
|
use anchor_spl::token;
|
|
|
|
use context::*;
|
|
|
|
use error::*;
|
2021-10-21 19:16:32 -07:00
|
|
|
use spl_governance::addins::voter_weight::VoterWeightAccountType;
|
2021-10-18 12:17:39 -07:00
|
|
|
|
2021-10-20 12:38:47 -07:00
|
|
|
mod access_control;
|
2021-10-19 15:51:13 -07:00
|
|
|
mod account;
|
|
|
|
mod context;
|
|
|
|
mod error;
|
2021-10-05 13:40:01 -07:00
|
|
|
|
2021-10-20 12:38:47 -07:00
|
|
|
// The program address.
|
2021-10-05 13:40:01 -07:00
|
|
|
declare_id!("Fg6PaFpoGXkYsidMpWTK6W2BeZ7FEfcYkg476zPFsLnS");
|
|
|
|
|
2021-10-16 09:47:57 -07:00
|
|
|
/// # Introduction
|
|
|
|
///
|
|
|
|
/// The governance registry is an "addin" to the SPL governance program that
|
2021-10-20 12:38:47 -07:00
|
|
|
/// allows one to both vote with many different ypes of tokens for voting and to
|
|
|
|
/// scale voting power as a linear function of time locked--subject to some
|
|
|
|
/// maximum upper bound.
|
2021-10-16 09:47:57 -07:00
|
|
|
///
|
2021-10-20 12:38:47 -07:00
|
|
|
/// The flow for voting with this program is as follows:
|
2021-10-16 09:47:57 -07:00
|
|
|
///
|
|
|
|
/// - Create a SPL governance realm.
|
|
|
|
/// - Create a governance registry account.
|
|
|
|
/// - Add exchange rates for any tokens one wants to deposit. For example,
|
|
|
|
/// if one wants to vote with tokens A and B, where token B has twice the
|
|
|
|
/// voting power of token A, then the exchange rate of B would be 2 and the
|
|
|
|
/// exchange rate of A would be 1.
|
|
|
|
/// - Create a voter account.
|
|
|
|
/// - Deposit tokens into this program, with an optional lockup period.
|
|
|
|
/// - Vote.
|
|
|
|
///
|
|
|
|
/// Upon voting with SPL governance, a client is expected to call
|
|
|
|
/// `decay_voting_power` to get an up to date measurement of a given `Voter`'s
|
|
|
|
/// voting power for the given slot. If this is not done, then the transaction
|
|
|
|
/// will fail (since the SPL governance program will require the measurement
|
|
|
|
/// to be active for the current slot).
|
|
|
|
///
|
|
|
|
/// # Interacting with SPL Governance
|
|
|
|
///
|
|
|
|
/// This program does not directly interact with SPL governance via CPI.
|
|
|
|
/// Instead, it simply writes a `VoterWeightRecord` account with a well defined
|
|
|
|
/// format, which is then used by SPL governance as the voting power measurement
|
|
|
|
/// for a given user.
|
2021-10-20 12:38:47 -07:00
|
|
|
///
|
|
|
|
/// # Max Vote Weight
|
|
|
|
///
|
|
|
|
/// Given that one can use multiple tokens to vote, the max vote weight needs
|
|
|
|
/// to be a function of the total supply of all tokens, converted into a common
|
|
|
|
/// currency. For example, if you have Token A and Token B, where 1 Token B =
|
|
|
|
/// 10 Token A, then the `max_vote_weight` should be `supply(A) + supply(B)*10`
|
|
|
|
/// where both are converted into common decimals. Then, when calculating the
|
|
|
|
/// weight of an individual voter, one can convert B into A via the given
|
|
|
|
/// exchange rate, which must be fixed.
|
|
|
|
///
|
|
|
|
/// Note that the above also implies that the `max_vote_weight` must fit into
|
|
|
|
/// a u64.
|
2021-10-05 13:40:01 -07:00
|
|
|
#[program]
|
|
|
|
pub mod governance_registry {
|
|
|
|
use super::*;
|
|
|
|
|
2021-10-12 12:34:05 -07:00
|
|
|
/// Creates a new voting registrar. There can only be a single regsitrar
|
|
|
|
/// per governance realm.
|
2021-10-16 09:47:57 -07:00
|
|
|
pub fn create_registrar(
|
|
|
|
ctx: Context<CreateRegistrar>,
|
2021-10-18 17:55:15 -07:00
|
|
|
warmup_secs: i64,
|
2021-10-05 13:40:01 -07:00
|
|
|
registrar_bump: u8,
|
|
|
|
) -> Result<()> {
|
2021-10-12 12:34:05 -07:00
|
|
|
let registrar = &mut ctx.accounts.registrar.load_init()?;
|
2021-10-15 11:22:05 -07:00
|
|
|
registrar.bump = registrar_bump;
|
2021-10-05 13:40:01 -07:00
|
|
|
registrar.realm = ctx.accounts.realm.key();
|
2021-10-21 19:16:32 -07:00
|
|
|
registrar.realm_community_mint = ctx.accounts.realm_community_mint.key();
|
2021-10-05 13:40:01 -07:00
|
|
|
registrar.authority = ctx.accounts.authority.key();
|
2021-10-18 17:55:15 -07:00
|
|
|
registrar.warmup_secs = warmup_secs;
|
2021-10-12 12:34:05 -07:00
|
|
|
|
2021-10-05 13:40:01 -07:00
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2021-10-12 12:34:05 -07:00
|
|
|
/// Creates a new exchange rate for a given mint. This allows a voter to
|
|
|
|
/// deposit the mint in exchange for vTokens. There can only be a single
|
|
|
|
/// exchange rate per mint.
|
2021-10-20 12:38:47 -07:00
|
|
|
///
|
|
|
|
/// WARNING: This can be freely called when any of the rates are empty.
|
|
|
|
/// This should be called immediately upon creation of a Registrar.
|
|
|
|
#[access_control(rate_is_empty(&ctx, idx))]
|
2021-10-16 09:47:57 -07:00
|
|
|
pub fn create_exchange_rate(
|
|
|
|
ctx: Context<CreateExchangeRate>,
|
2021-10-20 12:38:47 -07:00
|
|
|
idx: u16,
|
2021-10-16 09:47:57 -07:00
|
|
|
er: ExchangeRateEntry,
|
|
|
|
) -> Result<()> {
|
2021-10-12 12:34:05 -07:00
|
|
|
require!(er.rate > 0, InvalidRate);
|
|
|
|
let registrar = &mut ctx.accounts.registrar.load_mut()?;
|
2021-10-20 12:38:47 -07:00
|
|
|
registrar.rates[idx as usize] = er;
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Creates a new voter account. There can only be a single voter per
|
|
|
|
/// user wallet.
|
2021-10-21 19:16:32 -07:00
|
|
|
pub fn create_voter(
|
|
|
|
ctx: Context<CreateVoter>,
|
|
|
|
voter_bump: u8,
|
|
|
|
voter_weight_record_bump: u8,
|
|
|
|
) -> Result<()> {
|
|
|
|
// Load accounts.
|
|
|
|
let registrar = &ctx.accounts.registrar.load()?;
|
2021-10-20 12:38:47 -07:00
|
|
|
let voter = &mut ctx.accounts.voter.load_init()?;
|
2021-10-21 19:16:32 -07:00
|
|
|
let voter_weight_record = &mut ctx.accounts.voter_weight_record;
|
|
|
|
|
|
|
|
// Init the voter.
|
2021-10-20 12:38:47 -07:00
|
|
|
voter.voter_bump = voter_bump;
|
2021-10-21 19:16:32 -07:00
|
|
|
voter.voter_weight_record_bump = voter_weight_record_bump;
|
2021-10-20 12:38:47 -07:00
|
|
|
voter.authority = ctx.accounts.authority.key();
|
|
|
|
voter.registrar = ctx.accounts.registrar.key();
|
|
|
|
|
2021-10-21 19:16:32 -07:00
|
|
|
// Init the voter weight record.
|
|
|
|
voter_weight_record.account_type = VoterWeightAccountType::VoterWeightRecord;
|
|
|
|
voter_weight_record.realm = registrar.realm;
|
|
|
|
voter_weight_record.governing_token_mint = registrar.realm_community_mint;
|
|
|
|
voter_weight_record.governing_token_owner = ctx.accounts.authority.key();
|
|
|
|
|
2021-10-05 13:40:01 -07:00
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2021-10-16 09:47:57 -07:00
|
|
|
/// Creates a new deposit entry and updates it by transferring in tokens.
|
2021-10-19 15:08:05 -07:00
|
|
|
pub fn create_deposit(
|
|
|
|
ctx: Context<CreateDeposit>,
|
|
|
|
kind: LockupKind,
|
|
|
|
amount: u64,
|
|
|
|
days: i32,
|
|
|
|
) -> Result<()> {
|
2021-10-16 09:47:57 -07:00
|
|
|
// Creates the new deposit.
|
|
|
|
let deposit_id = {
|
2021-10-19 15:08:05 -07:00
|
|
|
// Load accounts.
|
2021-10-16 09:47:57 -07:00
|
|
|
let registrar = &ctx.accounts.deposit.registrar.load()?;
|
|
|
|
let voter = &mut ctx.accounts.deposit.voter.load_mut()?;
|
|
|
|
|
2021-10-19 15:08:05 -07:00
|
|
|
// Set the lockup start timestamp, delayed by the warmup period.
|
|
|
|
let start_ts = Clock::get()?.unix_timestamp + registrar.warmup_secs;
|
|
|
|
|
2021-10-16 09:47:57 -07:00
|
|
|
// Get the exchange rate entry associated with this deposit.
|
|
|
|
let er_idx = registrar
|
|
|
|
.rates
|
|
|
|
.iter()
|
|
|
|
.position(|r| r.mint == ctx.accounts.deposit.deposit_mint.key())
|
|
|
|
.ok_or(ErrorCode::ExchangeRateEntryNotFound)?;
|
|
|
|
|
|
|
|
// Get and set up the first free deposit entry.
|
|
|
|
let free_entry_idx = voter
|
|
|
|
.deposits
|
|
|
|
.iter()
|
|
|
|
.position(|d_entry| !d_entry.is_used)
|
|
|
|
.ok_or(ErrorCode::DepositEntryFull)?;
|
|
|
|
let d_entry = &mut voter.deposits[free_entry_idx];
|
|
|
|
d_entry.is_used = true;
|
|
|
|
d_entry.rate_idx = free_entry_idx as u8;
|
|
|
|
d_entry.rate_idx = er_idx as u8;
|
2021-10-19 15:08:05 -07:00
|
|
|
d_entry.amount_withdrawn = 0;
|
|
|
|
d_entry.lockup = Lockup {
|
|
|
|
kind,
|
|
|
|
start_ts,
|
|
|
|
end_ts: start_ts
|
|
|
|
.checked_add(i64::from(days).checked_mul(SECS_PER_DAY).unwrap())
|
|
|
|
.unwrap(),
|
|
|
|
padding: [0u8; 16],
|
|
|
|
};
|
2021-10-16 09:47:57 -07:00
|
|
|
|
|
|
|
free_entry_idx as u8
|
|
|
|
};
|
|
|
|
|
|
|
|
// Updates the entry by transferring in tokens.
|
|
|
|
let update_ctx = Context::new(ctx.program_id, &mut ctx.accounts.deposit, &[]);
|
|
|
|
update_deposit(update_ctx, deposit_id, amount)?;
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Updates a deposit entry by depositing tokens into the registrar in
|
|
|
|
/// exchange for *frozen* voting tokens. These tokens are not used for
|
|
|
|
/// anything other than displaying the amount in wallets.
|
|
|
|
pub fn update_deposit(ctx: Context<UpdateDeposit>, id: u8, amount: u64) -> Result<()> {
|
2021-10-14 11:31:52 -07:00
|
|
|
let registrar = &ctx.accounts.registrar.load()?;
|
2021-10-12 12:34:05 -07:00
|
|
|
let voter = &mut ctx.accounts.voter.load_mut()?;
|
|
|
|
|
|
|
|
// Get the exchange rate entry associated with this deposit.
|
|
|
|
let er_idx = registrar
|
|
|
|
.rates
|
|
|
|
.iter()
|
|
|
|
.position(|r| r.mint == ctx.accounts.deposit_mint.key())
|
|
|
|
.ok_or(ErrorCode::ExchangeRateEntryNotFound)?;
|
|
|
|
let er_entry = registrar.rates[er_idx];
|
|
|
|
|
2021-10-15 11:22:05 -07:00
|
|
|
// Calculate the amount of voting tokens to mint at the specified
|
|
|
|
// exchange rate.
|
2021-10-21 19:30:52 -07:00
|
|
|
let amount_scaled = er_entry.rate.checked_mul(amount).unwrap();
|
2021-10-12 12:34:05 -07:00
|
|
|
|
2021-10-18 17:59:09 -07:00
|
|
|
require!(voter.deposits.len() > id as usize, InvalidDepositId);
|
|
|
|
let d_entry = &mut voter.deposits[id as usize];
|
2021-10-19 15:08:05 -07:00
|
|
|
d_entry.amount_deposited += amount;
|
|
|
|
d_entry.amount_scaled += amount_scaled;
|
2021-10-18 17:59:09 -07:00
|
|
|
|
2021-10-12 12:34:05 -07:00
|
|
|
// Deposit tokens into the registrar.
|
2021-10-15 11:22:05 -07:00
|
|
|
token::transfer(ctx.accounts.transfer_ctx(), amount)?;
|
2021-10-05 13:40:01 -07:00
|
|
|
|
2021-10-19 15:08:05 -07:00
|
|
|
// Thaw the account if it's frozen, so that we can mint.
|
|
|
|
if ctx.accounts.voting_token.is_frozen() {
|
|
|
|
token::thaw_account(
|
|
|
|
ctx.accounts
|
|
|
|
.thaw_ctx()
|
|
|
|
.with_signer(&[&[registrar.realm.as_ref(), &[registrar.bump]]]),
|
|
|
|
)?;
|
|
|
|
}
|
|
|
|
|
2021-10-05 13:40:01 -07:00
|
|
|
// Mint vote tokens to the depositor.
|
2021-10-15 11:22:05 -07:00
|
|
|
token::mint_to(
|
|
|
|
ctx.accounts
|
|
|
|
.mint_to_ctx()
|
|
|
|
.with_signer(&[&[registrar.realm.as_ref(), &[registrar.bump]]]),
|
2021-10-19 15:08:05 -07:00
|
|
|
amount_scaled,
|
2021-10-15 11:22:05 -07:00
|
|
|
)?;
|
|
|
|
|
|
|
|
// Freeze the vote tokens; they are just used for UIs + accounting.
|
|
|
|
token::freeze_account(
|
|
|
|
ctx.accounts
|
|
|
|
.freeze_ctx()
|
|
|
|
.with_signer(&[&[registrar.realm.as_ref(), &[registrar.bump]]]),
|
|
|
|
)?;
|
2021-10-05 13:40:01 -07:00
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2021-10-12 12:34:05 -07:00
|
|
|
/// Withdraws tokens from a deposit entry, if they are unlocked according
|
|
|
|
/// to a vesting schedule.
|
2021-10-16 09:47:57 -07:00
|
|
|
///
|
|
|
|
/// `amount` is in units of the native currency being withdrawn.
|
|
|
|
pub fn withdraw(ctx: Context<Withdraw>, deposit_id: u8, amount: u64) -> Result<()> {
|
2021-10-21 13:03:59 -07:00
|
|
|
// Load the accounts.
|
2021-10-16 09:47:57 -07:00
|
|
|
let registrar = &ctx.accounts.registrar.load()?;
|
|
|
|
let voter = &mut ctx.accounts.voter.load_mut()?;
|
|
|
|
require!(voter.deposits.len() > deposit_id.into(), InvalidDepositId);
|
|
|
|
|
2021-10-21 13:03:59 -07:00
|
|
|
// Get the deposit being withdrawn from.
|
2021-10-16 09:47:57 -07:00
|
|
|
let deposit_entry = &mut voter.deposits[deposit_id as usize];
|
|
|
|
require!(deposit_entry.is_used, InvalidDepositId);
|
2021-10-19 15:08:05 -07:00
|
|
|
require!(deposit_entry.vested()? >= amount, InsufficientVestedTokens);
|
|
|
|
require!(
|
|
|
|
deposit_entry.amount_left() >= amount,
|
|
|
|
InsufficientVestedTokens
|
|
|
|
);
|
2021-10-16 09:47:57 -07:00
|
|
|
|
2021-10-21 13:03:59 -07:00
|
|
|
// Scale the amount being withdrawn by the exchange rate.
|
|
|
|
let amount_scaled = {
|
|
|
|
// Get the exchange rate for the token being withdrawn.
|
|
|
|
let er_idx = registrar
|
|
|
|
.rates
|
|
|
|
.iter()
|
|
|
|
.position(|r| r.mint == ctx.accounts.withdraw_mint.key())
|
|
|
|
.ok_or(ErrorCode::ExchangeRateEntryNotFound)?;
|
|
|
|
let er_entry = registrar.rates[er_idx];
|
|
|
|
er_entry.rate * amount
|
|
|
|
};
|
2021-10-16 09:47:57 -07:00
|
|
|
|
2021-10-21 13:03:59 -07:00
|
|
|
// Update deposit book keeping.
|
2021-10-21 19:30:52 -07:00
|
|
|
deposit_entry.amount_scaled -= amount_scaled;
|
2021-10-21 13:03:59 -07:00
|
|
|
deposit_entry.amount_deposited -= amount;
|
|
|
|
deposit_entry.amount_withdrawn += amount;
|
2021-10-16 09:47:57 -07:00
|
|
|
|
|
|
|
// Transfer the tokens to withdraw.
|
|
|
|
token::transfer(
|
|
|
|
ctx.accounts
|
|
|
|
.transfer_ctx()
|
|
|
|
.with_signer(&[&[registrar.realm.as_ref(), &[registrar.bump]]]),
|
|
|
|
amount,
|
|
|
|
)?;
|
|
|
|
|
2021-10-21 13:03:59 -07:00
|
|
|
// Unfreeze the voting token.
|
2021-10-16 09:47:57 -07:00
|
|
|
token::thaw_account(
|
|
|
|
ctx.accounts
|
|
|
|
.thaw_ctx()
|
|
|
|
.with_signer(&[&[registrar.realm.as_ref(), &[registrar.bump]]]),
|
|
|
|
)?;
|
|
|
|
|
|
|
|
// Burn the voting tokens.
|
2021-10-21 13:03:59 -07:00
|
|
|
token::burn(ctx.accounts.burn_ctx(), amount)?;
|
|
|
|
|
|
|
|
// Re-freeze the vote token.
|
|
|
|
token::freeze_account(
|
|
|
|
ctx.accounts
|
|
|
|
.freeze_ctx()
|
|
|
|
.with_signer(&[&[registrar.realm.as_ref(), &[registrar.bump]]]),
|
|
|
|
)?;
|
2021-10-16 09:47:57 -07:00
|
|
|
|
2021-10-12 12:34:05 -07:00
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2021-10-19 15:08:05 -07:00
|
|
|
/// Resets a lockup to start at the current slot timestamp and to last for
|
|
|
|
/// `days`, which must be longer than the number of days left on the lockup.
|
|
|
|
pub fn reset_lockup(ctx: Context<UpdateSchedule>, deposit_id: u8, days: i64) -> Result<()> {
|
2021-10-18 17:55:15 -07:00
|
|
|
let voter = &mut ctx.accounts.voter.load_mut()?;
|
|
|
|
require!(voter.deposits.len() > deposit_id as usize, InvalidDepositId);
|
|
|
|
|
|
|
|
let d = &mut voter.deposits[deposit_id as usize];
|
|
|
|
require!(d.is_used, InvalidDepositId);
|
|
|
|
|
2021-10-19 15:08:05 -07:00
|
|
|
// The lockup period can only be increased.
|
|
|
|
require!(days as u64 > d.lockup.days_left()?, InvalidDays);
|
2021-10-18 17:55:15 -07:00
|
|
|
|
2021-10-19 15:08:05 -07:00
|
|
|
let start_ts = Clock::get()?.unix_timestamp;
|
|
|
|
let end_ts = start_ts
|
|
|
|
.checked_add(days.checked_mul(SECS_PER_DAY).unwrap())
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
d.lockup.start_ts = start_ts;
|
2021-10-18 17:55:15 -07:00
|
|
|
d.lockup.end_ts = end_ts;
|
|
|
|
|
2021-10-05 13:40:01 -07:00
|
|
|
Ok(())
|
|
|
|
}
|
2021-10-14 11:31:52 -07:00
|
|
|
|
|
|
|
/// Calculates the lockup-scaled, time-decayed voting power for the given
|
|
|
|
/// voter and writes it into a `VoteWeightRecord` account to be used by
|
|
|
|
/// the SPL governance program.
|
|
|
|
///
|
2021-10-18 17:55:15 -07:00
|
|
|
/// This "revise" instruction should be called in the same transaction,
|
|
|
|
/// immediately before voting.
|
2021-10-21 19:16:32 -07:00
|
|
|
pub fn update_voter_weight_record(ctx: Context<UpdateVoterWeightRecord>) -> Result<()> {
|
2021-10-18 17:55:15 -07:00
|
|
|
let voter = ctx.accounts.voter.load()?;
|
2021-10-21 19:16:32 -07:00
|
|
|
let record = &mut ctx.accounts.voter_weight_record;
|
2021-10-18 17:55:15 -07:00
|
|
|
record.voter_weight = voter.weight()?;
|
|
|
|
record.voter_weight_expiry = Some(Clock::get()?.slot);
|
2021-10-21 19:16:32 -07:00
|
|
|
|
2021-10-14 11:31:52 -07:00
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Closes the voter account, allowing one to retrieve rent exemption SOL.
|
2021-10-21 19:30:52 -07:00
|
|
|
/// Only accounts with no remaining deposits can be closed.
|
2021-10-14 11:31:52 -07:00
|
|
|
pub fn close_voter(ctx: Context<CloseVoter>) -> Result<()> {
|
2021-10-21 19:30:52 -07:00
|
|
|
let voter = &ctx.accounts.voter.load()?;
|
|
|
|
let amount = voter.deposits.iter().fold(0u64, |sum, d| {
|
|
|
|
sum.checked_add(d.amount_deposited.checked_sub(d.amount_withdrawn).unwrap())
|
|
|
|
.unwrap()
|
|
|
|
});
|
|
|
|
require!(amount == 0, VotingTokenNonZero);
|
2021-10-14 11:31:52 -07:00
|
|
|
Ok(())
|
|
|
|
}
|
2021-10-05 13:40:01 -07:00
|
|
|
}
|