Skip to main content

Interface: ColonyClientV6

Hierarchy

  • AugmentedIColony<IColony>

  • ColonyAugmentsV3<IColony>

  • ColonyAugmentsV4<IColony>

  • ColonyAugmentsV5<IColony>

  • AddDomainAugmentsB<IColony>

  • MoveFundsBetweenPotsAugmentsA<IColony>

  • SetExpenditureClaimDelayAugments<IColony>

  • SetExpenditurePayoutModifierAugments<IColony>

    ColonyClientV6

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: 6

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: ColonyClientV6Estimate

Overrides

AugmentedIColony.estimateGas


filters

filters: Object

Type declaration

NameType
Annotation(agent?: null | PromiseOrValue<string>, txHash?: null | PromiseOrValue<BytesLike>, metadata?: null) => AnnotationEventFilter
Annotation(address,bytes32,string)(agent?: null | PromiseOrValue<string>, txHash?: null | PromiseOrValue<BytesLike>, metadata?: null) => AnnotationEventFilter
ColonyBootstrapped(agent?: null, users?: null, amounts?: null) => ColonyBootstrappedEventFilter
ColonyBootstrapped(address,address[],int256[])(agent?: null, users?: null, amounts?: null) => ColonyBootstrappedEventFilter
ColonyFundsClaimed(agent?: null, token?: null, fee?: null, payoutRemainder?: null) => ColonyFundsClaimedEventFilter
ColonyFundsClaimed(address,address,uint256,uint256)(agent?: null, token?: null, fee?: null, payoutRemainder?: null) => ColonyFundsClaimedEventFilter
ColonyFundsMovedBetweenFundingPots(agent?: null, fromPot?: null | PromiseOrValue<BigNumberish>, toPot?: null | PromiseOrValue<BigNumberish>, amount?: null, token?: null) => ColonyFundsMovedBetweenFundingPotsEventFilter
ColonyFundsMovedBetweenFundingPots(address,uint256,uint256,uint256,address)(agent?: null, fromPot?: null | PromiseOrValue<BigNumberish>, toPot?: null | PromiseOrValue<BigNumberish>, amount?: null, token?: null) => ColonyFundsMovedBetweenFundingPotsEventFilter
ColonyInitialised(agent?: null, colonyNetwork?: null, token?: null) => ColonyInitialisedEventFilter
ColonyInitialised(address,address,address)(agent?: null, colonyNetwork?: null, token?: null) => ColonyInitialisedEventFilter
ColonyMetadata(agent?: null, metadata?: null) => ColonyMetadataEventFilter
ColonyMetadata(address,string)(agent?: null, metadata?: null) => ColonyMetadataEventFilter
ColonyRewardInverseSet(agent?: null, rewardInverse?: null) => ColonyRewardInverseSetEventFilter
ColonyRewardInverseSet(address,uint256)(agent?: null, rewardInverse?: null) => ColonyRewardInverseSetEventFilter
ColonyRoleSet(agent?: null, user?: null | PromiseOrValue<string>, domainId?: null | PromiseOrValue<BigNumberish>, role?: null | PromiseOrValue<BigNumberish>, setTo?: null) => ColonyRoleSetEventFilter
ColonyRoleSet(address,address,uint256,uint8,bool)(agent?: null, user?: null | PromiseOrValue<string>, domainId?: null | PromiseOrValue<BigNumberish>, role?: null | PromiseOrValue<BigNumberish>, setTo?: null) => ColonyRoleSetEventFilter
ColonyUpgraded(agent?: null, oldVersion?: null, newVersion?: null) => ColonyUpgradedEventFilter
ColonyUpgraded(address,uint256,uint256)(agent?: null, oldVersion?: null, newVersion?: null) => ColonyUpgradedEventFilter
DomainAdded(agent?: null, domainId?: null) => DomainAddedEventFilter
DomainAdded(address,uint256)(agent?: null, domainId?: null) => DomainAddedEventFilter
DomainMetadata(agent?: null, domainId?: null | PromiseOrValue<BigNumberish>, metadata?: null) => DomainMetadataEventFilter
DomainMetadata(address,uint256,string)(agent?: null, domainId?: null | PromiseOrValue<BigNumberish>, metadata?: null) => DomainMetadataEventFilter
ExpenditureAdded(agent?: null, expenditureId?: null) => ExpenditureAddedEventFilter
ExpenditureAdded(address,uint256)(agent?: null, expenditureId?: null) => ExpenditureAddedEventFilter
ExpenditureCancelled(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>) => ExpenditureCancelledEventFilter
ExpenditureCancelled(address,uint256)(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>) => ExpenditureCancelledEventFilter
ExpenditureFinalized(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>) => ExpenditureFinalizedEventFilter
ExpenditureFinalized(address,uint256)(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>) => ExpenditureFinalizedEventFilter
ExpenditurePayoutSet(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>, slot?: null | PromiseOrValue<BigNumberish>, token?: null | PromiseOrValue<string>, amount?: null) => ExpenditurePayoutSetEventFilter
ExpenditurePayoutSet(address,uint256,uint256,address,uint256)(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>, slot?: null | PromiseOrValue<BigNumberish>, token?: null | PromiseOrValue<string>, amount?: null) => ExpenditurePayoutSetEventFilter
ExpenditureRecipientSet(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>, slot?: null | PromiseOrValue<BigNumberish>, recipient?: null | PromiseOrValue<string>) => ExpenditureRecipientSetEventFilter
ExpenditureRecipientSet(address,uint256,uint256,address)(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>, slot?: null | PromiseOrValue<BigNumberish>, recipient?: null | PromiseOrValue<string>) => ExpenditureRecipientSetEventFilter
ExpenditureSkillSet(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>, slot?: null | PromiseOrValue<BigNumberish>, skillId?: null | PromiseOrValue<BigNumberish>) => ExpenditureSkillSetEventFilter
ExpenditureSkillSet(address,uint256,uint256,uint256)(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>, slot?: null | PromiseOrValue<BigNumberish>, skillId?: null | PromiseOrValue<BigNumberish>) => ExpenditureSkillSetEventFilter
ExpenditureTransferred(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>, owner?: null | PromiseOrValue<string>) => ExpenditureTransferredEventFilter
ExpenditureTransferred(address,uint256,address)(agent?: null, expenditureId?: null | PromiseOrValue<BigNumberish>, owner?: null | PromiseOrValue<string>) => ExpenditureTransferredEventFilter
FundingPotAdded(fundingPotId?: null) => FundingPotAddedEventFilter
FundingPotAdded(uint256)(fundingPotId?: null) => FundingPotAddedEventFilter
PaymentAdded(agent?: null, paymentId?: null) => PaymentAddedEventFilter
PaymentAdded(address,uint256)(agent?: null, paymentId?: null) => PaymentAddedEventFilter
PaymentFinalized(agent?: null, paymentId?: null | PromiseOrValue<BigNumberish>) => PaymentFinalizedEventFilter
PaymentFinalized(address,uint256)(agent?: null, paymentId?: null | PromiseOrValue<BigNumberish>) => PaymentFinalizedEventFilter
PaymentPayoutSet(agent?: null, paymentId?: null | PromiseOrValue<BigNumberish>, token?: null, amount?: null) => PaymentPayoutSetEventFilter
PaymentPayoutSet(address,uint256,address,uint256)(agent?: null, paymentId?: null | PromiseOrValue<BigNumberish>, token?: null, amount?: null) => PaymentPayoutSetEventFilter
PaymentRecipientSet(agent?: null, paymentId?: null | PromiseOrValue<BigNumberish>, recipient?: null) => PaymentRecipientSetEventFilter
PaymentRecipientSet(address,uint256,address)(agent?: null, paymentId?: null | PromiseOrValue<BigNumberish>, recipient?: null) => PaymentRecipientSetEventFilter
PaymentSkillSet(agent?: null, paymentId?: null | PromiseOrValue<BigNumberish>, skillId?: null) => PaymentSkillSetEventFilter
PaymentSkillSet(address,uint256,uint256)(agent?: null, paymentId?: null | PromiseOrValue<BigNumberish>, skillId?: null) => PaymentSkillSetEventFilter
PayoutClaimed(agent?: null, fundingPotId?: null | PromiseOrValue<BigNumberish>, token?: null, amount?: null) => PayoutClaimedEventFilter
PayoutClaimed(address,uint256,address,uint256)(agent?: null, fundingPotId?: null | PromiseOrValue<BigNumberish>, token?: null, amount?: null) => PayoutClaimedEventFilter
RecoveryModeEntered(user?: null) => RecoveryModeEnteredEventFilter
RecoveryModeEntered(address)(user?: null) => RecoveryModeEnteredEventFilter
RecoveryModeExitApproved(user?: null) => RecoveryModeExitApprovedEventFilter
RecoveryModeExitApproved(address)(user?: null) => RecoveryModeExitApprovedEventFilter
RecoveryModeExited(user?: null) => RecoveryModeExitedEventFilter
RecoveryModeExited(address)(user?: null) => RecoveryModeExitedEventFilter
RecoveryRoleSet(user?: null | PromiseOrValue<string>, setTo?: null) => RecoveryRoleSetEventFilter
RecoveryRoleSet(address,bool)(user?: null | PromiseOrValue<string>, setTo?: null) => RecoveryRoleSetEventFilter
RecoveryStorageSlotSet(user?: null, slot?: null, fromValue?: null, toValue?: null) => RecoveryStorageSlotSetEventFilter
RecoveryStorageSlotSet(address,uint256,bytes32,bytes32)(user?: null, slot?: null, fromValue?: null, toValue?: null) => RecoveryStorageSlotSetEventFilter
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(agent?: null, rewardPayoutId?: null) => RewardPayoutCycleEndedEventFilter
RewardPayoutCycleEnded(address,uint256)(agent?: null, rewardPayoutId?: null) => RewardPayoutCycleEndedEventFilter
RewardPayoutCycleStarted(agent?: null, rewardPayoutId?: null) => RewardPayoutCycleStartedEventFilter
RewardPayoutCycleStarted(address,uint256)(agent?: null, rewardPayoutId?: null) => RewardPayoutCycleStartedEventFilter
TaskAdded(agent?: null, taskId?: null) => TaskAddedEventFilter
TaskAdded(address,uint256)(agent?: null, taskId?: null) => TaskAddedEventFilter
TaskBriefSet(taskId?: null | PromiseOrValue<BigNumberish>, specificationHash?: null) => TaskBriefSetEventFilter
TaskBriefSet(uint256,bytes32)(taskId?: null | PromiseOrValue<BigNumberish>, specificationHash?: null) => TaskBriefSetEventFilter
TaskCanceled(taskId?: null | PromiseOrValue<BigNumberish>) => TaskCanceledEventFilter
TaskCanceled(uint256)(taskId?: null | PromiseOrValue<BigNumberish>) => TaskCanceledEventFilter
TaskChangedViaSignatures(reviewerAddresses?: null) => TaskChangedViaSignaturesEventFilter
TaskChangedViaSignatures(address[])(reviewerAddresses?: null) => TaskChangedViaSignaturesEventFilter
TaskCompleted(agent?: null, taskId?: null | PromiseOrValue<BigNumberish>) => TaskCompletedEventFilter
TaskCompleted(address,uint256)(agent?: null, taskId?: null | PromiseOrValue<BigNumberish>) => TaskCompletedEventFilter
TaskDeliverableSubmitted(agent?: null, taskId?: null | PromiseOrValue<BigNumberish>, deliverableHash?: null) => TaskDeliverableSubmittedEventFilter
TaskDeliverableSubmitted(address,uint256,bytes32)(agent?: null, taskId?: null | PromiseOrValue<BigNumberish>, deliverableHash?: null) => TaskDeliverableSubmittedEventFilter
TaskDueDateSet(taskId?: null | PromiseOrValue<BigNumberish>, dueDate?: null) => TaskDueDateSetEventFilter
TaskDueDateSet(uint256,uint256)(taskId?: null | PromiseOrValue<BigNumberish>, dueDate?: null) => TaskDueDateSetEventFilter
TaskFinalized(agent?: null, taskId?: null | PromiseOrValue<BigNumberish>) => TaskFinalizedEventFilter
TaskFinalized(address,uint256)(agent?: null, taskId?: null | PromiseOrValue<BigNumberish>) => TaskFinalizedEventFilter
TaskPayoutSet(taskId?: null | PromiseOrValue<BigNumberish>, role?: null, token?: null, amount?: null) => TaskPayoutSetEventFilter
TaskPayoutSet(uint256,uint8,address,uint256)(taskId?: null | PromiseOrValue<BigNumberish>, role?: null, token?: null, amount?: null) => TaskPayoutSetEventFilter
TaskRoleUserSet(taskId?: null | PromiseOrValue<BigNumberish>, role?: null, user?: null | PromiseOrValue<string>) => TaskRoleUserSetEventFilter
TaskRoleUserSet(uint256,uint8,address)(taskId?: null | PromiseOrValue<BigNumberish>, role?: null, user?: null | PromiseOrValue<string>) => TaskRoleUserSetEventFilter
TaskSkillSet(taskId?: null | PromiseOrValue<BigNumberish>, skillId?: null | PromiseOrValue<BigNumberish>) => TaskSkillSetEventFilter
TaskSkillSet(uint256,uint256)(taskId?: null | PromiseOrValue<BigNumberish>, skillId?: null | PromiseOrValue<BigNumberish>) => TaskSkillSetEventFilter
TaskWorkRatingRevealed(agent?: null, taskId?: null | PromiseOrValue<BigNumberish>, role?: null, rating?: null) => TaskWorkRatingRevealedEventFilter
TaskWorkRatingRevealed(address,uint256,uint8,uint8)(agent?: null, taskId?: null | PromiseOrValue<BigNumberish>, role?: null, rating?: null) => TaskWorkRatingRevealedEventFilter
TokenUnlocked() => TokenUnlockedEventFilter
TokenUnlocked()() => TokenUnlockedEventFilter
TokensBurned(agent?: null, token?: null, amount?: null) => TokensBurnedEventFilter
TokensBurned(address,address,uint256)(agent?: null, token?: null, amount?: null) => TokensBurnedEventFilter
TokensMinted(agent?: null, who?: null, amount?: null) => TokensMintedEventFilter
TokensMinted(address,address,uint256)(agent?: null, who?: null, amount?: null) => TokensMintedEventFilter

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<ColonyClientV6>

Inherited from

AugmentedIColony.off


on

on: OnEvent<ColonyClientV6>

Inherited from

AugmentedIColony.on


once

once: OnEvent<ColonyClientV6>

Inherited from

AugmentedIColony.once


provider

Readonly provider: Provider

Inherited from

AugmentedIColony.provider


removeListener

removeListener: OnEvent<ColonyClientV6>

Inherited from

AugmentedIColony.removeListener


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

NameType
runningEventRunningEvent

Returns

void

Inherited from

AugmentedIColony._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedIColony._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

AugmentedIColony._wrapEvent


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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_parentDomainIdPromiseOrValue<BigNumberish>Id of the domain under which the new one will be added
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.addDomain(uint256,uint256,uint256)


addDomain(uint256,uint256,uint256,string)

addDomain(uint256,uint256,uint256,string)(_permissionDomainId, _childSkillIndex, _parentDomainId, _metadata, overrides?): Promise<ContractTransaction>

Adding new domains is currently retricted to one level only, i.e. _parentDomainId has to be the root domain id: 1.We expect this function to only be used by the dapp 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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_parentDomainIdPromiseOrValue<BigNumberish>Id of the domain under which the new one will be added
_metadataPromiseOrValue<string>Metadata relating to the domain. Expected to be the IPFS hash of a JSON blob, but not enforced by the contracts.
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.addDomain(uint256,uint256,uint256,string)


addDomainWithProofs(uint256)

addDomainWithProofs(uint256)(_parentDomainId, overrides?): Promise<ContractTransaction>

Same as addDomain(uint256,uint256,uint256), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_parentDomainIdBigNumberishId of the domain under which the new one will be added
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AddDomainAugmentsB.addDomainWithProofs(uint256)


addDomainWithProofs(uint256,string)

addDomainWithProofs(uint256,string)(_parentDomainId, _metadata, overrides?): Promise<ContractTransaction>

Same as addDomain(uint256,uint256,uint256,string), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_parentDomainIdBigNumberishId of the domain under which the new one will be added
_metadatastringMetadata relating to the domain. Expected to be the IPFS hash of a JSON blob, but not enforced by the contracts.
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AddDomainAugmentsB.addDomainWithProofs(uint256,string)


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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId)
_recipientPromiseOrValue<string>Address of the payment recipient
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
_amountPromiseOrValue<BigNumberish>Payout amount
_domainIdPromiseOrValue<BigNumberish>The domain where the payment belongs
_skillIdPromiseOrValue<BigNumberish>The skill associated with the payment
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.addPayment


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

NameTypeDescription
_recipientstringAddress of the payment recipient
_tokenstringAddress of the token, 0x0 value indicates Ether
_amountBigNumberishPayout amount
_domainIdBigNumberishThe domain where the payment belongs
_skillIdBigNumberishThe skill associated with the payment
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.addPaymentWithProofs


annotateTransaction

annotateTransaction(_txHash, _metadata, overrides?): Promise<ContractTransaction>

Emit a metadata string for a transaction

Parameters

NameTypeDescription
_txHashPromiseOrValue<BytesLike>Hash of transaction being annotated (0x0 for current tx)
_metadataPromiseOrValue<string>String of metadata for tx
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.annotateTransaction


approveExitRecovery

approveExitRecovery(overrides?): Promise<ContractTransaction>

Indicate approval to exit recovery mode. Can only be called by user with recovery role.

Parameters

NameType
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.approveExitRecovery


approveStake

approveStake(_approvee, _domainId, _amount, overrides?): Promise<ContractTransaction>

Allow the _approvee to obligate some amount of tokens as a stake.

Parameters

NameTypeDescription
_approveePromiseOrValue<string>Address of the account we are willing to let obligate us.
_domainIdPromiseOrValue<BigNumberish>Domain in which we are willing to be obligated.
_amountPromiseOrValue<BigNumberish>Amount of internal token up to which we are willing to be obligated.
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.approveStake


attach

attach(addressOrName): ColonyClientV6

Parameters

NameType
addressOrNamestring

Returns

ColonyClientV6

Inherited from

AugmentedIColony.attach


authority

authority(overrides?): Promise<string>

Get the ColonyAuthority for the colony.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

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

NameTypeDescription
_usersPromiseOrValue<string>[]Array of address to bootstrap with reputation
_amountPromiseOrValue<BigNumberish>[]Amount of reputation/tokens for every address
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.bootstrapColony


burnTokens

burnTokens(token, amount, overrides?): Promise<ContractTransaction>

Burn tokens held by the colony. Can only burn tokens held in the root funding pot.

Parameters

NameTypeDescription
tokenPromiseOrValue<string>The address of the token to burn
amountPromiseOrValue<BigNumberish>The amount of tokens to burn
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.burnTokens


cancelExpenditure

cancelExpenditure(_id, overrides?): Promise<ContractTransaction>

Cancels the expenditure and prevents further editing. Can only be called by expenditure owner.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Expenditure identifier
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.cancelExpenditure


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.cancelTask


checkNotAdditionalProtectedVariable

checkNotAdditionalProtectedVariable(_slot, overrides?): Promise<void>

No return value, but should throw if protected.This is external, 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

NameTypeDescription
_slotPromiseOrValue<BigNumberish>The storage slot number to check.
overrides?CallOverrides-

Returns

Promise<void>

Inherited from

AugmentedIColony.checkNotAdditionalProtectedVariable


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

NameTypeDescription
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.claimColonyFunds


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Expenditure identifier
_slotPromiseOrValue<BigNumberish>Number of the slot
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.claimExpenditurePayout


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Payment identifier
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.claimPayment


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

NameTypeDescription
_payoutIdPromiseOrValue<BigNumberish>Id of the reward payout
_squareRootsPromiseOrValue<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.
keyPromiseOrValue<BytesLike>Some Reputation hash tree key
valuePromiseOrValue<BytesLike>Reputation value
branchMaskPromiseOrValue<BigNumberish>The branchmask of the proof
siblingsPromiseOrValue<BytesLike>[]The siblings of the proof
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.claimRewardPayout


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_rolePromiseOrValue<BigNumberish>Id of the role, as defined in TaskRole enum
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.claimTaskPayout


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.completeTask


connect

connect(signerOrProvider): ColonyClientV6

Parameters

NameType
signerOrProviderstring | Provider | Signer

Returns

ColonyClientV6

Inherited from

AugmentedIColony.connect


deobligateStake

deobligateStake(_user, _domainId, _amount, overrides?): Promise<ContractTransaction>

Deobligate the user some amount of tokens, releasing the stake.

Parameters

NameTypeDescription
_userPromiseOrValue<string>Address of the account we are deobligating.
_domainIdPromiseOrValue<BigNumberish>Domain in which we are deobligating the user.
_amountPromiseOrValue<BigNumberish>Amount of internal token we are deobligating.
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.deobligateStake


deployed

deployed(): Promise<ColonyClientV6>

Returns

Promise<ColonyClientV6>

Inherited from

AugmentedIColony.deployed


deprecateExtension

deprecateExtension(extensionId, deprecated, overrides?): Promise<ContractTransaction>

Set the deprecation of an extension in a colony. Secured function to authorised members.

Parameters

NameTypeDescription
extensionIdPromiseOrValue<BytesLike>keccak256 hash of the extension name, used as an indentifier
deprecatedPromiseOrValue<boolean>Whether to deprecate the extension or not
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.deprecateExtension


editColony

editColony(_metadata, overrides?): Promise<ContractTransaction>

Called to change the metadata associated with a colony. Expected to be a IPFS hash of a JSON blob, but not enforced to any degree by the contracts

Parameters

NameTypeDescription
_metadataPromiseOrValue<string>IPFS hash of the metadata
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.editColony


editDomain

editDomain(_permissionDomainId, _childSkillIndex, _domainId, _metadata, overrides?): Promise<ContractTransaction>

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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_domainIdPromiseOrValue<BigNumberish>Id of the domain being edited
_metadataPromiseOrValue<string>Metadata relating to the domain. Expected to be the IPFS hash of a JSON blob, but not enforced by the contracts.
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.editDomain


editDomainWithProofs

editDomainWithProofs(_domainId, _metadata, overrides?): Promise<ContractTransaction>

Same as editDomain, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_domainIdBigNumberishId of the domain being edited
_metadatastringMetadata relating to the domain. Expected to be the IPFS hash of a JSON blob, but not enforced by the contracts.
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

ColonyAugmentsV5.editDomainWithProofs


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

Returns

boolean

Inherited from

AugmentedIColony.emit


emitDomainReputationPenalty

emitDomainReputationPenalty(_permissionDomainId, _childSkillIndex, _domainId, _user, _amount, overrides?): Promise<ContractTransaction>

Emit a negative domain reputation update. Available only to Arbitration role holders

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I hold the Arbitration role
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_domainIdPromiseOrValue<BigNumberish>The domain where the user will lose reputation
_userPromiseOrValue<string>The user who will lose reputation
_amountPromiseOrValue<BigNumberish>The (negative) amount of reputation to lose
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.emitDomainReputationPenalty


emitDomainReputationPenaltyWithProofs

emitDomainReputationPenaltyWithProofs(_domainId, _user, _amount, overrides?): Promise<ContractTransaction>

Same as emitDomainReputationPenalty, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_domainIdBigNumberishThe domain where the user will lose reputation
_userstringThe user who will lose reputation
_amountBigNumberishThe (negative) amount of reputation to lose
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

ColonyAugmentsV5.emitDomainReputationPenaltyWithProofs


emitDomainReputationReward

emitDomainReputationReward(_domainId, _user, _amount, overrides?): Promise<ContractTransaction>

Emit a positive domain reputation update. Available only to Root role holders

Parameters

NameTypeDescription
_domainIdPromiseOrValue<BigNumberish>The domain where the user will gain reputation
_userPromiseOrValue<string>The user who will gain reputation
_amountPromiseOrValue<BigNumberish>The (positive) amount of reputation to gain
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.emitDomainReputationReward


emitSkillReputationPenalty

emitSkillReputationPenalty(_skillId, _user, _amount, overrides?): Promise<ContractTransaction>

Emit a negative skill reputation update. Available only to Arbitration role holders in the root domain

Parameters

NameTypeDescription
_skillIdPromiseOrValue<BigNumberish>The skill where the user will lose reputation
_userPromiseOrValue<string>The user who will lose reputation
_amountPromiseOrValue<BigNumberish>The (negative) amount of reputation to lose
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.emitSkillReputationPenalty


emitSkillReputationReward

emitSkillReputationReward(_skillId, _user, _amount, overrides?): Promise<ContractTransaction>

Emit a positive skill reputation update. Available only to Root role holders

Parameters

NameTypeDescription
_skillIdPromiseOrValue<BigNumberish>The skill where the user will gain reputation
_userPromiseOrValue<string>The user who will gain reputation
_amountPromiseOrValue<BigNumberish>The (positive) amount of reputation to gain
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.emitSkillReputationReward


enterRecoveryMode

enterRecoveryMode(overrides?): Promise<ContractTransaction>

Put colony network mining into recovery mode. Can only be called by user with recovery role.

Parameters

NameType
overrides?Overrides & { from?: PromiseOrValue<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

NameTypeDescription
_sigVPromiseOrValue<BigNumberish>[]recovery id
_sigRPromiseOrValue<BytesLike>[]r output of the ECDSA signature of the transaction
_sigSPromiseOrValue<BytesLike>[]s output of the ECDSA signature of the transaction
_modePromiseOrValue<BigNumberish>[]How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this)
_valuePromiseOrValue<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
_dataPromiseOrValue<BytesLike>The transaction data
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.executeTaskChange


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

NameTypeDescription
_sigVPromiseOrValue<BigNumberish>[]recovery id
_sigRPromiseOrValue<BytesLike>[]r output of the ECDSA signature of the transaction
_sigSPromiseOrValue<BytesLike>[]s output of the ECDSA signature of the transaction
_modePromiseOrValue<BigNumberish>[]How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this)
_valuePromiseOrValue<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
_dataPromiseOrValue<BytesLike>The transaction data
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.executeTaskRoleAssignment


exitRecoveryMode

exitRecoveryMode(overrides?): Promise<ContractTransaction>

Exit recovery mode, can be called by anyone if enough whitelist approvals are given.

Parameters

NameType
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.exitRecoveryMode


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Expenditure identifier
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.finalizeExpenditure


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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_idPromiseOrValue<BigNumberish>Payment identifier
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.finalizePayment


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

NameTypeDescription
_idBigNumberishPayment 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

NameTypeDescription
_payoutIdPromiseOrValue<BigNumberish>Id of the reward payout
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.finalizeRewardPayout


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.finalizeTask


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 external so it can be an external call. A function to be called after an upgrade has been done from v2 to v3.

Parameters

NameType
overrides?Overrides & { from?: PromiseOrValue<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

NameTypeDescription
_saltPromiseOrValue<BytesLike>Salt value
_valuePromiseOrValue<BigNumberish>Value to hide
overrides?CallOverrides-

Returns

Promise<string>

Inherited from

AugmentedIColony.generateSecret


getApproval

getApproval(_user, _obligator, _domainId, overrides?): Promise<BigNumber>

View an approval to obligate tokens.

Parameters

NameTypeDescription
_userPromiseOrValue<string>User allowing their tokens to be obligated.
_obligatorPromiseOrValue<string>Address of the account we are willing to let obligate us.
_domainIdPromiseOrValue<BigNumberish>Domain in which we are willing to be obligated.
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getApproval


getCapabilityRoles

getCapabilityRoles(_sig, overrides?): Promise<string>

Gets the bytes32 representation of the roles authorized to call a function

Parameters

NameTypeDescription
_sigPromiseOrValue<BytesLike>The function signature
overrides?CallOverrides-

Returns

Promise<string>

Inherited from

AugmentedIColony.getCapabilityRoles


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

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedIColony.getColonyNetwork


getDomain

getDomain(_id, overrides?): Promise<DomainStructOutput>

Get a domain by id.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the domain which details to get
overrides?CallOverrides-

Returns

Promise<DomainStructOutput>

Inherited from

AugmentedIColony.getDomain


getDomainCount

getDomainCount(overrides?): Promise<BigNumber>

Get the number of domains in the colony.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getDomainCount


getDomainFromFundingPot

getDomainFromFundingPot(_fundingPotId, overrides?): Promise<BigNumber>

Get the domain corresponding to a funding pot

Parameters

NameTypeDescription
_fundingPotIdPromiseOrValue<BigNumberish>Id of the funding pot
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getDomainFromFundingPot


getExpenditure

getExpenditure(_id, overrides?): Promise<ExpenditureStructOutput>

Returns an existing expenditure.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Expenditure identifier
overrides?CallOverrides-

Returns

Promise<ExpenditureStructOutput>

Inherited from

AugmentedIColony.getExpenditure


getExpenditureCount

getExpenditureCount(overrides?): Promise<BigNumber>

Get the number of expenditures in the colony.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getExpenditureCount


getExpenditureSlot

getExpenditureSlot(_id, _slot, overrides?): Promise<ExpenditureSlotStructOutput>

Returns an existing expenditure slot.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Expenditure identifier
_slotPromiseOrValue<BigNumberish>Expenditure slot
overrides?CallOverrides-

Returns

Promise<ExpenditureSlotStructOutput>

Inherited from

AugmentedIColony.getExpenditureSlot


getExpenditureSlotPayout

getExpenditureSlotPayout(_id, _slot, _token, overrides?): Promise<BigNumber>

Returns an existing expenditure slot's payout for a token.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Expenditure identifier
_slotPromiseOrValue<BigNumberish>Expenditure slot
_tokenPromiseOrValue<string>Token address
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getExpenditureSlotPayout


getExtensionClient

getExtensionClient<E>(extension): Promise<GetExtensionClientReturns[E]>

Get an instance of an extension client associated with this Colony.

Type parameters

NameType
Eextends Extension

Parameters

NameTypeDescription
extensionEAn 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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the pot which details to get
overrides?CallOverrides-

Returns

Promise<[number, BigNumber, BigNumber] & { associatedType: number ; associatedTypeId: BigNumber ; payoutsWeCannotMake: BigNumber }>

Inherited from

AugmentedIColony.getFundingPot


getFundingPotBalance

getFundingPotBalance(_potId, _token, overrides?): Promise<BigNumber>

Get the _token balance of pot with id _potId.

Parameters

NameTypeDescription
_potIdPromiseOrValue<BigNumberish>Id of the funding pot
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getFundingPotBalance


getFundingPotCount

getFundingPotCount(overrides?): Promise<BigNumber>

Get the number of funding pots in the colony.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getFundingPotCount


getFundingPotPayout

getFundingPotPayout(_potId, _token, overrides?): Promise<BigNumber>

Get the assigned _token payouts of pot with id _potId.

Parameters

NameTypeDescription
_potIdPromiseOrValue<BigNumberish>Id of the funding pot
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getFundingPotPayout


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

NameTypeDescription
skillIdBigNumberishThe 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

NameTypeDescription
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getNonRewardPotsTotal


getObligation

getObligation(_user, _obligator, _domainId, overrides?): Promise<BigNumber>

View an obligation of tokens.

Parameters

NameTypeDescription
_userPromiseOrValue<string>User whose tokens are obligated.
_obligatorPromiseOrValue<string>Address of the account who obligated us.
_domainIdPromiseOrValue<BigNumberish>Domain in which we are obligated.
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getObligation


getPayment

getPayment(_id, overrides?): Promise<PaymentStructOutput>

Returns an exiting payment.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Payment identifier
overrides?CallOverrides-

Returns

Promise<PaymentStructOutput>

Inherited from

AugmentedIColony.getPayment


getPaymentCount

getPaymentCount(overrides?): Promise<BigNumber>

Get the number of payments in the colony.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

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

NameTypeDescription
skillIdBigNumberishThe skill id to get the addresses reputation in
addressstringWallet address to retrieve the reputation of
customRootHash?stringThe 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

NameTypeDescription
addressstringWallet address to retrieve the reputation of
customRootHash?stringThe 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

NameTypeDescription
skillIdBigNumberishThe skill id to get the addresses reputation in
addressstringWallet address to retrieve the reputation of
customRootHash?stringThe 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

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getRewardInverse


getRewardPayoutInfo

getRewardPayoutInfo(_payoutId, overrides?): Promise<RewardPayoutCycleStructOutput>

Get useful information about specific reward payout.

Parameters

NameTypeDescription
_payoutIdPromiseOrValue<BigNumberish>Id of the reward payout
overrides?CallOverrides-

Returns

Promise<RewardPayoutCycleStructOutput>

Inherited from

AugmentedIColony.getRewardPayoutInfo


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

NameTypeDescription
_idPromiseOrValue<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 }>

Inherited from

AugmentedIColony.getTask


getTaskChangeNonce

getTaskChangeNonce(_id, overrides?): Promise<BigNumber>

Starts from 0 and is incremented on every co-reviewed task change via executeTaskChange call.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getTaskChangeNonce


getTaskCount

getTaskCount(overrides?): Promise<BigNumber>

Get the number of tasks in the colony.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_rolePromiseOrValue<BigNumberish>Id of the role, as defined in TaskRole enum
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.getTaskPayout


getTaskRole

getTaskRole(_id, _role, overrides?): Promise<RoleStructOutput>

Get the Role properties back for role _role in task _id.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_rolePromiseOrValue<BigNumberish>Id of the role, as defined in TaskRole enum
overrides?CallOverrides-

Returns

Promise<RoleStructOutput>

Inherited from

AugmentedIColony.getTaskRole


getTaskWorkRatingSecret

getTaskWorkRatingSecret(_id, _role, overrides?): Promise<string>

Get the rating secret submitted for role _role in task _id

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_rolePromiseOrValue<BigNumberish>Id of the role, as defined in TaskRole enum
overrides?CallOverrides-

Returns

Promise<string>

Inherited from

AugmentedIColony.getTaskWorkRatingSecret


getTaskWorkRatingSecretsInfo

getTaskWorkRatingSecretsInfo(_id, overrides?): Promise<[BigNumber, BigNumber] & { lastSubmittedAt: BigNumber ; nSecrets: BigNumber }>

Get the ColonyStorage.RatingSecrets information for task _id.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
overrides?CallOverrides-

Returns

Promise<[BigNumber, BigNumber] & { lastSubmittedAt: BigNumber ; nSecrets: BigNumber }>

Inherited from

AugmentedIColony.getTaskWorkRatingSecretsInfo


getToken

getToken(overrides?): Promise<string>

Get the colony token.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedIColony.getToken


getUserRoles

getUserRoles(_user, _domain, overrides?): Promise<string>

Gets the bytes32 representation of the roles for a user in a given domain

Parameters

NameTypeDescription
_userPromiseOrValue<string>The user whose roles we want to get
_domainPromiseOrValue<BigNumberish>The domain we want to get roles in
overrides?CallOverrides-

Returns

Promise<string>

Inherited from

AugmentedIColony.getUserRoles


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

NameTypeDescription
_userPromiseOrValue<string>The user whose role we want to check
_domainIdPromiseOrValue<BigNumberish>Domain in which the caller has the role
_rolePromiseOrValue<BigNumberish>The role we want to check for
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _childDomainId is relative to _domainId
_childDomainIdPromiseOrValue<BigNumberish>The domain where we want to use the role
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedIColony.hasInheritedUserRole


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

NameTypeDescription
_userstringThe user whose role we want to check
_domainIdBigNumberishDomain in which the caller has the role
_roleBigNumberishThe 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

NameTypeDescription
_userPromiseOrValue<string>The user whose role we want to check
_domainIdPromiseOrValue<BigNumberish>The domain where we want to check for the role
_rolePromiseOrValue<BigNumberish>The role we want to check for
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedIColony.hasUserRole


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

NameTypeDescription
_colonyNetworkAddressPromiseOrValue<string>Address of the colony network
_tokenPromiseOrValue<string>Address of the colony ERC20 Token
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.initialiseColony


installExtension

installExtension(extensionId, version, overrides?): Promise<ContractTransaction>

Install an extension to the colony. Secured function to authorised members.

Parameters

NameTypeDescription
extensionIdPromiseOrValue<BytesLike>keccak256 hash of the extension name, used as an indentifier
versionPromiseOrValue<BigNumberish>The new extension version to install
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.installExtension


installExtensionChecked

installExtensionChecked(extension, version?, overrides?): Promise<ContractTransaction>

Similar to installExtension, but first check whether the desired extension can be installed in this Colony Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
extensionExtensionA Extension name
version?numberThe desired version number of the extension you wish to install
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

ColonyAugmentsV5.installExtensionChecked


isInRecoveryMode

isInRecoveryMode(overrides?): Promise<boolean>

Is colony network in recovery mode.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedIColony.isInRecoveryMode


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

AugmentedIColony.listenerCount


listeners

listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilter?TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Inherited from

AugmentedIColony.listeners

listeners(eventName?): Listener[]

Parameters

NameType
eventName?string

Returns

Listener[]

Inherited from

AugmentedIColony.listeners


lockToken

lockToken(overrides?): Promise<ContractTransaction>

Lock the colony's token. Can only be called by a network-managed extension.

Parameters

NameType
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.lockToken


makeArbitraryTransaction

makeArbitraryTransaction(_to, _action, overrides?): Promise<ContractTransaction>

Execute arbitrary transaction on behalf of the Colony

Parameters

NameTypeDescription
_toPromiseOrValue<string>Contract to receive the function call (cannot be network or token locking)
_actionPromiseOrValue<BytesLike>Bytes array encoding the function call and arguments
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.makeArbitraryTransaction


makeExpenditure

makeExpenditure(_permissionDomainId, _childSkillIndex, _domainId, overrides?): Promise<ContractTransaction>

Add a new expenditure in the colony. Secured function to authorised members.

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId)
_domainIdPromiseOrValue<BigNumberish>The domain where the expenditure belongs
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.makeExpenditure


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

NameTypeDescription
_domainIdBigNumberishThe 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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_specificationHashPromiseOrValue<BytesLike>Database identifier where the task specification is stored
_domainIdPromiseOrValue<BigNumberish>The domain where the task belongs
_skillIdPromiseOrValue<BigNumberish>The skill associated with the task, can set to 0 for no-op
_dueDatePromiseOrValue<BigNumberish>The due date of the task, can set to 0 for no-op
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.makeTask


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

NameTypeDescription
_specificationHashBytesLikeDatabase identifier where the task specification is stored
_domainIdBigNumberishThe domain where the task belongs
_skillIdBigNumberishThe skill associated with the task, can set to 0 for no-op
_dueDateBigNumberishThe 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

NameTypeDescription
_wadPromiseOrValue<BigNumberish>Amount to mint
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.mintTokens


mintTokensFor

mintTokensFor(_guy, _wad, overrides?): Promise<ContractTransaction>

Mint _wad amount of colony tokens and send to _guy. Secured function to authorised members.

Parameters

NameTypeDescription
_guyPromiseOrValue<string>Recipient of new tokens
_wadPromiseOrValue<BigNumberish>Amount to mint
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.mintTokensFor


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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_fromChildSkillIndexPromiseOrValue<BigNumberish>The child index in _permissionDomainId where we can find the domain for _fromPotId
_toChildSkillIndexPromiseOrValue<BigNumberish>The child index in _permissionDomainId where we can find the domain for _toPotId
_fromPotPromiseOrValue<BigNumberish>Funding pot id providing the funds
_toPotPromiseOrValue<BigNumberish>Funding pot id receiving the funds
_amountPromiseOrValue<BigNumberish>Amount of funds
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.moveFundsBetweenPots


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

NameTypeDescription
_fromPotBigNumberishFunding pot id providing the funds
_toPotBigNumberishFunding pot id receiving the funds
_amountBigNumberishAmount of funds
_tokenstringAddress 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

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.numRecoveryRoles


obligateStake

obligateStake(_user, _domainId, _amount, overrides?): Promise<ContractTransaction>

Obligate the user some amount of tokens as a stake.

Parameters

NameTypeDescription
_userPromiseOrValue<string>Address of the account we are obligating.
_domainIdPromiseOrValue<BigNumberish>Domain in which we are obligating the user.
_amountPromiseOrValue<BigNumberish>Amount of internal token we are obligating.
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.obligateStake


owner

owner(overrides?): Promise<string>

Used for testing. Get the colony owner address. This should be address(0x0) at all times.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedIColony.owner


queryFilter

queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventTypedEventFilter<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

NameTypeDescription
colonyNamePromiseOrValue<string>The label to register.
orbitdbPromiseOrValue<string>The path of the orbitDB database associated with the colony name
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.registerColonyLabel


removeAllListeners

removeAllListeners<TEvent>(eventFilter): ColonyClientV6

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

ColonyClientV6

Inherited from

AugmentedIColony.removeAllListeners

removeAllListeners(eventName?): ColonyClientV6

Parameters

NameType
eventName?string

Returns

ColonyClientV6

Inherited from

AugmentedIColony.removeAllListeners


removeRecoveryRole

removeRecoveryRole(_user, overrides?): Promise<ContractTransaction>

Remove colony recovery role. Can only be called by root role.

Parameters

NameTypeDescription
_userPromiseOrValue<string>User we want to remove recovery role from
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.removeRecoveryRole


removeTaskEvaluatorRole

removeTaskEvaluatorRole(_id, overrides?): Promise<ContractTransaction>

Removing evaluator role. Agreed between manager and currently assigned evaluator.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.removeTaskEvaluatorRole


removeTaskWorkerRole

removeTaskWorkerRole(_id, overrides?): Promise<ContractTransaction>

Removing worker role. Agreed between manager and currently assigned worker.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.removeTaskWorkerRole


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_rolePromiseOrValue<BigNumberish>Id of the role, as defined in TaskRole enum
_ratingPromiseOrValue<BigNumberish>0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50)
_saltPromiseOrValue<BytesLike>Salt value used to generate the rating secret
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.revealTaskWorkRating


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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>Domain in which the caller has root/architecture role
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_userPromiseOrValue<string>User we want to give an admin role to
_domainIdPromiseOrValue<BigNumberish>Domain in which we are giving user the role
_setToPromiseOrValue<boolean>The state of the role permission (true assign the permission, false revokes it)
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setAdministrationRole


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

NameTypeDescription
_userstringUser we want to give an admin role to
_domainIdBigNumberishDomain in which we are giving user the role
_setTobooleanThe 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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
_managerAmountPromiseOrValue<BigNumberish>Payout amount for manager
_evaluatorAmountPromiseOrValue<BigNumberish>Payout amount for evaluator
_workerAmountPromiseOrValue<BigNumberish>Payout amount for worker
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setAllTaskPayouts


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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>Domain in which the caller has root role
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_userPromiseOrValue<string>User we want to give an arbitration role to
_domainIdPromiseOrValue<BigNumberish>Domain in which we are giving user the role
_setToPromiseOrValue<boolean>The state of the role permission (true assign the permission, false revokes it)
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setArbitrationRole


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

NameTypeDescription
_userstringUser we want to give an arbitration role to
_domainIdBigNumberishDomain in which we are giving user the role
_setTobooleanThe 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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>Domain in which the caller has root/architecture role
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_userPromiseOrValue<string>User we want to give an architecture role to
_domainIdPromiseOrValue<BigNumberish>Domain in which we are giving user the role
_setToPromiseOrValue<boolean>The state of the role permission (true assign the permission, false revokes it)
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setArchitectureRole


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

NameTypeDescription
_userstringUser we want to give an architecture role to
_domainIdBigNumberishDomain in which we are giving user the role
_setTobooleanThe 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>

This is now deprecated and will be removed in a future version DEPRECATED Set the claim delay on an expenditure slot. Can only be called by Arbitration role.

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId)
_idPromiseOrValue<BigNumberish>Expenditure identifier
_slotPromiseOrValue<BigNumberish>Number of the slot
_claimDelayPromiseOrValue<BigNumberish>Time (in seconds) to delay claiming payout after finalization
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setExpenditureClaimDelay


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

NameTypeDescription
_idBigNumberishExpenditure identifier
_slotBigNumberishNumber of the slot
_claimDelayBigNumberishTime (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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the expenditure
_slotPromiseOrValue<BigNumberish>Number of the slot
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
_amountPromiseOrValue<BigNumberish>Payout amount
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setExpenditurePayout


setExpenditurePayoutModifier

setExpenditurePayoutModifier(_permissionDomainId, _childSkillIndex, _id, _slot, _payoutModifier, overrides?): Promise<ContractTransaction>

This is now deprecated and will be removed in a future versionNote that when determining payouts the payoutModifier is incremented by WAD and converted into payoutScalar DEPRECATED Set the payout modifier on an expenditure slot. Can only be called by Arbitration role.

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId)
_idPromiseOrValue<BigNumberish>Expenditure identifier
_slotPromiseOrValue<BigNumberish>Number of the slot
_payoutModifierPromiseOrValue<BigNumberish>Modifier to their payout (between -1 and 1, denominated in WADs, 0 means no modification)
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setExpenditurePayoutModifier


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

NameTypeDescription
_idBigNumberishExpenditure identifier
_slotBigNumberishNumber of the slot
_payoutModifierBigNumberishModifier 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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the expenditure
_slotPromiseOrValue<BigNumberish>Slot for the recipient address
_recipientPromiseOrValue<string>Address of the recipient
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setExpenditureRecipient


setExpenditureSkill

setExpenditureSkill(_id, _slot, _skillId, overrides?): Promise<ContractTransaction>

Sets the skill on an expenditure slot. Can only be called by expenditure owner.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Expenditure identifier
_slotPromiseOrValue<BigNumberish>Number of the slot
_skillIdPromiseOrValue<BigNumberish>Id of the new skill to set
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setExpenditureSkill


setExpenditureState

setExpenditureState(_permissionDomainId, _childSkillIndex, _id, _storageSlot, _mask, _keys, _value, overrides?): Promise<ContractTransaction>

Set arbitrary state on an expenditure slot. Can only be called by Arbitration role.

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId)
_idPromiseOrValue<BigNumberish>Expenditure identifier
_storageSlotPromiseOrValue<BigNumberish>Number of the top-level storage slot (25, 26, or 27)
_maskPromiseOrValue<boolean>[]Array of booleans indicated whether a key is a mapping (F) or an array index (T).
_keysPromiseOrValue<BytesLike>[]Array of additional keys (for mappings & arrays)
_valuePromiseOrValue<BytesLike>Value to set at location
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setExpenditureState


setExpenditureStateWithProofs

setExpenditureStateWithProofs(_id, _storageSlot, _mask, _keys, _value, overrides?): Promise<ContractTransaction>

Same as editDomain, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_idBigNumberishExpenditure identifier
_storageSlotBigNumberishNumber of the top-level storage slot (25, 26, or 27)
_maskboolean[]Array of booleans indicated whether a key is a mapping (F) or an array index (T).
_keysBytesLike[]Array of additional keys (for mappings & arrays)
_valueBytesLikeValue to set at location
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

ColonyAugmentsV5.setExpenditureStateWithProofs


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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>Domain in which the caller has root/architecture role
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_userPromiseOrValue<string>User we want to give an funding role to
_domainIdPromiseOrValue<BigNumberish>Domain in which we are giving user the role
_setToPromiseOrValue<boolean>The state of the role permission (true assign the permission, false revokes it)
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setFundingRole


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

NameTypeDescription
_userstringUser we want to give an funding role to
_domainIdBigNumberishDomain in which we are giving user the role
_setTobooleanThe 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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_idPromiseOrValue<BigNumberish>Payment identifier
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
_amountPromiseOrValue<BigNumberish>Payout amount
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setPaymentPayout


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

NameTypeDescription
_idBigNumberishPayment identifier
_tokenBigNumberishAddress of the token, 0x0 value indicates Ether
_amountBigNumberishPayout 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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_idPromiseOrValue<BigNumberish>Payment identifier
_recipientPromiseOrValue<string>Address of the payment recipient
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setPaymentRecipient


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

NameTypeDescription
_idBigNumberishPayment identifier
_recipientstringAddress 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

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_idPromiseOrValue<BigNumberish>Payment identifier
_skillIdPromiseOrValue<BigNumberish>Id of the new skill to set
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setPaymentSkill


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

NameTypeDescription
_idBigNumberishPayment identifier
_skillIdBigNumberishId 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

NameTypeDescription
_userPromiseOrValue<string>User we want to give a recovery role to
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setRecoveryRole


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

NameTypeDescription
_rewardInversePromiseOrValue<BigNumberish>The inverse of the reward
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setRewardInverse


setRootRole

setRootRole(_user, _setTo, overrides?): Promise<ContractTransaction>

Set new colony root role. Can be called by root role only.

Parameters

NameTypeDescription
_userPromiseOrValue<string>User we want to give an root role to
_setToPromiseOrValue<boolean>The state of the role permission (true assign the permission, false revokes it)
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setRootRole


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

NameTypeDescription
_slotPromiseOrValue<BigNumberish>Uint address of storage slot to be updated
_valuePromiseOrValue<BytesLike>word of data to be set
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setStorageSlotRecovery


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_specificationHashPromiseOrValue<BytesLike>Unique hash of the task brief in ddb
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskBrief


setTaskDueDate

setTaskDueDate(_id, _dueDate, overrides?): Promise<ContractTransaction>

Set the due date on task _id. Allowed before a task is finalized.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_dueDatePromiseOrValue<BigNumberish>Due date as seconds since unix epoch
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskDueDate


setTaskEvaluatorPayout

setTaskEvaluatorPayout(_id, _token, _amount, overrides?): Promise<ContractTransaction>

Set _token payout for evaluator in task _id to _amount.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
_amountPromiseOrValue<BigNumberish>Payout amount
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskEvaluatorPayout


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_userPromiseOrValue<string>Address of the user we want to give a evaluator role to
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskEvaluatorRole


setTaskManagerPayout

setTaskManagerPayout(_id, _token, _amount, overrides?): Promise<ContractTransaction>

Set _token payout for manager in task _id to _amount.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
_amountPromiseOrValue<BigNumberish>Payout amount
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskManagerPayout


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_userPromiseOrValue<string>Address of the user we want to give a manager role to
_permissionDomainIdPromiseOrValue<BigNumberish>The domain ID in which _user has the Administration permission
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskManagerRole


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_skillIdPromiseOrValue<BigNumberish>Id of the skill which has to be a global skill
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskSkill


setTaskWorkerPayout

setTaskWorkerPayout(_id, _token, _amount, overrides?): Promise<ContractTransaction>

Set _token payout for worker in task _id to _amount.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_tokenPromiseOrValue<string>Address of the token, 0x0 value indicates Ether
_amountPromiseOrValue<BigNumberish>Payout amount
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskWorkerPayout


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_userPromiseOrValue<string>Address of the user we want to give a worker role to
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setTaskWorkerRole


setUserRoles

setUserRoles(_permissionDomainId, _childSkillIndex, _user, _domainId, _roles, overrides?): Promise<ContractTransaction>

Set several roles in one transaction. Can be called by root role or architecture role.

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>Domain in which the caller has root/architecture role
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_userPromiseOrValue<string>User we want to give a role to
_domainIdPromiseOrValue<BigNumberish>Domain in which we are giving user the role
_rolesPromiseOrValue<BytesLike>Byte array representing the desired role setting (1 for on, 0 for off)
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.setUserRoles


setUserRolesWithProofs

setUserRolesWithProofs(_user, _domainId, _roles, overrides?): Promise<ContractTransaction>

Same as setUserRoles, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_userstringUser we want to give a role to
_domainIdBigNumberishDomain in which we are giving user the role
_rolesBytesLikeByte array representing the desired role setting (1 for on, 0 for off)
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

ColonyAugmentsV5.setUserRolesWithProofs


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

NameTypeDescription
_tokenPromiseOrValue<string>Address of the token used for reward payout
keyPromiseOrValue<BytesLike>Some Reputation hash tree key
valuePromiseOrValue<BytesLike>Reputation value
branchMaskPromiseOrValue<BigNumberish>The branchmask of the proof
siblingsPromiseOrValue<BytesLike>[]The siblings of the proof
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.startNextRewardPayout


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_deliverableHashPromiseOrValue<BytesLike>Unique hash of the task deliverable content in ddb
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.submitTaskDeliverable


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_deliverableHashPromiseOrValue<BytesLike>Unique hash of the task deliverable content in ddb
_ratingSecretPromiseOrValue<BytesLike>Rating secret for manager
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.submitTaskDeliverableAndRating


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

NameTypeDescription
_idPromiseOrValue<BigNumberish>Id of the task
_rolePromiseOrValue<BigNumberish>Id of the role, as defined in TaskRole enum
_ratingSecretPromiseOrValue<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?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.submitTaskWorkRating


transferExpenditure

transferExpenditure(_id, _newOwner, overrides?): Promise<ContractTransaction>

Updates the expenditure owner. Can only be called by expenditure owner.

Parameters

NameTypeDescription
_idPromiseOrValue<BigNumberish>Expenditure identifier
_newOwnerPromiseOrValue<string>New owner of expenditure
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.transferExpenditure


transferExpenditureViaArbitration

transferExpenditureViaArbitration(_permissionDomainId, _childSkillIndex, _id, _newOwner, overrides?): Promise<ContractTransaction>

This is now deprecated and will be removed in a future version DEPRECATED Updates the expenditure owner. Can only be called by Arbitration role.

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId, (only used if _permissionDomainId is different to _domainId)
_idPromiseOrValue<BigNumberish>Expenditure identifier
_newOwnerPromiseOrValue<string>New owner of expenditure
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.transferExpenditureViaArbitration


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

NameTypeDescription
_idBigNumberishExpenditure identifier
_newOwnerstringNew owner of expenditure
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

ColonyAugmentsV4.transferExpenditureViaArbitrationWithProofs


transferStake

transferStake(_permissionDomainId, _childSkillIndex, _obligator, _user, _domainId, _amount, _recipient, overrides?): Promise<ContractTransaction>

Transfer some amount of obligated tokens. Can be called by the arbitration role.

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which I have the permission to take this action.
_childSkillIndexPromiseOrValue<BigNumberish>The child index in _permissionDomainId where we can find _domainId.
_obligatorPromiseOrValue<string>Address of the account who set the obligation.
_userPromiseOrValue<string>Address of the account we are transferring.
_domainIdPromiseOrValue<BigNumberish>Domain in which we are transferring the tokens.
_amountPromiseOrValue<BigNumberish>Amount of internal token we are transferring.
_recipientPromiseOrValue<string>Recipient of the transferred tokens.
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.transferStake


transferStakeWithProofs

transferStakeWithProofs(_obligator, _user, _domainId, _amount, _recipient, overrides?): Promise<ContractTransaction>

Same as transferStake, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_obligatorstringAddress of the account who set the obligation.
_userstringAddress of the account we are transferring.
_domainIdBigNumberishDomain in which we are transferring the tokens.
_amountBigNumberishAmount of internal token we are transferring.
_recipientstringRecipient of the transferred tokens.
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

ColonyAugmentsV5.transferStakeWithProofs


uninstallExtension

uninstallExtension(extensionId, overrides?): Promise<ContractTransaction>

This is a permanent action -- re-installing the extension will deploy a new contractIt is recommended to deprecate an extension before uninstalling to allow active objects to be resolved Uninstall an extension from a colony. Secured function to authorised members.

Parameters

NameTypeDescription
extensionIdPromiseOrValue<BytesLike>keccak256 hash of the extension name, used as an indentifier
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.uninstallExtension


unlockToken

unlockToken(overrides?): Promise<ContractTransaction>

unlock the native colony token, if possible

Parameters

NameType
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.unlockToken


unlockTokenForUser

unlockTokenForUser(user, lockId, overrides?): Promise<ContractTransaction>

Unlock the colony's token for a user. Can only be called by a network-managed extension.

Parameters

NameTypeDescription
userPromiseOrValue<string>The user to unlock
lockIdPromiseOrValue<BigNumberish>The specific lock to unlock
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.unlockTokenForUser


updateColonyOrbitDB

updateColonyOrbitDB(orbitdb, overrides?): Promise<ContractTransaction>

Update a colony's orbitdb address. Can only be called by a colony with a registered subdomain

Parameters

NameTypeDescription
orbitdbPromiseOrValue<string>The path of the orbitDB database to be associated with the colony
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.updateColonyOrbitDB


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

NameTypeDescription
_newVersionPromiseOrValue<BigNumberish>The target version for the upgrade
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.upgrade


upgradeExtension

upgradeExtension(extensionId, newVersion, overrides?): Promise<ContractTransaction>

Upgrade an extension in a colony. Secured function to authorised members.

Parameters

NameTypeDescription
extensionIdPromiseOrValue<BytesLike>keccak256 hash of the extension name, used as an indentifier
newVersionPromiseOrValue<BigNumberish>The version to upgrade to (must be one larger than the current version)
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedIColony.upgradeExtension


upgradeExtensionChecked

upgradeExtensionChecked(extension, newVersion?, overrides?): Promise<ContractTransaction>

Similar to upgradeExtension, but first check whether the desired extension can be upgraded to the desired version in this Colony Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
extensionExtensionA Extension name
newVersion?numberThe desired version number of the extension you wish to upgrade
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

ColonyAugmentsV5.upgradeExtensionChecked


userCanSetRoles

userCanSetRoles(_user, _domainId, _childSkillIndex, _childDomainId, overrides?): Promise<boolean>

Check whether a given user can modify roles in the target domain _childDomainId. Mostly a convenience function to provide a uniform interface for extension contracts validating permissions

Parameters

NameTypeDescription
_userPromiseOrValue<string>The user whose permissions we want to check
_domainIdPromiseOrValue<BigNumberish>Domain in which the caller has the role (currently Root or Architecture)
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _childDomainId is relative to _domainId
_childDomainIdPromiseOrValue<BigNumberish>The domain where we want to edit roles
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedIColony.userCanSetRoles


verifyReputationProof

verifyReputationProof(key, value, branchMask, siblings, overrides?): Promise<boolean>

For more detail about branchMask and siblings, examine the PatriciaTree implementation. While external, 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

NameTypeDescription
keyPromiseOrValue<BytesLike>The key of the element the proof is for.
valuePromiseOrValue<BytesLike>The value of the element that the proof is for.
branchMaskPromiseOrValue<BigNumberish>The branchmask of the proof
siblingsPromiseOrValue<BytesLike>[]The siblings of the proof
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedIColony.verifyReputationProof


version

version(overrides?): Promise<BigNumber>

Get the Colony contract version. Starts from 1 and is incremented with every deployed contract change.

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedIColony.version