ProtocolConfig
ProtocolConfig stores configuration associated with the OpenGuild protocol, including take rates and contract address whitelists
Methods
DEFAULT_ADMIN_ROLE
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
OWNER_ROLE
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
PAUSER_ROLE
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
POOL_MANAGER_TAKE_RATE
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
PROTOCOL_TAKE_RATE
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
TAKE_RATE_PRECISION
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
__BaseUpgradeablePausable__init
Parameters
Name | Type | Description |
---|---|---|
owner | address | undefined |
__PauserPausable__init
addAggregatePool
Adds the given aggregate pool to the array of validAggregatePoolsOnly callable by the admin
Parameters
Name | Type | Description |
---|---|---|
pool | address | An aggregate pool that the protocol adds |
addIndividualPool
Adds the given individual pool to the array of validIndividualPoolsOnly callable by the admin
Parameters
Name | Type | Description |
---|---|---|
pool | address | An individual pool that the protocol adds |
addresses
Parameters
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | address | undefined |
getAddress
The address at a given index
Parameters
Name | Type | Description |
---|---|---|
index | uint256 | The index of the address |
Returns
Name | Type | Description |
---|---|---|
_0 | address | Returns the address at the given index |
getGovernanceTokenContract
Returns the governance token contract
Returns
Name | Type | Description |
---|---|---|
_0 | contract GovernanceToken | The protocol's governance token contract |
getPoolManagerTakeRate
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | The protocol wide pool manager take rate |
getProtocolTakeRate
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | The protocol wide take rate |
getRoleAdmin
Returns the admin role that controls role
. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
getRoleMember
Returns one of the accounts that have role
. index
must be a value between 0 and {getRoleMemberCount}, non-inclusive. Role bearers are not sorted in any particular way, and their ordering may change at any point. WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure you perform all queries on the same block. See the following https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] for more information.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
index | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | address | undefined |
getRoleMemberCount
Returns the number of accounts that have role
. Can be used together with {getRoleMember} to enumerate all bearers of a role.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
getTakeRatePrecision
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | The protocol wide take rate precision |
getTreasuryAddress
Returns the governance token contract
Returns
Name | Type | Description |
---|---|---|
_0 | address | The OpenGuild treasury address |
grantRole
Grants role
to account
. If account
had not been already granted role
, emits a {RoleGranted} event. Requirements: - the caller must have role
's admin role.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
hasRole
Returns true
if account
has been granted role
.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
initialize
Run only once, on initialization
Parameters
Name | Type | Description |
---|---|---|
_owner | address | The address of who should have the "OWNER_ROLE" of this contract |
_treasury | address | The address of the OpenGuild treasury |
isAdmin
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
isValidAggregatePool
Parameters
Name | Type | Description |
---|---|---|
pool | address | The aggregate pool being checked |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | Whether or not the aggregate pool is valid |
isValidIndividualPool
Whether or not the individual pool is valid
Parameters
Name | Type | Description |
---|---|---|
pool | address | The individual pool being checked |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | Whether or not the given address is a valid individual pool |
pause
Pauses all functions guarded by Pause See {Pausable-_pause}. Requirements: - the caller must have the PAUSER_ROLE.
paused
Returns true if the contract is paused, and false otherwise.
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
removeAggregatePool
Removes the given aggregate pool from the array of validAggregatePoolsOnly callable by the admin
Parameters
Name | Type | Description |
---|---|---|
pool | address | An aggregate pool that the protocol removes |
removeIndividualPool
Removes the given individual pool from the array of validIndividualPoolsOnly callable by the admin
Parameters
Name | Type | Description |
---|---|---|
pool | address | An individual pool that the protocol removes |
renounceRole
Revokes role
from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked role
, emits a {RoleRevoked} event. Requirements: - the caller must be account
.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
revokeRole
Revokes role
from account
. If account
had been granted role
, emits a {RoleRevoked} event. Requirements: - the caller must have role
's admin role.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
setGovernanceTokenAddress
Sets the governance token address in the addresses mappingOnly callable by the admin
Parameters
Name | Type | Description |
---|---|---|
newGovernanceTokenAddress | address | The governance token address |
setTreasuryAddress
Sets the treasury address in the addresses mappingOnly callable by the admin
Parameters
Name | Type | Description |
---|---|---|
newTreasuryAddress | address | The treasury address |
supportsInterface
See {IERC165-supportsInterface}.
Parameters
Name | Type | Description |
---|---|---|
interfaceId | bytes4 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
unpause
Unpauses the contract See {Pausable-_unpause}. Requirements: - the caller must have the Pauser role
validAggregatePools
Parameters
Name | Type | Description |
---|---|---|
_0 | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
validIndividualPools
Parameters
Name | Type | Description |
---|---|---|
_0 | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
Events
Paused
Parameters
Name | Type | Description |
---|---|---|
account | address | undefined |
RoleAdminChanged
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
previousAdminRole | bytes32 | undefined |
newAdminRole | bytes32 | undefined |
RoleGranted
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
sender | address | undefined |
RoleRevoked
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
sender | address | undefined |
Unpaused
Parameters
Name | Type | Description |
---|---|---|
account | address | undefined |
Last updated