pool registry docs

PoolRegistry
authority
address authority
Returns the address of the Rigoblock authority contract.
Return Values
rigoblockDao
address rigoblockDao
Returns the address of the Rigoblock Dao.
Return Values
_mapIdByAddress
mapping(address => bytes32) _mapIdByAddress
_poolMetaByAddress
mapping(address => struct IPoolRegistry.PoolMeta) _poolMetaByAddress
onlyWhitelistedFactory
modifier onlyWhitelistedFactory()
onlyPoolOperator
modifier onlyPoolOperator(address pool)
onlyRigoblockDao
modifier onlyRigoblockDao()
whenAddressFree
modifier whenAddressFree(address pool)
whenPoolRegistered
modifier whenPoolRegistered(address pool)
constructor
constructor(address newAuthority, address newRigoblockDao) public
register
function register(address pool, string name, string symbol, bytes32 poolId) external
Allows a factory which is an authority to register a pool.
Parameters
Name
Type
Description
pool
address
Address of the pool.
name
string
String name of the pool (31 characters/bytes or less).
symbol
string
String symbol of the pool (3 to 5 characters/bytes).
poolId
bytes32
Bytes32 of the pool id.
setAuthority
function setAuthority(address newAuthority) external
Allows Rigoblock governance to update authority.
Parameters
Name
Type
Description
newAuthority
address
​
setMeta
function setMeta(address pool, bytes32 key, bytes32 value) external
Allows pool owner to set metadata for a pool.
Parameters
Name
Type
Description
pool
address
Address of the pool.
key
bytes32
Bytes32 of the key.
value
bytes32
Bytes32 of the value.
setRigoblockDao
function setRigoblockDao(address newRigoblockDao) external
Allows Rigoblock Dao to update its address.
Creates internal record.
Parameters
Name
Type
Description
newRigoblockDao
address
Address of the Rigoblock Dao.
getPoolIdFromAddress
function getPoolIdFromAddress(address pool) external view returns (bytes32 poolId)
Returns the id of a pool from its address.
Parameters
Name
Type
Description
pool
address
Address of the pool.
Return Values
Name
Type
Description
poolId
bytes32
bytes32 id of the pool.
getMeta
function getMeta(address pool, bytes32 key) external view returns (bytes32 poolMeta)
Returns metadata for a given pool.
Parameters
Name
Type
Description
pool
address
Address of the pool.
key
bytes32
Bytes32 key.
Return Values
Name
Type
Description
poolMeta
bytes32
Meta by key.
_assertValidNameAndSymbol
function _assertValidNameAndSymbol(string name, string symbol) internal pure
_isContract
function _isContract(address target) private view returns (bool)

Name	Type	Description
pool	address	Address of the pool.
name	string	String name of the pool (31 characters/bytes or less).
symbol	string	String symbol of the pool (3 to 5 characters/bytes).
poolId	bytes32	Bytes32 of the pool id.

Name	Type	Description
newAuthority	address

Name	Type	Description
pool	address	Address of the pool.
key	bytes32	Bytes32 of the key.
value	bytes32	Bytes32 of the value.

Name	Type	Description
newRigoblockDao	address	Address of the Rigoblock Dao.

Name	Type	Description
pool	address	Address of the pool.

Name	Type	Description
poolId	bytes32	bytes32 id of the pool.

Name	Type	Description
pool	address	Address of the pool.
key	bytes32	Bytes32 key.

Name	Type	Description
poolMeta	bytes32	Meta by key.

PoolRegistry

Extensions

Last modified 2mo ago