1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
// Copyright (c) 2021 Ivan Jelincic <parazyd@dyne.org>
//
// This file is part of streamflow-finance/timelock-crate
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License version 3
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
use borsh::{BorshDeserialize, BorshSerialize};
use solana_program::{account_info::AccountInfo, pubkey::Pubkey};
/// The struct containing instructions for initializing a stream
#[repr(C)]
#[derive(BorshDeserialize, BorshSerialize, Clone, Debug)]
pub struct StreamInstruction {
/// Timestamp when the tokens start vesting
pub start_time: u64,
/// Timestamp when all tokens are fully vested
pub end_time: u64,
/// Initially deposited amount of tokens (<= total_amount)
pub deposited_amount: u64,
/// Total amount of the tokens in the escrow account if contract is fully vested
pub total_amount: u64,
/// Time step (period) in seconds per which the vesting occurs
pub period: u64,
/// Vesting contract "cliff" timestamp
pub cliff: u64,
/// Amount unlocked at the "cliff" timestamp
pub cliff_amount: u64,
}
impl Default for StreamInstruction {
fn default() -> Self {
StreamInstruction {
start_time: 0,
end_time: 0,
deposited_amount: 0,
total_amount: 0,
period: 1,
cliff: 0,
cliff_amount: 0,
}
}
}
/// The account-holding struct for the stream initialization instruction
#[derive(Debug)]
pub struct InitializeAccounts<'a> {
/// The main wallet address of the initializer.
pub sender: AccountInfo<'a>,
/// The associated token account address of `sender`.
pub sender_tokens: AccountInfo<'a>,
/// The main wallet address of the recipient.
pub recipient: AccountInfo<'a>,
/// The associated token account address of `recipient`.
/// (Can be either empty or initialized).
pub recipient_tokens: AccountInfo<'a>,
/// The account holding the stream metadata.
/// Eexpects empty (non-initialized) account.
pub metadata: AccountInfo<'a>,
/// The escrow account holding the stream funds.
/// Expects empty (non-initialized) account.
pub escrow_tokens: AccountInfo<'a>,
/// The SPL token mint account
pub mint: AccountInfo<'a>,
/// The Rent Sysvar account
pub rent: AccountInfo<'a>,
/// The SPL program needed in case an associated account
/// for the new recipient is being created.
pub token_program: AccountInfo<'a>,
/// The Associated Token program needed in case associated
/// account for the new recipient is being created.
pub associated_token_program: AccountInfo<'a>,
/// The Solana system program
pub system_program: AccountInfo<'a>,
}
/// The account-holding struct for the stream withdraw instruction
pub struct WithdrawAccounts<'a> {
pub recipient: AccountInfo<'a>,
/// The associated token account address of `recipient`
pub recipient_tokens: AccountInfo<'a>,
/// The account holding the stream metadata
pub metadata: AccountInfo<'a>,
/// The escrow account holding the stream funds
pub escrow_tokens: AccountInfo<'a>,
/// The SPL token mint account
pub mint: AccountInfo<'a>,
/// The SPL token program
pub token_program: AccountInfo<'a>,
}
/// The account-holding struct for the stream cancel instruction
pub struct CancelAccounts<'a> {
/// The main wallet address of the initializer
pub sender: AccountInfo<'a>,
/// The associated token account address of `sender`
pub sender_tokens: AccountInfo<'a>,
/// The main wallet address of the recipient
pub recipient: AccountInfo<'a>,
/// The associated token account address of `recipient`
pub recipient_tokens: AccountInfo<'a>,
/// The account holding the stream metadata
pub metadata: AccountInfo<'a>,
/// The escrow account holding the stream funds
pub escrow_tokens: AccountInfo<'a>,
/// The SPL token mint account
pub mint: AccountInfo<'a>,
/// The SPL token program
pub token_program: AccountInfo<'a>,
}
/// Accounts needed for updating stream recipient
pub struct TransferAccounts<'a> {
/// Wallet address of the existing recipient
pub existing_recipient: AccountInfo<'a>,
/// New stream beneficiary
pub new_recipient: AccountInfo<'a>,
/// New stream beneficiary's token account.
/// If not initialized, it will be created and
/// `existing_recipient` is the fee payer
pub new_recipient_tokens: AccountInfo<'a>,
/// The account holding the stream metadata
pub metadata: AccountInfo<'a>,
/// The escrow account holding the stream funds
pub escrow_tokens: AccountInfo<'a>,
/// The SPL token mint account
pub mint: AccountInfo<'a>,
/// Rent account
pub rent: AccountInfo<'a>,
/// The SPL program needed in case associated account
/// for the new recipients is being created.
pub token_program: AccountInfo<'a>,
/// The Associated Token program needed in case associated
/// account for the new recipients is being created.
pub associated_token_program: AccountInfo<'a>,
/// The Solana system program needed in case associated
/// account for the new recipients is being created.
pub system_program: AccountInfo<'a>,
}
/// TokenStreamData is the struct containing metadata for an SPL token stream.
#[derive(BorshSerialize, BorshDeserialize, Default, Debug)]
#[repr(C)]
pub struct TokenStreamData {
/// Magic bytes
pub magic: u64,
/// The stream instruction
pub ix: StreamInstruction,
/// Timestamp when stream was created
pub created_at: u64,
/// Amount of funds withdrawn
pub withdrawn: u64,
/// Timestamp at which stream can be safely cancelled by a 3rd party
/// (Stream is either fully vested or there isn't enough capital to
/// keep it active)
pub cancel_time: u64,
/// Pubkey of the stream initializer
pub sender: Pubkey,
/// Pubkey of the stream initializer's token account
pub sender_tokens: Pubkey,
/// Pubkey of the stream recipient
pub recipient: Pubkey,
/// Pubkey of the stream recipient's token account
pub recipient_tokens: Pubkey,
/// Pubkey of the token mint
pub mint: Pubkey,
/// Pubkey of the account holding the locked tokens
pub escrow_tokens: Pubkey,
}
#[allow(clippy::too_many_arguments)]
impl TokenStreamData {
/// Initialize a new `TokenStreamData` struct.
pub fn new(
start_time: u64,
end_time: u64,
deposited_amount: u64,
total_amount: u64,
period: u64,
cliff: u64,
cliff_amount: u64,
created_at: u64,
sender: Pubkey,
sender_tokens: Pubkey,
recipient: Pubkey,
recipient_tokens: Pubkey,
mint: Pubkey,
escrow_tokens: Pubkey,
) -> Self {
let ix = StreamInstruction {
start_time,
end_time,
deposited_amount,
total_amount,
period,
cliff,
cliff_amount,
};
// TODO: calculate cancel_time based on other parameters
Self {
magic: 0,
ix,
created_at,
withdrawn: 0,
cancel_time: end_time,
sender,
sender_tokens,
recipient,
recipient_tokens,
mint,
escrow_tokens,
}
}
/// Calculate amount available for withdrawal with given timestamp.
pub fn available(&self, now: u64) -> u64 {
if self.ix.start_time > now || self.ix.cliff > now {
return 0;
}
if now >= self.ix.end_time {
return self.ix.total_amount - self.withdrawn;
}
let cliff = if self.ix.cliff > 0 {
self.ix.cliff
} else {
self.ix.start_time
};
let cliff_amount = if self.ix.cliff_amount > 0 {
self.ix.cliff_amount
} else {
0
};
// TODO: Use uint arithmetics, floats are imprecise
let num_periods = (self.ix.end_time - cliff) as f64 / self.ix.period as f64;
let period_amount = (self.ix.total_amount - cliff_amount) as f64 / num_periods;
let periods_passed = (now - cliff) / self.ix.period;
(periods_passed as f64 * period_amount) as u64 + cliff_amount - self.withdrawn
}
}