Skip to main content

CreateShapeParams

@bidask-protocol/sdk

@bidask-protocol/sdk / CreateShapeParams

Type Alias: CreateShapeParams

CreateShapeParams = object

Parameters for creating a liquidity shape

Properties​

autocomplete?​

optional autocomplete: "x" | "y" | null

Autocomplete token side

baseRatio?​

optional baseRatio: number

Ratio of liquidity to distribute from active bin to other bins (0-1) in case of central bin takes all of the liquidity

Default​

1

bps​

bps: bigint

Basis points for fee calculation

currentPrice​

currentPrice: number

Current price of the pool

fallbackRatio?​

optional fallbackRatio: number

Ratio of liquidity to distribute from active bin to other bins (0-1) in case of central bin takes all of the liquidity

Default​

0.8 (for curve and spot shape)

Default​

0.2 (for bidask shape)

fromBin​

fromBin: number

Starting bin index

toBin​

toBin: number

Ending bin index

token0Amount?​

optional token0Amount: bigint

Amount of token0 to provide

token1Amount?​

optional token1Amount: bigint

Amount of token1 to provide