Skip to main content

HookBase

balancer_maths_rust::hooks

Trait HookBase 

Source 
pub trait HookBase {
    // Required methods
    fn hook_type(&self) -> &str;
    fn config(&self) -> &HookConfig;
    fn on_before_add_liquidity(
        &self,
        kind: AddLiquidityKind,
        max_amounts_in_scaled_18: &[U256],
        min_bpt_amount_out: &U256,
        balances_scaled_18: &[U256],
        hook_state: &HookState,
    ) -> BeforeAddLiquidityResult;
    fn on_after_add_liquidity(
        &self,
        kind: AddLiquidityKind,
        amounts_in_scaled_18: &[U256],
        amounts_in_raw: &[U256],
        bpt_amount_out: &U256,
        balances_scaled_18: &[U256],
        hook_state: &HookState,
    ) -> AfterAddLiquidityResult;
    fn on_before_remove_liquidity(
        &self,
        kind: RemoveLiquidityKind,
        max_bpt_amount_in: &U256,
        min_amounts_out_scaled_18: &[U256],
        balances_scaled_18: &[U256],
        hook_state: &HookState,
    ) -> BeforeRemoveLiquidityResult;
    fn on_after_remove_liquidity(
        &self,
        kind: RemoveLiquidityKind,
        bpt_amount_in: &U256,
        amounts_out_scaled_18: &[U256],
        amounts_out_raw: &[U256],
        balances_scaled_18: &[U256],
        hook_state: &HookState,
    ) -> AfterRemoveLiquidityResult;
    fn on_before_swap(
        &self,
        swap_params: &SwapParams,
        hook_state: &HookState,
    ) -> BeforeSwapResult;
    fn on_after_swap(
        &self,
        after_swap_params: &AfterSwapParams,
        hook_state: &HookState,
    ) -> AfterSwapResult;
    fn on_compute_dynamic_swap_fee(
        &self,
        swap_params: &SwapParams,
        static_swap_fee_percentage: &U256,
        hook_state: &HookState,
    ) -> DynamicSwapFeeResult;
}
Expand description

Trait for pool hooks (matches Python HookBase interface exactly)

Required Methods§

Source

fn hook_type(&self) -> &str

Get the hook type

Source

fn config(&self) -> &HookConfig

Get the hook configuration

Source

fn on_before_add_liquidity( &self, kind: AddLiquidityKind, max_amounts_in_scaled_18: &[U256], min_bpt_amount_out: &U256, balances_scaled_18: &[U256], hook_state: &HookState, ) -> BeforeAddLiquidityResult

Process before add liquidity (matches Python on_before_add_liquidity)

Source

fn on_after_add_liquidity( &self, kind: AddLiquidityKind, amounts_in_scaled_18: &[U256], amounts_in_raw: &[U256], bpt_amount_out: &U256, balances_scaled_18: &[U256], hook_state: &HookState, ) -> AfterAddLiquidityResult

Process after add liquidity (matches Python on_after_add_liquidity)

Source

fn on_before_remove_liquidity( &self, kind: RemoveLiquidityKind, max_bpt_amount_in: &U256, min_amounts_out_scaled_18: &[U256], balances_scaled_18: &[U256], hook_state: &HookState, ) -> BeforeRemoveLiquidityResult

Process before remove liquidity (matches Python on_before_remove_liquidity)

Source

fn on_after_remove_liquidity( &self, kind: RemoveLiquidityKind, bpt_amount_in: &U256, amounts_out_scaled_18: &[U256], amounts_out_raw: &[U256], balances_scaled_18: &[U256], hook_state: &HookState, ) -> AfterRemoveLiquidityResult

Process after remove liquidity (matches Python on_after_remove_liquidity)

Source

fn on_before_swap( &self, swap_params: &SwapParams, hook_state: &HookState, ) -> BeforeSwapResult

Process before swap (matches Python on_before_swap)

Source

fn on_after_swap( &self, after_swap_params: &AfterSwapParams, hook_state: &HookState, ) -> AfterSwapResult

Process after swap (matches Python on_after_swap)

Source

fn on_compute_dynamic_swap_fee( &self, swap_params: &SwapParams, static_swap_fee_percentage: &U256, hook_state: &HookState, ) -> DynamicSwapFeeResult

Compute dynamic swap fee (matches Python on_compute_dynamic_swap_fee)

Implementors§