Skip to main content

ClaimTokenBuilder

satrush_client::instructions

Struct ClaimTokenBuilder 

Source 
pub struct ClaimTokenBuilder { /* private fields */ }
Expand description

Instruction builder for ClaimToken.

§Accounts:

  1. [writable, signer] authority
  2. [] satrush_config
  3. [writable] token_vault
  4. [writable] sats_vault
  5. [writable] miner
  6. [] token_mint
  7. [] btc_mint
  8. [writable] token_vault_token_ata
  9. [writable] sats_vault_btc_ata
  10. [writable] authority_token_ata
  11. [writable] authority_btc_ata
  12. [optional] token_program (default to TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA)
  13. [optional] associated_token_program (default to ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL)
  14. [optional] system_program (default to 11111111111111111111111111111111)
  15. [] event_authority
  16. [] program

Implementations§

Source§

impl ClaimTokenBuilder

Source

pub fn new() -> Self

Source

pub fn authority(&mut self, authority: Address) -> &mut Self

Source

pub fn satrush_config(&mut self, satrush_config: Address) -> &mut Self

Source

pub fn token_vault(&mut self, token_vault: Address) -> &mut Self

The vault: source of tokens and the authority over its own reserves ATA.

Source

pub fn sats_vault(&mut self, sats_vault: Address) -> &mut Self

The Sats Vault the coupled BTC leg redeems from.

Source

pub fn miner(&mut self, miner: Address) -> &mut Self

The redeeming miner’s profile; holds both share balances being burned.

Source

pub fn token_mint(&mut self, token_mint: Address) -> &mut Self

Source

pub fn btc_mint(&mut self, btc_mint: Address) -> &mut Self

Source

pub fn token_vault_token_ata( &mut self, token_vault_token_ata: Address, ) -> &mut Self

Vault’s token reserves — the token payout source.

Source

pub fn sats_vault_btc_ata(&mut self, sats_vault_btc_ata: Address) -> &mut Self

Vault’s BTC reserves — the BTC payout source.

Source

pub fn authority_token_ata(&mut self, authority_token_ata: Address) -> &mut Self

Miner’s token account — the token payout destination.

Source

pub fn authority_btc_ata(&mut self, authority_btc_ata: Address) -> &mut Self

Miner’s BTC account — the BTC payout destination.

Source

pub fn token_program(&mut self, token_program: Address) -> &mut Self

[optional account, default to 'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA']

Source

pub fn associated_token_program( &mut self, associated_token_program: Address, ) -> &mut Self

[optional account, default to 'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL']

Source

pub fn system_program(&mut self, system_program: Address) -> &mut Self

[optional account, default to '11111111111111111111111111111111']

Source

pub fn event_authority(&mut self, event_authority: Address) -> &mut Self

Source

pub fn program(&mut self, program: Address) -> &mut Self

Source

pub fn token_shares(&mut self, token_shares: u64) -> &mut Self

Source

pub fn add_remaining_account(&mut self, account: AccountMeta) -> &mut Self

Add an additional account to the instruction.

Source

pub fn add_remaining_accounts(&mut self, accounts: &[AccountMeta]) -> &mut Self

Add additional accounts to the instruction.

Source

pub fn instruction(&self) -> Instruction

Trait Implementations§

Source§

impl Clone for ClaimTokenBuilder

Source§

fn clone(&self) -> ClaimTokenBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ClaimTokenBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ClaimTokenBuilder

Source§

fn default() -> ClaimTokenBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more