Skip to main content

​
IFactory

Git Source Inherits: IFactoryEvents Author: @oscarsernarosero @mpetersoCode55 @cirsteve function signatures of a Pool Factory

​
Functions

​
VERSION

version of the pool factory 
function VERSION() external view returns (string memory);
Returns
NameTypeDescription
<none>stringthe version of the pool factory

​
setYTokenAllowList

sets the y token allow list 
function setYTokenAllowList(address _address) external;
Parameters
NameTypeDescription
_addressaddressof the allow list contract

​
getYTokenAllowList

gets the y token allow list 
function getYTokenAllowList() external returns (address _address);
Returns
NameTypeDescription
_addressaddressof the current allow list contract

​
setDeployerAllowList

sets the deployer allow list 
function setDeployerAllowList(address _address) external;
Parameters
NameTypeDescription
_addressaddressof the allow list contract

​
getDeployerAllowList

gets the deployer allow list 
function getDeployerAllowList() external returns (address _address);
Returns
NameTypeDescription
_addressaddressof the current allow list contract

​
protocolFee

fee percentage for swaps for the protocol 
function protocolFee() external returns (uint16);
Returns
NameTypeDescription
<none>uint16the percentage for swaps in basis points that will go towards the protocol

​
protocolFeeCollector

protocol-fee collector address 
function protocolFeeCollector() external returns (address);
Returns
NameTypeDescription
<none>addressthe current protocolFeeCollector address

​
proposedProtocolFeeCollector

proposed protocol-fee collector address 
function proposedProtocolFeeCollector() external returns (address);
Returns
NameTypeDescription
<none>addressthe current proposedProtocolFeeCollector address

​
setProtocolFee

This is the function to update the protocol fees per trading. 
function setProtocolFee(uint16 _protocolFee) external;
Parameters
NameTypeDescription
_protocolFeeuint16percentage of the transaction that will get collected as fees (in percentage basis points: 10000 -> 100.00%; 500 -> 5.00%; 1 -> 0.01%)

​
proposeProtocolFeeCollector

that only the current fee collector address can call this function function to propose a new protocol fee collector 
function proposeProtocolFeeCollector(address _protocolFeeCollector) external;
Parameters
NameTypeDescription
_protocolFeeCollectoraddressthe new fee collector

​
confirmProtocolFeeCollector

that only the already proposed fee collector can call this function function to confirm a new protocol fee collector 
function confirmProtocolFeeCollector() external;