Struct dflow_sdk::instructions::InitAuctionEpochStateInstruction

pub struct InitAuctionEpochStateInstruction<'info> {
    pub auction_epoch_state: Account<'info, AuctionEpochState>,
    pub auction_state_account: Account<'info, AuctionStateAccount>,
    pub owner: AccountInfo<'info>,
    pub system_program: AccountInfo<'info>,
    pub rent: Sysvar<'info, Rent>,
}

This instruction initializes an auction epoch state account AuctionEpochState carries state specific to a certain auction that needs to be remembered after the epoch ends. The AuctionEpochState accounts associated with auction epochs N and N + 1 need to be initialized when the auction for epoch N begins (i.e. in the first SubmitAuctionBid that auction N will receive). Recall that if the AuctionState has an epoch field that has value X, then auction X is currently active, and auction X - 1 is currently receiving order flow.

Fields

auction_epoch_state: Account<'info, AuctionEpochState>

The auction epoch state account holds state specific to an epoch of the auction, if that state must be remembered beyond the duration of that auction epoch. This account is being initialized with 101 bytes, paid for by owner. This account is a PDA generated by the following seeds: the string literal epoch, an unsigned 64 bit integer, an unsigned 64 bit integer

auction_state_account: Account<'info, AuctionStateAccount>

The auction state account holds state specific to the auction. This account is expected to be mutable. This account is a PDA generated by the following seeds: the string literal auction_state, an unsigned 64 bit integer

owner: AccountInfo<'info>

The creator and owner of AuctionEpochState account. This account is a signer for the instruction. This account is expected to be mutable

system_program: AccountInfo<'info>

rent: Sysvar<'info, Rent>

Trait Implementations

impl<'info> Accounts<'info> for InitAuctionEpochStateInstruction<'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 InitAuctionEpochStateInstruction<'info> where
    'info: 'info, 

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

program_id is the currently executing program.

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

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

impl<'info> ToAccountMetas for InitAuctionEpochStateInstruction<'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.