CreateShapeParams

@bidask-protocol/sdk

---

@bidask-protocol/sdk / CreateShapeParams

Type Alias: CreateShapeParams

CreateShapeParams = object

Defined in: types/liquidity.ts:46

Parameters for creating a liquidity shape

Properties

autocomplete?

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

Defined in: types/liquidity.ts:52

Autocomplete token side

---

baseRatio?

optional baseRatio: number

Defined in: types/liquidity.ts:66

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

Defined in: types/liquidity.ts:60

Basis points for fee calculation

---

currentPrice

currentPrice: number

Defined in: types/liquidity.ts:54

Current price of the pool

---

fallbackRatio?

optional fallbackRatio: number

Defined in: types/liquidity.ts:73

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

Defined in: types/liquidity.ts:56

Starting bin index

---

toBin

toBin: number

Defined in: types/liquidity.ts:58

Ending bin index

---

token0Amount?

optional token0Amount: bigint

Defined in: types/liquidity.ts:48

Amount of token0 to provide

---

token1Amount?

optional token1Amount: bigint

Defined in: types/liquidity.ts:50

Amount of token1 to provide