Interface: ColonyClientV4
Hierarchy
AugmentedIColony<IColony>ColonyAugmentsV3<IColony>ColonyAugmentsV4<IColony>AddDomainAugmentsA<IColony>MoveFundsBetweenPotsAugmentsA<IColony>SetExpenditureClaimDelayAugments<IColony>SetExpenditurePayoutModifierAugments<IColony>↳
ColonyClientV4
Properties
_deployedPromise
• _deployedPromise: Promise<Contract>
Inherited from
AugmentedIColony._deployedPromise
_runningEvents
• _runningEvents: Object
Index signature
▪ [eventTag: string]: RunningEvent
Inherited from
AugmentedIColony._runningEvents
_wrappedEmits
• _wrappedEmits: Object
Index signature
▪ [eventTag: string]: (...args: any[]) => void
Inherited from
AugmentedIColony._wrappedEmits
address
• Readonly address: string
Inherited from
AugmentedIColony.address
clientType
• clientType: ColonyClient
Inherited from
AugmentedIColony.clientType
clientVersion
• clientVersion: 4
Overrides
AugmentedIColony.clientVersion
colonyEvents
• colonyEvents: IColonyEvents
The colonyEvents contract supports all events across all versions. Isn't that amazing? It's an ethers contract with only events to filter
Inherited from
AugmentedIColony.colonyEvents
deployTransaction
• Readonly deployTransaction: TransactionResponse
Inherited from
AugmentedIColony.deployTransaction
estimateGas
• estimateGas: ColonyClientV4Estimate
Overrides
AugmentedIColony.estimateGas
filters
• filters: Object
Type declaration
| Name | Type |
|---|---|
ColonyBootstrapped | (users?: null, amounts?: null) => ColonyBootstrappedEventFilter |
ColonyBootstrapped(address[],int256[]) | (users?: null, amounts?: null) => ColonyBootstrappedEventFilter |
ColonyFundsClaimed | (token?: null, fee?: null, payoutRemainder?: null) => ColonyFundsClaimedEventFilter |
ColonyFundsClaimed(address,uint256,uint256) | (token?: null, fee?: null, payoutRemainder?: null) => ColonyFundsClaimedEventFilter |
ColonyFundsMovedBetweenFundingPots | (fromPot?: null | BigNumberish, toPot?: null | BigNumberish, amount?: null, token?: null) => ColonyFundsMovedBetweenFundingPotsEventFilter |
ColonyFundsMovedBetweenFundingPots(uint256,uint256,uint256,address) | (fromPot?: null | BigNumberish, toPot?: null | BigNumberish, amount?: null, token?: null) => ColonyFundsMovedBetweenFundingPotsEventFilter |
ColonyInitialised | (colonyNetwork?: null, token?: null) => ColonyInitialisedEventFilter |
ColonyInitialised(address,address) | (colonyNetwork?: null, token?: null) => ColonyInitialisedEventFilter |
ColonyRewardInverseSet | (rewardInverse?: null) => ColonyRewardInverseSetEventFilter |
ColonyRewardInverseSet(uint256) | (rewardInverse?: null) => ColonyRewardInverseSetEventFilter |
ColonyRoleSet | (user?: null | string, domainId?: null | BigNumberish, role?: null | BigNumberish, setTo?: null) => ColonyRoleSetEventFilter |
ColonyRoleSet(address,uint256,uint8,bool) | (user?: null | string, domainId?: null | BigNumberish, role?: null | BigNumberish, setTo?: null) => ColonyRoleSetEventFilter |
ColonyUpgraded | (oldVersion?: null, newVersion?: null) => ColonyUpgradedEventFilter |
ColonyUpgraded(uint256,uint256) | (oldVersion?: null, newVersion?: null) => ColonyUpgradedEventFilter |
DomainAdded | (domainId?: null) => DomainAddedEventFilter |
DomainAdded(uint256) | (domainId?: null) => DomainAddedEventFilter |
ExpenditureAdded | (expenditureId?: null) => ExpenditureAddedEventFilter |
ExpenditureAdded(uint256) | (expenditureId?: null) => ExpenditureAddedEventFilter |
ExpenditureCancelled | (expenditureId?: null | BigNumberish) => ExpenditureCancelledEventFilter |
ExpenditureCancelled(uint256) | (expenditureId?: null | BigNumberish) => ExpenditureCancelledEventFilter |
ExpenditureFinalized | (expenditureId?: null | BigNumberish) => ExpenditureFinalizedEventFilter |
ExpenditureFinalized(uint256) | (expenditureId?: null | BigNumberish) => ExpenditureFinalizedEventFilter |
ExpenditurePayoutSet | (expenditureId?: null | BigNumberish, slot?: null | BigNumberish, token?: null | string, amount?: null) => ExpenditurePayoutSetEventFilter |
ExpenditurePayoutSet(uint256,uint256,address,uint256) | (expenditureId?: null | BigNumberish, slot?: null | BigNumberish, token?: null | string, amount?: null) => ExpenditurePayoutSetEventFilter |
ExpenditureRecipientSet | (expenditureId?: null | BigNumberish, slot?: null | BigNumberish, recipient?: null | string) => ExpenditureRecipientSetEventFilter |
ExpenditureRecipientSet(uint256,uint256,address) | (expenditureId?: null | BigNumberish, slot?: null | BigNumberish, recipient?: null | string) => ExpenditureRecipientSetEventFilter |
ExpenditureSkillSet | (expenditureId?: null | BigNumberish, slot?: null | BigNumberish, skillId?: null | BigNumberish) => ExpenditureSkillSetEventFilter |
ExpenditureSkillSet(uint256,uint256,uint256) | (expenditureId?: null | BigNumberish, slot?: null | BigNumberish, skillId?: null | BigNumberish) => ExpenditureSkillSetEventFilter |
ExpenditureTransferred | (expenditureId?: null | BigNumberish, owner?: null | string) => ExpenditureTransferredEventFilter |
ExpenditureTransferred(uint256,address) | (expenditureId?: null | BigNumberish, owner?: null | string) => ExpenditureTransferredEventFilter |
FundingPotAdded | (fundingPotId?: null) => FundingPotAddedEventFilter |
FundingPotAdded(uint256) | (fundingPotId?: null) => FundingPotAddedEventFilter |
PaymentAdded | (paymentId?: null) => PaymentAddedEventFilter |
PaymentAdded(uint256) | (paymentId?: null) => PaymentAddedEventFilter |
PayoutClaimed | (fundingPotId?: null | BigNumberish, token?: null, amount?: null) => PayoutClaimedEventFilter |
PayoutClaimed(uint256,address,uint256) | (fundingPotId?: null | BigNumberish, token?: null, amount?: null) => PayoutClaimedEventFilter |
RecoveryRoleSet | (user?: null | string, setTo?: null) => RecoveryRoleSetEventFilter |
RecoveryRoleSet(address,bool) | (user?: null | string, setTo?: null) => RecoveryRoleSetEventFilter |
RewardPayoutClaimed | (rewardPayoutId?: null, user?: null, fee?: null, rewardRemainder?: null) => RewardPayoutClaimedEventFilter |
RewardPayoutClaimed(uint256,address,uint256,uint256) | (rewardPayoutId?: null, user?: null, fee?: null, rewardRemainder?: null) => RewardPayoutClaimedEventFilter |
RewardPayoutCycleEnded | (rewardPayoutId?: null) => RewardPayoutCycleEndedEventFilter |
RewardPayoutCycleEnded(uint256) | (rewardPayoutId?: null) => RewardPayoutCycleEndedEventFilter |
RewardPayoutCycleStarted | (rewardPayoutId?: null) => RewardPayoutCycleStartedEventFilter |
RewardPayoutCycleStarted(uint256) | (rewardPayoutId?: null) => RewardPayoutCycleStartedEventFilter |
TaskAdded | (taskId?: null) => TaskAddedEventFilter |
TaskAdded(uint256) | (taskId?: null) => TaskAddedEventFilter |
TaskBriefSet | (taskId?: null | BigNumberish, specificationHash?: null) => TaskBriefSetEventFilter |
TaskBriefSet(uint256,bytes32) | (taskId?: null | BigNumberish, specificationHash?: null) => TaskBriefSetEventFilter |
TaskCanceled | (taskId?: null | BigNumberish) => TaskCanceledEventFilter |
TaskCanceled(uint256) | (taskId?: null | BigNumberish) => TaskCanceledEventFilter |
TaskCompleted | (taskId?: null | BigNumberish) => TaskCompletedEventFilter |
TaskCompleted(uint256) | (taskId?: null | BigNumberish) => TaskCompletedEventFilter |
TaskDeliverableSubmitted | (taskId?: null | BigNumberish, deliverableHash?: null) => TaskDeliverableSubmittedEventFilter |
TaskDeliverableSubmitted(uint256,bytes32) | (taskId?: null | BigNumberish, deliverableHash?: null) => TaskDeliverableSubmittedEventFilter |
TaskDueDateSet | (taskId?: null | BigNumberish, dueDate?: null) => TaskDueDateSetEventFilter |
TaskDueDateSet(uint256,uint256) | (taskId?: null | BigNumberish, dueDate?: null) => TaskDueDateSetEventFilter |
TaskFinalized | (taskId?: null | BigNumberish) => TaskFinalizedEventFilter |
TaskFinalized(uint256) | (taskId?: null | BigNumberish) => TaskFinalizedEventFilter |
TaskPayoutSet | (taskId?: null | BigNumberish, role?: null, token?: null, amount?: null) => TaskPayoutSetEventFilter |
TaskPayoutSet(uint256,uint8,address,uint256) | (taskId?: null | BigNumberish, role?: null, token?: null, amount?: null) => TaskPayoutSetEventFilter |
TaskRoleUserSet | (taskId?: null | BigNumberish, role?: null, user?: null | string) => TaskRoleUserSetEventFilter |
TaskRoleUserSet(uint256,uint8,address) | (taskId?: null | BigNumberish, role?: null, user?: null | string) => TaskRoleUserSetEventFilter |
TaskSkillSet | (taskId?: null | BigNumberish, skillId?: null | BigNumberish) => TaskSkillSetEventFilter |
TaskSkillSet(uint256,uint256) | (taskId?: null | BigNumberish, skillId?: null | BigNumberish) => TaskSkillSetEventFilter |
TaskWorkRatingRevealed | (taskId?: null | BigNumberish, role?: null, rating?: null) => TaskWorkRatingRevealedEventFilter |
TaskWorkRatingRevealed(uint256,uint8,uint8) | (taskId?: null | BigNumberish, role?: null, rating?: null) => TaskWorkRatingRevealedEventFilter |
Inherited from
AugmentedIColony.filters
interface
• interface: IColonyInterface
Inherited from
AugmentedIColony.interface
networkClient
• networkClient: ColonyNetworkClient
An instance of the ColonyNetworkClient
Inherited from
AugmentedIColony.networkClient
off
• off: OnEvent<ColonyClientV4>
Inherited from
AugmentedIColony.off
on
• on: OnEvent<ColonyClientV4>
Inherited from
AugmentedIColony.on
once
• once: OnEvent<ColonyClientV4>
Inherited from
AugmentedIColony.once
provider
• Readonly provider: Provider
Inherited from
AugmentedIColony.provider
removeListener
• removeListener: OnEvent<ColonyClientV4>
Inherited from
AugmentedIColony.removeListener
reputationClient
• reputationClient: ReputationClient
A helper client to retrieve reputation
Inherited from
AugmentedIColony.reputationClient
resolvedAddress
• Readonly resolvedAddress: Promise<string>
Inherited from
AugmentedIColony.resolvedAddress
signer
• Readonly signer: Signer
Inherited from
AugmentedIColony.signer
tokenClient
• tokenClient: TokenClient
An instance of the TokenClient for the Colony's native token
Inherited from
AugmentedIColony.tokenClient
Methods
_checkRunningEvents
▸ _checkRunningEvents(runningEvent): void
Parameters
| Name | Type |
|---|---|
runningEvent | RunningEvent |
Returns
void
Inherited from
AugmentedIColony._checkRunningEvents
_deployed
▸ _deployed(blockTag?): Promise<Contract>
Parameters
| Name | Type |
|---|---|
blockTag? | BlockTag |
Returns
Promise<Contract>
Inherited from
AugmentedIColony._deployed
_wrapEvent
▸ _wrapEvent(runningEvent, log, listener): Event
Parameters
| Name | Type |
|---|---|
runningEvent | RunningEvent |
log | Log |
listener | Listener |
Returns
Event
Inherited from
AugmentedIColony._wrapEvent
addDomain
▸ addDomain(_permissionDomainId, _childSkillIndex, _parentDomainId, overrides?): Promise<ContractTransaction>
Adding new domains is currently retricted to one level only, i.e. _parentDomainId has to be the root domain id: 1.
Add a colony domain, and its respective local skill under skill with id _parentSkillId. New funding pot is created and associated with the domain here.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_parentDomainId | BigNumberish | Id of the domain under which the new one will be added |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.addDomain
addDomain(uint256,uint256,uint256)
▸ addDomain(uint256,uint256,uint256)(_permissionDomainId, _childSkillIndex, _parentDomainId, overrides?): Promise<ContractTransaction>
Adding new domains is currently retricted to one level only, i.e. _parentDomainId has to be the root domain id: 1.
Add a colony domain, and its respective local skill under skill with id _parentSkillId. New funding pot is created and associated with the domain here.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_parentDomainId | BigNumberish | Id of the domain under which the new one will be added |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.addDomain(uint256,uint256,uint256)
addDomainWithProofs
▸ addDomainWithProofs(_parentDomainId, overrides?): Promise<ContractTransaction>
Deprecated
Same as addDomain, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_parentDomainId | BigNumberish | Id of the domain under which the new one will be added |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AddDomainAugmentsA.addDomainWithProofs
addPayment
▸ addPayment(_permissionDomainId, _childSkillIndex, _recipient, _token, _amount, _domainId, _skillId, overrides?): Promise<ContractTransaction>
Add a new payment in the colony. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_recipient | string | Address of the payment recipient |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
_domainId | BigNumberish | The domain where the payment belongs |
_skillId | BigNumberish | The skill associated with the payment |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
paymentId Identifier of the newly created payment
Inherited from
AugmentedIColony.addPayment
addPayment(uint256,uint256,address,address,uint256,uint256,uint256)
▸ addPayment(uint256,uint256,address,address,uint256,uint256,uint256)(_permissionDomainId, _childSkillIndex, _recipient, _token, _amount, _domainId, _skillId, overrides?): Promise<ContractTransaction>
Add a new payment in the colony. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_recipient | string | Address of the payment recipient |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
_domainId | BigNumberish | The domain where the payment belongs |
_skillId | BigNumberish | The skill associated with the payment |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
paymentId Identifier of the newly created payment
Inherited from
AugmentedIColony.addPayment(uint256,uint256,address,address,uint256,uint256,uint256)
addPaymentWithProofs
▸ addPaymentWithProofs(_recipient, _token, _amount, _domainId, _skillId, overrides?): Promise<ContractTransaction>
Same as addPayment, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_recipient | string | Address of the payment recipient |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
_domainId | BigNumberish | The domain where the payment belongs |
_skillId | BigNumberish | The skill associated with the payment |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.addPaymentWithProofs
approveExitRecovery
▸ approveExitRecovery(overrides?): Promise<ContractTransaction>
Indicate approval to exit recovery mode. Can only be called by user with recovery role.
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: string } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.approveExitRecovery
approveExitRecovery()
▸ approveExitRecovery()(overrides?): Promise<ContractTransaction>
Indicate approval to exit recovery mode. Can only be called by user with recovery role.
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: string } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.approveExitRecovery()
attach
▸ attach(addressOrName): ColonyClientV4
Parameters
| Name | Type |
|---|---|
addressOrName | string |
Returns
Inherited from
AugmentedIColony.attach
authority
▸ authority(overrides?): Promise<string>
Get the ColonyAuthority for the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
colonyAuthority The ColonyAuthority contract address
Inherited from
AugmentedIColony.authority
authority()
▸ authority()(overrides?): Promise<string>
Get the ColonyAuthority for the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
colonyAuthority The ColonyAuthority contract address
Inherited from
AugmentedIColony.authority()
bootstrapColony
▸ bootstrapColony(_users, _amount, overrides?): Promise<ContractTransaction>
Only allowed to be called when taskCount is 0 by authorized addresses.
Allows the colony to bootstrap itself by having initial reputation and token _amount assigned to _users. This reputation is assigned in the colony-wide domain. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_users | string[] | Array of address to bootstrap with reputation |
_amount | BigNumberish[] | Amount of reputation/tokens for every address |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.bootstrapColony
bootstrapColony(address[],int256[])
▸ bootstrapColony(address[],int256[])(_users, _amount, overrides?): Promise<ContractTransaction>
Only allowed to be called when taskCount is 0 by authorized addresses.
Allows the colony to bootstrap itself by having initial reputation and token _amount assigned to _users. This reputation is assigned in the colony-wide domain. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_users | string[] | Array of address to bootstrap with reputation |
_amount | BigNumberish[] | Amount of reputation/tokens for every address |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.bootstrapColony(address[],int256[])
cancelExpenditure
▸ cancelExpenditure(_id, overrides?): Promise<ContractTransaction>
Cancels the expenditure and prevents further editing. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.cancelExpenditure
cancelExpenditure(uint256)
▸ cancelExpenditure(uint256)(_id, overrides?): Promise<ContractTransaction>
Cancels the expenditure and prevents further editing. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.cancelExpenditure(uint256)
cancelTask
▸ cancelTask(_id, overrides?): Promise<ContractTransaction>
Set the task.status property to 1.
Cancel a task at any point before it is finalized. Secured function to authorised members. Any funds assigned to its funding pot can be moved back to the domain via IColony.moveFundsBetweenPots.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.cancelTask
cancelTask(uint256)
▸ cancelTask(uint256)(_id, overrides?): Promise<ContractTransaction>
Set the task.status property to 1.
Cancel a task at any point before it is finalized. Secured function to authorised members. Any funds assigned to its funding pot can be moved back to the domain via IColony.moveFundsBetweenPots.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.cancelTask(uint256)
checkNotAdditionalProtectedVariable
▸ checkNotAdditionalProtectedVariable(_slot, overrides?): Promise<void>
No return value, but should throw if protected.This is public, but is only expected to be called from ContractRecovery; no need toexpose this to any users. Check whether the supplied slot is a protected variable specific to this contract
Parameters
| Name | Type | Description |
|---|---|---|
_slot | BigNumberish | The storage slot number to check. |
overrides? | CallOverrides | - |
Returns
Promise<void>
Inherited from
AugmentedIColony.checkNotAdditionalProtectedVariable
checkNotAdditionalProtectedVariable(uint256)
▸ checkNotAdditionalProtectedVariable(uint256)(_slot, overrides?): Promise<void>
No return value, but should throw if protected.This is public, but is only expected to be called from ContractRecovery; no need toexpose this to any users. Check whether the supplied slot is a protected variable specific to this contract
Parameters
| Name | Type | Description |
|---|---|---|
_slot | BigNumberish | The storage slot number to check. |
overrides? | CallOverrides | - |
Returns
Promise<void>
Inherited from
AugmentedIColony.checkNotAdditionalProtectedVariable(uint256)
claimColonyFunds
▸ claimColonyFunds(_token, overrides?): Promise<ContractTransaction>
Move any funds received by the colony in _token denomination to the top-level domain pot, siphoning off a small amount to the reward pot. If called against a colony's own token, no fee is taken.
Parameters
| Name | Type | Description |
|---|---|---|
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimColonyFunds
claimColonyFunds(address)
▸ claimColonyFunds(address)(_token, overrides?): Promise<ContractTransaction>
Move any funds received by the colony in _token denomination to the top-level domain pot, siphoning off a small amount to the reward pot. If called against a colony's own token, no fee is taken.
Parameters
| Name | Type | Description |
|---|---|---|
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimColonyFunds(address)
claimExpenditurePayout
▸ claimExpenditurePayout(_id, _slot, _token, overrides?): Promise<ContractTransaction>
Claim the payout for an expenditure slot. Here the network receives a fee from each payout.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimExpenditurePayout
claimExpenditurePayout(uint256,uint256,address)
▸ claimExpenditurePayout(uint256,uint256,address)(_id, _slot, _token, overrides?): Promise<ContractTransaction>
Claim the payout for an expenditure slot. Here the network receives a fee from each payout.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimExpenditurePayout(uint256,uint256,address)
claimPayment
▸ claimPayment(_id, _token, overrides?): Promise<ContractTransaction>
Claim the payout in _token denomination for payment _id. Here the network receives its fee from each payout. Same as for tasks, ether fees go straight to the Meta Colony whereas Token fees go to the Network to be auctioned off.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Payment identifier |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimPayment
claimPayment(uint256,address)
▸ claimPayment(uint256,address)(_id, _token, overrides?): Promise<ContractTransaction>
Claim the payout in _token denomination for payment _id. Here the network receives its fee from each payout. Same as for tasks, ether fees go straight to the Meta Colony whereas Token fees go to the Network to be auctioned off.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Payment identifier |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimPayment(uint256,address)
claimRewardPayout
▸ claimRewardPayout(_payoutId, _squareRoots, key, value, branchMask, siblings, overrides?): Promise<ContractTransaction>
Claim the reward payout at _payoutId. User needs to provide their reputation and colony-wide reputation which will be proven via Merkle proof inside this function. Can only be called if payout is active, i.e if 60 days have not passed from its creation. Can only be called if next in queue.
Parameters
| Name | Type | Description |
|---|---|---|
_payoutId | BigNumberish | Id of the reward payout |
_squareRoots | BigNumberish[] | Square roots of values used in equation: _squareRoots[0] - square root of user reputation, _squareRoots[1] - square root of user tokens (deposited in TokenLocking), _squareRoots[2] - square root of total reputation, _squareRoots[3] - square root of total tokens, _squareRoots[4] - square root of numerator (user reputation user tokens), _squareRoots[5] - square root of denominator (total reputation total tokens), _squareRoots[6] - square root of payout amount. |
key | BytesLike | Some Reputation hash tree key |
value | BytesLike | Reputation value |
branchMask | BigNumberish | The branchmask of the proof |
siblings | BytesLike[] | The siblings of the proof |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimRewardPayout
claimRewardPayout(uint256,uint256[7],bytes,bytes,uint256,bytes32[])
▸ claimRewardPayout(uint256,uint256[7],bytes,bytes,uint256,bytes32[])(_payoutId, _squareRoots, key, value, branchMask, siblings, overrides?): Promise<ContractTransaction>
Claim the reward payout at _payoutId. User needs to provide their reputation and colony-wide reputation which will be proven via Merkle proof inside this function. Can only be called if payout is active, i.e if 60 days have not passed from its creation. Can only be called if next in queue.
Parameters
| Name | Type | Description |
|---|---|---|
_payoutId | BigNumberish | Id of the reward payout |
_squareRoots | BigNumberish[] | Square roots of values used in equation: _squareRoots[0] - square root of user reputation, _squareRoots[1] - square root of user tokens (deposited in TokenLocking), _squareRoots[2] - square root of total reputation, _squareRoots[3] - square root of total tokens, _squareRoots[4] - square root of numerator (user reputation user tokens), _squareRoots[5] - square root of denominator (total reputation total tokens), _squareRoots[6] - square root of payout amount. |
key | BytesLike | Some Reputation hash tree key |
value | BytesLike | Reputation value |
branchMask | BigNumberish | The branchmask of the proof |
siblings | BytesLike[] | The siblings of the proof |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimRewardPayout(uint256,uint256[7],bytes,bytes,uint256,bytes32[])
claimTaskPayout
▸ claimTaskPayout(_id, _role, _token, overrides?): Promise<ContractTransaction>
Claim the payout in _token denomination for work completed in task _id by contributor with role _role. Allowed only after task is finalized. Here the network receives its fee from each payout. Ether fees go straight to the Meta Colony whereas Token fees go to the Network to be auctioned off.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimTaskPayout
claimTaskPayout(uint256,uint8,address)
▸ claimTaskPayout(uint256,uint8,address)(_id, _role, _token, overrides?): Promise<ContractTransaction>
Claim the payout in _token denomination for work completed in task _id by contributor with role _role. Allowed only after task is finalized. Here the network receives its fee from each payout. Ether fees go straight to the Meta Colony whereas Token fees go to the Network to be auctioned off.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.claimTaskPayout(uint256,uint8,address)
completeTask
▸ completeTask(_id, overrides?): Promise<ContractTransaction>
Mark a task as complete after the due date has passed. This allows the task to be rated and finalized (and funds recovered) even in the presence of a worker who has disappeared. Note that if the due date was not set, then this function will throw.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.completeTask
completeTask(uint256)
▸ completeTask(uint256)(_id, overrides?): Promise<ContractTransaction>
Mark a task as complete after the due date has passed. This allows the task to be rated and finalized (and funds recovered) even in the presence of a worker who has disappeared. Note that if the due date was not set, then this function will throw.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.completeTask(uint256)
connect
▸ connect(signerOrProvider): ColonyClientV4
Parameters
| Name | Type |
|---|---|
signerOrProvider | string | Signer | Provider |
Returns
Inherited from
AugmentedIColony.connect
deployed
▸ deployed(): Promise<ColonyClientV4>
Returns
Promise<ColonyClientV4>
Inherited from
AugmentedIColony.deployed
emit
▸ emit(eventName, ...args): boolean
Parameters
| Name | Type |
|---|---|
eventName | string | EventFilter |
...args | any[] |
Returns
boolean
Inherited from
AugmentedIColony.emit
enterRecoveryMode
▸ enterRecoveryMode(overrides?): Promise<ContractTransaction>
Put colony network mining into recovery mode. Can only be called by user with recovery role.
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: string } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.enterRecoveryMode
enterRecoveryMode()
▸ enterRecoveryMode()(overrides?): Promise<ContractTransaction>
Put colony network mining into recovery mode. Can only be called by user with recovery role.
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: string } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.enterRecoveryMode()
executeTaskChange
▸ executeTaskChange(_sigV, _sigR, _sigS, _mode, _value, _data, overrides?): Promise<ContractTransaction>
The Colony functions which require approval and the task roles to review these are set in IColony.initialiseColony at colony creation. Upon successful execution the taskChangeNonces entry for the task is incremented.
Executes a task update transaction _data which is approved and signed by two of its roles (e.g. manager and worker) using the detached signatures for these users.
Parameters
| Name | Type | Description |
|---|---|---|
_sigV | BigNumberish[] | recovery id |
_sigR | BytesLike[] | r output of the ECDSA signature of the transaction |
_sigS | BytesLike[] | s output of the ECDSA signature of the transaction |
_mode | BigNumberish[] | How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this) |
_value | BigNumberish | The transaction value, i.e. number of wei to be sent when the transaction is executed Currently we only accept 0 value transactions but this is kept as a future option |
_data | BytesLike | The transaction data |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.executeTaskChange
executeTaskChange(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes)
▸ executeTaskChange(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes)(_sigV, _sigR, _sigS, _mode, _value, _data, overrides?): Promise<ContractTransaction>
The Colony functions which require approval and the task roles to review these are set in IColony.initialiseColony at colony creation. Upon successful execution the taskChangeNonces entry for the task is incremented.
Executes a task update transaction _data which is approved and signed by two of its roles (e.g. manager and worker) using the detached signatures for these users.
Parameters
| Name | Type | Description |
|---|---|---|
_sigV | BigNumberish[] | recovery id |
_sigR | BytesLike[] | r output of the ECDSA signature of the transaction |
_sigS | BytesLike[] | s output of the ECDSA signature of the transaction |
_mode | BigNumberish[] | How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this) |
_value | BigNumberish | The transaction value, i.e. number of wei to be sent when the transaction is executed Currently we only accept 0 value transactions but this is kept as a future option |
_data | BytesLike | The transaction data |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.executeTaskChange(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes)
executeTaskRoleAssignment
▸ executeTaskRoleAssignment(_sigV, _sigR, _sigS, _mode, _value, _data, overrides?): Promise<ContractTransaction>
Executes a task role update transaction _data which is approved and signed by two of addresses. depending of which function we are calling. Allowed functions are setTaskManagerRole, setTaskEvaluatorRole and setTaskWorkerRole. Upon successful execution the taskChangeNonces entry for the task is incremented.
Parameters
| Name | Type | Description |
|---|---|---|
_sigV | BigNumberish[] | recovery id |
_sigR | BytesLike[] | r output of the ECDSA signature of the transaction |
_sigS | BytesLike[] | s output of the ECDSA signature of the transaction |
_mode | BigNumberish[] | How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this) |
_value | BigNumberish | The transaction value, i.e. number of wei to be sent when the transaction is executed Currently we only accept 0 value transactions but this is kept as a future option |
_data | BytesLike | The transaction data |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.executeTaskRoleAssignment
executeTaskRoleAssignment(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes)
▸ executeTaskRoleAssignment(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes)(_sigV, _sigR, _sigS, _mode, _value, _data, overrides?): Promise<ContractTransaction>
Executes a task role update transaction _data which is approved and signed by two of addresses. depending of which function we are calling. Allowed functions are setTaskManagerRole, setTaskEvaluatorRole and setTaskWorkerRole. Upon successful execution the taskChangeNonces entry for the task is incremented.
Parameters
| Name | Type | Description |
|---|---|---|
_sigV | BigNumberish[] | recovery id |
_sigR | BytesLike[] | r output of the ECDSA signature of the transaction |
_sigS | BytesLike[] | s output of the ECDSA signature of the transaction |
_mode | BigNumberish[] | How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this) |
_value | BigNumberish | The transaction value, i.e. number of wei to be sent when the transaction is executed Currently we only accept 0 value transactions but this is kept as a future option |
_data | BytesLike | The transaction data |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.executeTaskRoleAssignment(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes)
exitRecoveryMode
▸ exitRecoveryMode(overrides?): Promise<ContractTransaction>
Exit recovery mode, can be called by anyone if enough whitelist approvals are given.
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: string } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.exitRecoveryMode
exitRecoveryMode()
▸ exitRecoveryMode()(overrides?): Promise<ContractTransaction>
Exit recovery mode, can be called by anyone if enough whitelist approvals are given.
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: string } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.exitRecoveryMode()
fallback
▸ fallback(overrides?): Promise<TransactionResponse>
Parameters
| Name | Type |
|---|---|
overrides? | TransactionRequest |
Returns
Promise<TransactionResponse>
Inherited from
AugmentedIColony.fallback
finalizeExpenditure
▸ finalizeExpenditure(_id, overrides?): Promise<ContractTransaction>
Finalizes the expenditure and prevents further editing. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizeExpenditure
finalizeExpenditure(uint256)
▸ finalizeExpenditure(uint256)(_id, overrides?): Promise<ContractTransaction>
Finalizes the expenditure and prevents further editing. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizeExpenditure(uint256)
finalizePayment
▸ finalizePayment(_permissionDomainId, _childSkillIndex, _id, overrides?): Promise<ContractTransaction>
Finalizes the payment and logs the reputation log updates. Allowed to be called once after payment is fully funded. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_id | BigNumberish | Payment identifier |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizePayment
finalizePayment(uint256,uint256,uint256)
▸ finalizePayment(uint256,uint256,uint256)(_permissionDomainId, _childSkillIndex, _id, overrides?): Promise<ContractTransaction>
Finalizes the payment and logs the reputation log updates. Allowed to be called once after payment is fully funded. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_id | BigNumberish | Payment identifier |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizePayment(uint256,uint256,uint256)
finalizePaymentWithProofs
▸ finalizePaymentWithProofs(_id, overrides?): Promise<ContractTransaction>
Same as finalizePayment, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Payment identifier |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizePaymentWithProofs
finalizeRewardPayout
▸ finalizeRewardPayout(_payoutId, overrides?): Promise<ContractTransaction>
Finalises the reward payout. Allows creation of next reward payouts for token that has been used in _payoutId. Can only be called when reward payout cycle is finished i.e when 60 days have passed from its creation.
Parameters
| Name | Type | Description |
|---|---|---|
_payoutId | BigNumberish | Id of the reward payout |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizeRewardPayout
finalizeRewardPayout(uint256)
▸ finalizeRewardPayout(uint256)(_payoutId, overrides?): Promise<ContractTransaction>
Finalises the reward payout. Allows creation of next reward payouts for token that has been used in _payoutId. Can only be called when reward payout cycle is finished i.e when 60 days have passed from its creation.
Parameters
| Name | Type | Description |
|---|---|---|
_payoutId | BigNumberish | Id of the reward payout |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizeRewardPayout(uint256)
finalizeTask
▸ finalizeTask(_id, overrides?): Promise<ContractTransaction>
Set the task.finalized property to true
Called after task work rating is complete which closes the task and logs the respective reputation log updates. Allowed to be called once per task. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizeTask
finalizeTask(uint256)
▸ finalizeTask(uint256)(_id, overrides?): Promise<ContractTransaction>
Set the task.finalized property to true
Called after task work rating is complete which closes the task and logs the respective reputation log updates. Allowed to be called once per task. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finalizeTask(uint256)
finishUpgrade
▸ finishUpgrade(overrides?): Promise<ContractTransaction>
Can only be called by the colony itself, and only expected to be called as part of the upgrade() call. Required to be public so it can be an external call.
A function to be called after an upgrade has been done from v2 to v3.
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: string } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finishUpgrade
finishUpgrade()
▸ finishUpgrade()(overrides?): Promise<ContractTransaction>
Can only be called by the colony itself, and only expected to be called as part of the upgrade() call. Required to be public so it can be an external call.
A function to be called after an upgrade has been done from v2 to v3.
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: string } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.finishUpgrade()
generateSecret
▸ generateSecret(_salt, _value, overrides?): Promise<string>
Helper function used to generage consistently the rating secret using salt value _salt and value to hide _value
Parameters
| Name | Type | Description |
|---|---|---|
_salt | BytesLike | Salt value |
_value | BigNumberish | Value to hide |
overrides? | CallOverrides | - |
Returns
Promise<string>
secret keccak256 hash of joint _salt and _value
Inherited from
AugmentedIColony.generateSecret
generateSecret(bytes32,uint256)
▸ generateSecret(bytes32,uint256)(_salt, _value, overrides?): Promise<string>
Helper function used to generage consistently the rating secret using salt value _salt and value to hide _value
Parameters
| Name | Type | Description |
|---|---|---|
_salt | BytesLike | Salt value |
_value | BigNumberish | Value to hide |
overrides? | CallOverrides | - |
Returns
Promise<string>
secret keccak256 hash of joint _salt and _value
Inherited from
AugmentedIColony.generateSecret(bytes32,uint256)
getColonyNetwork
▸ getColonyNetwork(overrides?): Promise<string>
The colonyNetworkAddress we read here is set once, during initialiseColony.
Returns the colony network address set on the Colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
colonyNetwork The address of Colony Network instance
Inherited from
AugmentedIColony.getColonyNetwork
getColonyNetwork()
▸ getColonyNetwork()(overrides?): Promise<string>
The colonyNetworkAddress we read here is set once, during initialiseColony.
Returns the colony network address set on the Colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
colonyNetwork The address of Colony Network instance
Inherited from
AugmentedIColony.getColonyNetwork()
getDomain
▸ getDomain(_id, overrides?): Promise<[BigNumber, BigNumber] & { fundingPotId: BigNumber ; skillId: BigNumber }>
Get a domain by id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the domain which details to get |
overrides? | CallOverrides | - |
Returns
Promise<[BigNumber, BigNumber] & { fundingPotId: BigNumber ; skillId: BigNumber }>
domain The domain
Inherited from
AugmentedIColony.getDomain
getDomain(uint256)
▸ getDomain(uint256)(_id, overrides?): Promise<[BigNumber, BigNumber] & { fundingPotId: BigNumber ; skillId: BigNumber }>
Get a domain by id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the domain which details to get |
overrides? | CallOverrides | - |
Returns
Promise<[BigNumber, BigNumber] & { fundingPotId: BigNumber ; skillId: BigNumber }>
domain The domain
Inherited from
AugmentedIColony.getDomain(uint256)
getDomainCount
▸ getDomainCount(overrides?): Promise<BigNumber>
Get the number of domains in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The domain count. Min 1 as the root domain is created at the same time as the colony
Inherited from
AugmentedIColony.getDomainCount
getDomainCount()
▸ getDomainCount()(overrides?): Promise<BigNumber>
Get the number of domains in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The domain count. Min 1 as the root domain is created at the same time as the colony
Inherited from
AugmentedIColony.getDomainCount()
getExpenditure
▸ getExpenditure(_id, overrides?): Promise<[number, string, BigNumber, BigNumber, BigNumber] & { domainId: BigNumber ; finalizedTimestamp: BigNumber ; fundingPotId: BigNumber ; owner: string ; status: number }>
Returns an existing expenditure.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
overrides? | CallOverrides | - |
Returns
Promise<[number, string, BigNumber, BigNumber, BigNumber] & { domainId: BigNumber ; finalizedTimestamp: BigNumber ; fundingPotId: BigNumber ; owner: string ; status: number }>
expenditure The expenditure
Inherited from
AugmentedIColony.getExpenditure
getExpenditure(uint256)
▸ getExpenditure(uint256)(_id, overrides?): Promise<[number, string, BigNumber, BigNumber, BigNumber] & { domainId: BigNumber ; finalizedTimestamp: BigNumber ; fundingPotId: BigNumber ; owner: string ; status: number }>
Returns an existing expenditure.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
overrides? | CallOverrides | - |
Returns
Promise<[number, string, BigNumber, BigNumber, BigNumber] & { domainId: BigNumber ; finalizedTimestamp: BigNumber ; fundingPotId: BigNumber ; owner: string ; status: number }>
expenditure The expenditure
Inherited from
AugmentedIColony.getExpenditure(uint256)
getExpenditureCount
▸ getExpenditureCount(overrides?): Promise<BigNumber>
Get the number of expenditures in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The expenditure count
Inherited from
AugmentedIColony.getExpenditureCount
getExpenditureCount()
▸ getExpenditureCount()(overrides?): Promise<BigNumber>
Get the number of expenditures in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The expenditure count
Inherited from
AugmentedIColony.getExpenditureCount()
getExpenditureSlot
▸ getExpenditureSlot(_id, _slot, overrides?): Promise<[string, BigNumber, BigNumber, BigNumber[]] & { claimDelay: BigNumber ; payoutModifier: BigNumber ; recipient: string ; skills: BigNumber[] }>
Returns an existing expenditure slot.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Expenditure slot |
overrides? | CallOverrides | - |
Returns
Promise<[string, BigNumber, BigNumber, BigNumber[]] & { claimDelay: BigNumber ; payoutModifier: BigNumber ; recipient: string ; skills: BigNumber[] }>
expenditureSlot The expenditure slot
Inherited from
AugmentedIColony.getExpenditureSlot
getExpenditureSlot(uint256,uint256)
▸ getExpenditureSlot(uint256,uint256)(_id, _slot, overrides?): Promise<[string, BigNumber, BigNumber, BigNumber[]] & { claimDelay: BigNumber ; payoutModifier: BigNumber ; recipient: string ; skills: BigNumber[] }>
Returns an existing expenditure slot.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Expenditure slot |
overrides? | CallOverrides | - |
Returns
Promise<[string, BigNumber, BigNumber, BigNumber[]] & { claimDelay: BigNumber ; payoutModifier: BigNumber ; recipient: string ; skills: BigNumber[] }>
expenditureSlot The expenditure slot
Inherited from
AugmentedIColony.getExpenditureSlot(uint256,uint256)
getExpenditureSlotPayout
▸ getExpenditureSlotPayout(_id, _slot, _token, overrides?): Promise<BigNumber>
Returns an existing expenditure slot's payout for a token.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Expenditure slot |
_token | string | Token address |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
amount Amount of the payout for that slot/token.
Inherited from
AugmentedIColony.getExpenditureSlotPayout
getExpenditureSlotPayout(uint256,uint256,address)
▸ getExpenditureSlotPayout(uint256,uint256,address)(_id, _slot, _token, overrides?): Promise<BigNumber>
Returns an existing expenditure slot's payout for a token.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Expenditure slot |
_token | string | Token address |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
amount Amount of the payout for that slot/token.
Inherited from
AugmentedIColony.getExpenditureSlotPayout(uint256,uint256,address)
getExtensionClient
▸ getExtensionClient<E>(extension): Promise<GetExtensionClientReturns[E]>
Get an instance of an extension client associated with this Colony.
Type parameters
| Name | Type |
|---|---|
E | extends Extension |
Parameters
| Name | Type | Description |
|---|---|---|
extension | E | An Extension |
Returns
Promise<GetExtensionClientReturns[E]>
An instance of an intialized extension client for the desired extension
Inherited from
AugmentedIColony.getExtensionClient
getFundingPot
▸ getFundingPot(_id, overrides?): Promise<[number, BigNumber, BigNumber] & { associatedType: number ; associatedTypeId: BigNumber ; payoutsWeCannotMake: BigNumber }>
For the reward funding pot (e.g. id: 0) this returns (0, 0, 0). Get the non-mapping properties of a pot by id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the pot which details to get |
overrides? | CallOverrides | - |
Returns
Promise<[number, BigNumber, BigNumber] & { associatedType: number ; associatedTypeId: BigNumber ; payoutsWeCannotMake: BigNumber }>
associatedType The FundingPotAssociatedType value of the current funding pot, e.g. Domain, Task, PayoutassociatedTypeId Id of the associated type, e.g. if associatedType = FundingPotAssociatedType.Domain, this refers to the domainIdpayoutsWeCannotMake Number of payouts that cannot be completed with the current funding
Inherited from
AugmentedIColony.getFundingPot
getFundingPot(uint256)
▸ getFundingPot(uint256)(_id, overrides?): Promise<[number, BigNumber, BigNumber] & { associatedType: number ; associatedTypeId: BigNumber ; payoutsWeCannotMake: BigNumber }>
For the reward funding pot (e.g. id: 0) this returns (0, 0, 0). Get the non-mapping properties of a pot by id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the pot which details to get |
overrides? | CallOverrides | - |
Returns
Promise<[number, BigNumber, BigNumber] & { associatedType: number ; associatedTypeId: BigNumber ; payoutsWeCannotMake: BigNumber }>
associatedType The FundingPotAssociatedType value of the current funding pot, e.g. Domain, Task, PayoutassociatedTypeId Id of the associated type, e.g. if associatedType = FundingPotAssociatedType.Domain, this refers to the domainIdpayoutsWeCannotMake Number of payouts that cannot be completed with the current funding
Inherited from
AugmentedIColony.getFundingPot(uint256)
getFundingPotBalance
▸ getFundingPotBalance(_potId, _token, overrides?): Promise<BigNumber>
Get the _token balance of pot with id _potId.
Parameters
| Name | Type | Description |
|---|---|---|
_potId | BigNumberish | Id of the funding pot |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
balance Funding pot supply balance
Inherited from
AugmentedIColony.getFundingPotBalance
getFundingPotBalance(uint256,address)
▸ getFundingPotBalance(uint256,address)(_potId, _token, overrides?): Promise<BigNumber>
Get the _token balance of pot with id _potId.
Parameters
| Name | Type | Description |
|---|---|---|
_potId | BigNumberish | Id of the funding pot |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
balance Funding pot supply balance
Inherited from
AugmentedIColony.getFundingPotBalance(uint256,address)
getFundingPotCount
▸ getFundingPotCount(overrides?): Promise<BigNumber>
Get the number of funding pots in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The funding pots count
Inherited from
AugmentedIColony.getFundingPotCount
getFundingPotCount()
▸ getFundingPotCount()(overrides?): Promise<BigNumber>
Get the number of funding pots in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The funding pots count
Inherited from
AugmentedIColony.getFundingPotCount()
getFundingPotPayout
▸ getFundingPotPayout(_potId, _token, overrides?): Promise<BigNumber>
Get the assigned _token payouts of pot with id _potId.
Parameters
| Name | Type | Description |
|---|---|---|
_potId | BigNumberish | Id of the funding pot |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
payout Funding pot payout amount
Inherited from
AugmentedIColony.getFundingPotPayout
getFundingPotPayout(uint256,address)
▸ getFundingPotPayout(uint256,address)(_potId, _token, overrides?): Promise<BigNumber>
Get the assigned _token payouts of pot with id _potId.
Parameters
| Name | Type | Description |
|---|---|---|
_potId | BigNumberish | Id of the funding pot |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
payout Funding pot payout amount
Inherited from
AugmentedIColony.getFundingPotPayout(uint256,address)
getMembersReputation
▸ getMembersReputation(skillId): Promise<{ addresses: string[] }>
Get all addresses that have reputation for a given skill. If you need the skillId for a certain domain you can use the getDomain function.
Parameters
| Name | Type | Description |
|---|---|---|
skillId | BigNumberish | The skill id to get the reputation in |
Returns
Promise<{ addresses: string[] }>
All addresses that have a non-zero reputation for the given skill
Inherited from
AugmentedIColony.getMembersReputation
getNonRewardPotsTotal
▸ getNonRewardPotsTotal(_token, overrides?): Promise<BigNumber>
Get the total amount of tokens _token minus amount reserved to be paid to the reputation and token holders as rewards.
Parameters
| Name | Type | Description |
|---|---|---|
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
amount Total amount of tokens in funding pots other than the rewards pot (id 0)
Inherited from
AugmentedIColony.getNonRewardPotsTotal
getNonRewardPotsTotal(address)
▸ getNonRewardPotsTotal(address)(_token, overrides?): Promise<BigNumber>
Get the total amount of tokens _token minus amount reserved to be paid to the reputation and token holders as rewards.
Parameters
| Name | Type | Description |
|---|---|---|
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
amount Total amount of tokens in funding pots other than the rewards pot (id 0)
Inherited from
AugmentedIColony.getNonRewardPotsTotal(address)
getPayment
▸ getPayment(_id, overrides?): Promise<[string, boolean, BigNumber, BigNumber, BigNumber[]] & { domainId: BigNumber ; finalized: boolean ; fundingPotId: BigNumber ; recipient: string ; skills: BigNumber[] }>
Returns an exiting payment.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Payment identifier |
overrides? | CallOverrides | - |
Returns
Promise<[string, boolean, BigNumber, BigNumber, BigNumber[]] & { domainId: BigNumber ; finalized: boolean ; fundingPotId: BigNumber ; recipient: string ; skills: BigNumber[] }>
payment The Payment data structure
Inherited from
AugmentedIColony.getPayment
getPayment(uint256)
▸ getPayment(uint256)(_id, overrides?): Promise<[string, boolean, BigNumber, BigNumber, BigNumber[]] & { domainId: BigNumber ; finalized: boolean ; fundingPotId: BigNumber ; recipient: string ; skills: BigNumber[] }>
Returns an exiting payment.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Payment identifier |
overrides? | CallOverrides | - |
Returns
Promise<[string, boolean, BigNumber, BigNumber, BigNumber[]] & { domainId: BigNumber ; finalized: boolean ; fundingPotId: BigNumber ; recipient: string ; skills: BigNumber[] }>
payment The Payment data structure
Inherited from
AugmentedIColony.getPayment(uint256)
getPaymentCount
▸ getPaymentCount(overrides?): Promise<BigNumber>
Get the number of payments in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The payment count
Inherited from
AugmentedIColony.getPaymentCount
getPaymentCount()
▸ getPaymentCount()(overrides?): Promise<BigNumber>
Get the number of payments in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The payment count
Inherited from
AugmentedIColony.getPaymentCount()
getReputation
▸ getReputation(skillId, address, customRootHash?): Promise<{ branchMask: string ; key: string ; reputationAmount: BigNumber ; siblings: string[] ; value: string }>
Get the reputation for an address and a certain skill. If you need the skillId for a certain domain you can use the getDomain function.
Remarks
This function also retrieves the proofs (branchMask, siblings) that are needed to verify the reputation on chain.
If you don't need to do that (e.g. in order to proof the reputation when calling a contract method), you should probably just use
the getReputationWithoutProofs method as it requires fewer computations
Parameters
| Name | Type | Description |
|---|---|---|
skillId | BigNumberish | The skill id to get the addresses reputation in |
address | string | Wallet address to retrieve the reputation of |
customRootHash? | string | The customRootHash can be set to retrieve the reputation at a certain block time in the past |
Returns
Promise<{ branchMask: string ; key: string ; reputationAmount: BigNumber ; siblings: string[] ; value: string }>
The reputation amount as well as the two proofs that are needed to verify the reputation on chain
Inherited from
AugmentedIColony.getReputation
getReputationAcrossDomains
▸ getReputationAcrossDomains(address, customRootHash?): Promise<{ domainId: number ; reputationAmount?: BigNumberish ; skillId: number }[]>
Get the reputation for an address across all domains in a Colony.
Parameters
| Name | Type | Description |
|---|---|---|
address | string | Wallet address to retrieve the reputation of |
customRootHash? | string | The customRootHash can be set to retrieve the reputation at a certain block time in the past |
Returns
Promise<{ domainId: number ; reputationAmount?: BigNumberish ; skillId: number }[]>
The reputation amount
Inherited from
AugmentedIColony.getReputationAcrossDomains
getReputationWithoutProofs
▸ getReputationWithoutProofs(skillId, address, customRootHash?): Promise<{ key: string ; reputationAmount: BigNumber ; value: string }>
Get the reputation for an address and a certain skill. If you need the skillId for a certain domain you can use the getDomain function.
Parameters
| Name | Type | Description |
|---|---|---|
skillId | BigNumberish | The skill id to get the addresses reputation in |
address | string | Wallet address to retrieve the reputation of |
customRootHash? | string | The customRootHash can be set to retrieve the reputation at a certain block time in the past |
Returns
Promise<{ key: string ; reputationAmount: BigNumber ; value: string }>
The reputation amount
Inherited from
AugmentedIColony.getReputationWithoutProofs
getRewardInverse
▸ getRewardInverse(overrides?): Promise<BigNumber>
Return 1 / the reward to pay out from revenue. e.g. if the fee is 1% (or 0.01), return 100.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
rewardInverse The inverse of the reward
Inherited from
AugmentedIColony.getRewardInverse
getRewardInverse()
▸ getRewardInverse()(overrides?): Promise<BigNumber>
Return 1 / the reward to pay out from revenue. e.g. if the fee is 1% (or 0.01), return 100.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
rewardInverse The inverse of the reward
Inherited from
AugmentedIColony.getRewardInverse()
getRewardPayoutInfo
▸ getRewardPayoutInfo(_payoutId, overrides?): Promise<[string, BigNumber, BigNumber, BigNumber, string, BigNumber, BigNumber, boolean] & { amount: BigNumber ; amountRemaining: BigNumber ; blockTimestamp: BigNumber ; colonyWideReputation: BigNumber ; finalized: boolean ; reputationState: string ; tokenAddress: string ; totalTokens: BigNumber }>
Get useful information about specific reward payout.
Parameters
| Name | Type | Description |
|---|---|---|
_payoutId | BigNumberish | Id of the reward payout |
overrides? | CallOverrides | - |
Returns
Promise<[string, BigNumber, BigNumber, BigNumber, string, BigNumber, BigNumber, boolean] & { amount: BigNumber ; amountRemaining: BigNumber ; blockTimestamp: BigNumber ; colonyWideReputation: BigNumber ; finalized: boolean ; reputationState: string ; tokenAddress: string ; totalTokens: BigNumber }>
rewardPayoutCycle RewardPayoutCycle, containing propertes: reputationState Reputation root hash at the time of creation, colonyWideReputation Colony wide reputation in reputationState, totalTokens Total colony tokens at the time of creation, amount Total amount of tokens taken aside for reward payout, tokenAddress Token address, blockTimestamp Block number at the time of creation.
Inherited from
AugmentedIColony.getRewardPayoutInfo
getRewardPayoutInfo(uint256)
▸ getRewardPayoutInfo(uint256)(_payoutId, overrides?): Promise<[string, BigNumber, BigNumber, BigNumber, string, BigNumber, BigNumber, boolean] & { amount: BigNumber ; amountRemaining: BigNumber ; blockTimestamp: BigNumber ; colonyWideReputation: BigNumber ; finalized: boolean ; reputationState: string ; tokenAddress: string ; totalTokens: BigNumber }>
Get useful information about specific reward payout.
Parameters
| Name | Type | Description |
|---|---|---|
_payoutId | BigNumberish | Id of the reward payout |
overrides? | CallOverrides | - |
Returns
Promise<[string, BigNumber, BigNumber, BigNumber, string, BigNumber, BigNumber, boolean] & { amount: BigNumber ; amountRemaining: BigNumber ; blockTimestamp: BigNumber ; colonyWideReputation: BigNumber ; finalized: boolean ; reputationState: string ; tokenAddress: string ; totalTokens: BigNumber }>
rewardPayoutCycle RewardPayoutCycle, containing propertes: reputationState Reputation root hash at the time of creation, colonyWideReputation Colony wide reputation in reputationState, totalTokens Total colony tokens at the time of creation, amount Total amount of tokens taken aside for reward payout, tokenAddress Token address, blockTimestamp Block number at the time of creation.
Inherited from
AugmentedIColony.getRewardPayoutInfo(uint256)
getTask
▸ getTask(_id, overrides?): Promise<[string, string, number, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber[]] & { completionTimestamp: BigNumber ; deliverableHash: string ; domainId: BigNumber ; dueDate: BigNumber ; fundingPotId: BigNumber ; skillIds: BigNumber[] ; specificationHash: string ; status: number }>
Get a task with id _id
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | CallOverrides | - |
Returns
Promise<[string, string, number, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber[]] & { completionTimestamp: BigNumber ; deliverableHash: string ; domainId: BigNumber ; dueDate: BigNumber ; fundingPotId: BigNumber ; skillIds: BigNumber[] ; specificationHash: string ; status: number }>
specificationHash Task brief hashdeliverableHash Task deliverable hashstatus TaskStatus property. 0 - Active. 1 - Cancelled. 2 - FinalizeddueDate Due datefundingPotId Id of funding pot for taskcompletionTimestamp Task completion timestampdomainId Task domain id, default is root colony domain with id 1skillIds Array of global skill ids assigned to task
Inherited from
AugmentedIColony.getTask
getTask(uint256)
▸ getTask(uint256)(_id, overrides?): Promise<[string, string, number, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber[]] & { completionTimestamp: BigNumber ; deliverableHash: string ; domainId: BigNumber ; dueDate: BigNumber ; fundingPotId: BigNumber ; skillIds: BigNumber[] ; specificationHash: string ; status: number }>
Get a task with id _id
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | CallOverrides | - |
Returns
Promise<[string, string, number, BigNumber, BigNumber, BigNumber, BigNumber, BigNumber[]] & { completionTimestamp: BigNumber ; deliverableHash: string ; domainId: BigNumber ; dueDate: BigNumber ; fundingPotId: BigNumber ; skillIds: BigNumber[] ; specificationHash: string ; status: number }>
specificationHash Task brief hashdeliverableHash Task deliverable hashstatus TaskStatus property. 0 - Active. 1 - Cancelled. 2 - FinalizeddueDate Due datefundingPotId Id of funding pot for taskcompletionTimestamp Task completion timestampdomainId Task domain id, default is root colony domain with id 1skillIds Array of global skill ids assigned to task
Inherited from
AugmentedIColony.getTask(uint256)
getTaskChangeNonce
▸ getTaskChangeNonce(_id, overrides?): Promise<BigNumber>
Starts from 0 and is incremented on every co-reviewed task change via executeTaskChange call.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
nonce The current task change nonce value
Inherited from
AugmentedIColony.getTaskChangeNonce
getTaskChangeNonce(uint256)
▸ getTaskChangeNonce(uint256)(_id, overrides?): Promise<BigNumber>
Starts from 0 and is incremented on every co-reviewed task change via executeTaskChange call.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
nonce The current task change nonce value
Inherited from
AugmentedIColony.getTaskChangeNonce(uint256)
getTaskCount
▸ getTaskCount(overrides?): Promise<BigNumber>
Get the number of tasks in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The task count
Inherited from
AugmentedIColony.getTaskCount
getTaskCount()
▸ getTaskCount()(overrides?): Promise<BigNumber>
Get the number of tasks in the colony.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
count The task count
Inherited from
AugmentedIColony.getTaskCount()
getTaskPayout
▸ getTaskPayout(_id, _role, _token, overrides?): Promise<BigNumber>
Get payout amount in _token denomination for role _role in task _id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
amount Payout amount
Inherited from
AugmentedIColony.getTaskPayout
getTaskPayout(uint256,uint8,address)
▸ getTaskPayout(uint256,uint8,address)(_id, _role, _token, overrides?): Promise<BigNumber>
Get payout amount in _token denomination for role _role in task _id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
amount Payout amount
Inherited from
AugmentedIColony.getTaskPayout(uint256,uint8,address)
getTaskRole
▸ getTaskRole(_id, _role, overrides?): Promise<[string, boolean, number] & { rateFail: boolean ; rating: number ; user: string }>
Get the Role properties back for role _role in task _id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
overrides? | CallOverrides | - |
Returns
Promise<[string, boolean, number] & { rateFail: boolean ; rating: number ; user: string }>
role The Role
Inherited from
AugmentedIColony.getTaskRole
getTaskRole(uint256,uint8)
▸ getTaskRole(uint256,uint8)(_id, _role, overrides?): Promise<[string, boolean, number] & { rateFail: boolean ; rating: number ; user: string }>
Get the Role properties back for role _role in task _id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
overrides? | CallOverrides | - |
Returns
Promise<[string, boolean, number] & { rateFail: boolean ; rating: number ; user: string }>
role The Role
Inherited from
AugmentedIColony.getTaskRole(uint256,uint8)
getTaskWorkRatingSecret
▸ getTaskWorkRatingSecret(_id, _role, overrides?): Promise<string>
Get the rating secret submitted for role _role in task _id
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
overrides? | CallOverrides | - |
Returns
Promise<string>
secret Rating secret bytes32 value
Inherited from
AugmentedIColony.getTaskWorkRatingSecret
getTaskWorkRatingSecret(uint256,uint8)
▸ getTaskWorkRatingSecret(uint256,uint8)(_id, _role, overrides?): Promise<string>
Get the rating secret submitted for role _role in task _id
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
overrides? | CallOverrides | - |
Returns
Promise<string>
secret Rating secret bytes32 value
Inherited from
AugmentedIColony.getTaskWorkRatingSecret(uint256,uint8)
getTaskWorkRatingSecretsInfo
▸ getTaskWorkRatingSecretsInfo(_id, overrides?): Promise<[BigNumber, BigNumber] & { lastSubmittedAt: BigNumber ; nSecrets: BigNumber }>
Get the ColonyStorage.RatingSecrets information for task _id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | CallOverrides | - |
Returns
Promise<[BigNumber, BigNumber] & { lastSubmittedAt: BigNumber ; nSecrets: BigNumber }>
nSecrets Number of secretslastSubmittedAt Timestamp of the last submitted rating secret
Inherited from
AugmentedIColony.getTaskWorkRatingSecretsInfo
getTaskWorkRatingSecretsInfo(uint256)
▸ getTaskWorkRatingSecretsInfo(uint256)(_id, overrides?): Promise<[BigNumber, BigNumber] & { lastSubmittedAt: BigNumber ; nSecrets: BigNumber }>
Get the ColonyStorage.RatingSecrets information for task _id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | CallOverrides | - |
Returns
Promise<[BigNumber, BigNumber] & { lastSubmittedAt: BigNumber ; nSecrets: BigNumber }>
nSecrets Number of secretslastSubmittedAt Timestamp of the last submitted rating secret
Inherited from
AugmentedIColony.getTaskWorkRatingSecretsInfo(uint256)
getToken
▸ getToken(overrides?): Promise<string>
Get the colony token.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
tokenAddress Address of the token contract
Inherited from
AugmentedIColony.getToken
getToken()
▸ getToken()(overrides?): Promise<string>
Get the colony token.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
tokenAddress Address of the token contract
Inherited from
AugmentedIColony.getToken()
getUserRoles
▸ getUserRoles(who, where, overrides?): Promise<string>
Gets the bytes32 representation of the roles for a user in a given domain
Parameters
| Name | Type | Description |
|---|---|---|
who | string | The user whose roles we want to get |
where | BigNumberish | The domain where we want to get roles for |
overrides? | CallOverrides | - |
Returns
Promise<string>
roles bytes32 representation of the roles
Inherited from
AugmentedIColony.getUserRoles
getUserRoles(address,uint256)
▸ getUserRoles(address,uint256)(who, where, overrides?): Promise<string>
Gets the bytes32 representation of the roles for a user in a given domain
Parameters
| Name | Type | Description |
|---|---|---|
who | string | The user whose roles we want to get |
where | BigNumberish | The domain where we want to get roles for |
overrides? | CallOverrides | - |
Returns
Promise<string>
roles bytes32 representation of the roles
Inherited from
AugmentedIColony.getUserRoles(address,uint256)
hasInheritedUserRole
▸ hasInheritedUserRole(_user, _domainId, _role, _childSkillIndex, _childDomainId, overrides?): Promise<boolean>
Check whether a given user has a given role for the colony, in a child domain. Calls the function of the same name on the colony's authority contract and an internal inheritence validator function
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | The user whose role we want to check |
_domainId | BigNumberish | Domain in which the caller has the role |
_role | BigNumberish | The role we want to check for |
_childSkillIndex | BigNumberish | The index that the _childDomainId is relative to _domainId |
_childDomainId | BigNumberish | The domain where we want to use the role |
overrides? | CallOverrides | - |
Returns
Promise<boolean>
hasRole Boolean indicating whether the given user has the given role in domain
Inherited from
AugmentedIColony.hasInheritedUserRole
hasInheritedUserRole(address,uint256,uint8,uint256,uint256)
▸ hasInheritedUserRole(address,uint256,uint8,uint256,uint256)(_user, _domainId, _role, _childSkillIndex, _childDomainId, overrides?): Promise<boolean>
Check whether a given user has a given role for the colony, in a child domain. Calls the function of the same name on the colony's authority contract and an internal inheritence validator function
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | The user whose role we want to check |
_domainId | BigNumberish | Domain in which the caller has the role |
_role | BigNumberish | The role we want to check for |
_childSkillIndex | BigNumberish | The index that the _childDomainId is relative to _domainId |
_childDomainId | BigNumberish | The domain where we want to use the role |
overrides? | CallOverrides | - |
Returns
Promise<boolean>
hasRole Boolean indicating whether the given user has the given role in domain
Inherited from
AugmentedIColony.hasInheritedUserRole(address,uint256,uint8,uint256,uint256)
hasInheritedUserRoleWithProofs
▸ hasInheritedUserRoleWithProofs(_user, _domainId, _role, overrides?): Promise<boolean>
Same as hasInheritedUserRole, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | The user whose role we want to check |
_domainId | BigNumberish | Domain in which the caller has the role |
_role | BigNumberish | The role we want to check for |
overrides? | TxOverrides | - |
Returns
Promise<boolean>
Inherited from
ColonyAugmentsV4.hasInheritedUserRoleWithProofs
hasUserRole
▸ hasUserRole(_user, _domainId, _role, overrides?): Promise<boolean>
Check whether a given user has a given role for the colony. Calls the function of the same name on the colony's authority contract.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | The user whose role we want to check |
_domainId | BigNumberish | The domain where we want to check for the role |
_role | BigNumberish | The role we want to check for |
overrides? | CallOverrides | - |
Returns
Promise<boolean>
hasRole Boolean indicating whether the given user has the given role in domain
Inherited from
AugmentedIColony.hasUserRole
hasUserRole(address,uint256,uint8)
▸ hasUserRole(address,uint256,uint8)(_user, _domainId, _role, overrides?): Promise<boolean>
Check whether a given user has a given role for the colony. Calls the function of the same name on the colony's authority contract.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | The user whose role we want to check |
_domainId | BigNumberish | The domain where we want to check for the role |
_role | BigNumberish | The role we want to check for |
overrides? | CallOverrides | - |
Returns
Promise<boolean>
hasRole Boolean indicating whether the given user has the given role in domain
Inherited from
AugmentedIColony.hasUserRole(address,uint256,uint8)
initialiseColony
▸ initialiseColony(_colonyNetworkAddress, _token, overrides?): Promise<ContractTransaction>
Sets the reward inverse to the uint max 2**256 - 1. Called once when the colony is created to initialise certain storage slot values.
Parameters
| Name | Type | Description |
|---|---|---|
_colonyNetworkAddress | string | Address of the colony network |
_token | string | Address of the colony ERC20 Token |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.initialiseColony
initialiseColony(address,address)
▸ initialiseColony(address,address)(_colonyNetworkAddress, _token, overrides?): Promise<ContractTransaction>
Sets the reward inverse to the uint max 2**256 - 1. Called once when the colony is created to initialise certain storage slot values.
Parameters
| Name | Type | Description |
|---|---|---|
_colonyNetworkAddress | string | Address of the colony network |
_token | string | Address of the colony ERC20 Token |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.initialiseColony(address,address)
isInRecoveryMode
▸ isInRecoveryMode(overrides?): Promise<boolean>
Is colony network in recovery mode.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<boolean>
inRecoveryMode Return true if recovery mode is active, false otherwise
Inherited from
AugmentedIColony.isInRecoveryMode
isInRecoveryMode()
▸ isInRecoveryMode()(overrides?): Promise<boolean>
Is colony network in recovery mode.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<boolean>
inRecoveryMode Return true if recovery mode is active, false otherwise
Inherited from
AugmentedIColony.isInRecoveryMode()
listenerCount
▸ listenerCount(eventName?): number
Parameters
| Name | Type |
|---|---|
eventName? | string | EventFilter |
Returns
number
Inherited from
AugmentedIColony.listenerCount
listeners
▸ listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]
Type parameters
| Name | Type |
|---|---|
TEvent | extends TypedEvent<any, any, TEvent> |
Parameters
| Name | Type |
|---|---|
eventFilter? | TypedEventFilter<TEvent> |
Returns
TypedListener<TEvent>[]
Inherited from
AugmentedIColony.listeners
▸ listeners(eventName?): Listener[]
Parameters
| Name | Type |
|---|---|
eventName? | string |
Returns
Listener[]
Inherited from
AugmentedIColony.listeners
makeExpenditure
▸ makeExpenditure(_permissionDomainId, _childSkillIndex, _domainId, overrides?): Promise<ContractTransaction>
Add a new expenditure in the colony. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_domainId | BigNumberish | The domain where the expenditure belongs |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
expenditureId Identifier of the newly created expenditure
Inherited from
AugmentedIColony.makeExpenditure
makeExpenditure(uint256,uint256,uint256)
▸ makeExpenditure(uint256,uint256,uint256)(_permissionDomainId, _childSkillIndex, _domainId, overrides?): Promise<ContractTransaction>
Add a new expenditure in the colony. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_domainId | BigNumberish | The domain where the expenditure belongs |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
expenditureId Identifier of the newly created expenditure
Inherited from
AugmentedIColony.makeExpenditure(uint256,uint256,uint256)
makeExpenditureWithProofs
▸ makeExpenditureWithProofs(_domainId, overrides?): Promise<ContractTransaction>
Same as makeExpenditure, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_domainId | BigNumberish | The domain where the expenditure belongs |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
ColonyAugmentsV4.makeExpenditureWithProofs
makeTask
▸ makeTask(_permissionDomainId, _childSkillIndex, _specificationHash, _domainId, _skillId, _dueDate, overrides?): Promise<ContractTransaction>
Make a new task in the colony. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_specificationHash | BytesLike | Database identifier where the task specification is stored |
_domainId | BigNumberish | The domain where the task belongs |
_skillId | BigNumberish | The skill associated with the task, can set to 0 for no-op |
_dueDate | BigNumberish | The due date of the task, can set to 0 for no-op |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.makeTask
makeTask(uint256,uint256,bytes32,uint256,uint256,uint256)
▸ makeTask(uint256,uint256,bytes32,uint256,uint256,uint256)(_permissionDomainId, _childSkillIndex, _specificationHash, _domainId, _skillId, _dueDate, overrides?): Promise<ContractTransaction>
Make a new task in the colony. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_specificationHash | BytesLike | Database identifier where the task specification is stored |
_domainId | BigNumberish | The domain where the task belongs |
_skillId | BigNumberish | The skill associated with the task, can set to 0 for no-op |
_dueDate | BigNumberish | The due date of the task, can set to 0 for no-op |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.makeTask(uint256,uint256,bytes32,uint256,uint256,uint256)
makeTaskWithProofs
▸ makeTaskWithProofs(_specificationHash, _domainId, _skillId, _dueDate, overrides?): Promise<ContractTransaction>
Same as makeTask, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_specificationHash | BytesLike | Database identifier where the task specification is stored |
_domainId | BigNumberish | The domain where the task belongs |
_skillId | BigNumberish | The skill associated with the task, can set to 0 for no-op |
_dueDate | BigNumberish | The due date of the task, can set to 0 for no-op |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.makeTaskWithProofs
mintTokens
▸ mintTokens(_wad, overrides?): Promise<ContractTransaction>
Mint _wad amount of colony tokens. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_wad | BigNumberish | Amount to mint |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.mintTokens
mintTokens(uint256)
▸ mintTokens(uint256)(_wad, overrides?): Promise<ContractTransaction>
Mint _wad amount of colony tokens. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_wad | BigNumberish | Amount to mint |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.mintTokens(uint256)
moveFundsBetweenPots
▸ moveFundsBetweenPots(_permissionDomainId, _fromChildSkillIndex, _toChildSkillIndex, _fromPot, _toPot, _amount, _token, overrides?): Promise<ContractTransaction>
Move a given amount: _amount of _token funds from funding pot with id _fromPot to one with id _toPot.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_fromChildSkillIndex | BigNumberish | The child index in _permissionDomainId where we can find the domain for _fromPotId |
_toChildSkillIndex | BigNumberish | The child index in _permissionDomainId where we can find the domain for _toPotId |
_fromPot | BigNumberish | Funding pot id providing the funds |
_toPot | BigNumberish | Funding pot id receiving the funds |
_amount | BigNumberish | Amount of funds |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.moveFundsBetweenPots
moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,address)
▸ moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,address)(_permissionDomainId, _fromChildSkillIndex, _toChildSkillIndex, _fromPot, _toPot, _amount, _token, overrides?): Promise<ContractTransaction>
Move a given amount: _amount of _token funds from funding pot with id _fromPot to one with id _toPot.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_fromChildSkillIndex | BigNumberish | The child index in _permissionDomainId where we can find the domain for _fromPotId |
_toChildSkillIndex | BigNumberish | The child index in _permissionDomainId where we can find the domain for _toPotId |
_fromPot | BigNumberish | Funding pot id providing the funds |
_toPot | BigNumberish | Funding pot id receiving the funds |
_amount | BigNumberish | Amount of funds |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,address)
moveFundsBetweenPotsWithProofs
▸ moveFundsBetweenPotsWithProofs(_fromPot, _toPot, _amount, _token, overrides?): Promise<ContractTransaction>
Deprecated
Same as moveFundsBetweenPots, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_fromPot | BigNumberish | Funding pot id providing the funds |
_toPot | BigNumberish | Funding pot id receiving the funds |
_amount | BigNumberish | Amount of funds |
_token | string | Address of the token, 0x0 value indicates Ether |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
MoveFundsBetweenPotsAugmentsA.moveFundsBetweenPotsWithProofs
numRecoveryRoles
▸ numRecoveryRoles(overrides?): Promise<BigNumber>
Return number of recovery roles.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
numRoles Number of users with the recovery role.
Inherited from
AugmentedIColony.numRecoveryRoles
numRecoveryRoles()
▸ numRecoveryRoles()(overrides?): Promise<BigNumber>
Return number of recovery roles.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
numRoles Number of users with the recovery role.
Inherited from
AugmentedIColony.numRecoveryRoles()
owner
▸ owner(overrides?): Promise<string>
Used for testing.
Get the colony owner address. This should be address(0x0) at all times.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
colonyOwner Address of the colony owner
Inherited from
AugmentedIColony.owner
owner()
▸ owner()(overrides?): Promise<string>
Used for testing.
Get the colony owner address. This should be address(0x0) at all times.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
colonyOwner Address of the colony owner
Inherited from
AugmentedIColony.owner()
queryFilter
▸ queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>
Type parameters
| Name | Type |
|---|---|
TEvent | extends TypedEvent<any, any, TEvent> |
Parameters
| Name | Type |
|---|---|
event | TypedEventFilter<TEvent> |
fromBlockOrBlockhash? | string | number |
toBlock? | string | number |
Returns
Promise<TEvent[]>
Inherited from
AugmentedIColony.queryFilter
registerColonyLabel
▸ registerColonyLabel(colonyName, orbitdb, overrides?): Promise<ContractTransaction>
Register colony's ENS label.
Parameters
| Name | Type | Description |
|---|---|---|
colonyName | string | The label to register. |
orbitdb | string | The path of the orbitDB database associated with the colony name |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.registerColonyLabel
registerColonyLabel(string,string)
▸ registerColonyLabel(string,string)(colonyName, orbitdb, overrides?): Promise<ContractTransaction>
Register colony's ENS label.
Parameters
| Name | Type | Description |
|---|---|---|
colonyName | string | The label to register. |
orbitdb | string | The path of the orbitDB database associated with the colony name |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.registerColonyLabel(string,string)
removeAllListeners
▸ removeAllListeners<TEvent>(eventFilter): ColonyClientV4
Type parameters
| Name | Type |
|---|---|
TEvent | extends TypedEvent<any, any, TEvent> |
Parameters
| Name | Type |
|---|---|
eventFilter | TypedEventFilter<TEvent> |
Returns
Inherited from
AugmentedIColony.removeAllListeners
▸ removeAllListeners(eventName?): ColonyClientV4
Parameters
| Name | Type |
|---|---|
eventName? | string |
Returns
Inherited from
AugmentedIColony.removeAllListeners
removeRecoveryRole
▸ removeRecoveryRole(_user, overrides?): Promise<ContractTransaction>
Remove colony recovery role. Can only be called by root role.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to remove recovery role from |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.removeRecoveryRole
removeRecoveryRole(address)
▸ removeRecoveryRole(address)(_user, overrides?): Promise<ContractTransaction>
Remove colony recovery role. Can only be called by root role.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to remove recovery role from |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.removeRecoveryRole(address)
removeTaskEvaluatorRole
▸ removeTaskEvaluatorRole(_id, overrides?): Promise<ContractTransaction>
Removing evaluator role. Agreed between manager and currently assigned evaluator.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.removeTaskEvaluatorRole
removeTaskEvaluatorRole(uint256)
▸ removeTaskEvaluatorRole(uint256)(_id, overrides?): Promise<ContractTransaction>
Removing evaluator role. Agreed between manager and currently assigned evaluator.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.removeTaskEvaluatorRole(uint256)
removeTaskWorkerRole
▸ removeTaskWorkerRole(_id, overrides?): Promise<ContractTransaction>
Removing worker role. Agreed between manager and currently assigned worker.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.removeTaskWorkerRole
removeTaskWorkerRole(uint256)
▸ removeTaskWorkerRole(uint256)(_id, overrides?): Promise<ContractTransaction>
Removing worker role. Agreed between manager and currently assigned worker.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.removeTaskWorkerRole(uint256)
revealTaskWorkRating
▸ revealTaskWorkRating(_id, _role, _rating, _salt, overrides?): Promise<ContractTransaction>
Compares the keccak256(_salt, _rating) output with the previously submitted rating secret and if they match, sets the task role properties rated to true and rating to _rating.
Reveal the secret rating submitted in IColony.submitTaskWorkRating for task _id and task role with id _role. Allowed within 5 days period starting which whichever is first from either both rating secrets being submitted (via IColony.submitTaskWorkRating) or the 5 day rating period expiring.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
_rating | BigNumberish | 0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50) |
_salt | BytesLike | Salt value used to generate the rating secret |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.revealTaskWorkRating
revealTaskWorkRating(uint256,uint8,uint8,bytes32)
▸ revealTaskWorkRating(uint256,uint8,uint8,bytes32)(_id, _role, _rating, _salt, overrides?): Promise<ContractTransaction>
Compares the keccak256(_salt, _rating) output with the previously submitted rating secret and if they match, sets the task role properties rated to true and rating to _rating.
Reveal the secret rating submitted in IColony.submitTaskWorkRating for task _id and task role with id _role. Allowed within 5 days period starting which whichever is first from either both rating secrets being submitted (via IColony.submitTaskWorkRating) or the 5 day rating period expiring.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
_rating | BigNumberish | 0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50) |
_salt | BytesLike | Salt value used to generate the rating secret |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.revealTaskWorkRating(uint256,uint8,uint8,bytes32)
setAdministrationRole
▸ setAdministrationRole(_permissionDomainId, _childSkillIndex, _user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Set new colony admin role. Can be called by root role or architecture role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | Domain in which the caller has root/architecture role |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_user | string | User we want to give an admin role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setAdministrationRole
setAdministrationRole(uint256,uint256,address,uint256,bool)
▸ setAdministrationRole(uint256,uint256,address,uint256,bool)(_permissionDomainId, _childSkillIndex, _user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Set new colony admin role. Can be called by root role or architecture role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | Domain in which the caller has root/architecture role |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_user | string | User we want to give an admin role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setAdministrationRole(uint256,uint256,address,uint256,bool)
setAdministrationRoleWithProofs
▸ setAdministrationRoleWithProofs(_user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Same as setAdministrationRole, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to give an admin role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setAdministrationRoleWithProofs
setAllTaskPayouts
▸ setAllTaskPayouts(_id, _token, _managerAmount, _evaluatorAmount, _workerAmount, overrides?): Promise<ContractTransaction>
Can only call if evaluator and worker are unassigned or manager, otherwise need signature.
Set _token payout for all roles in task _id to the respective amounts.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_token | string | Address of the token, 0x0 value indicates Ether |
_managerAmount | BigNumberish | Payout amount for manager |
_evaluatorAmount | BigNumberish | Payout amount for evaluator |
_workerAmount | BigNumberish | Payout amount for worker |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setAllTaskPayouts
setAllTaskPayouts(uint256,address,uint256,uint256,uint256)
▸ setAllTaskPayouts(uint256,address,uint256,uint256,uint256)(_id, _token, _managerAmount, _evaluatorAmount, _workerAmount, overrides?): Promise<ContractTransaction>
Can only call if evaluator and worker are unassigned or manager, otherwise need signature.
Set _token payout for all roles in task _id to the respective amounts.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_token | string | Address of the token, 0x0 value indicates Ether |
_managerAmount | BigNumberish | Payout amount for manager |
_evaluatorAmount | BigNumberish | Payout amount for evaluator |
_workerAmount | BigNumberish | Payout amount for worker |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setAllTaskPayouts(uint256,address,uint256,uint256,uint256)
setArbitrationRole
▸ setArbitrationRole(_permissionDomainId, _childSkillIndex, _user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Set new colony arbitration role. Can be called by root role or architecture role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | Domain in which the caller has root role |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_user | string | User we want to give an arbitration role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setArbitrationRole
setArbitrationRole(uint256,uint256,address,uint256,bool)
▸ setArbitrationRole(uint256,uint256,address,uint256,bool)(_permissionDomainId, _childSkillIndex, _user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Set new colony arbitration role. Can be called by root role or architecture role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | Domain in which the caller has root role |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_user | string | User we want to give an arbitration role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setArbitrationRole(uint256,uint256,address,uint256,bool)
setArbitrationRoleWithProofs
▸ setArbitrationRoleWithProofs(_user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Same as setArbitrationRole, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to give an arbitration role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
ColonyAugmentsV3.setArbitrationRoleWithProofs
setArchitectureRole
▸ setArchitectureRole(_permissionDomainId, _childSkillIndex, _user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Set new colony architecture role. Can be called by root role or architecture role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | Domain in which the caller has root/architecture role |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_user | string | User we want to give an architecture role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setArchitectureRole
setArchitectureRole(uint256,uint256,address,uint256,bool)
▸ setArchitectureRole(uint256,uint256,address,uint256,bool)(_permissionDomainId, _childSkillIndex, _user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Set new colony architecture role. Can be called by root role or architecture role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | Domain in which the caller has root/architecture role |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_user | string | User we want to give an architecture role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setArchitectureRole(uint256,uint256,address,uint256,bool)
setArchitectureRoleWithProofs
▸ setArchitectureRoleWithProofs(_user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Same as setArchitectureRole, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to give an architecture role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setArchitectureRoleWithProofs
setExpenditureClaimDelay
▸ setExpenditureClaimDelay(_permissionDomainId, _childSkillIndex, _id, _slot, _claimDelay, overrides?): Promise<ContractTransaction>
Set the claim delay on an expenditure slot. Can only be called by Arbitration role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_claimDelay | BigNumberish | Time (in seconds) to delay claiming payout after finalization |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditureClaimDelay
setExpenditureClaimDelay(uint256,uint256,uint256,uint256,uint256)
▸ setExpenditureClaimDelay(uint256,uint256,uint256,uint256,uint256)(_permissionDomainId, _childSkillIndex, _id, _slot, _claimDelay, overrides?): Promise<ContractTransaction>
Set the claim delay on an expenditure slot. Can only be called by Arbitration role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_claimDelay | BigNumberish | Time (in seconds) to delay claiming payout after finalization |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditureClaimDelay(uint256,uint256,uint256,uint256,uint256)
setExpenditureClaimDelayWithProofs
▸ setExpenditureClaimDelayWithProofs(_id, _slot, _claimDelay, overrides?): Promise<ContractTransaction>
Deprecated
Same as setExpenditureClaimDelay, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_claimDelay | BigNumberish | Time (in seconds) to delay claiming payout after finalization |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
SetExpenditureClaimDelayAugments.setExpenditureClaimDelayWithProofs
setExpenditurePayout
▸ setExpenditurePayout(_id, _slot, _token, _amount, overrides?): Promise<ContractTransaction>
Set the token payout on an expenditure slot. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the expenditure |
_slot | BigNumberish | Number of the slot |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditurePayout
setExpenditurePayout(uint256,uint256,address,uint256)
▸ setExpenditurePayout(uint256,uint256,address,uint256)(_id, _slot, _token, _amount, overrides?): Promise<ContractTransaction>
Set the token payout on an expenditure slot. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the expenditure |
_slot | BigNumberish | Number of the slot |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditurePayout(uint256,uint256,address,uint256)
setExpenditurePayoutModifier
▸ setExpenditurePayoutModifier(_permissionDomainId, _childSkillIndex, _id, _slot, _payoutModifier, overrides?): Promise<ContractTransaction>
Note that when determining payouts the payoutModifier is incremented by WAD and converted into payoutScalar Set the payout modifier on an expenditure slot. Can only be called by Arbitration role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_payoutModifier | BigNumberish | Modifier to their payout (between -1 and 1, denominated in WADs, 0 means no modification) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditurePayoutModifier
setExpenditurePayoutModifier(uint256,uint256,uint256,uint256,int256)
▸ setExpenditurePayoutModifier(uint256,uint256,uint256,uint256,int256)(_permissionDomainId, _childSkillIndex, _id, _slot, _payoutModifier, overrides?): Promise<ContractTransaction>
Note that when determining payouts the payoutModifier is incremented by WAD and converted into payoutScalar Set the payout modifier on an expenditure slot. Can only be called by Arbitration role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_payoutModifier | BigNumberish | Modifier to their payout (between -1 and 1, denominated in WADs, 0 means no modification) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditurePayoutModifier(uint256,uint256,uint256,uint256,int256)
setExpenditurePayoutModifierWithProofs
▸ setExpenditurePayoutModifierWithProofs(_id, _slot, _payoutModifier, overrides?): Promise<ContractTransaction>
Deprecated
Same as setExpenditurePayoutModifier, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_payoutModifier | BigNumberish | Modifier to their payout (between -1 and 1, denominated in WADs, 0 means no modification) |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
SetExpenditurePayoutModifierAugments.setExpenditurePayoutModifierWithProofs
setExpenditureRecipient
▸ setExpenditureRecipient(_id, _slot, _recipient, overrides?): Promise<ContractTransaction>
Sets the recipient on an expenditure slot. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the expenditure |
_slot | BigNumberish | Slot for the recipient address |
_recipient | string | Address of the recipient |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditureRecipient
setExpenditureRecipient(uint256,uint256,address)
▸ setExpenditureRecipient(uint256,uint256,address)(_id, _slot, _recipient, overrides?): Promise<ContractTransaction>
Sets the recipient on an expenditure slot. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the expenditure |
_slot | BigNumberish | Slot for the recipient address |
_recipient | string | Address of the recipient |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditureRecipient(uint256,uint256,address)
setExpenditureSkill
▸ setExpenditureSkill(_id, _slot, _skillId, overrides?): Promise<ContractTransaction>
Sets the skill on an expenditure slot. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_skillId | BigNumberish | Id of the new skill to set |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditureSkill
setExpenditureSkill(uint256,uint256,uint256)
▸ setExpenditureSkill(uint256,uint256,uint256)(_id, _slot, _skillId, overrides?): Promise<ContractTransaction>
Sets the skill on an expenditure slot. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_slot | BigNumberish | Number of the slot |
_skillId | BigNumberish | Id of the new skill to set |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setExpenditureSkill(uint256,uint256,uint256)
setFundingRole
▸ setFundingRole(_permissionDomainId, _childSkillIndex, _user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Set new colony funding role. Can be called by root role or architecture role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | Domain in which the caller has root/architecture role |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_user | string | User we want to give an funding role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setFundingRole
setFundingRole(uint256,uint256,address,uint256,bool)
▸ setFundingRole(uint256,uint256,address,uint256,bool)(_permissionDomainId, _childSkillIndex, _user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Set new colony funding role. Can be called by root role or architecture role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | Domain in which the caller has root/architecture role |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_user | string | User we want to give an funding role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setFundingRole(uint256,uint256,address,uint256,bool)
setFundingRoleWithProofs
▸ setFundingRoleWithProofs(_user, _domainId, _setTo, overrides?): Promise<ContractTransaction>
Same as setFundingRole, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to give an funding role to |
_domainId | BigNumberish | Domain in which we are giving user the role |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setFundingRoleWithProofs
setPaymentPayout
▸ setPaymentPayout(_permissionDomainId, _childSkillIndex, _id, _token, _amount, overrides?): Promise<ContractTransaction>
Sets the payout for a given token on an existing payment. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_id | BigNumberish | Payment identifier |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentPayout
setPaymentPayout(uint256,uint256,uint256,address,uint256)
▸ setPaymentPayout(uint256,uint256,uint256,address,uint256)(_permissionDomainId, _childSkillIndex, _id, _token, _amount, overrides?): Promise<ContractTransaction>
Sets the payout for a given token on an existing payment. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_id | BigNumberish | Payment identifier |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentPayout(uint256,uint256,uint256,address,uint256)
setPaymentPayoutWithProofs
▸ setPaymentPayoutWithProofs(_id, _token, _amount, overrides?): Promise<ContractTransaction>
Same as setPaymentPayout, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Payment identifier |
_token | BigNumberish | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentPayoutWithProofs
setPaymentRecipient
▸ setPaymentRecipient(_permissionDomainId, _childSkillIndex, _id, _recipient, overrides?): Promise<ContractTransaction>
Sets the recipient on an existing payment. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_id | BigNumberish | Payment identifier |
_recipient | string | Address of the payment recipient |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentRecipient
setPaymentRecipient(uint256,uint256,uint256,address)
▸ setPaymentRecipient(uint256,uint256,uint256,address)(_permissionDomainId, _childSkillIndex, _id, _recipient, overrides?): Promise<ContractTransaction>
Sets the recipient on an existing payment. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_id | BigNumberish | Payment identifier |
_recipient | string | Address of the payment recipient |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentRecipient(uint256,uint256,uint256,address)
setPaymentRecipientWithProofs
▸ setPaymentRecipientWithProofs(_id, _recipient, overrides?): Promise<ContractTransaction>
Same as setPaymentRecipient, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Payment identifier |
_recipient | string | Address of the payment recipient |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentRecipientWithProofs
setPaymentSkill
▸ setPaymentSkill(_permissionDomainId, _childSkillIndex, _id, _skillId, overrides?): Promise<ContractTransaction>
Sets the skill on an existing payment. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_id | BigNumberish | Payment identifier |
_skillId | BigNumberish | Id of the new skill to set |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentSkill
setPaymentSkill(uint256,uint256,uint256,uint256)
▸ setPaymentSkill(uint256,uint256,uint256,uint256)(_permissionDomainId, _childSkillIndex, _id, _skillId, overrides?): Promise<ContractTransaction>
Sets the skill on an existing payment. Secured function to authorised members.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
_id | BigNumberish | Payment identifier |
_skillId | BigNumberish | Id of the new skill to set |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentSkill(uint256,uint256,uint256,uint256)
setPaymentSkillWithProofs
▸ setPaymentSkillWithProofs(_id, _skillId, overrides?): Promise<ContractTransaction>
Same as setPaymentSkill, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Payment identifier |
_skillId | BigNumberish | Id of the new skill to set |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setPaymentSkillWithProofs
setRecoveryRole
▸ setRecoveryRole(_user, overrides?): Promise<ContractTransaction>
Set new colony recovery role. Can be called by root.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to give a recovery role to |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setRecoveryRole
setRecoveryRole(address)
▸ setRecoveryRole(address)(_user, overrides?): Promise<ContractTransaction>
Set new colony recovery role. Can be called by root.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to give a recovery role to |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setRecoveryRole(address)
setRewardInverse
▸ setRewardInverse(_rewardInverse, overrides?): Promise<ContractTransaction>
Set the reward inverse to pay out from revenue. e.g. if the fee is 1% (or 0.01), set 100.
Parameters
| Name | Type | Description |
|---|---|---|
_rewardInverse | BigNumberish | The inverse of the reward |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setRewardInverse
setRewardInverse(uint256)
▸ setRewardInverse(uint256)(_rewardInverse, overrides?): Promise<ContractTransaction>
Set the reward inverse to pay out from revenue. e.g. if the fee is 1% (or 0.01), set 100.
Parameters
| Name | Type | Description |
|---|---|---|
_rewardInverse | BigNumberish | The inverse of the reward |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setRewardInverse(uint256)
setRootRole
▸ setRootRole(_user, _setTo, overrides?): Promise<ContractTransaction>
Set new colony root role. Can be called by root role only.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to give an root role to |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setRootRole
setRootRole(address,bool)
▸ setRootRole(address,bool)(_user, _setTo, overrides?): Promise<ContractTransaction>
Set new colony root role. Can be called by root role only.
Parameters
| Name | Type | Description |
|---|---|---|
_user | string | User we want to give an root role to |
_setTo | boolean | The state of the role permission (true assign the permission, false revokes it) |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setRootRole(address,bool)
setStorageSlotRecovery
▸ setStorageSlotRecovery(_slot, _value, overrides?): Promise<ContractTransaction>
certain critical variables are protected from editing in this function Update value of arbitrary storage variable. Can only be called by user with recovery role.
Parameters
| Name | Type | Description |
|---|---|---|
_slot | BigNumberish | Uint address of storage slot to be updated |
_value | BytesLike | word of data to be set |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setStorageSlotRecovery
setStorageSlotRecovery(uint256,bytes32)
▸ setStorageSlotRecovery(uint256,bytes32)(_slot, _value, overrides?): Promise<ContractTransaction>
certain critical variables are protected from editing in this function Update value of arbitrary storage variable. Can only be called by user with recovery role.
Parameters
| Name | Type | Description |
|---|---|---|
_slot | BigNumberish | Uint address of storage slot to be updated |
_value | BytesLike | word of data to be set |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setStorageSlotRecovery(uint256,bytes32)
setTaskBrief
▸ setTaskBrief(_id, _specificationHash, overrides?): Promise<ContractTransaction>
Set the hash for the task brief, aka task work specification, which identifies the task brief content in ddb. Allowed before a task is finalized.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_specificationHash | BytesLike | Unique hash of the task brief in ddb |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskBrief
setTaskBrief(uint256,bytes32)
▸ setTaskBrief(uint256,bytes32)(_id, _specificationHash, overrides?): Promise<ContractTransaction>
Set the hash for the task brief, aka task work specification, which identifies the task brief content in ddb. Allowed before a task is finalized.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_specificationHash | BytesLike | Unique hash of the task brief in ddb |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskBrief(uint256,bytes32)
setTaskDueDate
▸ setTaskDueDate(_id, _dueDate, overrides?): Promise<ContractTransaction>
Set the due date on task _id. Allowed before a task is finalized.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_dueDate | BigNumberish | Due date as seconds since unix epoch |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskDueDate
setTaskDueDate(uint256,uint256)
▸ setTaskDueDate(uint256,uint256)(_id, _dueDate, overrides?): Promise<ContractTransaction>
Set the due date on task _id. Allowed before a task is finalized.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_dueDate | BigNumberish | Due date as seconds since unix epoch |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskDueDate(uint256,uint256)
setTaskEvaluatorPayout
▸ setTaskEvaluatorPayout(_id, _token, _amount, overrides?): Promise<ContractTransaction>
Set _token payout for evaluator in task _id to _amount.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskEvaluatorPayout
setTaskEvaluatorPayout(uint256,address,uint256)
▸ setTaskEvaluatorPayout(uint256,address,uint256)(_id, _token, _amount, overrides?): Promise<ContractTransaction>
Set _token payout for evaluator in task _id to _amount.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskEvaluatorPayout(uint256,address,uint256)
setTaskEvaluatorRole
▸ setTaskEvaluatorRole(_id, _user, overrides?): Promise<ContractTransaction>
This function can only be called through executeTaskRoleAssignment.
Assigning evaluator role. Can only be set if there is no one currently assigned to be an evaluator. Manager of the task and user we want to assign role to both need to agree. Managers can assign themselves to this role, if there is no one currently assigned to it.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_user | string | Address of the user we want to give a evaluator role to |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskEvaluatorRole
setTaskEvaluatorRole(uint256,address)
▸ setTaskEvaluatorRole(uint256,address)(_id, _user, overrides?): Promise<ContractTransaction>
This function can only be called through executeTaskRoleAssignment.
Assigning evaluator role. Can only be set if there is no one currently assigned to be an evaluator. Manager of the task and user we want to assign role to both need to agree. Managers can assign themselves to this role, if there is no one currently assigned to it.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_user | string | Address of the user we want to give a evaluator role to |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskEvaluatorRole(uint256,address)
setTaskManagerPayout
▸ setTaskManagerPayout(_id, _token, _amount, overrides?): Promise<ContractTransaction>
Set _token payout for manager in task _id to _amount.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskManagerPayout
setTaskManagerPayout(uint256,address,uint256)
▸ setTaskManagerPayout(uint256,address,uint256)(_id, _token, _amount, overrides?): Promise<ContractTransaction>
Set _token payout for manager in task _id to _amount.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskManagerPayout(uint256,address,uint256)
setTaskManagerRole
▸ setTaskManagerRole(_id, _user, _permissionDomainId, _childSkillIndex, overrides?): Promise<ContractTransaction>
This function can only be called through executeTaskRoleAssignment.
Assigning manager role. Current manager and user we want to assign role to both need to agree. User we want to set here also needs to be an admin. Note that the domain proof data comes at the end here to not interfere with the assembly argument unpacking.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_user | string | Address of the user we want to give a manager role to |
_permissionDomainId | BigNumberish | The domain ID in which _user has the Administration permission |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskManagerRole
setTaskManagerRole(uint256,address,uint256,uint256)
▸ setTaskManagerRole(uint256,address,uint256,uint256)(_id, _user, _permissionDomainId, _childSkillIndex, overrides?): Promise<ContractTransaction>
This function can only be called through executeTaskRoleAssignment.
Assigning manager role. Current manager and user we want to assign role to both need to agree. User we want to set here also needs to be an admin. Note that the domain proof data comes at the end here to not interfere with the assembly argument unpacking.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_user | string | Address of the user we want to give a manager role to |
_permissionDomainId | BigNumberish | The domain ID in which _user has the Administration permission |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskManagerRole(uint256,address,uint256,uint256)
setTaskSkill
▸ setTaskSkill(_id, _skillId, overrides?): Promise<ContractTransaction>
Currently we only allow one skill per task although we have provisioned for an array of skills in Task struct. Allowed before a task is finalized.
Set the skill for task _id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_skillId | BigNumberish | Id of the skill which has to be a global skill |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskSkill
setTaskSkill(uint256,uint256)
▸ setTaskSkill(uint256,uint256)(_id, _skillId, overrides?): Promise<ContractTransaction>
Currently we only allow one skill per task although we have provisioned for an array of skills in Task struct. Allowed before a task is finalized.
Set the skill for task _id.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_skillId | BigNumberish | Id of the skill which has to be a global skill |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskSkill(uint256,uint256)
setTaskWorkerPayout
▸ setTaskWorkerPayout(_id, _token, _amount, overrides?): Promise<ContractTransaction>
Set _token payout for worker in task _id to _amount.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskWorkerPayout
setTaskWorkerPayout(uint256,address,uint256)
▸ setTaskWorkerPayout(uint256,address,uint256)(_id, _token, _amount, overrides?): Promise<ContractTransaction>
Set _token payout for worker in task _id to _amount.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_token | string | Address of the token, 0x0 value indicates Ether |
_amount | BigNumberish | Payout amount |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskWorkerPayout(uint256,address,uint256)
setTaskWorkerRole
▸ setTaskWorkerRole(_id, _user, overrides?): Promise<ContractTransaction>
This function can only be called through executeTaskRoleAssignment.
Assigning worker role. Can only be set if there is no one currently assigned to be a worker. Manager of the task and user we want to assign role to both need to agree.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_user | string | Address of the user we want to give a worker role to |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskWorkerRole
setTaskWorkerRole(uint256,address)
▸ setTaskWorkerRole(uint256,address)(_id, _user, overrides?): Promise<ContractTransaction>
This function can only be called through executeTaskRoleAssignment.
Assigning worker role. Can only be set if there is no one currently assigned to be a worker. Manager of the task and user we want to assign role to both need to agree.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_user | string | Address of the user we want to give a worker role to |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.setTaskWorkerRole(uint256,address)
startNextRewardPayout
▸ startNextRewardPayout(_token, key, value, branchMask, siblings, overrides?): Promise<ContractTransaction>
Start next reward payout for _token. All funds in the reward pot for _token will become unavailable.Add a new payment in the colony. Can only be called by users with root permission. All tokens will be locked, and can be unlocked by calling waiveRewardPayout or claimRewardPayout.
Parameters
| Name | Type | Description |
|---|---|---|
_token | string | Address of the token used for reward payout |
key | BytesLike | Some Reputation hash tree key |
value | BytesLike | Reputation value |
branchMask | BigNumberish | The branchmask of the proof |
siblings | BytesLike[] | The siblings of the proof |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.startNextRewardPayout
startNextRewardPayout(address,bytes,bytes,uint256,bytes32[])
▸ startNextRewardPayout(address,bytes,bytes,uint256,bytes32[])(_token, key, value, branchMask, siblings, overrides?): Promise<ContractTransaction>
Start next reward payout for _token. All funds in the reward pot for _token will become unavailable.Add a new payment in the colony. Can only be called by users with root permission. All tokens will be locked, and can be unlocked by calling waiveRewardPayout or claimRewardPayout.
Parameters
| Name | Type | Description |
|---|---|---|
_token | string | Address of the token used for reward payout |
key | BytesLike | Some Reputation hash tree key |
value | BytesLike | Reputation value |
branchMask | BigNumberish | The branchmask of the proof |
siblings | BytesLike[] | The siblings of the proof |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.startNextRewardPayout(address,bytes,bytes,uint256,bytes32[])
submitTaskDeliverable
▸ submitTaskDeliverable(_id, _deliverableHash, overrides?): Promise<ContractTransaction>
Set the task.deliverableHash and task.completionTimestamp properties.
Submit the task deliverable, i.e. the output of the work performed for task _id. Submission is allowed only to the assigned worker before the task due date. Submissions cannot be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_deliverableHash | BytesLike | Unique hash of the task deliverable content in ddb |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.submitTaskDeliverable
submitTaskDeliverable(uint256,bytes32)
▸ submitTaskDeliverable(uint256,bytes32)(_id, _deliverableHash, overrides?): Promise<ContractTransaction>
Set the task.deliverableHash and task.completionTimestamp properties.
Submit the task deliverable, i.e. the output of the work performed for task _id. Submission is allowed only to the assigned worker before the task due date. Submissions cannot be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_deliverableHash | BytesLike | Unique hash of the task deliverable content in ddb |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.submitTaskDeliverable(uint256,bytes32)
submitTaskDeliverableAndRating
▸ submitTaskDeliverableAndRating(_id, _deliverableHash, _ratingSecret, overrides?): Promise<ContractTransaction>
Internally call submitTaskDeliverable and submitTaskWorkRating in sequence.
Submit the task deliverable for Worker and rating for Manager.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_deliverableHash | BytesLike | Unique hash of the task deliverable content in ddb |
_ratingSecret | BytesLike | Rating secret for manager |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.submitTaskDeliverableAndRating
submitTaskDeliverableAndRating(uint256,bytes32,bytes32)
▸ submitTaskDeliverableAndRating(uint256,bytes32,bytes32)(_id, _deliverableHash, _ratingSecret, overrides?): Promise<ContractTransaction>
Internally call submitTaskDeliverable and submitTaskWorkRating in sequence.
Submit the task deliverable for Worker and rating for Manager.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_deliverableHash | BytesLike | Unique hash of the task deliverable content in ddb |
_ratingSecret | BytesLike | Rating secret for manager |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.submitTaskDeliverableAndRating(uint256,bytes32,bytes32)
submitTaskWorkRating
▸ submitTaskWorkRating(_id, _role, _ratingSecret, overrides?): Promise<ContractTransaction>
Submit a hashed secret of the rating for work in task _id which was performed by user with task role id _role. Allowed within 5 days period starting which whichever is first from either the deliverable being submitted or the dueDate been reached. Allowed only for evaluator to rate worker and for worker to rate manager performance. Once submitted ratings can not be changed or overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
_ratingSecret | BytesLike | keccak256 hash of a salt and 0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50). Can be generated via IColony.generateSecret helper function. |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.submitTaskWorkRating
submitTaskWorkRating(uint256,uint8,bytes32)
▸ submitTaskWorkRating(uint256,uint8,bytes32)(_id, _role, _ratingSecret, overrides?): Promise<ContractTransaction>
Submit a hashed secret of the rating for work in task _id which was performed by user with task role id _role. Allowed within 5 days period starting which whichever is first from either the deliverable being submitted or the dueDate been reached. Allowed only for evaluator to rate worker and for worker to rate manager performance. Once submitted ratings can not be changed or overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Id of the task |
_role | BigNumberish | Id of the role, as defined in TaskRole enum |
_ratingSecret | BytesLike | keccak256 hash of a salt and 0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50). Can be generated via IColony.generateSecret helper function. |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.submitTaskWorkRating(uint256,uint8,bytes32)
transferExpenditure
▸ transferExpenditure(_id, _newOwner, overrides?): Promise<ContractTransaction>
Updates the expenditure owner. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_newOwner | string | New owner of expenditure |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.transferExpenditure
transferExpenditure(uint256,address)
▸ transferExpenditure(uint256,address)(_id, _newOwner, overrides?): Promise<ContractTransaction>
Updates the expenditure owner. Can only be called by expenditure owner.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_newOwner | string | New owner of expenditure |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.transferExpenditure(uint256,address)
transferExpenditureViaArbitration
▸ transferExpenditureViaArbitration(_permissionDomainId, _childSkillIndex, _id, _newOwner, overrides?): Promise<ContractTransaction>
Updates the expenditure owner. Can only be called by Arbitration role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_id | BigNumberish | Expenditure identifier |
_newOwner | string | New owner of expenditure |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.transferExpenditureViaArbitration
transferExpenditureViaArbitration(uint256,uint256,uint256,address)
▸ transferExpenditureViaArbitration(uint256,uint256,uint256,address)(_permissionDomainId, _childSkillIndex, _id, _newOwner, overrides?): Promise<ContractTransaction>
Updates the expenditure owner. Can only be called by Arbitration role.
Parameters
| Name | Type | Description |
|---|---|---|
_permissionDomainId | BigNumberish | The domainId in which I have the permission to take this action |
_childSkillIndex | BigNumberish | The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId) |
_id | BigNumberish | Expenditure identifier |
_newOwner | string | New owner of expenditure |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.transferExpenditureViaArbitration(uint256,uint256,uint256,address)
transferExpenditureViaArbitrationWithProofs
▸ transferExpenditureViaArbitrationWithProofs(_id, _newOwner, overrides?): Promise<ContractTransaction>
Deprecated
Same as transferExpenditureViaArbitration, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.
Parameters
| Name | Type | Description |
|---|---|---|
_id | BigNumberish | Expenditure identifier |
_newOwner | string | New owner of expenditure |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
ColonyAugmentsV4.transferExpenditureViaArbitrationWithProofs
updateColonyOrbitDB
▸ updateColonyOrbitDB(orbitdb, overrides?): Promise<ContractTransaction>
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 |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.updateColonyOrbitDB
updateColonyOrbitDB(string)
▸ updateColonyOrbitDB(string)(orbitdb, overrides?): Promise<ContractTransaction>
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 |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.updateColonyOrbitDB(string)
upgrade
▸ upgrade(_newVersion, overrides?): Promise<ContractTransaction>
Downgrades are not allowed, i.e. _newVersion should be higher than the currect colony version.
Upgrades a colony to a new Colony contract version _newVersion.
Parameters
| Name | Type | Description |
|---|---|---|
_newVersion | BigNumberish | The target version for the upgrade |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.upgrade
upgrade(uint256)
▸ upgrade(uint256)(_newVersion, overrides?): Promise<ContractTransaction>
Downgrades are not allowed, i.e. _newVersion should be higher than the currect colony version.
Upgrades a colony to a new Colony contract version _newVersion.
Parameters
| Name | Type | Description |
|---|---|---|
_newVersion | BigNumberish | The target version for the upgrade |
overrides? | Overrides & { from?: string } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedIColony.upgrade(uint256)
verifyReputationProof
▸ verifyReputationProof(key, value, branchMask, siblings, overrides?): Promise<boolean>
For more detail about branchMask and siblings, examine the PatriciaTree implementation. While public, likely only to be used by the Colony contracts, as it checks that the user is proving their own reputation in the current colony. The verifyProof function can be used to verify any proof, though this function is not currently exposed on the Colony's EtherRouter.
Helper function that can be used by a client to verify the correctness of a patricia proof they have been supplied with.
Parameters
| Name | Type | Description |
|---|---|---|
key | BytesLike | The key of the element the proof is for. |
value | BytesLike | The value of the element that the proof is for. |
branchMask | BigNumberish | The branchmask of the proof |
siblings | BytesLike[] | The siblings of the proof |
overrides? | CallOverrides | - |
Returns
Promise<boolean>
isValid True if the proof is valid, false otherwise.
Inherited from
AugmentedIColony.verifyReputationProof
verifyReputationProof(bytes,bytes,uint256,bytes32[])
▸ verifyReputationProof(bytes,bytes,uint256,bytes32[])(key, value, branchMask, siblings, overrides?): Promise<boolean>
For more detail about branchMask and siblings, examine the PatriciaTree implementation. While public, likely only to be used by the Colony contracts, as it checks that the user is proving their own reputation in the current colony. The verifyProof function can be used to verify any proof, though this function is not currently exposed on the Colony's EtherRouter.
Helper function that can be used by a client to verify the correctness of a patricia proof they have been supplied with.
Parameters
| Name | Type | Description |
|---|---|---|
key | BytesLike | The key of the element the proof is for. |
value | BytesLike | The value of the element that the proof is for. |
branchMask | BigNumberish | The branchmask of the proof |
siblings | BytesLike[] | The siblings of the proof |
overrides? | CallOverrides | - |
Returns
Promise<boolean>
isValid True if the proof is valid, false otherwise.
Inherited from
AugmentedIColony.verifyReputationProof(bytes,bytes,uint256,bytes32[])
version
▸ version(overrides?): Promise<BigNumber>
Get the Colony contract version. Starts from 1 and is incremented with every deployed contract change.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
colonyVersion Version number
Inherited from
AugmentedIColony.version
version()
▸ version()(overrides?): Promise<BigNumber>
Get the Colony contract version. Starts from 1 and is incremented with every deployed contract change.
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
colonyVersion Version number
Inherited from
AugmentedIColony.version()