Struct PositionWithdraw

pub struct PositionWithdraw {
    pub position_id: Id,
    pub reserves_commitment: Commitment,
    pub sequence: u64,
}

A transaction action that withdraws funds from a closed position.

This action’s contribution to the transaction’s value balance is to consume a closed position NFT and contribute a withdrawn position NFT, as well as all of the funds that were in the position at the time of closing.

Fields

position_id: Id

reserves_commitment: Commitment

A transparent (zero blinding factor) commitment to the position’s final reserves and fees.

The chain will check this commitment by recomputing it with the on-chain state.

sequence: u64

The sequence number of the withdrawal, allowing multiple withdrawals from the same position.

Trait Implementations

impl ActionHandler for PositionWithdraw

Available on crate feature component only.

Debits a closed position NFT and credits a withdrawn position NFT and the final reserves.

type CheckStatelessContext = ()

Context for stateless validity checks, like the transaction containing the action.

fn check_stateless<'life0, 'async_trait>( &'life0 self, _context: (), ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Performs all of this action’s stateless validity checks in the context of some [Transaction].

fn check_and_execute<'life0, 'async_trait, S>( &'life0 self, state: S, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where S: 'async_trait + StateWrite, Self: 'async_trait, 'life0: 'async_trait,

Attempts to execute this action against the provided state.

fn check_historical<'life0, 'async_trait, S>( &'life0 self, _state: Arc<S>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, S: 'async_trait + StateRead + 'static, Self: Sync + 'async_trait,

Performs those stateful validity checks that can be performed against a historical state snapshot.

impl Clone for PositionWithdraw

fn clone(&self) -> PositionWithdraw

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PositionWithdraw

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PositionWithdraw

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for PositionWithdraw

type Proto = PositionWithdraw

fn encode_to_vec(&self) -> Vec<u8>

Encode this domain type to a byte vector, via proto type P.

fn to_proto(&self) -> Self::Proto

Convert this domain type to the associated proto type.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Decode this domain type from a byte buffer, via proto type P.

impl EffectingData for PositionWithdraw

fn effect_hash(&self) -> EffectHash

impl From<PositionWithdraw> for PositionWithdraw

fn from(value: PositionWithdraw) -> Self

Converts to this type from the input type.

impl Serialize for PositionWithdraw

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PositionWithdraw> for PositionWithdraw

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PositionWithdraw) -> Result<Self, Self::Error>

Performs the conversion.