PoolDirectory
PoolDirectory is the main directory of all pools created and it is used to create new pools.
The API and Usage is shown below:
Structs / Data Objects
Pool
The Pool
struct is used to store metadata for every pool that is created. It contains details like:
name
creator
comptroller
and timestamps
View Methods
pools(uint id) -> Pool
Returns the pool metadata provided a pool id.
getAllPools -> Pool[]
Returns all the pools created by the pool directory.
getAllPoolsLength -> uint
Returns the number of pools which were created by the pool directory.
getPublicPools -> Pool[]
returns all pools that are whitelisted or private.
getPublicPoolsByVerification -> Pool[]
returns all pools that are managed by a whitelisted admin
enforceDeployerWhitelist -> bool
returns true
if permissionless pool deployment is disabled
adminWhitelist(address admin) -> bool
returns true
if an admin is verified
Writeable Methods
deployPool(string, address, bool, uint, uint, address)
Allows for pool creators or whitelisted users to deploy pools βΊοΈ
returns the poolId
and address
of the pool once it is deployed.
setPoolName(uint256 poolId, string calldata name)
Allows pool admins to change the name of their pool
Last updated