Skip to main content

AmmPool

Struct AmmPool 

Source
pub struct AmmPool {
    pub currency_a: String,
    pub currency_b: String,
    pub reserve_a: u64,
    pub reserve_b: u64,
    pub total_shares: u64,
    pub fee_bps: u64,
    /* private fields */
}
Expand description

AMM constant-product liquidity pool (x * y = k).

Supports add/remove liquidity and swaps with a configurable fee (default 30 basis points = 0.3%). All arithmetic uses u128 intermediates to prevent overflow.

Fields§

§currency_a: String§currency_b: String§reserve_a: u64§reserve_b: u64§total_shares: u64§fee_bps: u64

Fee in basis points (100 bps = 1%). Default 30 (0.3%).

Implementations§

Source§

impl AmmPool

Source

pub const DEFAULT_FEE_BPS: u64 = 30

Default fee: 30 bps (0.3%), matching Uniswap V2.

Source

pub fn new(currency_a: &str, currency_b: &str, fee_bps: u64) -> Self

Source

pub fn add_liquidity( &mut self, provider: &str, amount_a: u64, amount_b: u64, ledger: &mut WebLedger, ) -> Result<u64, PaymentError>

Add liquidity to the pool.

The first provider sets the initial ratio. Subsequent providers must provide amounts in the same ratio as the current reserves (within integer rounding). Returns the number of LP shares issued.

Source

pub fn remove_liquidity( &mut self, provider: &str, shares: u64, ledger: &mut WebLedger, ) -> Result<(u64, u64), PaymentError>

Remove liquidity from the pool.

Withdraws proportional amounts of both currencies based on the share count. Returns (amount_a, amount_b) credited back.

Source

pub fn swap( &mut self, trader: &str, from_currency: &str, amount_in: u64, ledger: &mut WebLedger, ) -> Result<SwapResult, PaymentError>

Execute a constant-product swap.

Formula (with fee):

amount_out = (reserve_out * amount_in * (10000 - fee_bps))
           / (reserve_in * 10000 + amount_in * (10000 - fee_bps))

All intermediate arithmetic uses u128 to prevent overflow.

Source

pub fn pool_info(&self) -> Value

Pool info as a JSON value (for /pay/.pool response).

Trait Implementations§

Source§

impl Clone for AmmPool

Source§

fn clone(&self) -> AmmPool

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 AmmPool

Source§

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

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

impl<'de> Deserialize<'de> for AmmPool

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AmmPool

Source§

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

Serialize this value into the given Serde serializer. 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<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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,