IFactory

Table of contents

Constructors

• constructor

Properties

• _origin

Methods

• acceptOwnership
• addQuoteAsset
• createLBPair
• forceDecay
• getAllLBPairs
• getAvailableLBPairBinSteps
• getLBPairInformation
• getOwner
• getPreset
• init
• proposeNewOwner
• removeLBHooksOnPair
• removePreset
• removeQuoteAsset
• setFactoryLockedState
• setFeeRecipient
• setFeesParametersOnPair
• setFlashLoanFee
• setLBHooksParametersOnPair
• setLBPairIgnored
• setPreset

Constructors

constructor

• new IFactory(at): IFactory

Wraps a smart contract exposing standard token FFI.

Parameters

Name	Type	Description
at	Address	Address of the smart contract.

Returns

IFactory

Defined in

assembly/interfaces/IFactory.ts:28

Properties

_origin

• _origin: Address

Defined in

assembly/interfaces/IFactory.ts:21

Methods

acceptOwnership

▸ acceptOwnership(): void

Returns

void

Defined in

assembly/interfaces/IFactory.ts:237

---

addQuoteAsset

▸ addQuoteAsset(_asset): void

Parameters

Name	Type
_asset	Address

Returns

void

Defined in

assembly/interfaces/IFactory.ts:221

---

createLBPair

▸ createLBPair(_tokenA, _tokenB, _activeId, _binStep, _masToSend): Address

Parameters

Name	Type	Description
_tokenA	Address	address of the first token
_tokenB	Address	address of the second token
_activeId	u32	active id disired
_binStep	u32	bin step disired
_masToSend	u64	Massa to send for storage

Returns

Address

the address of the new LBPair

Dev

Create a new LBPair

Defined in

assembly/interfaces/IFactory.ts:99

---

forceDecay

▸ forceDecay(_pair): void

Parameters

Name	Type
_pair	Address

Returns

void

Defined in

assembly/interfaces/IFactory.ts:229

---

getAllLBPairs

▸ getAllLBPairs(_tokenX, _tokenY): LBPairInformation[]

Parameters

Name	Type
_tokenX	Address
_tokenY	Address

Returns

LBPairInformation[]

Defined in

assembly/interfaces/IFactory.ts:60

---

getAvailableLBPairBinSteps

▸ getAvailableLBPairBinSteps(_tokenA, _tokenB): u32[]

Parameters

Name	Type
_tokenA	Address
_tokenB	Address

Returns

u32[]

Defined in

assembly/interfaces/IFactory.ts:241

---

getLBPairInformation

▸ getLBPairInformation(_tokenA, _tokenB, _binStep): LBPairInformation

Parameters

Name	Type
_tokenA	Address
_tokenB	Address
_binStep	u64

Returns

LBPairInformation

Defined in

assembly/interfaces/IFactory.ts:50

---

getOwner

▸ getOwner(): Address

Returns

Address

Defined in

assembly/interfaces/IFactory.ts:247

---

getPreset

▸ getPreset(binstep): Preset

Parameters

Name	Type
binstep	u32

Returns

Preset

Defined in

assembly/interfaces/IFactory.ts:251

---

init

▸ init(_feeRecipient, _quoteAssets, _flashLoanFee?): void

Initialize the factory. This function must be called before any other function.

Parameters

Name	Type	Default value	Description
_feeRecipient	Address	undefined	The address of the fee recipient
_quoteAssets	Address[]	undefined	-
_flashLoanFee	u256	ZERO	The value of the fee for flash loan

Returns

void

Defined in

assembly/interfaces/IFactory.ts:38

---

proposeNewOwner

▸ proposeNewOwner(_newOwner): void

Parameters

Name	Type
_newOwner	Address

Returns

void

Defined in

assembly/interfaces/IFactory.ts:233

---

removeLBHooksOnPair

▸ removeLBHooksOnPair(_tokenA, _tokenB, _binStep): void

Parameters

Name	Type
_tokenA	Address
_tokenB	Address
_binStep	u32

Returns

void

Defined in

assembly/interfaces/IFactory.ts:199

---

removePreset

▸ removePreset(_binStep): void

Parameters

Name	Type
_binStep	u32

Returns

void

Defined in

assembly/interfaces/IFactory.ts:153

---

removeQuoteAsset

▸ removeQuoteAsset(_asset): void

Parameters

Name	Type
_asset	Address

Returns

void

Defined in

assembly/interfaces/IFactory.ts:225

---

setFactoryLockedState

▸ setFactoryLockedState(_factoryLockedState): void

Parameters

Name	Type
_factoryLockedState	bool

Returns

void

Defined in

assembly/interfaces/IFactory.ts:212

---

setFeeRecipient

▸ setFeeRecipient(_feeRecipient): void

Parameters

Name	Type
_feeRecipient	Address

Returns

void

Defined in

assembly/interfaces/IFactory.ts:204

---

setFeesParametersOnPair

▸ setFeesParametersOnPair(_tokenA, _tokenB, _binStep, _baseFactor, _filterPeriod, _decayPeriod, _reductionFactor, _variableFeeControl, _protocolShare, _maxVolatilityAccumulated): void

Parameters

Name	Type
_tokenA	Address
_tokenB	Address
_binStep	u32
_baseFactor	u32
_filterPeriod	u32
_decayPeriod	u32
_reductionFactor	u32
_variableFeeControl	u32
_protocolShare	u32
_maxVolatilityAccumulated	u32

Returns

void

Defined in

assembly/interfaces/IFactory.ts:157

---

setFlashLoanFee

▸ setFlashLoanFee(_flashLoanFee): void

Parameters

Name	Type
_flashLoanFee	u64

Returns

void

Defined in

assembly/interfaces/IFactory.ts:208

---

setLBHooksParametersOnPair

▸ setLBHooksParametersOnPair(_tokenA, _tokenB, _binStep, _hooksParameters, _onHooksSetData): void

Parameters

Name	Type
_tokenA	Address
_tokenB	Address
_binStep	u32
_hooksParameters	HooksParameters
_onHooksSetData	StaticArray<u8>

Returns

void

Defined in

assembly/interfaces/IFactory.ts:183

---

setLBPairIgnored

▸ setLBPairIgnored(_tokenA, _tokenB, _binStep, _ignored): void

Parameters

Name	Type
_tokenA	Address
_tokenB	Address
_binStep	u32
_ignored	bool

Returns

void

Defined in

assembly/interfaces/IFactory.ts:115

---

setPreset

▸ setPreset(_binStep, _baseFactor, _filterPeriod, _decayPeriod, _reductionFactor, _variableFeeControl, _protocolShare, _maxVolatilityAccumulated, _sampleLifeTime): void

Parameters

Name	Type
_binStep	u32
_baseFactor	u32
_filterPeriod	u32
_decayPeriod	u32
_reductionFactor	u32
_variableFeeControl	u32
_protocolShare	u32
_maxVolatilityAccumulated	u32
_sampleLifeTime	u32

Returns

void

Defined in

assembly/interfaces/IFactory.ts:129