Struct cyclos_core::context::CollectProtocol

source · [−]

pub struct CollectProtocol<'info> {
    pub owner: Signer<'info>,
    pub factory_state: AccountLoader<'info, FactoryState>,
    pub pool_state: AccountLoader<'info, PoolState>,
    pub vault_0: Box<Account<'info, TokenAccount>>,
    pub vault_1: Box<Account<'info, TokenAccount>>,
    pub recipient_wallet_0: Box<Account<'info, TokenAccount>>,
    pub recipient_wallet_1: Box<Account<'info, TokenAccount>>,
    pub token_program: Program<'info, Token>,
}

Fields

owner: Signer<'info>

Valid protocol owner

factory_state: AccountLoader<'info, FactoryState>

Factory state stores the protocol owner address

pool_state: AccountLoader<'info, PoolState>

Pool state stores accumulated protocol fee amount

vault_0: Box<Account<'info, TokenAccount>>

The address that holds pool tokens for token_0

vault_1: Box<Account<'info, TokenAccount>>

The address that holds pool tokens for token_1

recipient_wallet_0: Box<Account<'info, TokenAccount>>

The address that receives the collected token_0 protocol fees

recipient_wallet_1: Box<Account<'info, TokenAccount>>

The address that receives the collected token_1 protocol fees

token_program: Program<'info, Token>

The SPL program to perform token transfers

Trait Implementations

source

impl<'info> Accounts<'info> for CollectProtocol<'info> where
'info: 'info,

source

fn try_accounts(
 program_id: &Pubkey,
 accounts: &mut &[AccountInfo<'info>],
 ix_data: &[u8 ],
 __bumps: &mut BTreeMap<String, u8>
) -> 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. Read more

source

impl<'info> AccountsExit<'info> for CollectProtocol<'info> where
'info: 'info,

source

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

program_id is the currently executing program.

source

impl<'info> ToAccountInfos<'info> for CollectProtocol<'info> where
'info: 'info,

source

fn to_account_infos(&self) -> Vec<AccountInfo<'info>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

source

impl<'info> ToAccountMetas for CollectProtocol<'info>

source

fn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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. Read more