Skip to main content

src/lib/cca/q96

creatorvault-miniapp


creatorvault-miniapp / src/lib/cca/q96

src/lib/cca/q96

Variables

MAX_UINT128

const MAX_UINT128: bigint

Defined in: lib/cca/q96.ts:2


Q96

const Q96: bigint

Defined in: lib/cca/q96.ts:1

Functions

applyBps()

applyBps(value, bps): bigint

Defined in: lib/cca/q96.ts:31

Parameters

value

bigint

bps

number

Returns

bigint


currencyPerTokenBaseUnitsToQ96()

currencyPerTokenBaseUnitsToQ96(currencyPerTokenBaseUnits, tokenDecimals): bigint

Defined in: lib/cca/q96.ts:26

Convert currency base units per 1 token into Q96 fixed-point price.

Example:

  • If currency is ETH (wei) and token has 18 decimals, pass weiPerToken to get priceQ96.

Parameters

currencyPerTokenBaseUnits

bigint

tokenDecimals

number

Returns

bigint


mulDiv()

mulDiv(a, b, denominator): bigint

Defined in: lib/cca/q96.ts:4

Parameters

a

bigint

b

bigint

denominator

bigint

Returns

bigint


q96ToCurrencyPerTokenBaseUnits()

q96ToCurrencyPerTokenBaseUnits(priceQ96, tokenDecimals): bigint

Defined in: lib/cca/q96.ts:15

Convert a Q96 fixed-point price (currencyBase/tokenBase * Q96) into currency base units per 1 token.

Example:

  • If currency is ETH (wei) and token has 18 decimals, this returns wei per 1 token.

Parameters

priceQ96

bigint

tokenDecimals

number

Returns

bigint