Skip to main content

OrderIntent

Struct OrderIntent 

Source
pub struct OrderIntent {
    pub owner: Pubkey,
    pub sell: TokenAsset,
    pub buy: Asset,
    pub sell_amount: NonZeroU64,
    pub buy_amount: NonZeroU64,
    pub valid_to: u32,
    pub flags: Flags,
    pub app_data: [u8; 32],
}
Expand description

Order intent. Its canonical encoding, EncodedOrderIntent, is the exact wire format of create_order’s intent argument and the exact bytes hashed (SHA-256) to produce the order UID used in the order PDA’s seeds.

Fields§

§owner: Pubkey

Account authorized to create and invalidate this order and whose signature authenticates it.

§sell: TokenAsset

What the order sells, and the token account the funds are pulled from. That account implicitly encodes the spender: the settlement state PDA must hold the SPL delegate on it for the order to be settleable, and it must be owned by the intent owner. An intent that doesn’t satisfy this property will be rejected.

§buy: Asset

What the order buys, and the account that receives the proceeds. That account implicitly encodes the recipient

§sell_amount: NonZeroU64

Amount of the sell token. For Sell orders this is the exact amount to be sold (subject to partially_fillable); for Buy orders it is the maximum the user is willing to spend. Must be non-zero.

§buy_amount: NonZeroU64

Amount of the buy token. For Buy orders this is the exact amount to be received (subject to partially_fillable); for Sell orders it is the minimum the user is willing to receive. Must be non-zero.

§valid_to: u32

Unix timestamp after which the order expires. The order cannot be executed after expiration.

§flags: Flags

The settings the encoding packs bit by bit into a single byte; see Flags.

§app_data: [u8; 32]

Opaque 32 bytes set by the order creator. Not interpreted by the settlement program; used off-chain for metadata such as the frontend version, slippage hints, or attribution.

Implementations§

Source§

impl OrderIntent

Source

pub fn uid(&self) -> Hash

SHA-256 of the canonical bytes. Doubles as the order UID and the middle seed of the order PDA.

Trait Implementations§

Source§

impl Clone for OrderIntent

Source§

fn clone(&self) -> Self

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 OrderIntent

Source§

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

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

impl Eq for OrderIntent

Source§

impl From<&OrderIntent> for EncodedOrderIntent

Source§

fn from(intent: &OrderIntent) -> Self

Lays each side out the way the wire spells it.

Source§

impl PartialEq for OrderIntent

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OrderIntent

Source§

impl TryFrom<&[u8; 213]> for OrderIntent

Source§

fn try_from(bytes: &[u8; 213]) -> Result<Self, Self::Error>

Decode an intent’s canonical bytes. Fails with ProgramError::InvalidInstructionData if the flags byte sets a reserved bit; every other byte combination decodes.

Source§

type Error = ProgramError

The type returned in the event of a conversion error.

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<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, 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> 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.