Struct UserStake

pub struct UserStake<'info> {
    pub wrapper: Account<'info, WrappedToken>,
    pub wrapper_mint: Account<'info, Mint>,
    pub wrapper_underlying_tokens: Account<'info, TokenAccount>,
    pub owner: Signer<'info>,
    pub user_underlying_tokens: Account<'info, TokenAccount>,
    pub user_wrapped_tokens: Account<'info, TokenAccount>,
    pub token_program: Program<'info, Token>,
}

Accounts for withdrawing or depositing into the wrapper.

Fields

wrapper: Account<'info, WrappedToken>

Wrapper account.

wrapper_mint: Account<'info, Mint>

Mint of the wrapper.

wrapper_underlying_tokens: Account<'info, TokenAccount>

Wrapper’s token account containing the underlying tokens.

owner: Signer<'info>

Owner of the user underlying token accounts.

user_underlying_tokens: Account<'info, TokenAccount>

User’s token account for the underlying tokens.

user_wrapped_tokens: Account<'info, TokenAccount>

User’s token account for wrapped tokens.

token_program: Program<'info, Token>

SPL Token program.

Implementations

impl<'info> UserStake<'info>

Helper methods for interacting with the user stake.

pub fn deposit_underlying(&self, amount: u64) -> Result<()>

Transfer user’s tokens to wrapper.

pub fn burn_wrapped(&self, amount: u64) -> Result<()>

Burn user’s wrapper tokens.

pub fn mint_wrapped(&self, amount: u64) -> Result<()>

Mint wrapped tokens to user wrapped token account.

pub fn withdraw_underlying(&self, amount: u64) -> Result<()>

Transfer underlying tokens from wrapper to user.

Trait Implementations

impl<'info> Accounts<'info> for UserStake<'info>

where 'info: 'info,

fn try_accounts( program_id: &Pubkey, accounts: &mut &[AccountInfo<'info>], ix_data: &[u8], __bumps: &mut BTreeMap<String, u8>, __reallocs: &mut BTreeSet<Pubkey>, ) -> Result<Self>

Returns the validated accounts struct. What constitutes “valid” is program dependent. However, users of these types should never have to worry about account substitution attacks. For example, if a program expects a Mint account from the SPL token program in a particular field, then it should be impossible for this method to return Ok if any other account type is given–from the SPL token program or elsewhere.

impl<'info> AccountsExit<'info> for UserStake<'info>

where 'info: 'info,

fn exit(&self, program_id: &Pubkey) -> Result<()>

program_id is the currently executing program.

impl<'info> RouterActionProcessor<'info, UserStake<'info>> for AddDecimals

fn process_action( ctx: Context<'_, '_, '_, '_, UserStake<'_>>, action: u16, amount_in: u64, _minimum_amount_out: u64, ) -> Result<()>

impl<'info> ToAccountInfos<'info> for UserStake<'info>

where 'info: 'info,

fn to_account_infos(&self) -> Vec<AccountInfo<'info>>

impl<'info> ToAccountMetas for UserStake<'info>

fn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>

is_signer is given as an optional override for the signer meta field. This covers the edge case when a program-derived-address needs to relay a transaction from a client to another program but sign the transaction before the relay. The client cannot mark the field as a signer, and so we have to override the is_signer meta field given by the client.

impl<'info> Validate<'info> for UserStake<'info>

fn validate(&self) -> Result<()>

Validates ownership of the accounts of the wrapper.