Class LiquidityModule

Hierarchy

LiquidityModule

Implements

IModule

Index

Constructors

constructor

Properties

_sdk

Accessors

sdk

Methods

Constructors

constructor

new LiquidityModule(sdk: SDK): LiquidityModule

- Defined in modules/LiquidityModule.ts:82
Parameters
- sdk: SDK
Returns LiquidityModule

Properties

Protected _sdk

_sdk: SDK

Accessors

sdk

get sdk(): SDK

Implementation of IModule.sdk
- Defined in modules/LiquidityModule.ts:78
Returns SDK

Methods

calculateOutputBurn

calculateOutputBurn(params: ICalculateBurnLiquidityParams): Promise<undefined | { withoutSlippage: { x: string; y: string }; x: string; y: string }>

- Defined in modules/LiquidityModule.ts:424
Parameters
- params: ICalculateBurnLiquidityParams
Returns Promise<undefined | { withoutSlippage: { x: string; y: string }; x: string; y: string }>

calculateRateAndMinReceivedLP

calculateRateAndMinReceivedLP(params: ICalculateRatesParams): Promise<{ rate: string; receiveLp: string }>

- Defined in modules/LiquidityModule.ts:228
Parameters
- params: ICalculateRatesParams
Returns Promise<{ rate: string; receiveLp: string }>

calculateSupply

calculateSupply(params: ICalculateSupplyParams): string

- Defined in modules/LiquidityModule.ts:198
Parameters
- params: ICalculateSupplyParams
Returns string

checkPoolExistence

checkPoolExistence(params: TGetResourcesPayload): Promise<boolean>

- Defined in modules/LiquidityModule.ts:86
Parameters
- params: TGetResourcesPayload
Returns Promise<boolean>

createAddLiquidityPayload

createAddLiquidityPayload(params: TCreateLiquidityPoolTXPayloadParams): Promise<TxPayloadCallFunction>

- Defined in modules/LiquidityModule.ts:316
Parameters
- params: TCreateLiquidityPoolTXPayloadParams
Returns Promise<TxPayloadCallFunction>

createBurnLiquidityPayload

createBurnLiquidityPayload(params: ICreateBurnLiquidityPayload): Promise<{ arguments: string[]; function: string; type: string; type_arguments: string[] }>

- Defined in modules/LiquidityModule.ts:382
Parameters
- params: ICreateBurnLiquidityPayload
Returns Promise<{ arguments: string[]; function: string; type: string; type_arguments: string[] }>

getAmountIn

getAmountIn(params: Omit<ICalculateRatesParams, "interactiveToken">): Promise<string>

- Defined in modules/LiquidityModule.ts:218
Parameters
- params: Omit<ICalculateRatesParams, "interactiveToken">
Returns Promise<string>

getAmountOut

getAmountOut(params: Omit<ICalculateRatesParams, "interactiveToken">): Promise<string>

- Defined in modules/LiquidityModule.ts:223
Parameters
- params: Omit<ICalculateRatesParams, "interactiveToken">
Returns Promise<string>

getLiquidityPoolResource

getLiquidityPoolResource(params: TGetResourcesPayload): Promise<{ liquidityPoolResource: undefined | AptosResource<AptosPoolResource> }>

- Defined in modules/LiquidityModule.ts:121
Parameters
- params: TGetResourcesPayload
Returns Promise<{ liquidityPoolResource: undefined | AptosResource<AptosPoolResource> }>

getLiquiditySupplyResource

getLiquiditySupplyResource(params: TGetResourcesPayload): Promise<{ liquidityPoolResource: undefined | AptosResource<AptosCoinInfoResource> }>

- Defined in modules/LiquidityModule.ts:157
Parameters
- params: TGetResourcesPayload
Returns Promise<{ liquidityPoolResource: undefined | AptosResource<AptosCoinInfoResource> }>

Generated using TypeDoc