FeeParameters

Implements

• Serializable

Table of contents

Constructors

• constructor

Properties

• baseFactor
• binStep
• decayPeriod
• filterPeriod
• indexRef
• maxVolatilityAccumulated
• protocolShare
• reductionFactor
• time
• variableFeeControl
• volatilityAccumulated
• volatilityReference

Methods

• deserialize
• getBaseFee
• getFeeAmount
• getFeeAmountDistribution
• getFeeAmountForC
• getFeeAmountFrom
• getTotalFee
• getVariableFee
• serialize
• updateVariableFeeParameters
• updateVolatilityAccumulated

Constructors

constructor

• new FeeParameters(binStep?, baseFactor?, filterPeriod?, decayPeriod?, reductionFactor?, variableFeeControl?, protocolShare?, maxVolatilityAccumulated?, volatilityAccumulated?, volatilityReference?, indexRef?, time?): FeeParameters

Parameters

Name	Type	Default value	Description
binStep	u32	0	The bin step
baseFactor	u32	0	The base factor
filterPeriod	u32	0	The filter period, where the fees stays constant
decayPeriod	u32	0	The decay period, where the fees are halved
reductionFactor	u32	0	The reduction factor, used to calculate the reduction of the accumulator
variableFeeControl	u32	0	The variable fee control, used to control the variable fee, can be 0 to disable them
protocolShare	u32	0	The share of fees sent to protocol
maxVolatilityAccumulated	u32	0	The max value of volatility accumulated
volatilityAccumulated	u32	0	The value of volatility accumulated
volatilityReference	u32	0	The value of volatility reference
indexRef	u32	0	The index reference
time	u64	undefined	The last time the accumulator was called

Returns

FeeParameters

Defined in

assembly/structs/FeeParameters.ts:30

Properties

baseFactor

• baseFactor: u32 = 0

The base factor

Defined in

assembly/structs/FeeParameters.ts:32

---

binStep

• binStep: u32 = 0

The bin step

Defined in

assembly/structs/FeeParameters.ts:31

---

decayPeriod

• decayPeriod: u32 = 0

The decay period, where the fees are halved

Defined in

assembly/structs/FeeParameters.ts:34

---

filterPeriod

• filterPeriod: u32 = 0

The filter period, where the fees stays constant

Defined in

assembly/structs/FeeParameters.ts:33

---

indexRef

• indexRef: u32 = 0

The index reference

Defined in

assembly/structs/FeeParameters.ts:41

---

maxVolatilityAccumulated

• maxVolatilityAccumulated: u32 = 0

The max value of volatility accumulated

Defined in

assembly/structs/FeeParameters.ts:38

---

protocolShare

• protocolShare: u32 = 0

The share of fees sent to protocol

Defined in

assembly/structs/FeeParameters.ts:37

---

reductionFactor

• reductionFactor: u32 = 0

The reduction factor, used to calculate the reduction of the accumulator

Defined in

assembly/structs/FeeParameters.ts:35

---

time

• time: u64

The last time the accumulator was called

Defined in

assembly/structs/FeeParameters.ts:42

---

variableFeeControl

• variableFeeControl: u32 = 0

The variable fee control, used to control the variable fee, can be 0 to disable them

Defined in

assembly/structs/FeeParameters.ts:36

---

volatilityAccumulated

• volatilityAccumulated: u32 = 0

The value of volatility accumulated

Defined in

assembly/structs/FeeParameters.ts:39

---

volatilityReference

• volatilityReference: u32 = 0

The value of volatility reference

Defined in

assembly/structs/FeeParameters.ts:40

Methods

deserialize

▸ deserialize(data, offset): Result<i32>

Parameters

Name	Type
data	StaticArray<u8>
offset	i32

Returns

Result<i32>

Implementation of

Serializable.deserialize

Defined in

assembly/structs/FeeParameters.ts:214

---

getBaseFee

▸ getBaseFee(): u256

Returns

u256

Notice

Returns the base fee added to a swap, with 18 decimals

Defined in

assembly/structs/FeeParameters.ts:125

---

getFeeAmount

▸ getFeeAmount(_amount): u256

Parameters

Name	Type	Description
_amount	u256	The amount of token sent

Returns

u256

The fee amount to add to the amount

Notice

Return the fees to add to an amount

Dev

Rounds amount up, follows amountWithFees = amount + getFeeAmount(amount)

Defined in

assembly/structs/FeeParameters.ts:67

---

getFeeAmountDistribution

▸ getFeeAmountDistribution(_fees): FeesDistribution

Return the fees distribution added to an amount

Parameters

Name	Type	Description
_fees	u256	The fee amount

Returns

FeesDistribution

Defined in

assembly/structs/FeeParameters.ts:51

---

getFeeAmountForC

▸ getFeeAmountForC(_amountWithFees): u256

Parameters

Name	Type	Description
_amountWithFees	u256	The amount of token sent

Returns

u256

The fee amount

Notice

Return the fees added when an user adds liquidity and change the ratio in the active bin

Dev

Rounds amount up

Defined in

assembly/structs/FeeParameters.ts:98

---

getFeeAmountFrom

▸ getFeeAmountFrom(_amountWithFees): u256

Parameters

Name	Type	Description
_amountWithFees	u256	The amount of token sent

Returns

u256

The fee amount from the amount sent

Notice

Return the amount of fees from an amount

Dev

Rounds amount up, follows amount = amountWithFees - getFeeAmountFrom(amountWithFees)

Defined in

assembly/structs/FeeParameters.ts:82

---

getTotalFee

▸ getTotalFee(): u256

Returns

u256

The total fee, with 18 decimals

Notice

Return the total fee, i.e. baseFee + variableFee

Defined in

assembly/structs/FeeParameters.ts:117

---

getVariableFee

▸ getVariableFee(): u256

Returns

u256

Notice

Returns the variable fee added to a swap, with 18 decimals

Defined in

assembly/structs/FeeParameters.ts:135

---

serialize

▸ serialize(): StaticArray<u8>

Returns

StaticArray<u8>

Implementation of

Serializable.serialize

Defined in

assembly/structs/FeeParameters.ts:197

---

updateVariableFeeParameters

▸ updateVariableFeeParameters(_activeId): void

Update the value of the volatility accumulated

Parameters

Name	Type	Description
_activeId	u32	The current active id

Returns

void

Defined in

assembly/structs/FeeParameters.ts:157

---

updateVolatilityAccumulated

▸ updateVolatilityAccumulated(_activeId): void

Update the volatility accumulated

Parameters

Name	Type	Description
_activeId	u32	The current active id

Returns

void

Defined in

assembly/structs/FeeParameters.ts:181