Colony Network (IColonyNetwork)
The functions for managing the Colony Network as a whole. Includes functions for creating and upgrading colonies, managing the reputation mining process, managing the skills used in colonies, and managing colony ENS names. These functions are not publically callable, but rather callable by the Meta Colony, a special colony which controls the network.
Interface Methods
▸ addColonyVersion(uint256 _version, address _resolver)
Adds a new Colony contract version and the address of associated _resolver contract. Secured function to authorised members. Allowed to be called by the Meta Colony only.
Parameters
| Name | Type | Description |
|---|---|---|
| _version | uint256 | The new Colony contract version |
| _resolver | address | Address of the Resolver contract which will be used with the underlying EtherRouter contract |
▸ addExtensionToNetwork(bytes32 _extensionId, address _resolver)
Add a new extension resolver to the Extensions repository.
Note: Can only be called by the MetaColony.
Parameters
| Name | Type | Description |
|---|---|---|
| _extensionId | bytes32 | keccak256 hash of the extension name, used as an indentifier |
| _resolver | address | The deployed resolver containing the extension contract logic |
▸ addPendingReputationUpdate(uint256 _chainId, address _colony)
Try to emit the next reputation update that was bridged but previously failed, if any
Parameters
| Name | Type | Description |
|---|---|---|
| _chainId | uint256 | The chainId the update was bridged from |
| _colony | address | The colony being queried |
▸ addPendingSkill(uint256 _skillId)
Called to add a bridged skill that wasn't next when it was bridged, but now is
Parameters
| Name | Type | Description |
|---|---|---|
| _skillId | uint256 | The skillId of the skill being bridged |
▸ addReputationUpdateLogFromBridge(address _colony, address _user, int _amount, uint _skillId, uint256 _updateNumber)
Adds a reputation update entry to log.
Note: Errors if it is called by anyone but a known bridge
Parameters
| Name | Type | Description |
|---|---|---|
| _colony | address | The colony the reputation is being awarded in |
| _user | address | The address of the user for the reputation update |
| _amount | int | The amount of reputation change for the update, this can be a negative as well as a positive value |
| _skillId | uint | The skill for the reputation update |
| _updateNumber | uint256 | The counter used for ordering bridged updates |
▸ addSkill(uint256 _parentSkillId):uint256 _skillId
Adds a new skill to the domain or local skills tree, under skill _parentSkillId. Any colony is allowed to add a local skill and which is associated with a new domain via IColony.addDomain.
Note: Errors if the parent skill does not exist or if this is called by an unauthorised sender.
Parameters
| Name | Type | Description |
|---|---|---|
| _parentSkillId | uint256 | Id of the skill under which the new skill will be added. If 0, a global skill is added with no parent. |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _skillId | uint256 | Id of the added skill |
▸ addSkillFromBridge(uint256 _parentSkillId, uint256 _skillCount)
Function called by bridge transactions to add a new skill
Parameters
| Name | Type | Description |
|---|---|---|
| _parentSkillId | uint256 | The parent id of the new skill |
| _skillCount | uint256 | The number of the new skill being created |
▸ addr(bytes32 _node):address _address
Returns the address the supplied node resolves do, if we are the resolver.
Parameters
| Name | Type | Description |
|---|---|---|
| _node | bytes32 | The namehash of the ENS address being requested |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _address | address | The address the supplied node resolves to |
▸ appendReputationUpdateLog(address _user, int256 _amount, uint256 _skillId)
Adds a reputation update entry to the log.
Note: Errors if it is called by anyone but a colony or if skill with id _skillId does not exist or.
Parameters
| Name | Type | Description |
|---|---|---|
| _user | address | The address of the user for the reputation update |
| _amount | int256 | The amount of reputation change for the update, this can be a negative as well as a positive value |
| _skillId | uint256 | The skill for the reputation update |
▸ approveExitRecovery()
Indicate approval to exit recovery mode. Can only be called by user with recovery role.
▸ bridgeCurrentRootHash(uint256 chainId)
Initiate a cross-chain update of the current reputation state
Parameters
| Name | Type | Description |
|---|---|---|
| chainId | uint256 | The chainid we want to bridge to |
▸ bridgePendingReputationUpdate(address _colony, uint256 _updateNumber)
Try to bridge a reputation update that (previously) failed
Parameters
| Name | Type | Description |
|---|---|---|
| _colony | address | The colony being queried |
| _updateNumber | uint256 | the emission index to bridge |
▸ bridgeSkillIfNotMiningChain(uint256 skillId)
Called to re-send the bridging transaction for a skill to the
Parameters
| Name | Type | Description |
|---|---|---|
| skillId | uint256 | The skillId we're bridging the creation of |
▸ burnUnneededRewards(uint256 _amount)
Used to burn tokens that are not needed to pay out rewards (because not every possible defence was made for all submissions)
Note: Only callable by the active reputation mining cycle
Parameters
| Name | Type | Description |
|---|---|---|
| _amount | uint256 | The amount of CLNY to burn |
▸ calculateMinerWeight(uint256 _timeStaked, uint256 _submissonIndex):uint256 _minerWeight
Calculate raw miner weight in WADs.
Parameters
| Name | Type | Description |
|---|---|---|
| _timeStaked | uint256 | Amount of time (in seconds) that the miner has staked their CLNY |
| _submissonIndex | uint256 | Index of reputation hash submission (between 0 and 11) |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _minerWeight | uint256 | The weight of miner reward |
▸ checkNotAdditionalProtectedVariable(uint256 _slot)
Check whether the supplied slot is a protected variable specific to this contract
Note: No return value, but should throw if protected.
Parameters
| Name | Type | Description |
|---|---|---|
| _slot | uint256 | The storage slot number to check. |
▸ claimMiningReward(address _recipient)
Used by a user to claim any mining rewards due to them. This will place them in their balance or pending balance, as appropriate.
Note: Can be called by anyone, not just _recipient
Parameters
| Name | Type | Description |
|---|---|---|
| _recipient | address | The user whose rewards to claim |
▸ createColony(address _tokenAddress):address _colonyAddress
Creates a new colony in the network, at version 3
Note: This is now deprecated and will be removed in a future version
Parameters
| Name | Type | Description |
|---|---|---|
| _tokenAddress | address | Address of an ERC20 token to serve as the colony token. |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _colonyAddress | address | Address of the newly created colony |
▸ createColony(address _tokenAddress, uint256 _version, string memory _colonyName):address _colonyAddress
Creates a new colony in the network, with an optional ENS name
Note: For the colony to mint tokens, token ownership must be transferred to the new colony
Parameters
| Name | Type | Description |
|---|---|---|
| _tokenAddress | address | Address of an ERC20 token to serve as the colony token |
| _version | uint256 | The version of colony to deploy (pass 0 for the current version) |
| _colonyName | string | The label to register (if null, no label is registered) |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _colonyAddress | address | Address of the newly created colony |
▸ createColony(address _tokenAddress, uint256 _version, string memory _colonyName, string memory _metadata):address _colonyAddress
Creates a new colony in the network, with an optional ENS name
Note: For the colony to mint tokens, token ownership must be transferred to the new colony
Parameters
| Name | Type | Description |
|---|---|---|
| _tokenAddress | address | Address of an ERC20 token to serve as the colony token |
| _version | uint256 | The version of colony to deploy (pass 0 for the current version) |
| _colonyName | string | The label to register (if null, no label is registered) |
| _metadata | string | The metadata associated with the new colony |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _colonyAddress | address | Address of the newly created colony |
▸ createColony(address _tokenAddress, uint256 _version, string memory _colonyName, string memory _orbitdb, bool _useExtensionManager):address _colonyAddress
Overload of the simpler createColony -- creates a new colony in the network with a variety of options, at version 4
Note: This is now deprecated and will be removed in a future version
Parameters
| Name | Type | Description |
|---|---|---|
| _tokenAddress | address | Address of an ERC20 token to serve as the colony token |
| _version | uint256 | The version of colony to deploy (pass 0 for the current version) |
| _colonyName | string | The label to register (if null, no label is registered) |
| _orbitdb | string | DEPRECATED Currently a no-op |
| _useExtensionManager | bool | DEPRECATED Currently a no-op |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _colonyAddress | address | Address of the newly created colony |
▸ createColonyForFrontend(address _tokenAddress, string memory _name, string memory _symbol, uint8 _decimals, uint256 _version, string memory _colonyName, string memory _metadata):address token, address colony
Creates a new colony in the network, possibly with a token and token authority, with an optional ENS name
Note: We expect this function to only be used by the dapp
Parameters
| Name | Type | Description |
|---|---|---|
| _tokenAddress | address | Address of an ERC20 token to serve as the colony token (optional) |
| _name | string | The name of the token (optional) |
| _symbol | string | The short 'ticket' symbol for the token (optional) |
| _decimals | uint8 | The number of decimal places that 1 user-facing token can be divided up in to (optional) In the case of ETH, and most tokens, this is 18. |
| _version | uint256 | The version of colony to deploy (pass 0 for the current version) |
| _colonyName | string | The label to register (if null, no label is registered) |
| _metadata | string | The metadata associated with the new colony |
Return Parameters
| Name | Type | Description |
|---|---|---|
| token | address | The address of the token - this may just be the passed _tokenAddress |
| colony | address |
▸ createMetaColony(address _tokenAddress)
Create the Meta Colony, same as a normal colony plus the root skill.
Parameters
| Name | Type | Description |
|---|---|---|
| _tokenAddress | address | Address of the CLNY token |
▸ deployTokenAuthority(address _token, address _colony, address[] memory _allowedToTransfer):address _tokenAuthority
Called to deploy a token authority
Note: This is more expensive than deploying a token directly, but is able to be done via a metatransaction
Parameters
| Name | Type | Description |
|---|---|---|
| _token | address | The address of the token |
| _colony | address | The address of the colony in control of the token |
| _allowedToTransfer | address[] | An array of addresses that are allowed to transfer the token even if it's locked |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _tokenAuthority | address | The address of the newly deployed TokenAuthority |
▸ deployTokenViaNetwork(string memory _name, string memory _symbol, uint8 _decimals):address _token
Called to deploy a token.
Note: This is more expensive than deploying a token directly, but is able to be done via a metatransaction
Parameters
| Name | Type | Description |
|---|---|---|
| _name | string | The name of the token |
| _symbol | string | The short 'ticket' symbol for the token |
| _decimals | uint8 | The number of decimal places that 1 user-facing token can be divided up in to In the case of ETH, and most tokens, this is 18. |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _token | address | The address of the newly deployed token |
▸ deprecateExtension(bytes32 _extensionId, bool _deprecated)
Set the deprecation of an extension in a colony. Can only be called by a Colony.
Parameters
| Name | Type | Description |
|---|---|---|
| _extensionId | bytes32 | keccak256 hash of the extension name, used as an indentifier |
| _deprecated | bool | Whether to deprecate the extension or not |
▸ deprecateSkill(uint256 _skillId, bool _deprecated):bool _changed
DEPRECATED Set deprecation status for a skill
Note: Deprecated and will revert if called
Parameters
| Name | Type | Description |
|---|---|---|
| _skillId | uint256 | Id of the skill |
| _deprecated | bool | Deprecation status |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _changed | bool | Whether the deprecated state was changed |
▸ enterRecoveryMode()
Put colony network mining into recovery mode. Can only be called by user with recovery role.
▸ executeMetaTransaction(address userAddress, bytes memory payload, bytes32 sigR, bytes32 sigS, uint8 sigV):bytes returnData
Executes a metatransaction targeting this contract
Parameters
| Name | Type | Description |
|---|---|---|
| userAddress | address | The address of the user that signed the metatransaction |
| payload | bytes | The transaction data that will be executed if signature valid |
| sigR | bytes32 | The 'r' part of the signature |
| sigS | bytes32 | The 's' part of the signature |
| sigV | uint8 | The 'v' part of the signature |
Return Parameters
| Name | Type | Description |
|---|---|---|
| returnData | bytes | The return data of the executed transaction |
▸ exitRecoveryMode()
Exit recovery mode, can be called by anyone if enough whitelist approvals are given.
▸ getBridgedReputationUpdateCount(uint256 _chainId, address _colony):uint256 bridgedReputationCount
Get the (currently bridged) reputation update count of a chain
Note: On the non-mining chain, this tracks the number of reputation updates that have either been bridged, or attempted to be bridged (and failed, and are now pending bridging). On the mining chain, it tracks how many have been successfully bridged and added to the log.
Parameters
| Name | Type | Description |
|---|---|---|
| _chainId | uint256 | The chainid of the chain |
| _colony | address | The colony being queried |
Return Parameters
| Name | Type | Description |
|---|---|---|
| bridgedReputationCount | uint256 | The bridge reputation count of the corresponding chain |
▸ getBridgedSkillCounts(uint256 _chainId):uint256 skillCount
Get the (currently bridged) skill count of another chain
Parameters
| Name | Type | Description |
|---|---|---|
| _chainId | uint256 | The chainid of foreign chain |
Return Parameters
| Name | Type | Description |
|---|---|---|
| skillCount | uint256 | The skillCount of the corresponding chain |
▸ getChildSkillId(uint256 _skillId, uint256 _childSkillIndex):uint256 _childSkillId
Get the id of the child skill at index _childSkillIndex for skill with Id _skillId.
Parameters
| Name | Type | Description |
|---|---|---|
| _skillId | uint256 | Id of the skill |
| _childSkillIndex | uint256 | Index of the skill.children array to get |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _childSkillId | uint256 | Skill Id of the requested child skill |
▸ getColony(uint256 _id):address _colonyAddress
Get a colony address by its Id in the network.
Parameters
| Name | Type | Description |
|---|---|---|
| _id | uint256 | Id of the colony to get |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _colonyAddress | address | The colony address, if no colony was found, returns 0x0 |
▸ getColonyBridgeAddress():address bridge
Called to get the next bridge in the list after bridge _bridgeAddress
Return Parameters
| Name | Type | Description |
|---|---|---|
| bridge | address | The address of the bridge to the mining chain, if set |
▸ getColonyCount():uint256 _count
Get the number of colonies in the network.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _count | uint256 | The colony count |
▸ getColonyCreationSalt():bytes32 salt
Pseudo-randomly generates a salt used for colony creation
Return Parameters
| Name | Type | Description |
|---|---|---|
| salt | bytes32 | The generated salt |
▸ getColonyVersionResolver(uint256 _version):address _resolverAddress
Get the Resolver address for Colony contract version _version.
Parameters
| Name | Type | Description |
|---|---|---|
| _version | uint256 | The Colony contract version |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _resolverAddress | address | Address of the Resolver contract |
▸ getCurrentColonyVersion():uint256 _version
Returns the latest Colony contract version. This is the version used to create all new colonies.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _version | uint256 | The current / latest Colony contract version |
▸ getENSRegistrar():address _address
Returns the address of the ENSRegistrar for the Network.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _address | address | The address the ENSRegistrar resolves to |
▸ getExtensionInstallation(bytes32 _extensionId, address _colony):address _installation
Get an extension's installation.
Parameters
| Name | Type | Description |
|---|---|---|
| _extensionId | bytes32 | keccak256 hash of the extension name, used as an indentifier |
| _colony | address | Address of the colony the extension is installed in |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _installation | address | The address of the installed extension |
▸ getExtensionResolver(bytes32 _extensionId, uint256 _version):address _resolver
Get an extension's resolver.
Parameters
| Name | Type | Description |
|---|---|---|
| _extensionId | bytes32 | keccak256 hash of the extension name, used as an indentifier |
| _version | uint256 | Version of the extension |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _resolver | address | The address of the deployed resolver |
▸ getFeeInverse():uint256 _feeInverse
Return 1 / the fee to pay to the network. e.g. if the fee is 1% (or 0.01), return 100.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _feeInverse | uint256 | The inverse of the network fee |
▸ getMetaColony():address _colonyAddress
Get the Meta Colony address.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _colonyAddress | address | The Meta colony address, if no colony was found, returns 0x0 |
▸ getMetatransactionNonce(address userAddress):uint256 nonce
Gets the next metatransaction nonce for user that should be used targeting this contract
Parameters
| Name | Type | Description |
|---|---|---|
| userAddress | address | The address of the user that will sign the metatransaction |
Return Parameters
| Name | Type | Description |
|---|---|---|
| nonce | uint256 | The nonce that should be used for the next metatransaction |
▸ getMiningChainId():uint256 reputationMiningChainId
Returns the chainId the network is expecting reputation mining to be one
Return Parameters
| Name | Type | Description |
|---|---|---|
| reputationMiningChainId | uint256 | The chainId |
▸ getMiningDelegator(address _delegate):address _delegator
Called to get the address _delegate is allowed to mine for
Parameters
| Name | Type | Description |
|---|---|---|
| _delegate | address | The address that wants to mine |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _delegator | address | The address they are allowed to mine on behalf of |
▸ getMiningResolver():address miningResolverAddress
Get the resolver to be used by new instances of ReputationMiningCycle.
Return Parameters
| Name | Type | Description |
|---|---|---|
| miningResolverAddress | address | The address of the mining cycle resolver currently used by new instances |
▸ getMiningStake(address _user):MiningStake _info
returns how much CLNY _user has staked for the purposes of reputation mining
Parameters
| Name | Type | Description |
|---|---|---|
| _user | address | The user to query |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _info | MiningStake | The amount staked and the timestamp the stake was made at. |
▸ getParentSkillId(uint256 _skillId, uint256 _parentSkillIndex):uint256 _parentSkillId
Get the id of the parent skill at index _parentSkillIndex for skill with Id _skillId.
Parameters
| Name | Type | Description |
|---|---|---|
| _skillId | uint256 | Id of the skill |
| _parentSkillIndex | uint256 | Index of the skill.parents array to get Note that not all parent skill ids are stored here. See Skill.parents member for definition on which parents are stored |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _parentSkillId | uint256 | Skill Id of the requested parent skill |
▸ getPayoutWhitelist(address _token):bool _status
Get a token's status in the payout whitelist
Parameters
| Name | Type | Description |
|---|---|---|
| _token | address | The token being queried |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _status | bool | Will be true if token is whitelisted |
▸ getPendingReputationUpdate(uint256 _chainId, address _colony, uint256 _updateNumber):PendingReputationUpdate update
Get the details of a reputation update that was bridged but was not added to the log because it was bridged out of order
Parameters
| Name | Type | Description |
|---|---|---|
| _chainId | uint256 | The chainId the update was bridged from |
| _colony | address | The colony being queried |
| _updateNumber | uint256 | the updatenumber being queries |
Return Parameters
| Name | Type | Description |
|---|---|---|
| update | PendingReputationUpdate | The update stored for that chain/colony/updateNumber |
▸ getPendingSkillAddition(uint256 _chainId, uint256 _skillCount):uint256 parentId
Called to get the information about a skill that has been bridged out of order
Parameters
| Name | Type | Description |
|---|---|---|
| _chainId | uint256 | The chainId we're bridging from |
| _skillCount | uint256 | The skill count |
Return Parameters
| Name | Type | Description |
|---|---|---|
| parentId | uint256 | The parent id of the skill being added |
▸ getProfileDBAddress(bytes32 _node):string _orbitdb
Retrieve the orbitdb address corresponding to a registered account.
Parameters
| Name | Type | Description |
|---|---|---|
| _node | bytes32 | The Namehash of the account being queried. |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _orbitdb | string | A string containing the address of the orbit database |
▸ getReplacementReputationUpdateLogEntry(address _reputationMiningCycle, uint256 _id):ReputationLogEntry _reputationLogEntry
Get a replacement log entry (if set) for the log entry _id in the mining cycle that was at the address _reputationMiningCycle.
Parameters
| Name | Type | Description |
|---|---|---|
| _reputationMiningCycle | address | The address of the reputation mining cycle we are asking about |
| _id | uint256 | The log entry number we wish to see if there is a replacement for |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _reputationLogEntry | ReputationLogEntry | ReputationLogEntry instance with the details of the log entry (if it exists) |
▸ getReplacementReputationUpdateLogsExist(address _reputationMiningCycle):bool _exists
Used by the client to avoid doubling the number of RPC calls when syncing from scratch.
Parameters
| Name | Type | Description |
|---|---|---|
| _reputationMiningCycle | address | The reputation mining cycle address we want to know if any entries have been replaced in. |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _exists | bool | Boolean indicating whether there is a replacement log |
▸ getReputationMiningCycle(bool _active):address _repMiningCycleAddress
Get the address of either the active or inactive reputation mining cycle, based on active. The active reputation mining cycle is the one currently under consideration by reputation miners. The inactive reputation cycle is the one with the log that is being appended to.
Parameters
| Name | Type | Description |
|---|---|---|
| _active | bool | Whether the user wants the active or inactive reputation mining cycle |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _repMiningCycleAddress | address | address of active or inactive ReputationMiningCycle |
▸ getReputationMiningCycleReward():uint256 _amount
Called to get the total per-cycle reputation mining reward.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _amount | uint256 | The CLNY awarded per mining cycle to the miners |
▸ getReputationMiningSkillId():uint256 _skillId
Get the skillId of the reputation mining skill. Only set once the metacolony is set up.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _skillId | uint256 | The skillId of the reputation mining skill. |
▸ getReputationRootHash():bytes32 rootHash
Get the root hash of the current reputation state tree.
Return Parameters
| Name | Type | Description |
|---|---|---|
| rootHash | bytes32 | The current Reputation Root Hash |
▸ getReputationRootHashNLeaves():uint256 nLeaves
Get the number of leaves in the current reputation state tree.
Note: I cannot see a reason why a user's client would need to call this - only stored to help with some edge cases in reputation mining dispute resolution.
Return Parameters
| Name | Type | Description |
|---|---|---|
| nLeaves | uint256 | uint256 The number of leaves in the state tree |
▸ getReputationRootHashNNodes():uint256 nNodes
Get the number of leaves in the current reputation state tree.
Note: Deprecated, replaced by getReputationRootHashNLeaves which does the same thing but is more accurately named.
Return Parameters
| Name | Type | Description |
|---|---|---|
| nNodes | uint256 | uint256 The number of leaves in the state tree |
▸ getSkill(uint256 _skillId):Skill _skill
Get the nParents and nChildren of skill with id _skillId.
Parameters
| Name | Type | Description |
|---|---|---|
| _skillId | uint256 | Id of the skill |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _skill | Skill | The Skill struct |
▸ getSkillCount():uint256 _count
Get the number of skills in the network including both global and local skills.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _count | uint256 | The skill count |
▸ getTokenLocking():address _lockingAddress
Get token locking contract address.
Return Parameters
| Name | Type | Description |
|---|---|---|
| _lockingAddress | address | Token locking contract address |
▸ initialise(address _resolver, uint256 _version)
Initialises the colony network by setting the first Colony version resolver to _resolver address.
Note: Only allowed to be run once, by the Network owner before any Colony versions are added.
Parameters
| Name | Type | Description |
|---|---|---|
| _resolver | address | Address of the resolver for Colony contract |
| _version | uint256 | Version of the Colony contract the resolver represents |
▸ initialiseReputationMining(uint256 miningChainId, bytes32 newHash, uint256 newNLeaves)
Creates initial inactive reputation mining cycle.
Note: Only callable from metacolony
Parameters
| Name | Type | Description |
|---|---|---|
| miningChainId | uint256 | The chainId of the chain the mining cycle is being created on Can either be this chain or another chain, and the function will behave differently depending on which is the case. |
| newHash | bytes32 | The root hash of the reputation state tree |
| newNLeaves | uint256 | The number of leaves in the state tree |
▸ initialiseRootLocalSkill():uint256 _rootLocalSkillId
Initialise the local skills tree for a colony
Return Parameters
| Name | Type | Description |
|---|---|---|
| _rootLocalSkillId | uint256 | The root local skill |
▸ installExtension(bytes32 _extensionId, uint256 _version)
Install an extension in a colony. Can only be called by a Colony.
Parameters
| Name | Type | Description |
|---|---|---|
| _extensionId | bytes32 | keccak256 hash of the extension name, used as an indentifier |
| _version | uint256 | Version of the extension to install |
▸ isColony(address _colony):bool _addressIsColony
Check if specific address is a colony created on colony network.
Parameters
| Name | Type | Description |
|---|---|---|
| _colony | address | Address of the colony |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _addressIsColony | bool | true if specified address is a colony, otherwise false |
▸ isInRecoveryMode():bool inRecoveryMode
Is colony network in recovery mode.
Return Parameters
| Name | Type | Description |
|---|---|---|
| inRecoveryMode | bool | Return true if recovery mode is active, false otherwise |
▸ lookupRegisteredENSDomain(address _addr):string _domain
Reverse lookup a username from an address.
Parameters
| Name | Type | Description |
|---|---|---|
| _addr | address | The address we wish to find the corresponding ENS domain for (if any) |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _domain | string | A string containing the colony-based ENS name corresponding to addr |
▸ multicall(bytes[] calldata data):bytes[] results
Call multiple functions in the current contract and return the data from all of them if they all succeed
Note: The msg.value should not be trusted for any method callable from multicall.
Parameters
| Name | Type | Description |
|---|---|---|
| data | bytes[] | The encoded function data for each of the calls to make to this contract |
Return Parameters
| Name | Type | Description |
|---|---|---|
| results | bytes[] | The results from each of the calls passed in via data |
▸ numRecoveryRoles():uint64 numRoles
Return number of recovery roles.
Return Parameters
| Name | Type | Description |
|---|---|---|
| numRoles | uint64 | Number of users with the recovery role. |
▸ punishStakers(address[] memory _stakers, uint256 _amount)
Function called to punish people who staked against a new reputation root hash that turned out to be incorrect.
Note: While external, it can only be called successfully by the current ReputationMiningCycle.
Parameters
| Name | Type | Description |
|---|---|---|
| _stakers | address[] | Array of the addresses of stakers to punish |
| _amount | uint256 | Amount of stake to slash |
▸ registerColonyLabel(string memory _colonyName, string memory _orbitdb)
Register a "colony.joincolony.eth" label. Can only be called by a Colony.
Parameters
| Name | Type | Description |
|---|---|---|
| _colonyName | string | The label to register. |
| _orbitdb | string | The path of the orbitDB database associated with the colony name |
▸ registerUserLabel(string memory _username, string memory _orbitdb)
Register a "user.joincolony.eth" label.
Parameters
| Name | Type | Description |
|---|---|---|
| _username | string | The label to register |
| _orbitdb | string | The path of the orbitDB database associated with the user profile |
▸ removeRecoveryRole(address _user)
Remove colony recovery role. Can only be called by root role.
Parameters
| Name | Type | Description |
|---|---|---|
| _user | address | User we want to remove recovery role from |
▸ reward(address _recipient, uint256 _amount)
Used to track that a user is eligible to claim a reward
Note: Only callable by the active reputation mining cycle
Parameters
| Name | Type | Description |
|---|---|---|
| _recipient | address | The address receiving the award |
| _amount | uint256 | The amount of CLNY to be awarded |
▸ setColonyBridgeAddress(address _bridgeAddress)
Called to set the address of the colony bridge contract
Parameters
| Name | Type | Description |
|---|---|---|
| _bridgeAddress | address | The address of the bridge |
▸ setFeeInverse(uint256 _feeInverse)
Set the colony network fee to pay. e.g. if the fee is 1% (or 0.01), pass 100 as _feeInverse.
Parameters
| Name | Type | Description |
|---|---|---|
| _feeInverse | uint256 | The inverse of the network fee to set |
▸ setMiningDelegate(address _delegate, bool _allowed)
Called to give or remove another address's permission to mine on your behalf
Parameters
| Name | Type | Description |
|---|---|---|
| _delegate | address | The address you're giving or removing permission from |
| _allowed | bool | Whether they are allowed (true) or not (false) to mine on your behalf |
▸ setMiningResolver(address _miningResolverAddress)
Set the resolver to be used by new instances of ReputationMiningCycle.
Parameters
| Name | Type | Description |
|---|---|---|
| _miningResolverAddress | address | The address of the Resolver contract with the functions correctly wired. |
▸ setPayoutWhitelist(address _token, bool _status)
Set a token's status in the payout whitelist
Parameters
| Name | Type | Description |
|---|---|---|
| _token | address | The token being set |
| _status | bool | The whitelist status |
▸ setRecoveryRole(address _user)
Set new colony recovery role. Can be called by root.
Parameters
| Name | Type | Description |
|---|---|---|
| _user | address | User we want to give a recovery role to |
▸ setReplacementReputationUpdateLogEntry(address _reputationMiningCycle, uint256 _id, address _user, int _amount, uint256 _skillId, address _colony, uint128 _nUpdates, uint128 _nPreviousUpdates)
Set a replacement log entry if we're in recovery mode.
Note: Note that strictly, _nUpdates and _nPreviousUpdates don't need to be set - they're only used during dispute resolution, which these replacement log entries are never used for. However, for ease of resyncing the client, we have decided to include them for now.
Parameters
| Name | Type | Description |
|---|---|---|
| _reputationMiningCycle | address | The address of the reputation mining cycle that the log was in. |
| _id | uint256 | The number of the log entry in the reputation mining cycle in question. |
| _user | address | The address of the user earning / losing the reputation |
| _amount | int | The amount of reputation being earned / lost |
| _skillId | uint256 | The id of the origin skill for the reputation update |
| _colony | address | The address of the colony being updated |
| _nUpdates | uint128 | The number of updates the log entry corresponds to |
| _nPreviousUpdates | uint128 | The number of updates in the log before this entry |
▸ setReputationMiningCycleReward(uint256 _amount)
Called to set the total per-cycle reputation reward, which will be split between all miners.
Note: Can only be called by the MetaColony.
Parameters
| Name | Type | Description |
|---|---|---|
| _amount | uint256 | The CLNY awarded per mining cycle to the miners |
▸ setReputationRootHash(bytes32 _newHash, uint256 _newNLeaves, address[] memory _stakers)
Set a new Reputation root hash and starts a new mining cycle. Can only be called by the ReputationMiningCycle contract.
Parameters
| Name | Type | Description |
|---|---|---|
| _newHash | bytes32 | The reputation root hash |
| _newNLeaves | uint256 | The updated leaves count value |
| _stakers | address[] | Array of users who submitted or backed the hash, being accepted here as the new reputation root hash |
▸ setReputationRootHashFromBridge(bytes32 newHash, uint256 newNLeaves, uint256 nonce)
Update the reputation on a foreign chain from the mining chain
Note: Should error if called by anyone other than the known bridge from the mining chain
Parameters
| Name | Type | Description |
|---|---|---|
| newHash | bytes32 | The new root hash |
| newNLeaves | uint256 | The new nLeaves in the root hash |
| nonce | uint256 | The nonce to ensure these txs can't be replayed |
▸ setStorageSlotRecovery(uint256 _slot, bytes32 _value)
Update value of arbitrary storage variable. Can only be called by user with recovery role.
Note: certain critical variables are protected from editing in this function
Parameters
| Name | Type | Description |
|---|---|---|
| _slot | uint256 | Uint address of storage slot to be updated |
| _value | bytes32 | word of data to be set |
▸ setTokenLocking(address _tokenLockingAddress)
Sets the token locking address. This is only set once, and can't be changed afterwards.
Parameters
| Name | Type | Description |
|---|---|---|
| _tokenLockingAddress | address | Address of the locking contract |
▸ setupRegistrar(address _ens, bytes32 _rootNode)
Setup registrar with ENS and root node.
Parameters
| Name | Type | Description |
|---|---|---|
| _ens | address | Address of ENS registrar |
| _rootNode | bytes32 | Namehash of the root node for the domain |
▸ stakeForMining(uint256 _amount)
Stake CLNY to allow the staker to participate in reputation mining.
Parameters
| Name | Type | Description |
|---|---|---|
| _amount | uint256 | Amount of CLNY to stake for the purposes of mining |
▸ startNextCycle()
Starts a new Reputation Mining cycle. Explicitly called only the first time, subsequently called from within setReputationRootHash.
▸ startTokenAuction(address _token)
Create and start a new DutchAuction for the entire amount of _token owned by the Colony Network.
Parameters
| Name | Type | Description |
|---|---|---|
| _token | address | Address of the token held by the network to be auctioned |
▸ supportsInterface(bytes4 _interfaceID):bool _status
Query if a contract implements an interface
Note: Interface identification is specified in ERC-165.
Parameters
| Name | Type | Description |
|---|---|---|
| _interfaceID | bytes4 | The interface identifier, as specified in ERC-165 |
Return Parameters
| Name | Type | Description |
|---|---|---|
| _status | bool | true if the contract implements interfaceID |
▸ uninstallExtension(bytes32 _extensionId)
Uninstall an extension in a colony. Can only be called by a Colony.
Parameters
| Name | Type | Description |
|---|---|---|
| _extensionId | bytes32 | keccak256 hash of the extension name, used as an indentifier |
▸ unstakeForMining(uint256 _amount)
Unstake CLNY currently staked for reputation mining.
Parameters
| Name | Type | Description |
|---|---|---|
| _amount | uint256 | Amount of CLNY staked for mining to unstake |
▸ updateColonyOrbitDB(string memory _orbitdb)
Update a colony's orbitdb address. Can only be called by a colony with a registered subdomain
Parameters
| Name | Type | Description |
|---|---|---|
| _orbitdb | string | The path of the orbitDB database to be associated with the colony |
▸ updateUserOrbitDB(string memory _orbitdb)
Update a user's orbitdb address. Can only be called by a user with a registered subdomain
Parameters
| Name | Type | Description |
|---|---|---|
| _orbitdb | string | The path of the orbitDB database to be associated with the user |
▸ upgradeExtension(bytes32 _extensionId, uint256 _newVersion)
Upgrade an extension in a colony. Can only be called by a Colony.
Parameters
| Name | Type | Description |
|---|---|---|
| _extensionId | bytes32 | keccak256 hash of the extension name, used as an indentifier |
| _newVersion | uint256 | Version of the extension to upgrade to (must be one greater than current) |