diff --git a/packages/colony-js/docs/api/README.md b/packages/colony-js/docs/api/README.md index ff1268cb5..dc89abdc1 100644 --- a/packages/colony-js/docs/api/README.md +++ b/packages/colony-js/docs/api/README.md @@ -36,7 +36,6 @@ ## Interfaces -- [ColonyClientV10](interfaces/ColonyClientV10.md) - [ColonyClientV11](interfaces/ColonyClientV11.md) - [ColonyClientV12](interfaces/ColonyClientV12.md) - [ColonyClientV13](interfaces/ColonyClientV13.md) @@ -66,10 +65,7 @@ - [StakedExpenditureClientV3](interfaces/StakedExpenditureClientV3.md) - [StakedExpenditureClientV4](interfaces/StakedExpenditureClientV4.md) - [StakedExpenditureClientV5](interfaces/StakedExpenditureClientV5.md) -- [StreamingPaymentsClientV1](interfaces/StreamingPaymentsClientV1.md) -- [StreamingPaymentsClientV2](interfaces/StreamingPaymentsClientV2.md) -- [StreamingPaymentsClientV3](interfaces/StreamingPaymentsClientV3.md) -- [StreamingPaymentsClientV4](interfaces/StreamingPaymentsClientV4.md) +- [StreamingPaymentsClientV5](interfaces/StreamingPaymentsClientV5.md) - [Token](interfaces/Token.md) - [TokenAuthority](interfaces/TokenAuthority.md) - [TokenLocking](interfaces/TokenLocking.md) @@ -121,7 +117,7 @@ Re-exports [Token__factory](classes/factories.Token__factory.md) ### AnyColonyClient -Ƭ **AnyColonyClient**: [`ColonyClientV10`](interfaces/ColonyClientV10.md) \| [`ColonyClientV11`](interfaces/ColonyClientV11.md) \| [`ColonyClientV12`](interfaces/ColonyClientV12.md) \| [`ColonyClientV13`](interfaces/ColonyClientV13.md) \| [`ColonyClientV14`](interfaces/ColonyClientV14.md) \| [`ColonyClientV15`](interfaces/ColonyClientV15.md) +Ƭ **AnyColonyClient**: [`ColonyClientV11`](interfaces/ColonyClientV11.md) \| [`ColonyClientV12`](interfaces/ColonyClientV12.md) \| [`ColonyClientV13`](interfaces/ColonyClientV13.md) \| [`ColonyClientV14`](interfaces/ColonyClientV14.md) \| [`ColonyClientV15`](interfaces/ColonyClientV15.md) ___ @@ -145,7 +141,7 @@ ___ ### AnyStreamingPaymentsClient -Ƭ **AnyStreamingPaymentsClient**: [`StreamingPaymentsClientV1`](interfaces/StreamingPaymentsClientV1.md) \| [`StreamingPaymentsClientV2`](interfaces/StreamingPaymentsClientV2.md) \| [`StreamingPaymentsClientV3`](interfaces/StreamingPaymentsClientV3.md) \| [`StreamingPaymentsClientV4`](interfaces/StreamingPaymentsClientV4.md) +Ƭ **AnyStreamingPaymentsClient**: [`StreamingPaymentsClientV5`](interfaces/StreamingPaymentsClientV5.md) ___ @@ -343,7 +339,7 @@ Latest versions of all extension contracts | `ReputationBootstrapper` | ``1`` \| ``2`` \| ``3`` \| ``4`` | | `StagedExpenditure` | ``1`` \| ``2`` | | `StakedExpenditure` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` | -| `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` | +| `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` | | `TokenSupplier` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` | | `VotingReputation` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` | diff --git a/packages/colony-js/docs/api/classes/ColonyFactory.md b/packages/colony-js/docs/api/classes/ColonyFactory.md index 5cd371dad..58e537d97 100644 --- a/packages/colony-js/docs/api/classes/ColonyFactory.md +++ b/packages/colony-js/docs/api/classes/ColonyFactory.md @@ -10,7 +10,7 @@ ### abi -▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"txHash"`` = "txHash"; `type`: ``"bytes32"`` = "bytes32" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"Annotation"`` = "Annotation"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"int256"`` = "int256"; `name`: ``"amount"`` = "amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"ArbitraryReputationUpdate"`` = "ArbitraryReputationUpdate"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"target"`` = "target"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes"`` = "bytes"; `name`: ``"data"`` = "data"; `type`: ``"bytes"`` = "bytes" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"success"`` = "success"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"ArbitraryTransaction"`` = "ArbitraryTransaction"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address[]"`` = "address[]"; `name`: ``"users"`` = "users"; `type`: ``"address[]"`` = "address[]" }, { `indexed`: ``false`` = false; `internalType`: ``"int256[]"`` = "int256[]"; `name`: ``"amounts"`` = "amounts"; `type`: ``"int256[]"`` = "int256[]" }] ; `name`: ``"ColonyBootstrapped"`` = "ColonyBootstrapped"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fee"`` = "fee"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"payoutRemainder"`` = "payoutRemainder"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ColonyFundsClaimed"`` = "ColonyFundsClaimed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fromPot"`` = "fromPot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"toPot"`` = "toPot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }] ; `name`: ``"ColonyFundsMovedBetweenFundingPots"`` = "ColonyFundsMovedBetweenFundingPots"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"colonyNetwork"`` = "colonyNetwork"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }] ; `name`: ``"ColonyInitialised"`` = "ColonyInitialised"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"ColonyMetadata"`` = "ColonyMetadata"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"ColonyMetadataDelta"`` = "ColonyMetadataDelta"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardInverse"`` = "rewardInverse"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ColonyRewardInverseSet"`` = "ColonyRewardInverseSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint8"`` = "uint8"; `name`: ``"role"`` = "role"; `type`: ``"uint8"`` = "uint8" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"setTo"`` = "setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"ColonyRoleSet"`` = "ColonyRoleSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"oldVersion"`` = "oldVersion"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"newVersion"`` = "newVersion"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ColonyUpgraded"`` = "ColonyUpgraded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"DomainAdded"`` = "DomainAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"deprecated"`` = "deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"DomainDeprecated"`` = "DomainDeprecated"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"DomainMetadata"`` = "DomainMetadata"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureAdded"`` = "ExpenditureAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureCancelled"`` = "ExpenditureCancelled"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"claimDelay"`` = "claimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureClaimDelaySet"`` = "ExpenditureClaimDelaySet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureFinalized"`` = "ExpenditureFinalized"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"globalClaimDelay"`` = "globalClaimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureGlobalClaimDelaySet"`` = "ExpenditureGlobalClaimDelaySet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureLocked"`` = "ExpenditureLocked"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"ExpenditureMetadataSet"`` = "ExpenditureMetadataSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"int256"`` = "int256"; `name`: ``"payoutModifier"`` = "payoutModifier"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"ExpenditurePayoutModifierSet"`` = "ExpenditurePayoutModifierSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditurePayoutSet"`` = "ExpenditurePayoutSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"recipient"`` = "recipient"; `type`: ``"address"`` = "address" }] ; `name`: ``"ExpenditureRecipientSet"`` = "ExpenditureRecipientSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureSkillSet"`` = "ExpenditureSkillSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"storageSlot"`` = "storageSlot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bool[]"`` = "bool[]"; `name`: ``"mask"`` = "mask"; `type`: ``"bool[]"`` = "bool[]" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"keys"`` = "keys"; `type`: ``"bytes32[]"`` = "bytes32[]" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"value"`` = "value"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"ExpenditureStateChanged"`` = "ExpenditureStateChanged"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"owner"`` = "owner"; `type`: ``"address"`` = "address" }] ; `name`: ``"ExpenditureTransferred"`` = "ExpenditureTransferred"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"FundingPotAdded"`` = "FundingPotAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"localSkillId"`` = "localSkillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"LocalSkillAdded"`` = "LocalSkillAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"localSkillId"`` = "localSkillId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"deprecated"`` = "deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"LocalSkillDeprecated"`` = "LocalSkillDeprecated"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"userAddress"`` = "userAddress"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address payable"`` = "address payable"; `name`: ``"relayerAddress"`` = "relayerAddress"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes"`` = "bytes"; `name`: ``"payload"`` = "payload"; `type`: ``"bytes"`` = "bytes" }] ; `name`: ``"MetaTransactionExecuted"`` = "MetaTransactionExecuted"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PaymentAdded"`` = "PaymentAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PaymentFinalized"`` = "PaymentFinalized"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PaymentPayoutSet"`` = "PaymentPayoutSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"recipient"`` = "recipient"; `type`: ``"address"`` = "address" }] ; `name`: ``"PaymentRecipientSet"`` = "PaymentRecipientSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PaymentSkillSet"`` = "PaymentSkillSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PayoutClaimed"`` = "PayoutClaimed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"id"`` = "id"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"tokenPayout"`` = "tokenPayout"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PayoutClaimed"`` = "PayoutClaimed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }] ; `name`: ``"RecoveryModeEntered"`` = "RecoveryModeEntered"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }] ; `name`: ``"RecoveryModeExitApproved"`` = "RecoveryModeExitApproved"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }] ; `name`: ``"RecoveryModeExited"`` = "RecoveryModeExited"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"setTo"`` = "setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"RecoveryRoleSet"`` = "RecoveryRoleSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"fromValue"`` = "fromValue"; `type`: ``"bytes32"`` = "bytes32" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"toValue"`` = "toValue"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"RecoveryStorageSlotSet"`` = "RecoveryStorageSlotSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardPayoutId"`` = "rewardPayoutId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fee"`` = "fee"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardRemainder"`` = "rewardRemainder"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"RewardPayoutClaimed"`` = "RewardPayoutClaimed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardPayoutId"`` = "rewardPayoutId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"RewardPayoutCycleEnded"`` = "RewardPayoutCycleEnded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardPayoutId"`` = "rewardPayoutId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"RewardPayoutCycleStarted"`` = "RewardPayoutCycleStarted"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskAdded"`` = "TaskAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"specificationHash"`` = "specificationHash"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"TaskBriefSet"`` = "TaskBriefSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskCanceled"`` = "TaskCanceled"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address[]"`` = "address[]"; `name`: ``"reviewerAddresses"`` = "reviewerAddresses"; `type`: ``"address[]"`` = "address[]" }] ; `name`: ``"TaskChangedViaSignatures"`` = "TaskChangedViaSignatures"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskCompleted"`` = "TaskCompleted"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"deliverableHash"`` = "deliverableHash"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"TaskDeliverableSubmitted"`` = "TaskDeliverableSubmitted"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"dueDate"`` = "dueDate"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskDueDateSet"`` = "TaskDueDateSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskFinalized"`` = "TaskFinalized"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` = "enum ColonyDataTypes.TaskRole"; `name`: ``"role"`` = "role"; `type`: ``"uint8"`` = "uint8" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskPayoutSet"`` = "TaskPayoutSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` = "enum ColonyDataTypes.TaskRole"; `name`: ``"role"`` = "role"; `type`: ``"uint8"`` = "uint8" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }] ; `name`: ``"TaskRoleUserSet"`` = "TaskRoleUserSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskSkillSet"`` = "TaskSkillSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` = "enum ColonyDataTypes.TaskRole"; `name`: ``"role"`` = "role"; `type`: ``"uint8"`` = "uint8" }, { `indexed`: ``false`` = false; `internalType`: ``"uint8"`` = "uint8"; `name`: ``"rating"`` = "rating"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"TaskWorkRatingRevealed"`` = "TaskWorkRatingRevealed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }] ; `name`: ``"TokenUnlocked"`` = "TokenUnlocked"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TokensBurned"`` = "TokensBurned"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"who"`` = "who"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TokensMinted"`` = "TokensMinted"; `type`: ``"event"`` = "event" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_parentDomainId"`` = "\_parentDomainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"addDomain"`` = "addDomain"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_parentDomainId"`` = "\_parentDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"addDomain"`` = "addDomain"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"addLocalSkill"`` = "addLocalSkill"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"_txHash"`` = "\_txHash"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"annotateTransaction"`` = "annotateTransaction"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"approveExitRecovery"`` = "approveExitRecovery"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_approvee"`` = "\_approvee"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"approveStake"`` = "approveStake"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"authority"`` = "authority"; `outputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"colonyAuthority"`` = "colonyAuthority"; `type`: ``"address"`` = "address" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address[]"`` = "address[]"; `name`: ``"_users"`` = "\_users"; `type`: ``"address[]"`` = "address[]" }, { `internalType`: ``"int256[]"`` = "int256[]"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256[]"`` = "int256[]" }] ; `name`: ``"bootstrapColony"`` = "bootstrapColony"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"burnTokens"`` = "burnTokens"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"cancelExpenditure"`` = "cancelExpenditure"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"cancelExpenditureViaArbitration"`` = "cancelExpenditureViaArbitration"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"checkNotAdditionalProtectedVariable"`` = "checkNotAdditionalProtectedVariable"; `outputs`: readonly [] = []; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"claimColonyFunds"`` = "claimColonyFunds"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"claimExpenditurePayout"`` = "claimExpenditurePayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_payoutId"`` = "\_payoutId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[7]"`` = "uint256[7]"; `name`: ``"_squareRoots"`` = "\_squareRoots"; `type`: ``"uint256[7]"`` = "uint256[7]" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"key"`` = "key"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"value"`` = "value"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"branchMask"`` = "branchMask"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"siblings"`` = "siblings"; `type`: ``"bytes32[]"`` = "bytes32[]" }] ; `name`: ``"claimRewardPayout"`` = "claimRewardPayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"deobligateStake"`` = "deobligateStake"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_deprecated"`` = "\_deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"deprecateDomain"`` = "deprecateDomain"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"extensionId"`` = "extensionId"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"deprecated"`` = "deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"deprecateExtension"`` = "deprecateExtension"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"localSkillId"`` = "localSkillId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"deprecated"`` = "deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"deprecateLocalSkill"`` = "deprecateLocalSkill"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"editColony"`` = "editColony"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"string"`` = "string"; `name`: ``"_metadataDelta"`` = "\_metadataDelta"; `type`: ``"string"`` = "string" }] ; `name`: ``"editColonyByDelta"`` = "editColonyByDelta"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"editDomain"`` = "editDomain"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"emitDomainReputationPenalty"`` = "emitDomainReputationPenalty"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"emitDomainReputationReward"`` = "emitDomainReputationReward"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_skillId"`` = "\_skillId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"emitSkillReputationPenalty"`` = "emitSkillReputationPenalty"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_skillId"`` = "\_skillId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"emitSkillReputationReward"`` = "emitSkillReputationReward"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"enterRecoveryMode"`` = "enterRecoveryMode"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"userAddress"`` = "userAddress"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"payload"`` = "payload"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"sigR"`` = "sigR"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"sigS"`` = "sigS"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"uint8"`` = "uint8"; `name`: ``"sigV"`` = "sigV"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"executeMetaTransaction"`` = "executeMetaTransaction"; `outputs`: readonly [{ `internalType`: ``"bytes"`` = "bytes"; `name`: ``""`` = ""; `type`: ``"bytes"`` = "bytes" }] ; `stateMutability`: ``"payable"`` = "payable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"exitRecoveryMode"`` = "exitRecoveryMode"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"finalizeExpenditure"`` = "finalizeExpenditure"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"finalizeExpenditureViaArbitration"`` = "finalizeExpenditureViaArbitration"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_payoutId"`` = "\_payoutId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"finalizeRewardPayout"`` = "finalizeRewardPayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"finishUpgrade"`` = "finishUpgrade"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_obligator"`` = "\_obligator"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getApproval"`` = "getApproval"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"approval"`` = "approval"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes4"`` = "bytes4"; `name`: ``"_sig"`` = "\_sig"; `type`: ``"bytes4"`` = "bytes4" }] ; `name`: ``"getCapabilityRoles"`` = "getCapabilityRoles"; `outputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"roles"`` = "roles"; `type`: ``"bytes32"`` = "bytes32" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getColonyNetwork"`` = "getColonyNetwork"; `outputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"colonyNetwork"`` = "colonyNetwork"; `type`: ``"address"`` = "address" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getDomain"`` = "getDomain"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }] ; `internalType`: ``"struct ColonyDataTypes.Domain"`` = "struct ColonyDataTypes.Domain"; `name`: ``"domain"`` = "domain"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getDomainCount"`` = "getDomainCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fundingPotId"`` = "\_fundingPotId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getDomainFromFundingPot"`` = "getDomainFromFundingPot"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getExpenditure"`` = "getExpenditure"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"enum ColonyDataTypes.ExpenditureStatus"`` = "enum ColonyDataTypes.ExpenditureStatus"; `name`: ``"status"`` = "status"; `type`: ``"uint8"`` = "uint8" }, { `internalType`: ``"address"`` = "address"; `name`: ``"owner"`` = "owner"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"finalizedTimestamp"`` = "finalizedTimestamp"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"globalClaimDelay"`` = "globalClaimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `internalType`: ``"struct ColonyDataTypes.Expenditure"`` = "struct ColonyDataTypes.Expenditure"; `name`: ``"expenditure"`` = "expenditure"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getExpenditureCount"`` = "getExpenditureCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getExpenditureSlot"`` = "getExpenditureSlot"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"address payable"`` = "address payable"; `name`: ``"recipient"`` = "recipient"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"claimDelay"`` = "claimDelay"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"payoutModifier"`` = "payoutModifier"; `type`: ``"int256"`` = "int256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"skills"`` = "skills"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `internalType`: ``"struct ColonyDataTypes.ExpenditureSlot"`` = "struct ColonyDataTypes.ExpenditureSlot"; `name`: ``"expenditureSlot"`` = "expenditureSlot"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getExpenditureSlotPayout"`` = "getExpenditureSlotPayout"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getFundingPot"`` = "getFundingPot"; `outputs`: readonly [{ `internalType`: ``"enum ColonyDataTypes.FundingPotAssociatedType"`` = "enum ColonyDataTypes.FundingPotAssociatedType"; `name`: ``"associatedType"`` = "associatedType"; `type`: ``"uint8"`` = "uint8" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"associatedTypeId"`` = "associatedTypeId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"payoutsWeCannotMake"`` = "payoutsWeCannotMake"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_potId"`` = "\_potId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getFundingPotBalance"`` = "getFundingPotBalance"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"balance"`` = "balance"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getFundingPotCount"`` = "getFundingPotCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_potId"`` = "\_potId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getFundingPotPayout"`` = "getFundingPotPayout"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"payout"`` = "payout"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"userAddress"`` = "userAddress"; `type`: ``"address"`` = "address" }] ; `name`: ``"getMetatransactionNonce"`` = "getMetatransactionNonce"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"nonce"`` = "nonce"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getNonRewardPotsTotal"`` = "getNonRewardPotsTotal"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_obligator"`` = "\_obligator"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getObligation"`` = "getObligation"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"obligation"`` = "obligation"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getPayment"`` = "getPayment"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"address payable"`` = "address payable"; `name`: ``"recipient"`` = "recipient"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"finalized"`` = "finalized"; `type`: ``"bool"`` = "bool" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"skills"`` = "skills"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `internalType`: ``"struct ColonyDataTypes.Payment"`` = "struct ColonyDataTypes.Payment"; `name`: ``"payment"`` = "payment"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getPaymentCount"`` = "getPaymentCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getRewardInverse"`` = "getRewardInverse"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardInverse"`` = "rewardInverse"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_payoutId"`` = "\_payoutId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getRewardPayoutInfo"`` = "getRewardPayoutInfo"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"reputationState"`` = "reputationState"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"colonyWideReputation"`` = "colonyWideReputation"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"totalTokens"`` = "totalTokens"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"tokenAddress"`` = "tokenAddress"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"blockTimestamp"`` = "blockTimestamp"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amountRemaining"`` = "amountRemaining"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"finalized"`` = "finalized"; `type`: ``"bool"`` = "bool" }] ; `internalType`: ``"struct ColonyDataTypes.RewardPayoutCycle"`` = "struct ColonyDataTypes.RewardPayoutCycle"; `name`: ``"rewardPayoutCycle"`` = "rewardPayoutCycle"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getRootLocalSkill"`` = "getRootLocalSkill"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rootLocalSkill"`` = "rootLocalSkill"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getTask"`` = "getTask"; `outputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"specificationHash"`` = "specificationHash"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"deliverableHash"`` = "deliverableHash"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"enum ColonyDataTypes.TaskStatus"`` = "enum ColonyDataTypes.TaskStatus"; `name`: ``"status"`` = "status"; `type`: ``"uint8"`` = "uint8" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"dueDate"`` = "dueDate"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"completionTimestamp"`` = "completionTimestamp"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"skillIds"`` = "skillIds"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getTaskChangeNonce"`` = "getTaskChangeNonce"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"nonce"`` = "nonce"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getTaskCount"`` = "getTaskCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint8"`` = "uint8"; `name`: ``"_role"`` = "\_role"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"getTaskRole"`` = "getTaskRole"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"address payable"`` = "address payable"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"rateFail"`` = "rateFail"; `type`: ``"bool"`` = "bool" }, { `internalType`: ``"enum ColonyDataTypes.TaskRatings"`` = "enum ColonyDataTypes.TaskRatings"; `name`: ``"rating"`` = "rating"; `type`: ``"uint8"`` = "uint8" }] ; `internalType`: ``"struct ColonyDataTypes.Role"`` = "struct ColonyDataTypes.Role"; `name`: ``"role"`` = "role"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint8"`` = "uint8"; `name`: ``"_role"`` = "\_role"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"getTaskWorkRatingSecret"`` = "getTaskWorkRatingSecret"; `outputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"secret"`` = "secret"; `type`: ``"bytes32"`` = "bytes32" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getTaskWorkRatingSecretsInfo"`` = "getTaskWorkRatingSecretsInfo"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"nSecrets"`` = "nSecrets"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"lastSubmittedAt"`` = "lastSubmittedAt"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getToken"`` = "getToken"; `outputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"tokenAddress"`` = "tokenAddress"; `type`: ``"address"`` = "address" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"spender"`` = "spender"; `type`: ``"address"`` = "address" }] ; `name`: ``"getTokenApproval"`` = "getTokenApproval"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getTotalTokenApproval"`` = "getTotalTokenApproval"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domain"`` = "\_domain"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getUserRoles"`` = "getUserRoles"; `outputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"roles"`` = "roles"; `type`: ``"bytes32"`` = "bytes32" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"enum ColonyDataTypes.ColonyRole"`` = "enum ColonyDataTypes.ColonyRole"; `name`: ``"_role"`` = "\_role"; `type`: ``"uint8"`` = "uint8" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childDomainId"`` = "\_childDomainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"hasInheritedUserRole"`` = "hasInheritedUserRole"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"hasRole"`` = "hasRole"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"enum ColonyDataTypes.ColonyRole"`` = "enum ColonyDataTypes.ColonyRole"; `name`: ``"_role"`` = "\_role"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"hasUserRole"`` = "hasUserRole"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"hasRole"`` = "hasRole"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_colonyNetworkAddress"`` = "\_colonyNetworkAddress"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"initialiseColony"`` = "initialiseColony"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"initialiseRootLocalSkill"`` = "initialiseRootLocalSkill"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"extensionId"`` = "extensionId"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"version"`` = "version"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"installExtension"`` = "installExtension"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"isInRecoveryMode"`` = "isInRecoveryMode"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"inRecoveryMode"`` = "inRecoveryMode"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"lockExpenditure"`` = "lockExpenditure"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"lockToken"`` = "lockToken"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"timesLocked"`` = "timesLocked"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_to"`` = "\_to"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"_action"`` = "\_action"; `type`: ``"bytes"`` = "bytes" }] ; `name`: ``"makeArbitraryTransaction"`` = "makeArbitraryTransaction"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"success"`` = "success"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address[]"`` = "address[]"; `name`: ``"_targets"`` = "\_targets"; `type`: ``"address[]"`` = "address[]" }, { `internalType`: ``"bytes[]"`` = "bytes[]"; `name`: ``"_actions"`` = "\_actions"; `type`: ``"bytes[]"`` = "bytes[]" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_strict"`` = "\_strict"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"makeArbitraryTransactions"`` = "makeArbitraryTransactions"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"success"`` = "success"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"makeExpenditure"`` = "makeExpenditure"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_target"`` = "\_target"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"_action"`` = "\_action"; `type`: ``"bytes"`` = "bytes" }] ; `name`: ``"makeSingleArbitraryTransaction"`` = "makeSingleArbitraryTransaction"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"success"`` = "success"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_wad"`` = "\_wad"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"mintTokens"`` = "mintTokens"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_guy"`` = "\_guy"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_wad"`` = "\_wad"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"mintTokensFor"`` = "mintTokensFor"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fromChildSkillIndex"`` = "\_fromChildSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_toChildSkillIndex"`` = "\_toChildSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fromPot"`` = "\_fromPot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_toPot"`` = "\_toPot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"moveFundsBetweenPots"`` = "moveFundsBetweenPots"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fromChildSkillIndex"`` = "\_fromChildSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_toChildSkillIndex"`` = "\_toChildSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fromPot"`` = "\_fromPot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_toPot"`` = "\_toPot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"moveFundsBetweenPots"`` = "moveFundsBetweenPots"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes[]"`` = "bytes[]"; `name`: ``"data"`` = "data"; `type`: ``"bytes[]"`` = "bytes[]" }] ; `name`: ``"multicall"`` = "multicall"; `outputs`: readonly [{ `internalType`: ``"bytes[]"`` = "bytes[]"; `name`: ``"results"`` = "results"; `type`: ``"bytes[]"`` = "bytes[]" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"numRecoveryRoles"`` = "numRecoveryRoles"; `outputs`: readonly [{ `internalType`: ``"uint64"`` = "uint64"; `name`: ``"numRoles"`` = "numRoles"; `type`: ``"uint64"`` = "uint64" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"obligateStake"`` = "obligateStake"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"owner"`` = "owner"; `outputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"colonyOwner"`` = "colonyOwner"; `type`: ``"address"`` = "address" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"string"`` = "string"; `name`: ``"colonyName"`` = "colonyName"; `type`: ``"string"`` = "string" }, { `internalType`: ``"string"`` = "string"; `name`: ``"orbitdb"`` = "orbitdb"; `type`: ``"string"`` = "string" }] ; `name`: ``"registerColonyLabel"`` = "registerColonyLabel"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }] ; `name`: ``"removeRecoveryRole"`` = "removeRecoveryRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setAdministrationRole"`` = "setAdministrationRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setArbitrationRole"`` = "setArbitrationRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setArchitectureRole"`` = "setArchitectureRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_globalClaimDelay"`` = "\_globalClaimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setDefaultGlobalClaimDelay"`` = "setDefaultGlobalClaimDelay"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_claimDelay"`` = "\_claimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setExpenditureClaimDelay"`` = "setExpenditureClaimDelay"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_claimDelays"`` = "\_claimDelays"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `name`: ``"setExpenditureClaimDelays"`` = "setExpenditureClaimDelays"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"setExpenditureMetadata"`` = "setExpenditureMetadata"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"setExpenditureMetadata"`` = "setExpenditureMetadata"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setExpenditurePayout"`` = "setExpenditurePayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setExpenditurePayout"`` = "setExpenditurePayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"int256[]"`` = "int256[]"; `name`: ``"_payoutModifiers"`` = "\_payoutModifiers"; `type`: ``"int256[]"`` = "int256[]" }] ; `name`: ``"setExpenditurePayoutModifiers"`` = "setExpenditurePayoutModifiers"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_amounts"`` = "\_amounts"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `name`: ``"setExpenditurePayouts"`` = "setExpenditurePayouts"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address payable"`` = "address payable"; `name`: ``"_recipient"`` = "\_recipient"; `type`: ``"address"`` = "address" }] ; `name`: ``"setExpenditureRecipient"`` = "setExpenditureRecipient"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"address payable[]"`` = "address payable[]"; `name`: ``"_recipients"`` = "\_recipients"; `type`: ``"address[]"`` = "address[]" }] ; `name`: ``"setExpenditureRecipients"`` = "setExpenditureRecipients"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_skillId"`` = "\_skillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setExpenditureSkill"`` = "setExpenditureSkill"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_skillIds"`` = "\_skillIds"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `name`: ``"setExpenditureSkills"`` = "setExpenditureSkills"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_storageSlot"`` = "\_storageSlot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool[]"`` = "bool[]"; `name`: ``"_mask"`` = "\_mask"; `type`: ``"bool[]"`` = "bool[]" }, { `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"_keys"`` = "\_keys"; `type`: ``"bytes32[]"`` = "bytes32[]" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"_value"`` = "\_value"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"setExpenditureState"`` = "setExpenditureState"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_recipientSlots"`` = "\_recipientSlots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"address payable[]"`` = "address payable[]"; `name`: ``"_recipients"`` = "\_recipients"; `type`: ``"address[]"`` = "address[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_skillIdSlots"`` = "\_skillIdSlots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_skillIds"`` = "\_skillIds"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_claimDelaySlots"`` = "\_claimDelaySlots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_claimDelays"`` = "\_claimDelays"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_payoutModifierSlots"`` = "\_payoutModifierSlots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"int256[]"`` = "int256[]"; `name`: ``"_payoutModifiers"`` = "\_payoutModifiers"; `type`: ``"int256[]"`` = "int256[]" }, { `internalType`: ``"address[]"`` = "address[]"; `name`: ``"_payoutTokens"`` = "\_payoutTokens"; `type`: ``"address[]"`` = "address[]" }, { `internalType`: ``"uint256[][]"`` = "uint256[][]"; `name`: ``"_payoutSlots"`` = "\_payoutSlots"; `type`: ``"uint256[][]"`` = "uint256[][]" }, { `internalType`: ``"uint256[][]"`` = "uint256[][]"; `name`: ``"_payoutValues"`` = "\_payoutValues"; `type`: ``"uint256[][]"`` = "uint256[][]" }] ; `name`: ``"setExpenditureValues"`` = "setExpenditureValues"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setFundingRole"`` = "setFundingRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }] ; `name`: ``"setRecoveryRole"`` = "setRecoveryRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_rewardInverse"`` = "\_rewardInverse"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setRewardInverse"`` = "setRewardInverse"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setRootRole"`` = "setRootRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"_value"`` = "\_value"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"setStorageSlotRecovery"`` = "setStorageSlotRecovery"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"_roles"`` = "\_roles"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"setUserRoles"`` = "setUserRoles"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"key"`` = "key"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"value"`` = "value"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"branchMask"`` = "branchMask"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"siblings"`` = "siblings"; `type`: ``"bytes32[]"`` = "bytes32[]" }] ; `name`: ``"startNextRewardPayout"`` = "startNextRewardPayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_newOwner"`` = "\_newOwner"; `type`: ``"address"`` = "address" }] ; `name`: ``"transferExpenditure"`` = "transferExpenditure"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_newOwner"`` = "\_newOwner"; `type`: ``"address"`` = "address" }] ; `name`: ``"transferExpenditureViaArbitration"`` = "transferExpenditureViaArbitration"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_obligator"`` = "\_obligator"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_recipient"`` = "\_recipient"; `type`: ``"address"`` = "address" }] ; `name`: ``"transferStake"`` = "transferStake"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"extensionId"`` = "extensionId"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"uninstallExtension"`` = "uninstallExtension"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"unlockToken"`` = "unlockToken"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"lockId"`` = "lockId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"unlockTokenForUser"`` = "unlockTokenForUser"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"spender"`` = "spender"; `type`: ``"address"`` = "address" }] ; `name`: ``"updateApprovalAmount"`` = "updateApprovalAmount"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"string"`` = "string"; `name`: ``"orbitdb"`` = "orbitdb"; `type`: ``"string"`` = "string" }] ; `name`: ``"updateColonyOrbitDB"`` = "updateColonyOrbitDB"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_newVersion"`` = "\_newVersion"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"upgrade"`` = "upgrade"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"extensionId"`` = "extensionId"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"newVersion"`` = "newVersion"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"upgradeExtension"`` = "upgradeExtension"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childDomainId"`` = "\_childDomainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"userCanSetRoles"`` = "userCanSetRoles"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"canSet"`` = "canSet"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes"`` = "bytes"; `name`: ``"key"`` = "key"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"value"`` = "value"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"branchMask"`` = "branchMask"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"siblings"`` = "siblings"; `type`: ``"bytes32[]"`` = "bytes32[]" }] ; `name`: ``"verifyReputationProof"`` = "verifyReputationProof"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"isValid"`` = "isValid"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"version"`` = "version"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"colonyVersion"`` = "colonyVersion"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"pure"`` = "pure"; `type`: ``"function"`` = "function" }] = `_abi` +▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"txHash"`` = "txHash"; `type`: ``"bytes32"`` = "bytes32" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"Annotation"`` = "Annotation"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"int256"`` = "int256"; `name`: ``"amount"`` = "amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"ArbitraryReputationUpdate"`` = "ArbitraryReputationUpdate"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"target"`` = "target"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes"`` = "bytes"; `name`: ``"data"`` = "data"; `type`: ``"bytes"`` = "bytes" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"success"`` = "success"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"ArbitraryTransaction"`` = "ArbitraryTransaction"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address[]"`` = "address[]"; `name`: ``"users"`` = "users"; `type`: ``"address[]"`` = "address[]" }, { `indexed`: ``false`` = false; `internalType`: ``"int256[]"`` = "int256[]"; `name`: ``"amounts"`` = "amounts"; `type`: ``"int256[]"`` = "int256[]" }] ; `name`: ``"ColonyBootstrapped"`` = "ColonyBootstrapped"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fee"`` = "fee"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"payoutRemainder"`` = "payoutRemainder"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ColonyFundsClaimed"`` = "ColonyFundsClaimed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fromPot"`` = "fromPot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"toPot"`` = "toPot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }] ; `name`: ``"ColonyFundsMovedBetweenFundingPots"`` = "ColonyFundsMovedBetweenFundingPots"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"colonyNetwork"`` = "colonyNetwork"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }] ; `name`: ``"ColonyInitialised"`` = "ColonyInitialised"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"ColonyMetadata"`` = "ColonyMetadata"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"ColonyMetadataDelta"`` = "ColonyMetadataDelta"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardInverse"`` = "rewardInverse"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ColonyRewardInverseSet"`` = "ColonyRewardInverseSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint8"`` = "uint8"; `name`: ``"role"`` = "role"; `type`: ``"uint8"`` = "uint8" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"setTo"`` = "setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"ColonyRoleSet"`` = "ColonyRoleSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"oldVersion"`` = "oldVersion"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"newVersion"`` = "newVersion"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ColonyUpgraded"`` = "ColonyUpgraded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"DomainAdded"`` = "DomainAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"deprecated"`` = "deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"DomainDeprecated"`` = "DomainDeprecated"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"DomainMetadata"`` = "DomainMetadata"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureAdded"`` = "ExpenditureAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureCancelled"`` = "ExpenditureCancelled"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"claimDelay"`` = "claimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureClaimDelaySet"`` = "ExpenditureClaimDelaySet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureFinalized"`` = "ExpenditureFinalized"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"globalClaimDelay"`` = "globalClaimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureGlobalClaimDelaySet"`` = "ExpenditureGlobalClaimDelaySet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureLocked"`` = "ExpenditureLocked"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"string"`` = "string"; `name`: ``"metadata"`` = "metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"ExpenditureMetadataSet"`` = "ExpenditureMetadataSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"int256"`` = "int256"; `name`: ``"payoutModifier"`` = "payoutModifier"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"ExpenditurePayoutModifierSet"`` = "ExpenditurePayoutModifierSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditurePayoutSet"`` = "ExpenditurePayoutSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"recipient"`` = "recipient"; `type`: ``"address"`` = "address" }] ; `name`: ``"ExpenditureRecipientSet"`` = "ExpenditureRecipientSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"ExpenditureSkillSet"`` = "ExpenditureSkillSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"storageSlot"`` = "storageSlot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bool[]"`` = "bool[]"; `name`: ``"mask"`` = "mask"; `type`: ``"bool[]"`` = "bool[]" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"keys"`` = "keys"; `type`: ``"bytes32[]"`` = "bytes32[]" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"value"`` = "value"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"ExpenditureStateChanged"`` = "ExpenditureStateChanged"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"owner"`` = "owner"; `type`: ``"address"`` = "address" }] ; `name`: ``"ExpenditureTransferred"`` = "ExpenditureTransferred"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"FundingPotAdded"`` = "FundingPotAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"localSkillId"`` = "localSkillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"LocalSkillAdded"`` = "LocalSkillAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"localSkillId"`` = "localSkillId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"deprecated"`` = "deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"LocalSkillDeprecated"`` = "LocalSkillDeprecated"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"userAddress"`` = "userAddress"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address payable"`` = "address payable"; `name`: ``"relayerAddress"`` = "relayerAddress"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes"`` = "bytes"; `name`: ``"payload"`` = "payload"; `type`: ``"bytes"`` = "bytes" }] ; `name`: ``"MetaTransactionExecuted"`` = "MetaTransactionExecuted"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PaymentAdded"`` = "PaymentAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PaymentFinalized"`` = "PaymentFinalized"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PaymentPayoutSet"`` = "PaymentPayoutSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"recipient"`` = "recipient"; `type`: ``"address"`` = "address" }] ; `name`: ``"PaymentRecipientSet"`` = "PaymentRecipientSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"paymentId"`` = "paymentId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PaymentSkillSet"`` = "PaymentSkillSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PayoutClaimed"`` = "PayoutClaimed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"id"`` = "id"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"tokenPayout"`` = "tokenPayout"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"PayoutClaimed"`` = "PayoutClaimed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }] ; `name`: ``"RecoveryModeEntered"`` = "RecoveryModeEntered"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }] ; `name`: ``"RecoveryModeExitApproved"`` = "RecoveryModeExitApproved"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }] ; `name`: ``"RecoveryModeExited"`` = "RecoveryModeExited"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"bool"`` = "bool"; `name`: ``"setTo"`` = "setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"RecoveryRoleSet"`` = "RecoveryRoleSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"slot"`` = "slot"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"fromValue"`` = "fromValue"; `type`: ``"bytes32"`` = "bytes32" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"toValue"`` = "toValue"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"RecoveryStorageSlotSet"`` = "RecoveryStorageSlotSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardPayoutId"`` = "rewardPayoutId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fee"`` = "fee"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardRemainder"`` = "rewardRemainder"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"RewardPayoutClaimed"`` = "RewardPayoutClaimed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardPayoutId"`` = "rewardPayoutId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"RewardPayoutCycleEnded"`` = "RewardPayoutCycleEnded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardPayoutId"`` = "rewardPayoutId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"RewardPayoutCycleStarted"`` = "RewardPayoutCycleStarted"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskAdded"`` = "TaskAdded"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"specificationHash"`` = "specificationHash"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"TaskBriefSet"`` = "TaskBriefSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskCanceled"`` = "TaskCanceled"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address[]"`` = "address[]"; `name`: ``"reviewerAddresses"`` = "reviewerAddresses"; `type`: ``"address[]"`` = "address[]" }] ; `name`: ``"TaskChangedViaSignatures"`` = "TaskChangedViaSignatures"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskCompleted"`` = "TaskCompleted"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"deliverableHash"`` = "deliverableHash"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"TaskDeliverableSubmitted"`` = "TaskDeliverableSubmitted"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"dueDate"`` = "dueDate"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskDueDateSet"`` = "TaskDueDateSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskFinalized"`` = "TaskFinalized"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` = "enum ColonyDataTypes.TaskRole"; `name`: ``"role"`` = "role"; `type`: ``"uint8"`` = "uint8" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskPayoutSet"`` = "TaskPayoutSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` = "enum ColonyDataTypes.TaskRole"; `name`: ``"role"`` = "role"; `type`: ``"uint8"`` = "uint8" }, { `indexed`: ``true`` = true; `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }] ; `name`: ``"TaskRoleUserSet"`` = "TaskRoleUserSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TaskSkillSet"`` = "TaskSkillSet"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``true`` = true; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"taskId"`` = "taskId"; `type`: ``"uint256"`` = "uint256" }, { `indexed`: ``false`` = false; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` = "enum ColonyDataTypes.TaskRole"; `name`: ``"role"`` = "role"; `type`: ``"uint8"`` = "uint8" }, { `indexed`: ``false`` = false; `internalType`: ``"uint8"`` = "uint8"; `name`: ``"rating"`` = "rating"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"TaskWorkRatingRevealed"`` = "TaskWorkRatingRevealed"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }] ; `name`: ``"TokenUnlocked"`` = "TokenUnlocked"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TokensBurned"`` = "TokensBurned"; `type`: ``"event"`` = "event" }, { `anonymous`: ``false`` = false; `inputs`: readonly [{ `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"agent"`` = "agent"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"address"`` = "address"; `name`: ``"who"`` = "who"; `type`: ``"address"`` = "address" }, { `indexed`: ``false`` = false; `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"TokensMinted"`` = "TokensMinted"; `type`: ``"event"`` = "event" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_parentDomainId"`` = "\_parentDomainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"addDomain"`` = "addDomain"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_parentDomainId"`` = "\_parentDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"addDomain"`` = "addDomain"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"addLocalSkill"`` = "addLocalSkill"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"_txHash"`` = "\_txHash"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"annotateTransaction"`` = "annotateTransaction"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"approveExitRecovery"`` = "approveExitRecovery"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_approvee"`` = "\_approvee"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"approveStake"`` = "approveStake"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"authority"`` = "authority"; `outputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"colonyAuthority"`` = "colonyAuthority"; `type`: ``"address"`` = "address" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address[]"`` = "address[]"; `name`: ``"_users"`` = "\_users"; `type`: ``"address[]"`` = "address[]" }, { `internalType`: ``"int256[]"`` = "int256[]"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256[]"`` = "int256[]" }] ; `name`: ``"bootstrapColony"`` = "bootstrapColony"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"burnTokens"`` = "burnTokens"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"cancelExpenditure"`` = "cancelExpenditure"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"cancelExpenditureViaArbitration"`` = "cancelExpenditureViaArbitration"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"checkNotAdditionalProtectedVariable"`` = "checkNotAdditionalProtectedVariable"; `outputs`: readonly [] = []; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"claimColonyFunds"`` = "claimColonyFunds"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"claimExpenditurePayout"`` = "claimExpenditurePayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_payoutId"`` = "\_payoutId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[7]"`` = "uint256[7]"; `name`: ``"_squareRoots"`` = "\_squareRoots"; `type`: ``"uint256[7]"`` = "uint256[7]" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"key"`` = "key"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"value"`` = "value"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"branchMask"`` = "branchMask"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"siblings"`` = "siblings"; `type`: ``"bytes32[]"`` = "bytes32[]" }] ; `name`: ``"claimRewardPayout"`` = "claimRewardPayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"deobligateStake"`` = "deobligateStake"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_deprecated"`` = "\_deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"deprecateDomain"`` = "deprecateDomain"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"extensionId"`` = "extensionId"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"deprecated"`` = "deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"deprecateExtension"`` = "deprecateExtension"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"localSkillId"`` = "localSkillId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"deprecated"`` = "deprecated"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"deprecateLocalSkill"`` = "deprecateLocalSkill"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"editColony"`` = "editColony"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"string"`` = "string"; `name`: ``"_metadataDelta"`` = "\_metadataDelta"; `type`: ``"string"`` = "string" }] ; `name`: ``"editColonyByDelta"`` = "editColonyByDelta"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"editDomain"`` = "editDomain"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"emitDomainReputationPenalty"`` = "emitDomainReputationPenalty"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"emitDomainReputationReward"`` = "emitDomainReputationReward"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_skillId"`` = "\_skillId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"emitSkillReputationPenalty"`` = "emitSkillReputationPenalty"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_skillId"`` = "\_skillId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"int256"`` = "int256" }] ; `name`: ``"emitSkillReputationReward"`` = "emitSkillReputationReward"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"enterRecoveryMode"`` = "enterRecoveryMode"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"userAddress"`` = "userAddress"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"payload"`` = "payload"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"sigR"`` = "sigR"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"sigS"`` = "sigS"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"uint8"`` = "uint8"; `name`: ``"sigV"`` = "sigV"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"executeMetaTransaction"`` = "executeMetaTransaction"; `outputs`: readonly [{ `internalType`: ``"bytes"`` = "bytes"; `name`: ``""`` = ""; `type`: ``"bytes"`` = "bytes" }] ; `stateMutability`: ``"payable"`` = "payable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"exitRecoveryMode"`` = "exitRecoveryMode"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"finalizeExpenditure"`` = "finalizeExpenditure"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"finalizeExpenditureViaArbitration"`` = "finalizeExpenditureViaArbitration"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_payoutId"`` = "\_payoutId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"finalizeRewardPayout"`` = "finalizeRewardPayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"finishUpgrade"`` = "finishUpgrade"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_obligator"`` = "\_obligator"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getApproval"`` = "getApproval"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"approval"`` = "approval"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes4"`` = "bytes4"; `name`: ``"_sig"`` = "\_sig"; `type`: ``"bytes4"`` = "bytes4" }] ; `name`: ``"getCapabilityRoles"`` = "getCapabilityRoles"; `outputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"roles"`` = "roles"; `type`: ``"bytes32"`` = "bytes32" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getColonyNetwork"`` = "getColonyNetwork"; `outputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"colonyNetwork"`` = "colonyNetwork"; `type`: ``"address"`` = "address" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getDomain"`` = "getDomain"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"skillId"`` = "skillId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }] ; `internalType`: ``"struct ColonyDataTypes.Domain"`` = "struct ColonyDataTypes.Domain"; `name`: ``"domain"`` = "domain"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getDomainCount"`` = "getDomainCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fundingPotId"`` = "\_fundingPotId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getDomainFromFundingPot"`` = "getDomainFromFundingPot"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getExpenditure"`` = "getExpenditure"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"enum ColonyDataTypes.ExpenditureStatus"`` = "enum ColonyDataTypes.ExpenditureStatus"; `name`: ``"status"`` = "status"; `type`: ``"uint8"`` = "uint8" }, { `internalType`: ``"address"`` = "address"; `name`: ``"owner"`` = "owner"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"finalizedTimestamp"`` = "finalizedTimestamp"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"globalClaimDelay"`` = "globalClaimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `internalType`: ``"struct ColonyDataTypes.Expenditure"`` = "struct ColonyDataTypes.Expenditure"; `name`: ``"expenditure"`` = "expenditure"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getExpenditureCount"`` = "getExpenditureCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getExpenditureSlot"`` = "getExpenditureSlot"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"address payable"`` = "address payable"; `name`: ``"recipient"`` = "recipient"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"claimDelay"`` = "claimDelay"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"int256"`` = "int256"; `name`: ``"payoutModifier"`` = "payoutModifier"; `type`: ``"int256"`` = "int256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"skills"`` = "skills"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `internalType`: ``"struct ColonyDataTypes.ExpenditureSlot"`` = "struct ColonyDataTypes.ExpenditureSlot"; `name`: ``"expenditureSlot"`` = "expenditureSlot"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getExpenditureSlotPayout"`` = "getExpenditureSlotPayout"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getFundingPot"`` = "getFundingPot"; `outputs`: readonly [{ `internalType`: ``"enum ColonyDataTypes.FundingPotAssociatedType"`` = "enum ColonyDataTypes.FundingPotAssociatedType"; `name`: ``"associatedType"`` = "associatedType"; `type`: ``"uint8"`` = "uint8" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"associatedTypeId"`` = "associatedTypeId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"payoutsWeCannotMake"`` = "payoutsWeCannotMake"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_potId"`` = "\_potId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getFundingPotBalance"`` = "getFundingPotBalance"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"balance"`` = "balance"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getFundingPotCount"`` = "getFundingPotCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_potId"`` = "\_potId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getFundingPotPayout"`` = "getFundingPotPayout"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"payout"`` = "payout"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"userAddress"`` = "userAddress"; `type`: ``"address"`` = "address" }] ; `name`: ``"getMetatransactionNonce"`` = "getMetatransactionNonce"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"nonce"`` = "nonce"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getNonRewardPotsTotal"`` = "getNonRewardPotsTotal"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_obligator"`` = "\_obligator"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getObligation"`` = "getObligation"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"obligation"`` = "obligation"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getPayment"`` = "getPayment"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"address payable"`` = "address payable"; `name`: ``"recipient"`` = "recipient"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"finalized"`` = "finalized"; `type`: ``"bool"`` = "bool" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"skills"`` = "skills"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `internalType`: ``"struct ColonyDataTypes.Payment"`` = "struct ColonyDataTypes.Payment"; `name`: ``"payment"`` = "payment"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getPaymentCount"`` = "getPaymentCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getRewardInverse"`` = "getRewardInverse"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rewardInverse"`` = "rewardInverse"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_payoutId"`` = "\_payoutId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getRewardPayoutInfo"`` = "getRewardPayoutInfo"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"reputationState"`` = "reputationState"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"colonyWideReputation"`` = "colonyWideReputation"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"totalTokens"`` = "totalTokens"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"tokenAddress"`` = "tokenAddress"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"blockTimestamp"`` = "blockTimestamp"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amountRemaining"`` = "amountRemaining"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"finalized"`` = "finalized"; `type`: ``"bool"`` = "bool" }] ; `internalType`: ``"struct ColonyDataTypes.RewardPayoutCycle"`` = "struct ColonyDataTypes.RewardPayoutCycle"; `name`: ``"rewardPayoutCycle"`` = "rewardPayoutCycle"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getRootLocalSkill"`` = "getRootLocalSkill"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"rootLocalSkill"`` = "rootLocalSkill"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getTask"`` = "getTask"; `outputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"specificationHash"`` = "specificationHash"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"deliverableHash"`` = "deliverableHash"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"enum ColonyDataTypes.TaskStatus"`` = "enum ColonyDataTypes.TaskStatus"; `name`: ``"status"`` = "status"; `type`: ``"uint8"`` = "uint8" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"dueDate"`` = "dueDate"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"fundingPotId"`` = "fundingPotId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"completionTimestamp"`` = "completionTimestamp"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"domainId"`` = "domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"skillIds"`` = "skillIds"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getTaskChangeNonce"`` = "getTaskChangeNonce"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"nonce"`` = "nonce"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getTaskCount"`` = "getTaskCount"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"count"`` = "count"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint8"`` = "uint8"; `name`: ``"_role"`` = "\_role"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"getTaskRole"`` = "getTaskRole"; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"address payable"`` = "address payable"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"rateFail"`` = "rateFail"; `type`: ``"bool"`` = "bool" }, { `internalType`: ``"enum ColonyDataTypes.TaskRatings"`` = "enum ColonyDataTypes.TaskRatings"; `name`: ``"rating"`` = "rating"; `type`: ``"uint8"`` = "uint8" }] ; `internalType`: ``"struct ColonyDataTypes.Role"`` = "struct ColonyDataTypes.Role"; `name`: ``"role"`` = "role"; `type`: ``"tuple"`` = "tuple" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint8"`` = "uint8"; `name`: ``"_role"`` = "\_role"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"getTaskWorkRatingSecret"`` = "getTaskWorkRatingSecret"; `outputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"secret"`` = "secret"; `type`: ``"bytes32"`` = "bytes32" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getTaskWorkRatingSecretsInfo"`` = "getTaskWorkRatingSecretsInfo"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"nSecrets"`` = "nSecrets"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"lastSubmittedAt"`` = "lastSubmittedAt"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"getToken"`` = "getToken"; `outputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"tokenAddress"`` = "tokenAddress"; `type`: ``"address"`` = "address" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"spender"`` = "spender"; `type`: ``"address"`` = "address" }] ; `name`: ``"getTokenApproval"`` = "getTokenApproval"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }] ; `name`: ``"getTotalTokenApproval"`` = "getTotalTokenApproval"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"amount"`` = "amount"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domain"`` = "\_domain"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"getUserRoles"`` = "getUserRoles"; `outputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"roles"`` = "roles"; `type`: ``"bytes32"`` = "bytes32" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"enum ColonyDataTypes.ColonyRole"`` = "enum ColonyDataTypes.ColonyRole"; `name`: ``"_role"`` = "\_role"; `type`: ``"uint8"`` = "uint8" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childDomainId"`` = "\_childDomainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"hasInheritedUserRole"`` = "hasInheritedUserRole"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"hasRole"`` = "hasRole"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"enum ColonyDataTypes.ColonyRole"`` = "enum ColonyDataTypes.ColonyRole"; `name`: ``"_role"`` = "\_role"; `type`: ``"uint8"`` = "uint8" }] ; `name`: ``"hasUserRole"`` = "hasUserRole"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"hasRole"`` = "hasRole"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_colonyNetworkAddress"`` = "\_colonyNetworkAddress"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"initialiseColony"`` = "initialiseColony"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"initialiseRootLocalSkill"`` = "initialiseRootLocalSkill"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"extensionId"`` = "extensionId"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"version"`` = "version"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"installExtension"`` = "installExtension"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"isInRecoveryMode"`` = "isInRecoveryMode"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"inRecoveryMode"`` = "inRecoveryMode"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"lockExpenditure"`` = "lockExpenditure"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"lockToken"`` = "lockToken"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"timesLocked"`` = "timesLocked"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_to"`` = "\_to"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"_action"`` = "\_action"; `type`: ``"bytes"`` = "bytes" }] ; `name`: ``"makeArbitraryTransaction"`` = "makeArbitraryTransaction"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"success"`` = "success"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address[]"`` = "address[]"; `name`: ``"_targets"`` = "\_targets"; `type`: ``"address[]"`` = "address[]" }, { `internalType`: ``"bytes[]"`` = "bytes[]"; `name`: ``"_actions"`` = "\_actions"; `type`: ``"bytes[]"`` = "bytes[]" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_strict"`` = "\_strict"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"makeArbitraryTransactions"`` = "makeArbitraryTransactions"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"success"`` = "success"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"makeExpenditure"`` = "makeExpenditure"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"expenditureId"`` = "expenditureId"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_target"`` = "\_target"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"_action"`` = "\_action"; `type`: ``"bytes"`` = "bytes" }] ; `name`: ``"makeSingleArbitraryTransaction"`` = "makeSingleArbitraryTransaction"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"success"`` = "success"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_wad"`` = "\_wad"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"mintTokens"`` = "mintTokens"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_guy"`` = "\_guy"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_wad"`` = "\_wad"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"mintTokensFor"`` = "mintTokensFor"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fromChildSkillIndex"`` = "\_fromChildSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_toChildSkillIndex"`` = "\_toChildSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fromPot"`` = "\_fromPot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_toPot"`` = "\_toPot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"moveFundsBetweenPots"`` = "moveFundsBetweenPots"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fromChildSkillIndex"`` = "\_fromChildSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_toChildSkillIndex"`` = "\_toChildSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_fromPot"`` = "\_fromPot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_toPot"`` = "\_toPot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }] ; `name`: ``"moveFundsBetweenPots"`` = "moveFundsBetweenPots"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes[]"`` = "bytes[]"; `name`: ``"data"`` = "data"; `type`: ``"bytes[]"`` = "bytes[]" }] ; `name`: ``"multicall"`` = "multicall"; `outputs`: readonly [{ `internalType`: ``"bytes[]"`` = "bytes[]"; `name`: ``"results"`` = "results"; `type`: ``"bytes[]"`` = "bytes[]" }] ; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"numRecoveryRoles"`` = "numRecoveryRoles"; `outputs`: readonly [{ `internalType`: ``"uint64"`` = "uint64"; `name`: ``"numRoles"`` = "numRoles"; `type`: ``"uint64"`` = "uint64" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"obligateStake"`` = "obligateStake"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"owner"`` = "owner"; `outputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"colonyOwner"`` = "colonyOwner"; `type`: ``"address"`` = "address" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"string"`` = "string"; `name`: ``"colonyName"`` = "colonyName"; `type`: ``"string"`` = "string" }, { `internalType`: ``"string"`` = "string"; `name`: ``"orbitdb"`` = "orbitdb"; `type`: ``"string"`` = "string" }] ; `name`: ``"registerColonyLabel"`` = "registerColonyLabel"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }] ; `name`: ``"removeRecoveryRole"`` = "removeRecoveryRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setAdministrationRole"`` = "setAdministrationRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setArbitrationRole"`` = "setArbitrationRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setArchitectureRole"`` = "setArchitectureRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_globalClaimDelay"`` = "\_globalClaimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setDefaultGlobalClaimDelay"`` = "setDefaultGlobalClaimDelay"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_claimDelay"`` = "\_claimDelay"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setExpenditureClaimDelay"`` = "setExpenditureClaimDelay"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_claimDelays"`` = "\_claimDelays"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `name`: ``"setExpenditureClaimDelays"`` = "setExpenditureClaimDelays"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"setExpenditureMetadata"`` = "setExpenditureMetadata"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"string"`` = "string"; `name`: ``"_metadata"`` = "\_metadata"; `type`: ``"string"`` = "string" }] ; `name`: ``"setExpenditureMetadata"`` = "setExpenditureMetadata"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setExpenditurePayout"`` = "setExpenditurePayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setExpenditurePayout"`` = "setExpenditurePayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"int256[]"`` = "int256[]"; `name`: ``"_payoutModifiers"`` = "\_payoutModifiers"; `type`: ``"int256[]"`` = "int256[]" }] ; `name`: ``"setExpenditurePayoutModifiers"`` = "setExpenditurePayoutModifiers"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_amounts"`` = "\_amounts"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `name`: ``"setExpenditurePayouts"`` = "setExpenditurePayouts"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address payable"`` = "address payable"; `name`: ``"_recipient"`` = "\_recipient"; `type`: ``"address"`` = "address" }] ; `name`: ``"setExpenditureRecipient"`` = "setExpenditureRecipient"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"address payable[]"`` = "address payable[]"; `name`: ``"_recipients"`` = "\_recipients"; `type`: ``"address[]"`` = "address[]" }] ; `name`: ``"setExpenditureRecipients"`` = "setExpenditureRecipients"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_skillId"`` = "\_skillId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setExpenditureSkill"`` = "setExpenditureSkill"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_slots"`` = "\_slots"; `type`: ``"uint256[]"`` = "uint256[]" }, { `internalType`: ``"uint256[]"`` = "uint256[]"; `name`: ``"_skillIds"`` = "\_skillIds"; `type`: ``"uint256[]"`` = "uint256[]" }] ; `name`: ``"setExpenditureSkills"`` = "setExpenditureSkills"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_storageSlot"`` = "\_storageSlot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool[]"`` = "bool[]"; `name`: ``"_mask"`` = "\_mask"; `type`: ``"bool[]"`` = "bool[]" }, { `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"_keys"`` = "\_keys"; `type`: ``"bytes32[]"`` = "bytes32[]" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"_value"`` = "\_value"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"setExpenditureState"`` = "setExpenditureState"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setFundingRole"`` = "setFundingRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }] ; `name`: ``"setRecoveryRole"`` = "setRecoveryRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_rewardInverse"`` = "\_rewardInverse"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"setRewardInverse"`` = "setRewardInverse"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bool"`` = "bool"; `name`: ``"_setTo"`` = "\_setTo"; `type`: ``"bool"`` = "bool" }] ; `name`: ``"setRootRole"`` = "setRootRole"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_slot"`` = "\_slot"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"_value"`` = "\_value"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"setStorageSlotRecovery"`` = "setStorageSlotRecovery"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"_roles"`` = "\_roles"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"setUserRoles"`` = "setUserRoles"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_token"`` = "\_token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"key"`` = "key"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"value"`` = "value"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"branchMask"`` = "branchMask"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"siblings"`` = "siblings"; `type`: ``"bytes32[]"`` = "bytes32[]" }] ; `name`: ``"startNextRewardPayout"`` = "startNextRewardPayout"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_newOwner"`` = "\_newOwner"; `type`: ``"address"`` = "address" }] ; `name`: ``"transferExpenditure"`` = "transferExpenditure"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_id"`` = "\_id"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_newOwner"`` = "\_newOwner"; `type`: ``"address"`` = "address" }] ; `name`: ``"transferExpenditureViaArbitration"`` = "transferExpenditureViaArbitration"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_obligator"`` = "\_obligator"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_amount"`` = "\_amount"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"address"`` = "address"; `name`: ``"_recipient"`` = "\_recipient"; `type`: ``"address"`` = "address" }] ; `name`: ``"transferStake"`` = "transferStake"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"extensionId"`` = "extensionId"; `type`: ``"bytes32"`` = "bytes32" }] ; `name`: ``"uninstallExtension"`` = "uninstallExtension"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"unlockToken"`` = "unlockToken"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"user"`` = "user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"lockId"`` = "lockId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"unlockTokenForUser"`` = "unlockTokenForUser"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"token"`` = "token"; `type`: ``"address"`` = "address" }, { `internalType`: ``"address"`` = "address"; `name`: ``"spender"`` = "spender"; `type`: ``"address"`` = "address" }] ; `name`: ``"updateApprovalAmount"`` = "updateApprovalAmount"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"string"`` = "string"; `name`: ``"orbitdb"`` = "orbitdb"; `type`: ``"string"`` = "string" }] ; `name`: ``"updateColonyOrbitDB"`` = "updateColonyOrbitDB"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_newVersion"`` = "\_newVersion"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"upgrade"`` = "upgrade"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes32"`` = "bytes32"; `name`: ``"extensionId"`` = "extensionId"; `type`: ``"bytes32"`` = "bytes32" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"newVersion"`` = "newVersion"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"upgradeExtension"`` = "upgradeExtension"; `outputs`: readonly [] = []; `stateMutability`: ``"nonpayable"`` = "nonpayable"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"address"`` = "address"; `name`: ``"_user"`` = "\_user"; `type`: ``"address"`` = "address" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_domainId"`` = "\_domainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childDomainId"`` = "\_childDomainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"userCanSetRoles"`` = "userCanSetRoles"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"canSet"`` = "canSet"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_permissionDomainId"`` = "\_permissionDomainId"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childSkillIndex"`` = "\_childSkillIndex"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"_childDomainId"`` = "\_childDomainId"; `type`: ``"uint256"`` = "uint256" }] ; `name`: ``"validateDomainInheritance"`` = "validateDomainInheritance"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"valid"`` = "valid"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [{ `internalType`: ``"bytes"`` = "bytes"; `name`: ``"key"`` = "key"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"bytes"`` = "bytes"; `name`: ``"value"`` = "value"; `type`: ``"bytes"`` = "bytes" }, { `internalType`: ``"uint256"`` = "uint256"; `name`: ``"branchMask"`` = "branchMask"; `type`: ``"uint256"`` = "uint256" }, { `internalType`: ``"bytes32[]"`` = "bytes32[]"; `name`: ``"siblings"`` = "siblings"; `type`: ``"bytes32[]"`` = "bytes32[]" }] ; `name`: ``"verifyReputationProof"`` = "verifyReputationProof"; `outputs`: readonly [{ `internalType`: ``"bool"`` = "bool"; `name`: ``"isValid"`` = "isValid"; `type`: ``"bool"`` = "bool" }] ; `stateMutability`: ``"view"`` = "view"; `type`: ``"function"`` = "function" }, { `inputs`: readonly [] = []; `name`: ``"version"`` = "version"; `outputs`: readonly [{ `internalType`: ``"uint256"`` = "uint256"; `name`: ``"colonyVersion"`` = "colonyVersion"; `type`: ``"uint256"`` = "uint256" }] ; `stateMutability`: ``"pure"`` = "pure"; `type`: ``"function"`` = "function" }] = `_abi` ## Methods diff --git a/packages/colony-js/docs/api/classes/ColonyTokenFactory.md b/packages/colony-js/docs/api/classes/ColonyTokenFactory.md index 6d291583e..2d94ae7af 100644 --- a/packages/colony-js/docs/api/classes/ColonyTokenFactory.md +++ b/packages/colony-js/docs/api/classes/ColonyTokenFactory.md @@ -62,7 +62,7 @@ ___ ### bytecode -▪ `Static` `Readonly` **bytecode**: ``"0x60c060405234801561001057600080fd5b5060405161205938038061205983398101604081905261002f9161030c565b60008060018161003d6101ab565b6001600160a01b031681526020810191909152604001600090812091909155556100656101ab565b600480546001600160a01b0319166001600160a01b039290921691909117905561008d6101ab565b6001600160a01b03167fce241d7ca1f669fee44b6fc00b8eba2df3bb514eed0f6f668f8f89096e81ed9460405160405180910390a260066100ce8482610414565b5060056100db8382610414565b5060ff81166080526007805460ff1916600117905560405146907f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f90610123906006906104d3565b60408051918290038220828201825260018352603160f81b6020938401528151928301939093528101919091527fc89efdaa54c0f20c7adf612882df0950f5a951637e0307cdcb4c672f298b8bc66060820152608081018290523060a082015260c00160408051601f19818403018152919052805160209091012060a0525061054992505050565b60003633301480156101be575060348110155b1561024757600080368080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525050505082810160131901519091507f02bcc191e283bfba76a1369ec8ba06566f33010645097c104c312753e04935e881146102365733935050505090565b5001516001600160a01b0316919050565b3391505090565b634e487b7160e01b600052604160045260246000fd5b600082601f83011261027557600080fd5b81516001600160401b038082111561028f5761028f61024e565b604051601f8301601f19908116603f011681019082821181831017156102b7576102b761024e565b81604052838152602092508660208588010111156102d457600080fd5b600091505b838210156102f657858201830151818301840152908201906102d9565b6000602085830101528094505050505092915050565b60008060006060848603121561032157600080fd5b83516001600160401b038082111561033857600080fd5b61034487838801610264565b9450602086015191508082111561035a57600080fd5b5061036786828701610264565b925050604084015160ff8116811461037e57600080fd5b809150509250925092565b600181811c9082168061039d57607f821691505b6020821081036103bd57634e487b7160e01b600052602260045260246000fd5b50919050565b601f82111561040f576000816000526020600020601f850160051c810160208610156103ec5750805b601f850160051c820191505b8181101561040b578281556001016103f8565b5050505b505050565b81516001600160401b0381111561042d5761042d61024e565b6104418161043b8454610389565b846103c3565b602080601f831160018114610476576000841561045e5750858301515b600019600386901b1c1916600185901b17855561040b565b600085815260208120601f198616915b828110156104a557888601518255948401946001909101908401610486565b50858210156104c35787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b60008083546104e181610389565b600182811680156104f9576001811461050e5761053d565b60ff198416875282151583028701945061053d565b8760005260208060002060005b858110156105345781548a82015290840190820161051b565b50505082870194505b50929695505050505050565b60805160a051611ae4610575600039600081816102e10152610f890152600061029b0152611ae46000f3fe6080604052600436106101815760003560e01c80637a9e5e4b116100d1578063a69df4b51161008a578063bf7e214f11610064578063bf7e214f146104b1578063cf309012146104d1578063d505accf146104eb578063dd62ed3e1461050b57600080fd5b8063a69df4b51461047c578063a9059cbb14610491578063b3eac1d8146103b957600080fd5b80637a9e5e4b146103995780637ecebe00146103b95780638da5cb5b146103ef57806395d89b41146104275780639dc29fac1461043c578063a0712d681461045c57600080fd5b806330adf81f1161013e57806340c10f191161011857806340c10f191461030357806342966c68146103235780636281133d1461034357806370a082311461036357600080fd5b806330adf81f14610255578063313ce567146102895780633644e515146102cf57600080fd5b806306fdde0314610186578063095ea7b3146101b15780630c53c51c146101e157806313af4035146101f457806318160ddd1461021657806323b872dd14610235575b600080fd5b34801561019257600080fd5b5061019b610551565b6040516101a891906115b2565b60405180910390f35b3480156101bd57600080fd5b506101d16101cc3660046115da565b6105df565b60405190151581526020016101a8565b61019b6101ef3660046116bf565b610672565b34801561020057600080fd5b5061021461020f366004611733565b61085b565b005b34801561022257600080fd5b506000545b6040519081526020016101a8565b34801561024157600080fd5b506101d1610250366004611750565b6108de565b34801561026157600080fd5b506102277f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c981565b34801561029557600080fd5b506102bd7f000000000000000000000000000000000000000000000000000000000000000081565b60405160ff90911681526020016101a8565b3480156102db57600080fd5b506102277f000000000000000000000000000000000000000000000000000000000000000081565b34801561030f57600080fd5b5061021461031e3660046115da565b610952565b34801561032f57600080fd5b5061021461033e366004611791565b610a41565b34801561034f57600080fd5b506101d161035e3660046117aa565b610a55565b34801561036f57600080fd5b5061022761037e366004611733565b6001600160a01b031660009081526001602052604090205490565b3480156103a557600080fd5b506102146103b4366004611733565b610ba9565b3480156103c557600080fd5b506102276103d4366004611733565b6001600160a01b031660009081526008602052604090205490565b3480156103fb57600080fd5b5060045461040f906001600160a01b031681565b6040516001600160a01b0390911681526020016101a8565b34801561043357600080fd5b5061019b610c1a565b34801561044857600080fd5b506102146104573660046115da565b610c27565b34801561046857600080fd5b50610214610477366004611791565b610e1e565b34801561048857600080fd5b50610214610e56565b34801561049d57600080fd5b506101d16104ac3660046115da565b610e89565b3480156104bd57600080fd5b5060035461040f906001600160a01b031681565b3480156104dd57600080fd5b506007546101d19060ff1681565b3480156104f757600080fd5b50610214610506366004611831565b610ea4565b34801561051757600080fd5b5061022761052636600461189f565b6001600160a01b03918216600090815260026020908152604080832093909416825291909152205490565b6006805461055e906118d8565b80601f016020809104026020016040519081016040528092919081815260200182805461058a906118d8565b80156105d75780601f106105ac576101008083540402835291602001916105d7565b820191906000526020600020905b8154815290600101906020018083116105ba57829003601f168201915b505050505081565b600081600260006105ee611193565b6001600160a01b0390811682526020808301939093526040918201600090812091881680825291909352912091909155610626611193565b6001600160a01b03167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9258460405161066091815260200190565b60405180910390a35060015b92915050565b60606106a186610697886001600160a01b031660009081526008602052604090205490565b4688888888610a55565b6107045760405162461bcd60e51b815260206004820152602960248201527f6d6574617472616e73616374696f6e2d7369676e65722d7369676e617475726560448201526805adad2e6dac2e8c6d60bb1b60648201526084015b60405180910390fd5b61070d86611236565b600080306001600160a01b0316877f02bcc191e283bfba76a1369ec8ba06566f33010645097c104c312753e04935e88a60405160200161074f93929190611912565b60408051601f19818403018152908290526107699161194b565b6000604051808303816000865af19150503d80600081146107a6576040519150601f19603f3d011682016040523d82523d6000602084013e6107ab565b606091505b50915091508161080e5760405162461bcd60e51b815260206004820152602860248201527f636f6c6f6e792d6d65746174782d66756e6374696f6e2d63616c6c2d756e737560448201526718d8d95cdcd99d5b60c21b60648201526084016106fb565b7f5845892132946850460bff5a0083f71031bc5bf9aadcd40f1de79423eac9b10b88610838611193565b8960405161084893929190611967565b60405180910390a1979650505050505050565b610878610866611193565b6000356001600160e01b031916611262565b6108945760405162461bcd60e51b81526004016106fb9061199c565b600480546001600160a01b0319166001600160a01b0383169081179091556040517fce241d7ca1f669fee44b6fc00b8eba2df3bb514eed0f6f668f8f89096e81ed9490600090a250565b60075460009060ff161561093f576108f7610866611193565b61093f5760405162461bcd60e51b815260206004820152601960248201527818dbdb1bdb9e4b5d1bdad95b8b5d5b985d5d1a1bdc9a5cd959603a1b60448201526064016106fb565b61094a84848461133d565b949350505050565b61095d610866611193565b6109795760405162461bcd60e51b81526004016106fb9061199c565b6001600160a01b038216600090815260016020526040812080548392906109a19084906119e0565b92505081905550806000808282546109b991906119e0565b90915550506040518181526001600160a01b038316907f0f6798a560793a54c3bcfe86a93cde1e73087d944c0ea20544137d41213968859060200160405180910390a26040518181526001600160a01b038316906000907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9060200160405180910390a35050565b610a52610a4c611193565b82610c27565b50565b600080610ad288308989604051602001610a7294939291906119f3565b60408051601f1981840301815282825280516020918201207f19457468657265756d205369676e6564204d6573736167653a0a33320000000084830152603c8085019190915282518085039091018152605c909301909152815191012090565b6040805160008082526020820180845284905260ff87169282019290925260608101889052608081018790529192509060019060a0016020604051602081039080840390855afa158015610b2a573d6000803e3d6000fd5b5050604051601f1901519150506001600160a01b038116610b8d5760405162461bcd60e51b815260206004820152601f60248201527f636f6c6f6e792d6d65746174782d696e76616c69642d7369676e61747572650060448201526064016106fb565b6001600160a01b038a8116911614915050979650505050505050565b610bb4610866611193565b610bd05760405162461bcd60e51b81526004016106fb9061199c565b600380546001600160a01b0319166001600160a01b0383169081179091556040517f1abebea81bfa2637f28358c371278fb15ede7ea8dd28d2e03b112ff6d936ada490600090a250565b6005805461055e906118d8565b610c2f611193565b6001600160a01b0316826001600160a01b031614610d2f576001600160a01b03821660009081526002602052604081208291610c69611193565b6001600160a01b03166001600160a01b03168152602001908152602001600020541015610cd85760405162461bcd60e51b815260206004820152601e60248201527f64732d746f6b656e2d696e73756666696369656e742d617070726f76616c000060448201526064016106fb565b6001600160a01b03821660009081526002602052604081208291610cfa611193565b6001600160a01b03166001600160a01b031681526020019081526020016000206000828254610d299190611a39565b90915550505b6001600160a01b038216600090815260016020526040902054811115610d975760405162461bcd60e51b815260206004820152601d60248201527f64732d746f6b656e2d696e73756666696369656e742d62616c616e636500000060448201526064016106fb565b6001600160a01b03821660009081526001602052604081208054839290610dbf908490611a39565b9250508190555080600080828254610dd79190611a39565b90915550506040518181526001600160a01b038316907fcc16f5dbb4873280815c1ee09dbd06736cffcc184412cf7a71a0fdb75d397ca59060200160405180910390a25050565b610e29610866611193565b610e455760405162461bcd60e51b81526004016106fb9061199c565b610a52610e50611193565b82610952565b610e61610866611193565b610e7d5760405162461bcd60e51b81526004016106fb9061199c565b6007805460ff19169055565b6000610e9d610e96611193565b84846108de565b9392505050565b60075460ff1615610f0257610eba610866611193565b610f025760405162461bcd60e51b815260206004820152601960248201527818dbdb1bdb9e4b5d1bdad95b8b5d5b985d5d1a1bdc9a5cd959603a1b60448201526064016106fb565b42841015610f525760405162461bcd60e51b815260206004820152601d60248201527f636f6c6f6e792d746f6b656e2d657870697265642d646561646c696e6500000060448201526064016106fb565b6040805180820182526002815261190160f01b6020808301919091526001600160a01b038a166000908152600890915291822080547f0000000000000000000000000000000000000000000000000000000000000000917f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9918c918c918c9188610fdb83611a4c565b909155506040805160208101969096526001600160a01b0394851690860152929091166060840152608083015260a082015260c0810188905260e0016040516020818303038152906040528051906020012060405160200161103f93929190611a65565b60408051601f198184030181528282528051602091820120600080855291840180845281905260ff88169284019290925260608301869052608083018590529092509060019060a0016020604051602081039080840390855afa1580156110aa573d6000803e3d6000fd5b5050604051601f1901519150506001600160a01b038116158015906110e05750886001600160a01b0316816001600160a01b0316145b61112c5760405162461bcd60e51b815260206004820152601e60248201527f636f6c6f6e792d746f6b656e2d696e76616c69642d7369676e6174757265000060448201526064016106fb565b6001600160a01b038981166000818152600260209081526040808320948d16808452948252918290208b905590518a81527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925910160405180910390a3505050505050505050565b60003633301480156111a6575060348110155b1561122f57600080368080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525050505082810160131901519091507f02bcc191e283bfba76a1369ec8ba06566f33010645097c104c312753e04935e8811461121e5733935050505090565b5001516001600160a01b0316919050565b3391505090565b6001600160a01b038116600090815260086020526040812080549161125a83611a4c565b919050555050565b6000306001600160a01b0384160361127c5750600161066c565b6004546001600160a01b039081169084160361129a5750600161066c565b6003546001600160a01b03166112b25750600061066c565b60035460405163b700961360e01b81526001600160a01b0385811660048301523060248301526001600160e01b0319851660448301529091169063b700961390606401602060405180830381865afa158015611312573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906113369190611a8c565b905061066c565b6000611347611193565b6001600160a01b0316846001600160a01b031614611447576001600160a01b03841660009081526002602052604081208391611381611193565b6001600160a01b03166001600160a01b031681526020019081526020016000205410156113f05760405162461bcd60e51b815260206004820152601e60248201527f64732d746f6b656e2d696e73756666696369656e742d617070726f76616c000060448201526064016106fb565b6001600160a01b03841660009081526002602052604081208391611412611193565b6001600160a01b03166001600160a01b0316815260200190815260200160002060008282546114419190611a39565b90915550505b6001600160a01b0384166000908152600160205260409020548211156114af5760405162461bcd60e51b815260206004820152601d60248201527f64732d746f6b656e2d696e73756666696369656e742d62616c616e636500000060448201526064016106fb565b6001600160a01b038416600090815260016020526040812080548492906114d7908490611a39565b90915550506001600160a01b038316600090815260016020526040812080548492906115049084906119e0565b92505081905550826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8460405161155091815260200190565b60405180910390a35060019392505050565b60005b8381101561157d578181015183820152602001611565565b50506000910152565b6000815180845261159e816020860160208601611562565b601f01601f19169290920160200192915050565b602081526000610e9d6020830184611586565b6001600160a01b0381168114610a5257600080fd5b600080604083850312156115ed57600080fd5b82356115f8816115c5565b946020939093013593505050565b634e487b7160e01b600052604160045260246000fd5b600082601f83011261162d57600080fd5b813567ffffffffffffffff8082111561164857611648611606565b604051601f8301601f19908116603f0116810190828211818310171561167057611670611606565b8160405283815286602085880101111561168957600080fd5b836020870160208301376000602085830101528094505050505092915050565b803560ff811681146116ba57600080fd5b919050565b600080600080600060a086880312156116d757600080fd5b85356116e2816115c5565b9450602086013567ffffffffffffffff8111156116fe57600080fd5b61170a8882890161161c565b9450506040860135925060608601359150611727608087016116a9565b90509295509295909350565b60006020828403121561174557600080fd5b8135610e9d816115c5565b60008060006060848603121561176557600080fd5b8335611770816115c5565b92506020840135611780816115c5565b929592945050506040919091013590565b6000602082840312156117a357600080fd5b5035919050565b600080600080600080600060e0888a0312156117c557600080fd5b87356117d0816115c5565b96506020880135955060408801359450606088013567ffffffffffffffff8111156117fa57600080fd5b6118068a828b0161161c565b9450506080880135925060a0880135915061182360c089016116a9565b905092959891949750929550565b600080600080600080600060e0888a03121561184c57600080fd5b8735611857816115c5565b96506020880135611867816115c5565b95506040880135945060608801359350611883608089016116a9565b925060a0880135915060c0880135905092959891949750929550565b600080604083850312156118b257600080fd5b82356118bd816115c5565b915060208301356118cd816115c5565b809150509250929050565b600181811c908216806118ec57607f821691505b60208210810361190c57634e487b7160e01b600052602260045260246000fd5b50919050565b60008451611924818460208901611562565b919091019283525060601b6bffffffffffffffffffffffff19166020820152603401919050565b6000825161195d818460208701611562565b9190910192915050565b6001600160a01b0384811682528316602082015260606040820181905260009061199390830184611586565b95945050505050565b602080825260149082015273191ccb585d5d1a0b5d5b985d5d1a1bdc9a5e995960621b604082015260600190565b634e487b7160e01b600052601160045260246000fd5b8082018082111561066c5761066c6119ca565b8481526bffffffffffffffffffffffff198460601b16602082015282603482015260008251611a29816054850160208701611562565b9190910160540195945050505050565b8181038181111561066c5761066c6119ca565b600060018201611a5e57611a5e6119ca565b5060010190565b60008451611a77818460208901611562565b91909101928352506020820152604001919050565b600060208284031215611a9e57600080fd5b81518015158114610e9d57600080fdfea2646970667358221220aeaaf2ee112cbd28c3bc4f4375bfff931deac6b71f509503ef3ddc3cc53b255664736f6c63430008190033"`` +▪ `Static` `Readonly` **bytecode**: ``"0x60c060405234801561001057600080fd5b5060405161205938038061205983398101604081905261002f9161030c565b60008060018161003d6101ab565b6001600160a01b031681526020810191909152604001600090812091909155556100656101ab565b600480546001600160a01b0319166001600160a01b039290921691909117905561008d6101ab565b6001600160a01b03167fce241d7ca1f669fee44b6fc00b8eba2df3bb514eed0f6f668f8f89096e81ed9460405160405180910390a260066100ce8482610414565b5060056100db8382610414565b5060ff81166080526007805460ff1916600117905560405146907f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f90610123906006906104d3565b60408051918290038220828201825260018352603160f81b6020938401528151928301939093528101919091527fc89efdaa54c0f20c7adf612882df0950f5a951637e0307cdcb4c672f298b8bc66060820152608081018290523060a082015260c00160408051601f19818403018152919052805160209091012060a0525061054992505050565b60003633301480156101be575060348110155b1561024757600080368080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525050505082810160131901519091507f02bcc191e283bfba76a1369ec8ba06566f33010645097c104c312753e04935e881146102365733935050505090565b5001516001600160a01b0316919050565b3391505090565b634e487b7160e01b600052604160045260246000fd5b600082601f83011261027557600080fd5b81516001600160401b038082111561028f5761028f61024e565b604051601f8301601f19908116603f011681019082821181831017156102b7576102b761024e565b81604052838152602092508660208588010111156102d457600080fd5b600091505b838210156102f657858201830151818301840152908201906102d9565b6000602085830101528094505050505092915050565b60008060006060848603121561032157600080fd5b83516001600160401b038082111561033857600080fd5b61034487838801610264565b9450602086015191508082111561035a57600080fd5b5061036786828701610264565b925050604084015160ff8116811461037e57600080fd5b809150509250925092565b600181811c9082168061039d57607f821691505b6020821081036103bd57634e487b7160e01b600052602260045260246000fd5b50919050565b601f82111561040f576000816000526020600020601f850160051c810160208610156103ec5750805b601f850160051c820191505b8181101561040b578281556001016103f8565b5050505b505050565b81516001600160401b0381111561042d5761042d61024e565b6104418161043b8454610389565b846103c3565b602080601f831160018114610476576000841561045e5750858301515b600019600386901b1c1916600185901b17855561040b565b600085815260208120601f198616915b828110156104a557888601518255948401946001909101908401610486565b50858210156104c35787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b60008083546104e181610389565b600182811680156104f9576001811461050e5761053d565b60ff198416875282151583028701945061053d565b8760005260208060002060005b858110156105345781548a82015290840190820161051b565b50505082870194505b50929695505050505050565b60805160a051611ae4610575600039600081816102e10152610f890152600061029b0152611ae46000f3fe6080604052600436106101815760003560e01c80637a9e5e4b116100d1578063a69df4b51161008a578063bf7e214f11610064578063bf7e214f146104b1578063cf309012146104d1578063d505accf146104eb578063dd62ed3e1461050b57600080fd5b8063a69df4b51461047c578063a9059cbb14610491578063b3eac1d8146103b957600080fd5b80637a9e5e4b146103995780637ecebe00146103b95780638da5cb5b146103ef57806395d89b41146104275780639dc29fac1461043c578063a0712d681461045c57600080fd5b806330adf81f1161013e57806340c10f191161011857806340c10f191461030357806342966c68146103235780636281133d1461034357806370a082311461036357600080fd5b806330adf81f14610255578063313ce567146102895780633644e515146102cf57600080fd5b806306fdde0314610186578063095ea7b3146101b15780630c53c51c146101e157806313af4035146101f457806318160ddd1461021657806323b872dd14610235575b600080fd5b34801561019257600080fd5b5061019b610551565b6040516101a891906115b2565b60405180910390f35b3480156101bd57600080fd5b506101d16101cc3660046115da565b6105df565b60405190151581526020016101a8565b61019b6101ef3660046116bf565b610672565b34801561020057600080fd5b5061021461020f366004611733565b61085b565b005b34801561022257600080fd5b506000545b6040519081526020016101a8565b34801561024157600080fd5b506101d1610250366004611750565b6108de565b34801561026157600080fd5b506102277f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c981565b34801561029557600080fd5b506102bd7f000000000000000000000000000000000000000000000000000000000000000081565b60405160ff90911681526020016101a8565b3480156102db57600080fd5b506102277f000000000000000000000000000000000000000000000000000000000000000081565b34801561030f57600080fd5b5061021461031e3660046115da565b610952565b34801561032f57600080fd5b5061021461033e366004611791565b610a41565b34801561034f57600080fd5b506101d161035e3660046117aa565b610a55565b34801561036f57600080fd5b5061022761037e366004611733565b6001600160a01b031660009081526001602052604090205490565b3480156103a557600080fd5b506102146103b4366004611733565b610ba9565b3480156103c557600080fd5b506102276103d4366004611733565b6001600160a01b031660009081526008602052604090205490565b3480156103fb57600080fd5b5060045461040f906001600160a01b031681565b6040516001600160a01b0390911681526020016101a8565b34801561043357600080fd5b5061019b610c1a565b34801561044857600080fd5b506102146104573660046115da565b610c27565b34801561046857600080fd5b50610214610477366004611791565b610e1e565b34801561048857600080fd5b50610214610e56565b34801561049d57600080fd5b506101d16104ac3660046115da565b610e89565b3480156104bd57600080fd5b5060035461040f906001600160a01b031681565b3480156104dd57600080fd5b506007546101d19060ff1681565b3480156104f757600080fd5b50610214610506366004611831565b610ea4565b34801561051757600080fd5b5061022761052636600461189f565b6001600160a01b03918216600090815260026020908152604080832093909416825291909152205490565b6006805461055e906118d8565b80601f016020809104026020016040519081016040528092919081815260200182805461058a906118d8565b80156105d75780601f106105ac576101008083540402835291602001916105d7565b820191906000526020600020905b8154815290600101906020018083116105ba57829003601f168201915b505050505081565b600081600260006105ee611193565b6001600160a01b0390811682526020808301939093526040918201600090812091881680825291909352912091909155610626611193565b6001600160a01b03167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9258460405161066091815260200190565b60405180910390a35060015b92915050565b60606106a186610697886001600160a01b031660009081526008602052604090205490565b4688888888610a55565b6107045760405162461bcd60e51b815260206004820152602960248201527f6d6574617472616e73616374696f6e2d7369676e65722d7369676e617475726560448201526805adad2e6dac2e8c6d60bb1b60648201526084015b60405180910390fd5b61070d86611236565b600080306001600160a01b0316877f02bcc191e283bfba76a1369ec8ba06566f33010645097c104c312753e04935e88a60405160200161074f93929190611912565b60408051601f19818403018152908290526107699161194b565b6000604051808303816000865af19150503d80600081146107a6576040519150601f19603f3d011682016040523d82523d6000602084013e6107ab565b606091505b50915091508161080e5760405162461bcd60e51b815260206004820152602860248201527f636f6c6f6e792d6d65746174782d66756e6374696f6e2d63616c6c2d756e737560448201526718d8d95cdcd99d5b60c21b60648201526084016106fb565b7f5845892132946850460bff5a0083f71031bc5bf9aadcd40f1de79423eac9b10b88610838611193565b8960405161084893929190611967565b60405180910390a1979650505050505050565b610878610866611193565b6000356001600160e01b031916611262565b6108945760405162461bcd60e51b81526004016106fb9061199c565b600480546001600160a01b0319166001600160a01b0383169081179091556040517fce241d7ca1f669fee44b6fc00b8eba2df3bb514eed0f6f668f8f89096e81ed9490600090a250565b60075460009060ff161561093f576108f7610866611193565b61093f5760405162461bcd60e51b815260206004820152601960248201527818dbdb1bdb9e4b5d1bdad95b8b5d5b985d5d1a1bdc9a5cd959603a1b60448201526064016106fb565b61094a84848461133d565b949350505050565b61095d610866611193565b6109795760405162461bcd60e51b81526004016106fb9061199c565b6001600160a01b038216600090815260016020526040812080548392906109a19084906119e0565b92505081905550806000808282546109b991906119e0565b90915550506040518181526001600160a01b038316907f0f6798a560793a54c3bcfe86a93cde1e73087d944c0ea20544137d41213968859060200160405180910390a26040518181526001600160a01b038316906000907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9060200160405180910390a35050565b610a52610a4c611193565b82610c27565b50565b600080610ad288308989604051602001610a7294939291906119f3565b60408051601f1981840301815282825280516020918201207f19457468657265756d205369676e6564204d6573736167653a0a33320000000084830152603c8085019190915282518085039091018152605c909301909152815191012090565b6040805160008082526020820180845284905260ff87169282019290925260608101889052608081018790529192509060019060a0016020604051602081039080840390855afa158015610b2a573d6000803e3d6000fd5b5050604051601f1901519150506001600160a01b038116610b8d5760405162461bcd60e51b815260206004820152601f60248201527f636f6c6f6e792d6d65746174782d696e76616c69642d7369676e61747572650060448201526064016106fb565b6001600160a01b038a8116911614915050979650505050505050565b610bb4610866611193565b610bd05760405162461bcd60e51b81526004016106fb9061199c565b600380546001600160a01b0319166001600160a01b0383169081179091556040517f1abebea81bfa2637f28358c371278fb15ede7ea8dd28d2e03b112ff6d936ada490600090a250565b6005805461055e906118d8565b610c2f611193565b6001600160a01b0316826001600160a01b031614610d2f576001600160a01b03821660009081526002602052604081208291610c69611193565b6001600160a01b03166001600160a01b03168152602001908152602001600020541015610cd85760405162461bcd60e51b815260206004820152601e60248201527f64732d746f6b656e2d696e73756666696369656e742d617070726f76616c000060448201526064016106fb565b6001600160a01b03821660009081526002602052604081208291610cfa611193565b6001600160a01b03166001600160a01b031681526020019081526020016000206000828254610d299190611a39565b90915550505b6001600160a01b038216600090815260016020526040902054811115610d975760405162461bcd60e51b815260206004820152601d60248201527f64732d746f6b656e2d696e73756666696369656e742d62616c616e636500000060448201526064016106fb565b6001600160a01b03821660009081526001602052604081208054839290610dbf908490611a39565b9250508190555080600080828254610dd79190611a39565b90915550506040518181526001600160a01b038316907fcc16f5dbb4873280815c1ee09dbd06736cffcc184412cf7a71a0fdb75d397ca59060200160405180910390a25050565b610e29610866611193565b610e455760405162461bcd60e51b81526004016106fb9061199c565b610a52610e50611193565b82610952565b610e61610866611193565b610e7d5760405162461bcd60e51b81526004016106fb9061199c565b6007805460ff19169055565b6000610e9d610e96611193565b84846108de565b9392505050565b60075460ff1615610f0257610eba610866611193565b610f025760405162461bcd60e51b815260206004820152601960248201527818dbdb1bdb9e4b5d1bdad95b8b5d5b985d5d1a1bdc9a5cd959603a1b60448201526064016106fb565b42841015610f525760405162461bcd60e51b815260206004820152601d60248201527f636f6c6f6e792d746f6b656e2d657870697265642d646561646c696e6500000060448201526064016106fb565b6040805180820182526002815261190160f01b6020808301919091526001600160a01b038a166000908152600890915291822080547f0000000000000000000000000000000000000000000000000000000000000000917f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9918c918c918c9188610fdb83611a4c565b909155506040805160208101969096526001600160a01b0394851690860152929091166060840152608083015260a082015260c0810188905260e0016040516020818303038152906040528051906020012060405160200161103f93929190611a65565b60408051601f198184030181528282528051602091820120600080855291840180845281905260ff88169284019290925260608301869052608083018590529092509060019060a0016020604051602081039080840390855afa1580156110aa573d6000803e3d6000fd5b5050604051601f1901519150506001600160a01b038116158015906110e05750886001600160a01b0316816001600160a01b0316145b61112c5760405162461bcd60e51b815260206004820152601e60248201527f636f6c6f6e792d746f6b656e2d696e76616c69642d7369676e6174757265000060448201526064016106fb565b6001600160a01b038981166000818152600260209081526040808320948d16808452948252918290208b905590518a81527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925910160405180910390a3505050505050505050565b60003633301480156111a6575060348110155b1561122f57600080368080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525050505082810160131901519091507f02bcc191e283bfba76a1369ec8ba06566f33010645097c104c312753e04935e8811461121e5733935050505090565b5001516001600160a01b0316919050565b3391505090565b6001600160a01b038116600090815260086020526040812080549161125a83611a4c565b919050555050565b6000306001600160a01b0384160361127c5750600161066c565b6004546001600160a01b039081169084160361129a5750600161066c565b6003546001600160a01b03166112b25750600061066c565b60035460405163b700961360e01b81526001600160a01b0385811660048301523060248301526001600160e01b0319851660448301529091169063b700961390606401602060405180830381865afa158015611312573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906113369190611a8c565b905061066c565b6000611347611193565b6001600160a01b0316846001600160a01b031614611447576001600160a01b03841660009081526002602052604081208391611381611193565b6001600160a01b03166001600160a01b031681526020019081526020016000205410156113f05760405162461bcd60e51b815260206004820152601e60248201527f64732d746f6b656e2d696e73756666696369656e742d617070726f76616c000060448201526064016106fb565b6001600160a01b03841660009081526002602052604081208391611412611193565b6001600160a01b03166001600160a01b0316815260200190815260200160002060008282546114419190611a39565b90915550505b6001600160a01b0384166000908152600160205260409020548211156114af5760405162461bcd60e51b815260206004820152601d60248201527f64732d746f6b656e2d696e73756666696369656e742d62616c616e636500000060448201526064016106fb565b6001600160a01b038416600090815260016020526040812080548492906114d7908490611a39565b90915550506001600160a01b038316600090815260016020526040812080548492906115049084906119e0565b92505081905550826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8460405161155091815260200190565b60405180910390a35060019392505050565b60005b8381101561157d578181015183820152602001611565565b50506000910152565b6000815180845261159e816020860160208601611562565b601f01601f19169290920160200192915050565b602081526000610e9d6020830184611586565b6001600160a01b0381168114610a5257600080fd5b600080604083850312156115ed57600080fd5b82356115f8816115c5565b946020939093013593505050565b634e487b7160e01b600052604160045260246000fd5b600082601f83011261162d57600080fd5b813567ffffffffffffffff8082111561164857611648611606565b604051601f8301601f19908116603f0116810190828211818310171561167057611670611606565b8160405283815286602085880101111561168957600080fd5b836020870160208301376000602085830101528094505050505092915050565b803560ff811681146116ba57600080fd5b919050565b600080600080600060a086880312156116d757600080fd5b85356116e2816115c5565b9450602086013567ffffffffffffffff8111156116fe57600080fd5b61170a8882890161161c565b9450506040860135925060608601359150611727608087016116a9565b90509295509295909350565b60006020828403121561174557600080fd5b8135610e9d816115c5565b60008060006060848603121561176557600080fd5b8335611770816115c5565b92506020840135611780816115c5565b929592945050506040919091013590565b6000602082840312156117a357600080fd5b5035919050565b600080600080600080600060e0888a0312156117c557600080fd5b87356117d0816115c5565b96506020880135955060408801359450606088013567ffffffffffffffff8111156117fa57600080fd5b6118068a828b0161161c565b9450506080880135925060a0880135915061182360c089016116a9565b905092959891949750929550565b600080600080600080600060e0888a03121561184c57600080fd5b8735611857816115c5565b96506020880135611867816115c5565b95506040880135945060608801359350611883608089016116a9565b925060a0880135915060c0880135905092959891949750929550565b600080604083850312156118b257600080fd5b82356118bd816115c5565b915060208301356118cd816115c5565b809150509250929050565b600181811c908216806118ec57607f821691505b60208210810361190c57634e487b7160e01b600052602260045260246000fd5b50919050565b60008451611924818460208901611562565b919091019283525060601b6bffffffffffffffffffffffff19166020820152603401919050565b6000825161195d818460208701611562565b9190910192915050565b6001600160a01b0384811682528316602082015260606040820181905260009061199390830184611586565b95945050505050565b602080825260149082015273191ccb585d5d1a0b5d5b985d5d1a1bdc9a5e995960621b604082015260600190565b634e487b7160e01b600052601160045260246000fd5b8082018082111561066c5761066c6119ca565b8481526bffffffffffffffffffffffff198460601b16602082015282603482015260008251611a29816054850160208701611562565b9190910160540195945050505050565b8181038181111561066c5761066c6119ca565b600060018201611a5e57611a5e6119ca565b5060010190565b60008451611a77818460208901611562565b91909101928352506020820152604001919050565b600060208284031215611a9e57600080fd5b81518015158114610e9d57600080fdfea26469706673582212207a2e26845af2fe425fbad6b846e23f03aed61e8b37f1083e7b67aa26da68f8a764736f6c63430008190033"`` ## Methods diff --git a/packages/colony-js/docs/api/interfaces/ColonyClientV10.md b/packages/colony-js/docs/api/interfaces/ColonyClientV10.md deleted file mode 100644 index c10516e8b..000000000 --- a/packages/colony-js/docs/api/interfaces/ColonyClientV10.md +++ /dev/null @@ -1,8802 +0,0 @@ -# Interface: ColonyClientV10 - -## Hierarchy - -- `AugmentedIColony`<`IColony`\> - -- `ColonyAugmentsV3`<`IColony`\> - -- `ColonyAugmentsV4`<`IColony`\> - -- `ColonyAugmentsV5`<`IColony`\> - -- `ColonyAugmentsV6`<`IColony`\> - -- `ColonyAugmentsV7`<`IColony`\> - -- `AddDomainAugmentsB`<`IColony`\> - -- `MoveFundsBetweenPotsAugmentsB`<`IColony`\> - - ↳ **`ColonyClientV10`** - -## 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`](../enums/ClientType.md#colonyclient) - -#### Inherited from - -AugmentedIColony.clientType - -___ - -### clientVersion - -• **clientVersion**: ``10`` - -#### 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**: `ColonyClientV10Estimate` - -#### Overrides - -AugmentedIColony.estimateGas - -___ - -### filters - -• **filters**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Annotation` | (`agent?`: ``null`` \| `string`, `txHash?`: ``null`` \| `BytesLike`, `metadata?`: ``null``) => `AnnotationEventFilter` | -| `Annotation(address,bytes32,string)` | (`agent?`: ``null`` \| `string`, `txHash?`: ``null`` \| `BytesLike`, `metadata?`: ``null``) => `AnnotationEventFilter` | -| `ArbitraryReputationUpdate` | (`agent?`: ``null``, `user?`: ``null``, `skillId?`: ``null``, `amount?`: ``null``) => `ArbitraryReputationUpdateEventFilter` | -| `ArbitraryReputationUpdate(address,address,uint256,int256)` | (`agent?`: ``null``, `user?`: ``null``, `skillId?`: ``null``, `amount?`: ``null``) => `ArbitraryReputationUpdateEventFilter` | -| `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`` \| `BigNumberish`, `toPot?`: ``null`` \| `BigNumberish`, `amount?`: ``null``, `token?`: ``null``) => `ColonyFundsMovedBetweenFundingPotsEventFilter` | -| `ColonyFundsMovedBetweenFundingPots(address,uint256,uint256,uint256,address)` | (`agent?`: ``null``, `fromPot?`: ``null`` \| `BigNumberish`, `toPot?`: ``null`` \| `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` | -| `ColonyMetadataDelta` | (`agent?`: ``null``, `metadata?`: ``null``) => `ColonyMetadataDeltaEventFilter` | -| `ColonyMetadataDelta(address,string)` | (`agent?`: ``null``, `metadata?`: ``null``) => `ColonyMetadataDeltaEventFilter` | -| `ColonyRewardInverseSet` | (`agent?`: ``null``, `rewardInverse?`: ``null``) => `ColonyRewardInverseSetEventFilter` | -| `ColonyRewardInverseSet(address,uint256)` | (`agent?`: ``null``, `rewardInverse?`: ``null``) => `ColonyRewardInverseSetEventFilter` | -| `ColonyRoleSet` | (`agent?`: ``null``, `user?`: ``null`` \| `string`, `domainId?`: ``null`` \| `BigNumberish`, `role?`: ``null`` \| `BigNumberish`, `setTo?`: ``null``) => `ColonyRoleSetEventFilter` | -| `ColonyRoleSet(address,address,uint256,uint8,bool)` | (`agent?`: ``null``, `user?`: ``null`` \| `string`, `domainId?`: ``null`` \| `BigNumberish`, `role?`: ``null`` \| `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` | -| `DomainDeprecated` | (`agent?`: ``null``, `domainId?`: ``null`` \| `BigNumberish`, `deprecated?`: ``null``) => `DomainDeprecatedEventFilter` | -| `DomainDeprecated(address,uint256,bool)` | (`agent?`: ``null``, `domainId?`: ``null`` \| `BigNumberish`, `deprecated?`: ``null``) => `DomainDeprecatedEventFilter` | -| `DomainMetadata` | (`agent?`: ``null``, `domainId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => `DomainMetadataEventFilter` | -| `DomainMetadata(address,uint256,string)` | (`agent?`: ``null``, `domainId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => `DomainMetadataEventFilter` | -| `ExpenditureAdded` | (`agent?`: ``null``, `expenditureId?`: ``null``) => `ExpenditureAddedEventFilter` | -| `ExpenditureAdded(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null``) => `ExpenditureAddedEventFilter` | -| `ExpenditureCancelled` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => `ExpenditureCancelledEventFilter` | -| `ExpenditureCancelled(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => `ExpenditureCancelledEventFilter` | -| `ExpenditureClaimDelaySet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `claimDelay?`: ``null``) => `ExpenditureClaimDelaySetEventFilter` | -| `ExpenditureClaimDelaySet(address,uint256,uint256,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `claimDelay?`: ``null``) => `ExpenditureClaimDelaySetEventFilter` | -| `ExpenditureFinalized` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => `ExpenditureFinalizedEventFilter` | -| `ExpenditureFinalized(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => `ExpenditureFinalizedEventFilter` | -| `ExpenditureGlobalClaimDelaySet` | (`agent?`: ``null``, `globalClaimDelay?`: ``null``) => `ExpenditureGlobalClaimDelaySetEventFilter` | -| `ExpenditureGlobalClaimDelaySet(address,uint256)` | (`agent?`: ``null``, `globalClaimDelay?`: ``null``) => `ExpenditureGlobalClaimDelaySetEventFilter` | -| `ExpenditureLocked` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => `ExpenditureLockedEventFilter` | -| `ExpenditureLocked(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => `ExpenditureLockedEventFilter` | -| `ExpenditureMetadataSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => `ExpenditureMetadataSetEventFilter` | -| `ExpenditureMetadataSet(address,uint256,string)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => `ExpenditureMetadataSetEventFilter` | -| `ExpenditurePayoutModifierSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `payoutModifier?`: ``null``) => `ExpenditurePayoutModifierSetEventFilter` | -| `ExpenditurePayoutModifierSet(address,uint256,uint256,int256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `payoutModifier?`: ``null``) => `ExpenditurePayoutModifierSetEventFilter` | -| `ExpenditurePayoutSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `token?`: ``null`` \| `string`, `amount?`: ``null``) => `ExpenditurePayoutSetEventFilter` | -| `ExpenditurePayoutSet(address,uint256,uint256,address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `token?`: ``null`` \| `string`, `amount?`: ``null``) => `ExpenditurePayoutSetEventFilter` | -| `ExpenditureRecipientSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `recipient?`: ``null`` \| `string`) => `ExpenditureRecipientSetEventFilter` | -| `ExpenditureRecipientSet(address,uint256,uint256,address)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `recipient?`: ``null`` \| `string`) => `ExpenditureRecipientSetEventFilter` | -| `ExpenditureSkillSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `skillId?`: ``null`` \| `BigNumberish`) => `ExpenditureSkillSetEventFilter` | -| `ExpenditureSkillSet(address,uint256,uint256,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `skillId?`: ``null`` \| `BigNumberish`) => `ExpenditureSkillSetEventFilter` | -| `ExpenditureStateChanged` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `storageSlot?`: ``null`` \| `BigNumberish`, `mask?`: ``null``, `keys?`: ``null``, `value?`: ``null``) => `ExpenditureStateChangedEventFilter` | -| `ExpenditureStateChanged(address,uint256,uint256,bool[],bytes32[],bytes32)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `storageSlot?`: ``null`` \| `BigNumberish`, `mask?`: ``null``, `keys?`: ``null``, `value?`: ``null``) => `ExpenditureStateChangedEventFilter` | -| `ExpenditureTransferred` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `owner?`: ``null`` \| `string`) => `ExpenditureTransferredEventFilter` | -| `ExpenditureTransferred(address,uint256,address)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `owner?`: ``null`` \| `string`) => `ExpenditureTransferredEventFilter` | -| `FundingPotAdded` | (`fundingPotId?`: ``null``) => `FundingPotAddedEventFilter` | -| `FundingPotAdded(uint256)` | (`fundingPotId?`: ``null``) => `FundingPotAddedEventFilter` | -| `LocalSkillAdded` | (`agent?`: ``null``, `localSkillId?`: ``null``) => `LocalSkillAddedEventFilter` | -| `LocalSkillAdded(address,uint256)` | (`agent?`: ``null``, `localSkillId?`: ``null``) => `LocalSkillAddedEventFilter` | -| `LocalSkillDeprecated` | (`agent?`: ``null``, `localSkillId?`: ``null``, `deprecated?`: ``null``) => `LocalSkillDeprecatedEventFilter` | -| `LocalSkillDeprecated(address,uint256,bool)` | (`agent?`: ``null``, `localSkillId?`: ``null``, `deprecated?`: ``null``) => `LocalSkillDeprecatedEventFilter` | -| `MetaTransactionExecuted` | (`userAddress?`: ``null``, `relayerAddress?`: ``null``, `payload?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `MetaTransactionExecuted(address,address,bytes)` | (`userAddress?`: ``null``, `relayerAddress?`: ``null``, `payload?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `PaymentAdded` | (`agent?`: ``null``, `paymentId?`: ``null``) => `PaymentAddedEventFilter` | -| `PaymentAdded(address,uint256)` | (`agent?`: ``null``, `paymentId?`: ``null``) => `PaymentAddedEventFilter` | -| `PaymentFinalized` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`) => `PaymentFinalizedEventFilter` | -| `PaymentFinalized(address,uint256)` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`) => `PaymentFinalizedEventFilter` | -| `PaymentPayoutSet` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentPayoutSetEventFilter` | -| `PaymentPayoutSet(address,uint256,address,uint256)` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentPayoutSetEventFilter` | -| `PaymentRecipientSet` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `recipient?`: ``null``) => `PaymentRecipientSetEventFilter` | -| `PaymentRecipientSet(address,uint256,address)` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `recipient?`: ``null``) => `PaymentRecipientSetEventFilter` | -| `PaymentSkillSet` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `skillId?`: ``null``) => `PaymentSkillSetEventFilter` | -| `PaymentSkillSet(address,uint256,uint256)` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `skillId?`: ``null``) => `PaymentSkillSetEventFilter` | -| `PayoutClaimed` | (`agent?`: ``null``, `fundingPotId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PayoutClaimedEventFilter` | -| `PayoutClaimed(address,uint256,address,uint256)` | (`agent?`: ``null``, `fundingPotId?`: ``null`` \| `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`` \| `string`, `setTo?`: ``null``) => `RecoveryRoleSetEventFilter` | -| `RecoveryRoleSet(address,bool)` | (`user?`: ``null`` \| `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`` \| `BigNumberish`, `specificationHash?`: ``null``) => `TaskBriefSetEventFilter` | -| `TaskBriefSet(uint256,bytes32)` | (`taskId?`: ``null`` \| `BigNumberish`, `specificationHash?`: ``null``) => `TaskBriefSetEventFilter` | -| `TaskCanceled` | (`taskId?`: ``null`` \| `BigNumberish`) => `TaskCanceledEventFilter` | -| `TaskCanceled(uint256)` | (`taskId?`: ``null`` \| `BigNumberish`) => `TaskCanceledEventFilter` | -| `TaskChangedViaSignatures` | (`reviewerAddresses?`: ``null``) => `TaskChangedViaSignaturesEventFilter` | -| `TaskChangedViaSignatures(address[])` | (`reviewerAddresses?`: ``null``) => `TaskChangedViaSignaturesEventFilter` | -| `TaskCompleted` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`) => `TaskCompletedEventFilter` | -| `TaskCompleted(address,uint256)` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`) => `TaskCompletedEventFilter` | -| `TaskDeliverableSubmitted` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`, `deliverableHash?`: ``null``) => `TaskDeliverableSubmittedEventFilter` | -| `TaskDeliverableSubmitted(address,uint256,bytes32)` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`, `deliverableHash?`: ``null``) => `TaskDeliverableSubmittedEventFilter` | -| `TaskDueDateSet` | (`taskId?`: ``null`` \| `BigNumberish`, `dueDate?`: ``null``) => `TaskDueDateSetEventFilter` | -| `TaskDueDateSet(uint256,uint256)` | (`taskId?`: ``null`` \| `BigNumberish`, `dueDate?`: ``null``) => `TaskDueDateSetEventFilter` | -| `TaskFinalized` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`) => `TaskFinalizedEventFilter` | -| `TaskFinalized(address,uint256)` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`) => `TaskFinalizedEventFilter` | -| `TaskPayoutSet` | (`taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `token?`: ``null``, `amount?`: ``null``) => `TaskPayoutSetEventFilter` | -| `TaskPayoutSet(uint256,uint8,address,uint256)` | (`taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `token?`: ``null``, `amount?`: ``null``) => `TaskPayoutSetEventFilter` | -| `TaskRoleUserSet` | (`taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `user?`: ``null`` \| `string`) => `TaskRoleUserSetEventFilter` | -| `TaskRoleUserSet(uint256,uint8,address)` | (`taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `user?`: ``null`` \| `string`) => `TaskRoleUserSetEventFilter` | -| `TaskSkillSet` | (`taskId?`: ``null`` \| `BigNumberish`, `skillId?`: ``null`` \| `BigNumberish`) => `TaskSkillSetEventFilter` | -| `TaskSkillSet(uint256,uint256)` | (`taskId?`: ``null`` \| `BigNumberish`, `skillId?`: ``null`` \| `BigNumberish`) => `TaskSkillSetEventFilter` | -| `TaskWorkRatingRevealed` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `rating?`: ``null``) => `TaskWorkRatingRevealedEventFilter` | -| `TaskWorkRatingRevealed(address,uint256,uint8,uint8)` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `rating?`: ``null``) => `TaskWorkRatingRevealedEventFilter` | -| `TokenUnlocked` | (`agent?`: ``null``) => `TokenUnlockedEventFilter` | -| `TokenUnlocked(address)` | (`agent?`: ``null``) => `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`](ColonyNetworkClient.md) - -An instance of the ColonyNetworkClient - -#### Inherited from - -AugmentedIColony.networkClient - -___ - -### off - -• **off**: `OnEvent`<[`ColonyClientV10`](ColonyClientV10.md)\> - -#### Inherited from - -AugmentedIColony.off - -___ - -### on - -• **on**: `OnEvent`<[`ColonyClientV10`](ColonyClientV10.md)\> - -#### Inherited from - -AugmentedIColony.on - -___ - -### once - -• **once**: `OnEvent`<[`ColonyClientV10`](ColonyClientV10.md)\> - -#### Inherited from - -AugmentedIColony.once - -___ - -### provider - -• `Readonly` **provider**: `Provider` - -#### Inherited from - -AugmentedIColony.provider - -___ - -### removeListener - -• **removeListener**: `OnEvent`<[`ColonyClientV10`](ColonyClientV10.md)\> - -#### Inherited from - -AugmentedIColony.removeListener - -___ - -### reputationClient - -• **reputationClient**: [`ReputationClient`](../classes/ReputationClient.md) - -A helper client to retrieve reputation - -#### Inherited from - -AugmentedIColony.reputationClient - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.resolvedAddress - -___ - -### signer - -• `Readonly` **signer**: `Signer` - -#### Inherited from - -AugmentedIColony.signer - -___ - -### tokenClient - -• **tokenClient**: [`TokenClient`](../README.md#tokenclient) - -An instance of the TokenClient for the Colony's native token - -#### Inherited from - -AugmentedIColony.tokenClient - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | `RunningEvent` | - -#### Returns - -`void` - -#### Inherited from - -AugmentedIColony.\_checkRunningEvents - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<`Contract`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | `BlockTag` | - -#### Returns - -`Promise`<`Contract`\> - -#### Inherited from - -AugmentedIColony.\_deployed - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): `Event` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | `RunningEvent` | -| `log` | `Log` | -| `listener` | `Listener` | - -#### Returns - -`Event` - -#### Inherited from - -AugmentedIColony.\_wrapEvent - -___ - -### addDomain(uint256,uint256,uint256) - -▸ **addDomain(uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_parentDomainId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Adding new domains is currently retricted to one level only, i.e. `_parentDomainId` has to be the root domain id: `1`. -Add a colony domain, and its respective local skill under skill with id `_parentSkillId`. New funding pot is created and associated with the domain here. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_parentDomainId` | `BigNumberish` | Id of the domain under which the new one will be added | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.addDomain(uint256,uint256,uint256) - -___ - -### 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_parentDomainId` | `BigNumberish` | Id of the domain under which the new one will be added | -| `_metadata` | `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?`: `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)](ColonyClientV10.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_parentDomainId` | `BigNumberish` | Id of the domain under which the new one will be added | -| `overrides?` | [`TxOverrides`](../README.md#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)](ColonyClientV10.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_parentDomainId` | `BigNumberish` | Id of the domain under which the new one will be added | -| `_metadata` | `string` | Metadata relating to the domain. Expected to be the IPFS hash of a JSON blob, but not enforced by the contracts. | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AddDomainAugmentsB.addDomainWithProofs(uint256,string) - -___ - -### addLocalSkill - -▸ **addLocalSkill**(`overrides?`): `Promise`<`ContractTransaction`\> - -Add a new local skill for the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.addLocalSkill - -___ - -### addLocalSkill() - -▸ **addLocalSkill()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Add a new local skill for the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.addLocalSkill() - -___ - -### addPayment - -▸ **addPayment**(`_permissionDomainId`, `_childSkillIndex`, `_recipient`, `_token`, `_amount`, `_domainId`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new payment in the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, (only used if `_permissionDomainId` is different to `_domainId`) | -| `_recipient` | `string` | Address of the payment recipient | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `_domainId` | `BigNumberish` | The domain where the payment belongs | -| `_skillId` | `BigNumberish` | The skill associated with the payment | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.addPayment - -___ - -### addPayment(uint256,uint256,address,address,uint256,uint256,uint256) - -▸ **addPayment(uint256,uint256,address,address,uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_recipient`, `_token`, `_amount`, `_domainId`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new payment in the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, (only used if `_permissionDomainId` is different to `_domainId`) | -| `_recipient` | `string` | Address of the payment recipient | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `_domainId` | `BigNumberish` | The domain where the payment belongs | -| `_skillId` | `BigNumberish` | The skill associated with the payment | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.addPayment(uint256,uint256,address,address,uint256,uint256,uint256) - -___ - -### annotateTransaction - -▸ **annotateTransaction**(`_txHash`, `_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> - -Emit a metadata string for a transaction - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_txHash` | `BytesLike` | Hash of transaction being annotated (0x0 for current tx) | -| `_metadata` | `string` | String of metadata for tx | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.annotateTransaction - -___ - -### annotateTransaction(bytes32,string) - -▸ **annotateTransaction(bytes32,string)**(`_txHash`, `_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> - -Emit a metadata string for a transaction - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_txHash` | `BytesLike` | Hash of transaction being annotated (0x0 for current tx) | -| `_metadata` | `string` | String of metadata for tx | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.annotateTransaction(bytes32,string) - -___ - -### approveExitRecovery - -▸ **approveExitRecovery**(`overrides?`): `Promise`<`ContractTransaction`\> - -Indicate approval to exit recovery mode. Can only be called by user with recovery role. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.approveExitRecovery - -___ - -### approveExitRecovery() - -▸ **approveExitRecovery()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Indicate approval to exit recovery mode. Can only be called by user with recovery role. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.approveExitRecovery() - -___ - -### approveStake - -▸ **approveStake**(`_approvee`, `_domainId`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Allow the _approvee to obligate some amount of tokens as a stake. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_approvee` | `string` | Address of the account we are willing to let obligate us. | -| `_domainId` | `BigNumberish` | Domain in which we are willing to be obligated. | -| `_amount` | `BigNumberish` | Amount of internal token up to which we are willing to be obligated. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.approveStake - -___ - -### approveStake(address,uint256,uint256) - -▸ **approveStake(address,uint256,uint256)**(`_approvee`, `_domainId`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Allow the _approvee to obligate some amount of tokens as a stake. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_approvee` | `string` | Address of the account we are willing to let obligate us. | -| `_domainId` | `BigNumberish` | Domain in which we are willing to be obligated. | -| `_amount` | `BigNumberish` | Amount of internal token up to which we are willing to be obligated. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.approveStake(address,uint256,uint256) - -___ - -### attach - -▸ **attach**(`addressOrName`): [`ColonyClientV10`](ColonyClientV10.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`ColonyClientV10`](ColonyClientV10.md) - -#### Inherited from - -AugmentedIColony.attach - -___ - -### authority - -▸ **authority**(`overrides?`): `Promise`<`string`\> - -Get the `ColonyAuthority` for the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.authority - -___ - -### authority() - -▸ **authority()**(`overrides?`): `Promise`<`string`\> - -Get the `ColonyAuthority` for the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_users` | `string`[] | Array of address to bootstrap with reputation | -| `_amount` | `BigNumberish`[] | Amount of reputation/tokens for every address | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.bootstrapColony - -___ - -### bootstrapColony(address[],int256[]) - -▸ **bootstrapColony(address[],int256[])**(`_users`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Only allowed to be called when `taskCount` is `0` by authorized addresses. -Allows the colony to bootstrap itself by having initial reputation and token `_amount` assigned to `_users`. This reputation is assigned in the colony-wide domain. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_users` | `string`[] | Array of address to bootstrap with reputation | -| `_amount` | `BigNumberish`[] | Amount of reputation/tokens for every address | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.bootstrapColony(address[],int256[]) - -___ - -### burnTokens - -▸ **burnTokens**(`token`, `amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Burn tokens held by the colony. Can only burn tokens held in the root funding pot. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | The address of the token to burn | -| `amount` | `BigNumberish` | The amount of tokens to burn | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.burnTokens - -___ - -### burnTokens(address,uint256) - -▸ **burnTokens(address,uint256)**(`token`, `amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Burn tokens held by the colony. Can only burn tokens held in the root funding pot. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | The address of the token to burn | -| `amount` | `BigNumberish` | The amount of tokens to burn | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.burnTokens(address,uint256) - -___ - -### cancelExpenditure - -▸ **cancelExpenditure**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancels the expenditure and prevents further editing. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.cancelExpenditure - -___ - -### cancelExpenditure(uint256) - -▸ **cancelExpenditure(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancels the expenditure and prevents further editing. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.cancelExpenditure(uint256) - -___ - -### cancelTask - -▸ **cancelTask**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the `task.status` property to `1`. -Cancel a task at any point before it is finalized. Secured function to authorised members. Any funds assigned to its funding pot can be moved back to the domain via `IColony.moveFundsBetweenPots`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.cancelTask - -___ - -### cancelTask(uint256) - -▸ **cancelTask(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the `task.status` property to `1`. -Cancel a task at any point before it is finalized. Secured function to authorised members. Any funds assigned to its funding pot can be moved back to the domain via `IColony.moveFundsBetweenPots`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.cancelTask(uint256) - -___ - -### checkNotAdditionalProtectedVariable - -▸ **checkNotAdditionalProtectedVariable**(`_slot`, `overrides?`): `Promise`<`void`\> - -No return value, but should throw if protected.This is 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_slot` | `BigNumberish` | The storage slot number to check. | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -AugmentedIColony.checkNotAdditionalProtectedVariable - -___ - -### checkNotAdditionalProtectedVariable(uint256) - -▸ **checkNotAdditionalProtectedVariable(uint256)**(`_slot`, `overrides?`): `Promise`<`void`\> - -No return value, but should throw if protected.This is 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_slot` | `BigNumberish` | The storage slot number to check. | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -AugmentedIColony.checkNotAdditionalProtectedVariable(uint256) - -___ - -### claimColonyFunds - -▸ **claimColonyFunds**(`_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Move any funds received by the colony in `_token` denomination to the top-level domain pot, siphoning off a small amount to the reward pot. If called against a colony's own token, no fee is taken. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimColonyFunds - -___ - -### claimColonyFunds(address) - -▸ **claimColonyFunds(address)**(`_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Move any funds received by the colony in `_token` denomination to the top-level domain pot, siphoning off a small amount to the reward pot. If called against a colony's own token, no fee is taken. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimColonyFunds(address) - -___ - -### claimExpenditurePayout - -▸ **claimExpenditurePayout**(`_id`, `_slot`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the payout for an expenditure slot. Here the network receives a fee from each payout. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Number of the slot | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimExpenditurePayout - -___ - -### claimExpenditurePayout(uint256,uint256,address) - -▸ **claimExpenditurePayout(uint256,uint256,address)**(`_id`, `_slot`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the payout for an expenditure slot. Here the network receives a fee from each payout. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Number of the slot | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimExpenditurePayout(uint256,uint256,address) - -___ - -### claimPayment - -▸ **claimPayment**(`_id`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the payout in `_token` denomination for payment `_id`. Here the network receives its fee from each payout. Same as for tasks, ether fees go straight to the Meta Colony whereas Token fees go to the Network to be auctioned off. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Payment identifier | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimPayment - -___ - -### claimPayment(uint256,address) - -▸ **claimPayment(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the payout in `_token` denomination for payment `_id`. Here the network receives its fee from each payout. Same as for tasks, ether fees go straight to the Meta Colony whereas Token fees go to the Network to be auctioned off. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Payment identifier | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimPayment(uint256,address) - -___ - -### claimRewardPayout - -▸ **claimRewardPayout**(`_payoutId`, `_squareRoots`, `key`, `value`, `branchMask`, `siblings`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the reward payout at `_payoutId`. User needs to provide their reputation and colony-wide reputation which will be proven via Merkle proof inside this function. Can only be called if payout is active, i.e if 60 days have not passed from its creation. Can only be called if next in queue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_payoutId` | `BigNumberish` | Id of the reward payout | -| `_squareRoots` | `BigNumberish`[] | Square roots of values used in equation: `_squareRoots[0]` - square root of user reputation, `_squareRoots[1]` - square root of user tokens (deposited in TokenLocking), `_squareRoots[2]` - square root of total reputation, `_squareRoots[3]` - square root of total tokens, `_squareRoots[4]` - square root of numerator (user reputation * user tokens), `_squareRoots[5]` - square root of denominator (total reputation * total tokens), `_squareRoots[6]` - square root of payout amount. | -| `key` | `BytesLike` | Some Reputation hash tree key | -| `value` | `BytesLike` | Reputation value | -| `branchMask` | `BigNumberish` | The branchmask of the proof | -| `siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimRewardPayout - -___ - -### claimRewardPayout(uint256,uint256[7],bytes,bytes,uint256,bytes32[]) - -▸ **claimRewardPayout(uint256,uint256[7],bytes,bytes,uint256,bytes32[])**(`_payoutId`, `_squareRoots`, `key`, `value`, `branchMask`, `siblings`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the reward payout at `_payoutId`. User needs to provide their reputation and colony-wide reputation which will be proven via Merkle proof inside this function. Can only be called if payout is active, i.e if 60 days have not passed from its creation. Can only be called if next in queue. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_payoutId` | `BigNumberish` | Id of the reward payout | -| `_squareRoots` | `BigNumberish`[] | Square roots of values used in equation: `_squareRoots[0]` - square root of user reputation, `_squareRoots[1]` - square root of user tokens (deposited in TokenLocking), `_squareRoots[2]` - square root of total reputation, `_squareRoots[3]` - square root of total tokens, `_squareRoots[4]` - square root of numerator (user reputation * user tokens), `_squareRoots[5]` - square root of denominator (total reputation * total tokens), `_squareRoots[6]` - square root of payout amount. | -| `key` | `BytesLike` | Some Reputation hash tree key | -| `value` | `BytesLike` | Reputation value | -| `branchMask` | `BigNumberish` | The branchmask of the proof | -| `siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimRewardPayout(uint256,uint256[7],bytes,bytes,uint256,bytes32[]) - -___ - -### claimTaskPayout - -▸ **claimTaskPayout**(`_id`, `_role`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the payout in `_token` denomination for work completed in task `_id` by contributor with role `_role`. Allowed only after task is finalized. Here the network receives its fee from each payout. Ether fees go straight to the Meta Colony whereas Token fees go to the Network to be auctioned off. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimTaskPayout - -___ - -### claimTaskPayout(uint256,uint8,address) - -▸ **claimTaskPayout(uint256,uint8,address)**(`_id`, `_role`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the payout in `_token` denomination for work completed in task `_id` by contributor with role `_role`. Allowed only after task is finalized. Here the network receives its fee from each payout. Ether fees go straight to the Meta Colony whereas Token fees go to the Network to be auctioned off. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.claimTaskPayout(uint256,uint8,address) - -___ - -### completeTask - -▸ **completeTask**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Mark a task as complete after the due date has passed. This allows the task to be rated and finalized (and funds recovered) even in the presence of a worker who has disappeared. Note that if the due date was not set, then this function will throw. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.completeTask - -___ - -### completeTask(uint256) - -▸ **completeTask(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Mark a task as complete after the due date has passed. This allows the task to be rated and finalized (and funds recovered) even in the presence of a worker who has disappeared. Note that if the due date was not set, then this function will throw. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.completeTask(uint256) - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`ColonyClientV10`](ColonyClientV10.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| `Signer` \| `Provider` | - -#### Returns - -[`ColonyClientV10`](ColonyClientV10.md) - -#### Inherited from - -AugmentedIColony.connect - -___ - -### deobligateStake - -▸ **deobligateStake**(`_user`, `_domainId`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Deobligate the user some amount of tokens, releasing the stake. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of the account we are deobligating. | -| `_domainId` | `BigNumberish` | Domain in which we are deobligating the user. | -| `_amount` | `BigNumberish` | Amount of internal token we are deobligating. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.deobligateStake - -___ - -### deobligateStake(address,uint256,uint256) - -▸ **deobligateStake(address,uint256,uint256)**(`_user`, `_domainId`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Deobligate the user some amount of tokens, releasing the stake. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of the account we are deobligating. | -| `_domainId` | `BigNumberish` | Domain in which we are deobligating the user. | -| `_amount` | `BigNumberish` | Amount of internal token we are deobligating. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.deobligateStake(address,uint256,uint256) - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`ColonyClientV10`](ColonyClientV10.md)\> - -#### Returns - -`Promise`<[`ColonyClientV10`](ColonyClientV10.md)\> - -#### Inherited from - -AugmentedIColony.deployed - -___ - -### deprecateDomain - -▸ **deprecateDomain**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Deprecate a domain, preventing certain actions from happening there - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_domainId` | `BigNumberish` | Id of the domain being deprecated | -| `_deprecated` | `boolean` | Whether or not the domain is deprecated | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.deprecateDomain - -___ - -### deprecateDomain(uint256,uint256,uint256,bool) - -▸ **deprecateDomain(uint256,uint256,uint256,bool)**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Deprecate a domain, preventing certain actions from happening there - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_domainId` | `BigNumberish` | Id of the domain being deprecated | -| `_deprecated` | `boolean` | Whether or not the domain is deprecated | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.deprecateDomain(uint256,uint256,uint256,bool) - -___ - -### deprecateDomainWithProofs - -▸ **deprecateDomainWithProofs**(`_domainId`, `_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [deprecateDomain](ColonyClientV10.md#deprecatedomain), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | Id of the domain being deprecated | -| `_deprecated` | `boolean` | Whether the domain should be deprecated (true) or undeprecated (false) | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -ColonyAugmentsV6.deprecateDomainWithProofs - -___ - -### deprecateExtension - -▸ **deprecateExtension**(`extensionId`, `deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the deprecation of an extension in a colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extensionId` | `BytesLike` | keccak256 hash of the extension name, used as an indentifier | -| `deprecated` | `boolean` | Whether to deprecate the extension or not | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.deprecateExtension - -___ - -### deprecateExtension(bytes32,bool) - -▸ **deprecateExtension(bytes32,bool)**(`extensionId`, `deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the deprecation of an extension in a colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extensionId` | `BytesLike` | keccak256 hash of the extension name, used as an indentifier | -| `deprecated` | `boolean` | Whether to deprecate the extension or not | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.deprecateExtension(bytes32,bool) - -___ - -### deprecateLocalSkill - -▸ **deprecateLocalSkill**(`localSkillId`, `deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Deprecate a local skill for the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `localSkillId` | `BigNumberish` | Id for the local skill | -| `deprecated` | `boolean` | Deprecation status to set for the skill | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.deprecateLocalSkill - -___ - -### deprecateLocalSkill(uint256,bool) - -▸ **deprecateLocalSkill(uint256,bool)**(`localSkillId`, `deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Deprecate a local skill for the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `localSkillId` | `BigNumberish` | Id for the local skill | -| `deprecated` | `boolean` | Deprecation status to set for the skill | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.deprecateLocalSkill(uint256,bool) - -___ - -### 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_metadata` | `string` | IPFS hash of the metadata | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.editColony - -___ - -### editColony(string) - -▸ **editColony(string)**(`_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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_metadata` | `string` | IPFS hash of the metadata | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.editColony(string) - -___ - -### editColonyByDelta - -▸ **editColonyByDelta**(`_metadataDelta`, `overrides?`): `Promise`<`ContractTransaction`\> - -Called to change the metadata associated with a colony. Expected to be a IPFS hash of a delta to a JSON blob, but not enforced to any degree by the contracts - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_metadataDelta` | `string` | IPFS hash of the metadata delta | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.editColonyByDelta - -___ - -### editColonyByDelta(string) - -▸ **editColonyByDelta(string)**(`_metadataDelta`, `overrides?`): `Promise`<`ContractTransaction`\> - -Called to change the metadata associated with a colony. Expected to be a IPFS hash of a delta to a JSON blob, but not enforced to any degree by the contracts - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_metadataDelta` | `string` | IPFS hash of the metadata delta | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.editColonyByDelta(string) - -___ - -### 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_domainId` | `BigNumberish` | Id of the domain being edited | -| `_metadata` | `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?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.editDomain - -___ - -### editDomain(uint256,uint256,uint256,string) - -▸ **editDomain(uint256,uint256,uint256,string)**(`_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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_domainId` | `BigNumberish` | Id of the domain being edited | -| `_metadata` | `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?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.editDomain(uint256,uint256,uint256,string) - -___ - -### editDomainWithProofs - -▸ **editDomainWithProofs**(`_domainId`, `_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [editDomain](ColonyClientV10.md#editdomain), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | Id of the domain being edited | -| `_metadata` | `string` | Metadata relating to the domain. Expected to be the IPFS hash of a JSON blob, but not enforced by the contracts. | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -ColonyAugmentsV5.editDomainWithProofs - -___ - -### emit - -▸ **emit**(`eventName`, `...args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `EventFilter` | -| `...args` | `any`[] | - -#### 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I hold the Arbitration role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_domainId` | `BigNumberish` | The domain where the user will lose reputation | -| `_user` | `string` | The user who will lose reputation | -| `_amount` | `BigNumberish` | The (negative) amount of reputation to lose | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.emitDomainReputationPenalty - -___ - -### emitDomainReputationPenalty(uint256,uint256,uint256,address,int256) - -▸ **emitDomainReputationPenalty(uint256,uint256,uint256,address,int256)**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `_user`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Emit a negative domain reputation update. Available only to Arbitration role holders - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I hold the Arbitration role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_domainId` | `BigNumberish` | The domain where the user will lose reputation | -| `_user` | `string` | The user who will lose reputation | -| `_amount` | `BigNumberish` | The (negative) amount of reputation to lose | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.emitDomainReputationPenalty(uint256,uint256,uint256,address,int256) - -___ - -### emitDomainReputationPenaltyWithProofs - -▸ **emitDomainReputationPenaltyWithProofs**(`_domainId`, `_user`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [emitDomainReputationPenalty](ColonyClientV10.md#emitdomainreputationpenalty), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where the user will lose reputation | -| `_user` | `string` | The user who will lose reputation | -| `_amount` | `BigNumberish` | The (negative) amount of reputation to lose | -| `overrides?` | [`TxOverrides`](../README.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where the user will gain reputation | -| `_user` | `string` | The user who will gain reputation | -| `_amount` | `BigNumberish` | The (positive) amount of reputation to gain | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.emitDomainReputationReward - -___ - -### emitDomainReputationReward(uint256,address,int256) - -▸ **emitDomainReputationReward(uint256,address,int256)**(`_domainId`, `_user`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Emit a positive domain reputation update. Available only to Root role holders - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where the user will gain reputation | -| `_user` | `string` | The user who will gain reputation | -| `_amount` | `BigNumberish` | The (positive) amount of reputation to gain | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.emitDomainReputationReward(uint256,address,int256) - -___ - -### 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_skillId` | `BigNumberish` | The skill where the user will lose reputation | -| `_user` | `string` | The user who will lose reputation | -| `_amount` | `BigNumberish` | The (negative) amount of reputation to lose | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.emitSkillReputationPenalty - -___ - -### emitSkillReputationPenalty(uint256,address,int256) - -▸ **emitSkillReputationPenalty(uint256,address,int256)**(`_skillId`, `_user`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Emit a negative skill reputation update. Available only to Arbitration role holders in the root domain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_skillId` | `BigNumberish` | The skill where the user will lose reputation | -| `_user` | `string` | The user who will lose reputation | -| `_amount` | `BigNumberish` | The (negative) amount of reputation to lose | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.emitSkillReputationPenalty(uint256,address,int256) - -___ - -### emitSkillReputationReward - -▸ **emitSkillReputationReward**(`_skillId`, `_user`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Emit a positive skill reputation update. Available only to Root role holders - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_skillId` | `BigNumberish` | The skill where the user will gain reputation | -| `_user` | `string` | The user who will gain reputation | -| `_amount` | `BigNumberish` | The (positive) amount of reputation to gain | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.emitSkillReputationReward - -___ - -### emitSkillReputationReward(uint256,address,int256) - -▸ **emitSkillReputationReward(uint256,address,int256)**(`_skillId`, `_user`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Emit a positive skill reputation update. Available only to Root role holders - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_skillId` | `BigNumberish` | The skill where the user will gain reputation | -| `_user` | `string` | The user who will gain reputation | -| `_amount` | `BigNumberish` | The (positive) amount of reputation to gain | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.emitSkillReputationReward(uint256,address,int256) - -___ - -### enterRecoveryMode - -▸ **enterRecoveryMode**(`overrides?`): `Promise`<`ContractTransaction`\> - -Put colony network mining into recovery mode. Can only be called by user with recovery role. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.enterRecoveryMode - -___ - -### enterRecoveryMode() - -▸ **enterRecoveryMode()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Put colony network mining into recovery mode. Can only be called by user with recovery role. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.enterRecoveryMode() - -___ - -### executeMetaTransaction - -▸ **executeMetaTransaction**(`userAddress`, `payload`, `sigR`, `sigS`, `sigV`, `overrides?`): `Promise`<`ContractTransaction`\> - -Executes a metatransaction targeting this contract - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userAddress` | `string` | The address of the user that signed the metatransaction | -| `payload` | `BytesLike` | The transaction data that will be executed if signature valid | -| `sigR` | `BytesLike` | The 'r' part of the signature | -| `sigS` | `BytesLike` | The 's' part of the signature | -| `sigV` | `BigNumberish` | The 'v' part of the signature | -| `overrides?` | `PayableOverrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.executeMetaTransaction - -___ - -### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) - -▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`userAddress`, `payload`, `sigR`, `sigS`, `sigV`, `overrides?`): `Promise`<`ContractTransaction`\> - -Executes a metatransaction targeting this contract - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userAddress` | `string` | The address of the user that signed the metatransaction | -| `payload` | `BytesLike` | The transaction data that will be executed if signature valid | -| `sigR` | `BytesLike` | The 'r' part of the signature | -| `sigS` | `BytesLike` | The 's' part of the signature | -| `sigV` | `BigNumberish` | The 'v' part of the signature | -| `overrides?` | `PayableOverrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) - -___ - -### executeTaskChange - -▸ **executeTaskChange**(`_sigV`, `_sigR`, `_sigS`, `_mode`, `_value`, `_data`, `overrides?`): `Promise`<`ContractTransaction`\> - -The Colony functions which require approval and the task roles to review these are set in `IColony.initialiseColony` at colony creation. Upon successful execution the `taskChangeNonces` entry for the task is incremented. -Executes a task update transaction `_data` which is approved and signed by two of its roles (e.g. manager and worker) using the detached signatures for these users. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_sigV` | `BigNumberish`[] | recovery id | -| `_sigR` | `BytesLike`[] | r output of the ECDSA signature of the transaction | -| `_sigS` | `BytesLike`[] | s output of the ECDSA signature of the transaction | -| `_mode` | `BigNumberish`[] | How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this) | -| `_value` | `BigNumberish` | The transaction value, i.e. number of wei to be sent when the transaction is executed Currently we only accept 0 value transactions but this is kept as a future option | -| `_data` | `BytesLike` | The transaction data | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.executeTaskChange - -___ - -### executeTaskChange(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes) - -▸ **executeTaskChange(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes)**(`_sigV`, `_sigR`, `_sigS`, `_mode`, `_value`, `_data`, `overrides?`): `Promise`<`ContractTransaction`\> - -The Colony functions which require approval and the task roles to review these are set in `IColony.initialiseColony` at colony creation. Upon successful execution the `taskChangeNonces` entry for the task is incremented. -Executes a task update transaction `_data` which is approved and signed by two of its roles (e.g. manager and worker) using the detached signatures for these users. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_sigV` | `BigNumberish`[] | recovery id | -| `_sigR` | `BytesLike`[] | r output of the ECDSA signature of the transaction | -| `_sigS` | `BytesLike`[] | s output of the ECDSA signature of the transaction | -| `_mode` | `BigNumberish`[] | How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this) | -| `_value` | `BigNumberish` | The transaction value, i.e. number of wei to be sent when the transaction is executed Currently we only accept 0 value transactions but this is kept as a future option | -| `_data` | `BytesLike` | The transaction data | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.executeTaskChange(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes) - -___ - -### executeTaskRoleAssignment - -▸ **executeTaskRoleAssignment**(`_sigV`, `_sigR`, `_sigS`, `_mode`, `_value`, `_data`, `overrides?`): `Promise`<`ContractTransaction`\> - -Executes a task role update transaction `_data` which is approved and signed by two of addresses. depending of which function we are calling. Allowed functions are `setTaskManagerRole`, `setTaskEvaluatorRole` and `setTaskWorkerRole`. Upon successful execution the `taskChangeNonces` entry for the task is incremented. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_sigV` | `BigNumberish`[] | recovery id | -| `_sigR` | `BytesLike`[] | r output of the ECDSA signature of the transaction | -| `_sigS` | `BytesLike`[] | s output of the ECDSA signature of the transaction | -| `_mode` | `BigNumberish`[] | How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this) | -| `_value` | `BigNumberish` | The transaction value, i.e. number of wei to be sent when the transaction is executed Currently we only accept 0 value transactions but this is kept as a future option | -| `_data` | `BytesLike` | The transaction data | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.executeTaskRoleAssignment - -___ - -### executeTaskRoleAssignment(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes) - -▸ **executeTaskRoleAssignment(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes)**(`_sigV`, `_sigR`, `_sigS`, `_mode`, `_value`, `_data`, `overrides?`): `Promise`<`ContractTransaction`\> - -Executes a task role update transaction `_data` which is approved and signed by two of addresses. depending of which function we are calling. Allowed functions are `setTaskManagerRole`, `setTaskEvaluatorRole` and `setTaskWorkerRole`. Upon successful execution the `taskChangeNonces` entry for the task is incremented. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_sigV` | `BigNumberish`[] | recovery id | -| `_sigR` | `BytesLike`[] | r output of the ECDSA signature of the transaction | -| `_sigS` | `BytesLike`[] | s output of the ECDSA signature of the transaction | -| `_mode` | `BigNumberish`[] | How the signature was generated - 0 for Geth-style (usual), 1 for Trezor-style (only Trezor does this) | -| `_value` | `BigNumberish` | The transaction value, i.e. number of wei to be sent when the transaction is executed Currently we only accept 0 value transactions but this is kept as a future option | -| `_data` | `BytesLike` | The transaction data | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.executeTaskRoleAssignment(uint8[],bytes32[],bytes32[],uint8[],uint256,bytes) - -___ - -### exitRecoveryMode - -▸ **exitRecoveryMode**(`overrides?`): `Promise`<`ContractTransaction`\> - -Exit recovery mode, can be called by anyone if enough whitelist approvals are given. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.exitRecoveryMode - -___ - -### exitRecoveryMode() - -▸ **exitRecoveryMode()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Exit recovery mode, can be called by anyone if enough whitelist approvals are given. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.exitRecoveryMode() - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `TransactionRequest` | - -#### Returns - -`Promise`<`TransactionResponse`\> - -#### Inherited from - -AugmentedIColony.fallback - -___ - -### finalizeExpenditure - -▸ **finalizeExpenditure**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Finalizes the expenditure and allows for funds to be claimed. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizeExpenditure - -___ - -### finalizeExpenditure(uint256) - -▸ **finalizeExpenditure(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Finalizes the expenditure and allows for funds to be claimed. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizeExpenditure(uint256) - -___ - -### finalizePayment - -▸ **finalizePayment**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Finalizes the payment and logs the reputation log updates. Allowed to be called once after payment is fully funded. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Payment identifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizePayment - -___ - -### finalizePayment(uint256,uint256,uint256) - -▸ **finalizePayment(uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Finalizes the payment and logs the reputation log updates. Allowed to be called once after payment is fully funded. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Payment identifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizePayment(uint256,uint256,uint256) - -___ - -### finalizePaymentWithProofs - -▸ **finalizePaymentWithProofs**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [finalizePayment](ColonyClientV10.md#finalizepayment), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Payment identifier | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizePaymentWithProofs - -___ - -### finalizeRewardPayout - -▸ **finalizeRewardPayout**(`_payoutId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Finalises the reward payout. Allows creation of next reward payouts for token that has been used in `_payoutId`. Can only be called when reward payout cycle is finished i.e when 60 days have passed from its creation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_payoutId` | `BigNumberish` | Id of the reward payout | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizeRewardPayout - -___ - -### finalizeRewardPayout(uint256) - -▸ **finalizeRewardPayout(uint256)**(`_payoutId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Finalises the reward payout. Allows creation of next reward payouts for token that has been used in `_payoutId`. Can only be called when reward payout cycle is finished i.e when 60 days have passed from its creation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_payoutId` | `BigNumberish` | Id of the reward payout | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizeRewardPayout(uint256) - -___ - -### finalizeTask - -▸ **finalizeTask**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the `task.finalized` property to true -Called after task work rating is complete which closes the task and logs the respective reputation log updates. Allowed to be called once per task. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizeTask - -___ - -### finalizeTask(uint256) - -▸ **finalizeTask(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the `task.finalized` property to true -Called after task work rating is complete which closes the task and logs the respective reputation log updates. Allowed to be called once per task. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finalizeTask(uint256) - -___ - -### finishUpgrade - -▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called by the colony itself, and only expected to be called as part of the `upgrade()` call. Required to be external so it can be an external call. -A function to be called after an upgrade has been done from v2 to v3. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finishUpgrade - -___ - -### finishUpgrade() - -▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called by the colony itself, and only expected to be called as part of the `upgrade()` call. Required to be external so it can be an external call. -A function to be called after an upgrade has been done from v2 to v3. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.finishUpgrade() - -___ - -### generateSecret - -▸ **generateSecret**(`_salt`, `_value`, `overrides?`): `Promise`<`string`\> - -Helper function used to generage consistently the rating secret using salt value `_salt` and value to hide `_value` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_salt` | `BytesLike` | Salt value | -| `_value` | `BigNumberish` | Value to hide | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.generateSecret - -___ - -### generateSecret(bytes32,uint256) - -▸ **generateSecret(bytes32,uint256)**(`_salt`, `_value`, `overrides?`): `Promise`<`string`\> - -Helper function used to generage consistently the rating secret using salt value `_salt` and value to hide `_value` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_salt` | `BytesLike` | Salt value | -| `_value` | `BigNumberish` | Value to hide | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.generateSecret(bytes32,uint256) - -___ - -### getApproval - -▸ **getApproval**(`_user`, `_obligator`, `_domainId`, `overrides?`): `Promise`<`BigNumber`\> - -View an approval to obligate tokens. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User allowing their tokens to be obligated. | -| `_obligator` | `string` | Address of the account we are willing to let obligate us. | -| `_domainId` | `BigNumberish` | Domain in which we are willing to be obligated. | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getApproval - -___ - -### getApproval(address,address,uint256) - -▸ **getApproval(address,address,uint256)**(`_user`, `_obligator`, `_domainId`, `overrides?`): `Promise`<`BigNumber`\> - -View an approval to obligate tokens. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User allowing their tokens to be obligated. | -| `_obligator` | `string` | Address of the account we are willing to let obligate us. | -| `_domainId` | `BigNumberish` | Domain in which we are willing to be obligated. | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getApproval(address,address,uint256) - -___ - -### getCapabilityRoles - -▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> - -Gets the bytes32 representation of the roles authorized to call a function - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_sig` | `BytesLike` | The function signature | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getCapabilityRoles - -___ - -### getCapabilityRoles(bytes4) - -▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> - -Gets the bytes32 representation of the roles authorized to call a function - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_sig` | `BytesLike` | The function signature | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getCapabilityRoles(bytes4) - -___ - -### getColonyNetwork - -▸ **getColonyNetwork**(`overrides?`): `Promise`<`string`\> - -The colonyNetworkAddress we read here is set once, during `initialiseColony`. -Returns the colony network address set on the Colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getColonyNetwork - -___ - -### getColonyNetwork() - -▸ **getColonyNetwork()**(`overrides?`): `Promise`<`string`\> - -The colonyNetworkAddress we read here is set once, during `initialiseColony`. -Returns the colony network address set on the Colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getColonyNetwork() - -___ - -### getDomain - -▸ **getDomain**(`_id`, `overrides?`): `Promise`<`DomainStructOutput`\> - -Get a domain by id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the domain which details to get | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`DomainStructOutput`\> - -#### Inherited from - -AugmentedIColony.getDomain - -___ - -### getDomain(uint256) - -▸ **getDomain(uint256)**(`_id`, `overrides?`): `Promise`<`DomainStructOutput`\> - -Get a domain by id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the domain which details to get | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`DomainStructOutput`\> - -#### Inherited from - -AugmentedIColony.getDomain(uint256) - -___ - -### getDomainCount - -▸ **getDomainCount**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of domains in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getDomainCount - -___ - -### getDomainCount() - -▸ **getDomainCount()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of domains in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getDomainCount() - -___ - -### getDomainFromFundingPot - -▸ **getDomainFromFundingPot**(`_fundingPotId`, `overrides?`): `Promise`<`BigNumber`\> - -Get the domain corresponding to a funding pot - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPotId` | `BigNumberish` | Id of the funding pot | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getDomainFromFundingPot - -___ - -### getDomainFromFundingPot(uint256) - -▸ **getDomainFromFundingPot(uint256)**(`_fundingPotId`, `overrides?`): `Promise`<`BigNumber`\> - -Get the domain corresponding to a funding pot - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPotId` | `BigNumberish` | Id of the funding pot | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getDomainFromFundingPot(uint256) - -___ - -### getExpenditure - -▸ **getExpenditure**(`_id`, `overrides?`): `Promise`<`ExpenditureStructOutput`\> - -Returns an existing expenditure. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`ExpenditureStructOutput`\> - -#### Inherited from - -AugmentedIColony.getExpenditure - -___ - -### getExpenditure(uint256) - -▸ **getExpenditure(uint256)**(`_id`, `overrides?`): `Promise`<`ExpenditureStructOutput`\> - -Returns an existing expenditure. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`ExpenditureStructOutput`\> - -#### Inherited from - -AugmentedIColony.getExpenditure(uint256) - -___ - -### getExpenditureCount - -▸ **getExpenditureCount**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of expenditures in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getExpenditureCount - -___ - -### getExpenditureCount() - -▸ **getExpenditureCount()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of expenditures in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getExpenditureCount() - -___ - -### getExpenditureSlot - -▸ **getExpenditureSlot**(`_id`, `_slot`, `overrides?`): `Promise`<`ExpenditureSlotStructOutput`\> - -Returns an existing expenditure slot. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Expenditure slot | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`ExpenditureSlotStructOutput`\> - -#### Inherited from - -AugmentedIColony.getExpenditureSlot - -___ - -### getExpenditureSlot(uint256,uint256) - -▸ **getExpenditureSlot(uint256,uint256)**(`_id`, `_slot`, `overrides?`): `Promise`<`ExpenditureSlotStructOutput`\> - -Returns an existing expenditure slot. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Expenditure slot | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`ExpenditureSlotStructOutput`\> - -#### Inherited from - -AugmentedIColony.getExpenditureSlot(uint256,uint256) - -___ - -### getExpenditureSlotPayout - -▸ **getExpenditureSlotPayout**(`_id`, `_slot`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Returns an existing expenditure slot's payout for a token. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Expenditure slot | -| `_token` | `string` | Token address | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getExpenditureSlotPayout - -___ - -### getExpenditureSlotPayout(uint256,uint256,address) - -▸ **getExpenditureSlotPayout(uint256,uint256,address)**(`_id`, `_slot`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Returns an existing expenditure slot's payout for a token. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Expenditure slot | -| `_token` | `string` | Token address | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getExpenditureSlotPayout(uint256,uint256,address) - -___ - -### getExtensionClient - -▸ **getExtensionClient**<`E`\>(`extension`): `Promise`<`GetExtensionClientReturns`[`E`]\> - -Get an instance of an extension client associated with this Colony. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends [`Extension`](../enums/Extension.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extension` | `E` | An [Extension](../enums/Extension.md) | - -#### Returns - -`Promise`<`GetExtensionClientReturns`[`E`]\> - -An instance of an intialized extension client for the desired extension - -#### Inherited from - -AugmentedIColony.getExtensionClient - -___ - -### getFundingPot - -▸ **getFundingPot**(`_id`, `overrides?`): `Promise`<[`number`, `BigNumber`, `BigNumber`] & { `associatedType`: `number` ; `associatedTypeId`: `BigNumber` ; `payoutsWeCannotMake`: `BigNumber` }\> - -For the reward funding pot (e.g. id: 0) this returns (0, 0, 0). -Get the non-mapping properties of a pot by id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the pot which details to get | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<[`number`, `BigNumber`, `BigNumber`] & { `associatedType`: `number` ; `associatedTypeId`: `BigNumber` ; `payoutsWeCannotMake`: `BigNumber` }\> - -#### Inherited from - -AugmentedIColony.getFundingPot - -___ - -### getFundingPot(uint256) - -▸ **getFundingPot(uint256)**(`_id`, `overrides?`): `Promise`<[`number`, `BigNumber`, `BigNumber`] & { `associatedType`: `number` ; `associatedTypeId`: `BigNumber` ; `payoutsWeCannotMake`: `BigNumber` }\> - -For the reward funding pot (e.g. id: 0) this returns (0, 0, 0). -Get the non-mapping properties of a pot by id. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the pot which details to get | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<[`number`, `BigNumber`, `BigNumber`] & { `associatedType`: `number` ; `associatedTypeId`: `BigNumber` ; `payoutsWeCannotMake`: `BigNumber` }\> - -#### Inherited from - -AugmentedIColony.getFundingPot(uint256) - -___ - -### getFundingPotBalance - -▸ **getFundingPotBalance**(`_potId`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the `_token` balance of pot with id `_potId`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_potId` | `BigNumberish` | Id of the funding pot | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getFundingPotBalance - -___ - -### getFundingPotBalance(uint256,address) - -▸ **getFundingPotBalance(uint256,address)**(`_potId`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the `_token` balance of pot with id `_potId`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_potId` | `BigNumberish` | Id of the funding pot | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getFundingPotBalance(uint256,address) - -___ - -### getFundingPotCount - -▸ **getFundingPotCount**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of funding pots in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getFundingPotCount - -___ - -### getFundingPotCount() - -▸ **getFundingPotCount()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of funding pots in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getFundingPotCount() - -___ - -### getFundingPotPayout - -▸ **getFundingPotPayout**(`_potId`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the assigned `_token` payouts of pot with id `_potId`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_potId` | `BigNumberish` | Id of the funding pot | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getFundingPotPayout - -___ - -### getFundingPotPayout(uint256,address) - -▸ **getFundingPotPayout(uint256,address)**(`_potId`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the assigned `_token` payouts of pot with id `_potId`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_potId` | `BigNumberish` | Id of the funding pot | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getFundingPotPayout(uint256,address) - -___ - -### getMembersReputation - -▸ **getMembersReputation**(`skillId`): `Promise`<{ `addresses`: `string`[] }\> - -Get all addresses that have reputation for a given skill. -If you need the skillId for a certain domain you can use the [getDomain](ColonyClientV10.md#getdomain) function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `skillId` | `BigNumberish` | The skill id to get the reputation in | - -#### Returns - -`Promise`<{ `addresses`: `string`[] }\> - -All addresses that have a non-zero reputation for the given skill - -#### Inherited from - -AugmentedIColony.getMembersReputation - -___ - -### getMetatransactionNonce - -▸ **getMetatransactionNonce**(`userAddress`, `overrides?`): `Promise`<`BigNumber`\> - -Gets the next metatransaction nonce for user that should be used targeting this contract - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userAddress` | `string` | The address of the user that will sign the metatransaction | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getMetatransactionNonce - -___ - -### getMetatransactionNonce(address) - -▸ **getMetatransactionNonce(address)**(`userAddress`, `overrides?`): `Promise`<`BigNumber`\> - -Gets the next metatransaction nonce for user that should be used targeting this contract - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userAddress` | `string` | The address of the user that will sign the metatransaction | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getMetatransactionNonce(address) - -___ - -### getNonRewardPotsTotal - -▸ **getNonRewardPotsTotal**(`_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the total amount of tokens `_token` minus amount reserved to be paid to the reputation and token holders as rewards. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getNonRewardPotsTotal - -___ - -### getNonRewardPotsTotal(address) - -▸ **getNonRewardPotsTotal(address)**(`_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the total amount of tokens `_token` minus amount reserved to be paid to the reputation and token holders as rewards. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getNonRewardPotsTotal(address) - -___ - -### getObligation - -▸ **getObligation**(`_user`, `_obligator`, `_domainId`, `overrides?`): `Promise`<`BigNumber`\> - -View an obligation of tokens. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User whose tokens are obligated. | -| `_obligator` | `string` | Address of the account who obligated us. | -| `_domainId` | `BigNumberish` | Domain in which we are obligated. | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getObligation - -___ - -### getObligation(address,address,uint256) - -▸ **getObligation(address,address,uint256)**(`_user`, `_obligator`, `_domainId`, `overrides?`): `Promise`<`BigNumber`\> - -View an obligation of tokens. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User whose tokens are obligated. | -| `_obligator` | `string` | Address of the account who obligated us. | -| `_domainId` | `BigNumberish` | Domain in which we are obligated. | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getObligation(address,address,uint256) - -___ - -### getPayment - -▸ **getPayment**(`_id`, `overrides?`): `Promise`<`PaymentStructOutput`\> - -Returns an exiting payment. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Payment identifier | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`PaymentStructOutput`\> - -#### Inherited from - -AugmentedIColony.getPayment - -___ - -### getPayment(uint256) - -▸ **getPayment(uint256)**(`_id`, `overrides?`): `Promise`<`PaymentStructOutput`\> - -Returns an exiting payment. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Payment identifier | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`PaymentStructOutput`\> - -#### Inherited from - -AugmentedIColony.getPayment(uint256) - -___ - -### getPaymentCount - -▸ **getPaymentCount**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of payments in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getPaymentCount - -___ - -### getPaymentCount() - -▸ **getPaymentCount()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of payments in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### 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](ColonyClientV10.md#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](ColonyClientV10.md#getreputationwithoutproofs) method as it requires fewer computations - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `skillId` | `BigNumberish` | The skill id to get the addresses reputation in | -| `address` | `string` | Wallet address to retrieve the reputation of | -| `customRootHash?` | `string` | The `customRootHash` can be set to retrieve the reputation at a certain block time in the past | - -#### Returns - -`Promise`<{ `branchMask`: `string` ; `key`: `string` ; `reputationAmount`: `BigNumber` ; `siblings`: `string`[] ; `value`: `string` }\> - -The reputation amount as well as the two proofs that are needed to verify the reputation on chain - -#### Inherited from - -AugmentedIColony.getReputation - -___ - -### getReputationAcrossDomains - -▸ **getReputationAcrossDomains**(`address`, `customRootHash?`): `Promise`<{ `domainId`: `number` ; `reputationAmount?`: `BigNumberish` ; `skillId`: `number` }[]\> - -Get the reputation for an address across all domains in a Colony. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `address` | `string` | Wallet address to retrieve the reputation of | -| `customRootHash?` | `string` | The `customRootHash` can be set to retrieve the reputation at a certain block time in the past | - -#### Returns - -`Promise`<{ `domainId`: `number` ; `reputationAmount?`: `BigNumberish` ; `skillId`: `number` }[]\> - -The reputation amount - -#### Inherited from - -AugmentedIColony.getReputationAcrossDomains - -___ - -### getReputationWithoutProofs - -▸ **getReputationWithoutProofs**(`skillId`, `address`, `customRootHash?`): `Promise`<{ `key`: `string` ; `reputationAmount`: `BigNumber` ; `value`: `string` }\> - -Get the reputation for an address and a certain skill. -If you need the skillId for a certain domain you can use the [getDomain](ColonyClientV10.md#getdomain) function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `skillId` | `BigNumberish` | The skill id to get the addresses reputation in | -| `address` | `string` | Wallet address to retrieve the reputation of | -| `customRootHash?` | `string` | The `customRootHash` can be set to retrieve the reputation at a certain block time in the past | - -#### Returns - -`Promise`<{ `key`: `string` ; `reputationAmount`: `BigNumber` ; `value`: `string` }\> - -The reputation amount - -#### Inherited from - -AugmentedIColony.getReputationWithoutProofs - -___ - -### getRewardInverse - -▸ **getRewardInverse**(`overrides?`): `Promise`<`BigNumber`\> - -Return 1 / the reward to pay out from revenue. e.g. if the fee is 1% (or 0.01), return 100. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getRewardInverse - -___ - -### getRewardInverse() - -▸ **getRewardInverse()**(`overrides?`): `Promise`<`BigNumber`\> - -Return 1 / the reward to pay out from revenue. e.g. if the fee is 1% (or 0.01), return 100. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getRewardInverse() - -___ - -### getRewardPayoutInfo - -▸ **getRewardPayoutInfo**(`_payoutId`, `overrides?`): `Promise`<`RewardPayoutCycleStructOutput`\> - -Get useful information about specific reward payout. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_payoutId` | `BigNumberish` | Id of the reward payout | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`RewardPayoutCycleStructOutput`\> - -#### Inherited from - -AugmentedIColony.getRewardPayoutInfo - -___ - -### getRewardPayoutInfo(uint256) - -▸ **getRewardPayoutInfo(uint256)**(`_payoutId`, `overrides?`): `Promise`<`RewardPayoutCycleStructOutput`\> - -Get useful information about specific reward payout. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_payoutId` | `BigNumberish` | Id of the reward payout | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`RewardPayoutCycleStructOutput`\> - -#### Inherited from - -AugmentedIColony.getRewardPayoutInfo(uint256) - -___ - -### getRootLocalSkill - -▸ **getRootLocalSkill**(`overrides?`): `Promise`<`BigNumber`\> - -Get the root local skill id - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getRootLocalSkill - -___ - -### getRootLocalSkill() - -▸ **getRootLocalSkill()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the root local skill id - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getRootLocalSkill() - -___ - -### getTask - -▸ **getTask**(`_id`, `overrides?`): `Promise`<[`string`, `string`, `number`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`[]] & { `completionTimestamp`: `BigNumber` ; `deliverableHash`: `string` ; `domainId`: `BigNumber` ; `dueDate`: `BigNumber` ; `fundingPotId`: `BigNumber` ; `skillIds`: `BigNumber`[] ; `specificationHash`: `string` ; `status`: `number` }\> - -Get a task with id `_id` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<[`string`, `string`, `number`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`[]] & { `completionTimestamp`: `BigNumber` ; `deliverableHash`: `string` ; `domainId`: `BigNumber` ; `dueDate`: `BigNumber` ; `fundingPotId`: `BigNumber` ; `skillIds`: `BigNumber`[] ; `specificationHash`: `string` ; `status`: `number` }\> - -#### Inherited from - -AugmentedIColony.getTask - -___ - -### getTask(uint256) - -▸ **getTask(uint256)**(`_id`, `overrides?`): `Promise`<[`string`, `string`, `number`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`[]] & { `completionTimestamp`: `BigNumber` ; `deliverableHash`: `string` ; `domainId`: `BigNumber` ; `dueDate`: `BigNumber` ; `fundingPotId`: `BigNumber` ; `skillIds`: `BigNumber`[] ; `specificationHash`: `string` ; `status`: `number` }\> - -Get a task with id `_id` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<[`string`, `string`, `number`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`, `BigNumber`[]] & { `completionTimestamp`: `BigNumber` ; `deliverableHash`: `string` ; `domainId`: `BigNumber` ; `dueDate`: `BigNumber` ; `fundingPotId`: `BigNumber` ; `skillIds`: `BigNumber`[] ; `specificationHash`: `string` ; `status`: `number` }\> - -#### Inherited from - -AugmentedIColony.getTask(uint256) - -___ - -### getTaskChangeNonce - -▸ **getTaskChangeNonce**(`_id`, `overrides?`): `Promise`<`BigNumber`\> - -Starts from 0 and is incremented on every co-reviewed task change via `executeTaskChange` call. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTaskChangeNonce - -___ - -### getTaskChangeNonce(uint256) - -▸ **getTaskChangeNonce(uint256)**(`_id`, `overrides?`): `Promise`<`BigNumber`\> - -Starts from 0 and is incremented on every co-reviewed task change via `executeTaskChange` call. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTaskChangeNonce(uint256) - -___ - -### getTaskCount - -▸ **getTaskCount**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of tasks in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTaskCount - -___ - -### getTaskCount() - -▸ **getTaskCount()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the number of tasks in the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTaskCount() - -___ - -### getTaskPayout - -▸ **getTaskPayout**(`_id`, `_role`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get payout amount in `_token` denomination for role `_role` in task `_id`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTaskPayout - -___ - -### getTaskPayout(uint256,uint8,address) - -▸ **getTaskPayout(uint256,uint8,address)**(`_id`, `_role`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get payout amount in `_token` denomination for role `_role` in task `_id`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTaskPayout(uint256,uint8,address) - -___ - -### getTaskRole - -▸ **getTaskRole**(`_id`, `_role`, `overrides?`): `Promise`<`RoleStructOutput`\> - -Get the `Role` properties back for role `_role` in task `_id`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`RoleStructOutput`\> - -#### Inherited from - -AugmentedIColony.getTaskRole - -___ - -### getTaskRole(uint256,uint8) - -▸ **getTaskRole(uint256,uint8)**(`_id`, `_role`, `overrides?`): `Promise`<`RoleStructOutput`\> - -Get the `Role` properties back for role `_role` in task `_id`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`RoleStructOutput`\> - -#### Inherited from - -AugmentedIColony.getTaskRole(uint256,uint8) - -___ - -### getTaskWorkRatingSecret - -▸ **getTaskWorkRatingSecret**(`_id`, `_role`, `overrides?`): `Promise`<`string`\> - -Get the rating secret submitted for role `_role` in task `_id` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getTaskWorkRatingSecret - -___ - -### getTaskWorkRatingSecret(uint256,uint8) - -▸ **getTaskWorkRatingSecret(uint256,uint8)**(`_id`, `_role`, `overrides?`): `Promise`<`string`\> - -Get the rating secret submitted for role `_role` in task `_id` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getTaskWorkRatingSecret(uint256,uint8) - -___ - -### getTaskWorkRatingSecretsInfo - -▸ **getTaskWorkRatingSecretsInfo**(`_id`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`] & { `lastSubmittedAt`: `BigNumber` ; `nSecrets`: `BigNumber` }\> - -Get the `ColonyStorage.RatingSecrets` information for task `_id`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<[`BigNumber`, `BigNumber`] & { `lastSubmittedAt`: `BigNumber` ; `nSecrets`: `BigNumber` }\> - -#### Inherited from - -AugmentedIColony.getTaskWorkRatingSecretsInfo - -___ - -### getTaskWorkRatingSecretsInfo(uint256) - -▸ **getTaskWorkRatingSecretsInfo(uint256)**(`_id`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`] & { `lastSubmittedAt`: `BigNumber` ; `nSecrets`: `BigNumber` }\> - -Get the `ColonyStorage.RatingSecrets` information for task `_id`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<[`BigNumber`, `BigNumber`] & { `lastSubmittedAt`: `BigNumber` ; `nSecrets`: `BigNumber` }\> - -#### Inherited from - -AugmentedIColony.getTaskWorkRatingSecretsInfo(uint256) - -___ - -### getToken - -▸ **getToken**(`overrides?`): `Promise`<`string`\> - -Get the colony token. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getToken - -___ - -### getToken() - -▸ **getToken()**(`overrides?`): `Promise`<`string`\> - -Get the colony token. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getToken() - -___ - -### getTokenApproval - -▸ **getTokenApproval**(`token`, `spender`, `overrides?`): `Promise`<`BigNumber`\> - -Get the current approval amount - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | The address of the token which was approved | -| `spender` | `string` | The account we have approved | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTokenApproval - -___ - -### getTokenApproval(address,address) - -▸ **getTokenApproval(address,address)**(`token`, `spender`, `overrides?`): `Promise`<`BigNumber`\> - -Get the current approval amount - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | The address of the token which was approved | -| `spender` | `string` | The account we have approved | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTokenApproval(address,address) - -___ - -### getTotalTokenApproval - -▸ **getTotalTokenApproval**(`token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the current total approval amount across all spenders - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | The address of the token which was approved | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTotalTokenApproval - -___ - -### getTotalTokenApproval(address) - -▸ **getTotalTokenApproval(address)**(`token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the current total approval amount across all spenders - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | The address of the token which was approved | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.getTotalTokenApproval(address) - -___ - -### getUserRoles - -▸ **getUserRoles**(`_user`, `_domain`, `overrides?`): `Promise`<`string`\> - -Gets the bytes32 representation of the roles for a user in a given domain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose roles we want to get | -| `_domain` | `BigNumberish` | The domain we want to get roles in | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getUserRoles - -___ - -### getUserRoles(address,uint256) - -▸ **getUserRoles(address,uint256)**(`_user`, `_domain`, `overrides?`): `Promise`<`string`\> - -Gets the bytes32 representation of the roles for a user in a given domain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose roles we want to get | -| `_domain` | `BigNumberish` | The domain we want to get roles in | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.getUserRoles(address,uint256) - -___ - -### hasInheritedUserRole - -▸ **hasInheritedUserRole**(`_user`, `_domainId`, `_role`, `_childSkillIndex`, `_childDomainId`, `overrides?`): `Promise`<`boolean`\> - -Check whether a given user has a given role for the colony, in a child domain. Calls the function of the same name on the colony's authority contract and an internal inheritance validator function - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose role we want to check | -| `_domainId` | `BigNumberish` | Domain in which the caller has the role | -| `_role` | `BigNumberish` | The role we want to check for | -| `_childSkillIndex` | `BigNumberish` | The index that the `_childDomainId` is relative to `_domainId` | -| `_childDomainId` | `BigNumberish` | The domain where we want to use the role | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.hasInheritedUserRole - -___ - -### hasInheritedUserRole(address,uint256,uint8,uint256,uint256) - -▸ **hasInheritedUserRole(address,uint256,uint8,uint256,uint256)**(`_user`, `_domainId`, `_role`, `_childSkillIndex`, `_childDomainId`, `overrides?`): `Promise`<`boolean`\> - -Check whether a given user has a given role for the colony, in a child domain. Calls the function of the same name on the colony's authority contract and an internal inheritance validator function - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose role we want to check | -| `_domainId` | `BigNumberish` | Domain in which the caller has the role | -| `_role` | `BigNumberish` | The role we want to check for | -| `_childSkillIndex` | `BigNumberish` | The index that the `_childDomainId` is relative to `_domainId` | -| `_childDomainId` | `BigNumberish` | The domain where we want to use the role | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.hasInheritedUserRole(address,uint256,uint8,uint256,uint256) - -___ - -### hasInheritedUserRoleWithProofs - -▸ **hasInheritedUserRoleWithProofs**(`_user`, `_domainId`, `_role`, `overrides?`): `Promise`<`boolean`\> - -Same as [hasInheritedUserRole](ColonyClientV10.md#hasinheriteduserrole), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose role we want to check | -| `_domainId` | `BigNumberish` | Domain in which the caller has the role | -| `_role` | `BigNumberish` | The role we want to check for | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -ColonyAugmentsV4.hasInheritedUserRoleWithProofs - -___ - -### hasUserRole - -▸ **hasUserRole**(`_user`, `_domainId`, `_role`, `overrides?`): `Promise`<`boolean`\> - -Check whether a given user has a given role for the colony. Calls the function of the same name on the colony's authority contract. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose role we want to check | -| `_domainId` | `BigNumberish` | The domain where we want to check for the role | -| `_role` | `BigNumberish` | The role we want to check for | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.hasUserRole - -___ - -### hasUserRole(address,uint256,uint8) - -▸ **hasUserRole(address,uint256,uint8)**(`_user`, `_domainId`, `_role`, `overrides?`): `Promise`<`boolean`\> - -Check whether a given user has a given role for the colony. Calls the function of the same name on the colony's authority contract. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose role we want to check | -| `_domainId` | `BigNumberish` | The domain where we want to check for the role | -| `_role` | `BigNumberish` | The role we want to check for | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.hasUserRole(address,uint256,uint8) - -___ - -### initialiseColony - -▸ **initialiseColony**(`_colonyNetworkAddress`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the reward inverse to the uint max 2**256 - 1. -Called once when the colony is created to initialise certain storage slot values. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_colonyNetworkAddress` | `string` | Address of the colony network | -| `_token` | `string` | Address of the colony ERC20 Token | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.initialiseColony - -___ - -### initialiseColony(address,address) - -▸ **initialiseColony(address,address)**(`_colonyNetworkAddress`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the reward inverse to the uint max 2**256 - 1. -Called once when the colony is created to initialise certain storage slot values. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_colonyNetworkAddress` | `string` | Address of the colony network | -| `_token` | `string` | Address of the colony ERC20 Token | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.initialiseColony(address,address) - -___ - -### initialiseRootLocalSkill - -▸ **initialiseRootLocalSkill**(`overrides?`): `Promise`<`ContractTransaction`\> - -Initialise the local skill tree for the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.initialiseRootLocalSkill - -___ - -### initialiseRootLocalSkill() - -▸ **initialiseRootLocalSkill()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Initialise the local skill tree for the colony. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.initialiseRootLocalSkill() - -___ - -### installExtension - -▸ **installExtension**(`extensionId`, `version`, `overrides?`): `Promise`<`ContractTransaction`\> - -Install an extension to the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extensionId` | `BytesLike` | keccak256 hash of the extension name, used as an indentifier | -| `version` | `BigNumberish` | The new extension version to install | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.installExtension - -___ - -### installExtension(bytes32,uint256) - -▸ **installExtension(bytes32,uint256)**(`extensionId`, `version`, `overrides?`): `Promise`<`ContractTransaction`\> - -Install an extension to the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extensionId` | `BytesLike` | keccak256 hash of the extension name, used as an indentifier | -| `version` | `BigNumberish` | The new extension version to install | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.installExtension(bytes32,uint256) - -___ - -### installExtensionChecked - -▸ **installExtensionChecked**(`extension`, `version?`, `overrides?`): `Promise`<`ContractTransaction`\> - -Similar to [installExtension](ColonyClientV10.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extension` | [`Extension`](../enums/Extension.md) | A [Extension](../enums/Extension.md) name | -| `version?` | `number` | The desired version number of the extension you wish to install | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -ColonyAugmentsV5.installExtensionChecked - -___ - -### isInRecoveryMode - -▸ **isInRecoveryMode**(`overrides?`): `Promise`<`boolean`\> - -Is colony network in recovery mode. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.isInRecoveryMode - -___ - -### isInRecoveryMode() - -▸ **isInRecoveryMode()**(`overrides?`): `Promise`<`boolean`\> - -Is colony network in recovery mode. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.isInRecoveryMode() - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| `EventFilter` | - -#### Returns - -`number` - -#### Inherited from - -AugmentedIColony.listenerCount - -___ - -### listeners - -▸ **listeners**<`TEvent`\>(`eventFilter?`): `TypedListener`<`TEvent`\>[] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter?` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -`TypedListener`<`TEvent`\>[] - -#### Inherited from - -AugmentedIColony.listeners - -▸ **listeners**(`eventName?`): `Listener`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -`Listener`[] - -#### Inherited from - -AugmentedIColony.listeners - -___ - -### lockExpenditure - -▸ **lockExpenditure**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Locks the expenditure and prevents further editing. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.lockExpenditure - -___ - -### lockExpenditure(uint256) - -▸ **lockExpenditure(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Locks the expenditure and prevents further editing. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.lockExpenditure(uint256) - -___ - -### lockToken - -▸ **lockToken**(`overrides?`): `Promise`<`ContractTransaction`\> - -Lock the colony's token. Can only be called by a network-managed extension. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.lockToken - -___ - -### lockToken() - -▸ **lockToken()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Lock the colony's token. Can only be called by a network-managed extension. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.lockToken() - -___ - -### makeArbitraryTransaction - -▸ **makeArbitraryTransaction**(`_to`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated Execute`** - -arbitrary transaction on behalf of the Colony - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_to` | `string` | Contract to receive the function call (cannot be this contract, network or token locking) | -| `_action` | `BytesLike` | Bytes array encoding the function call and arguments | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeArbitraryTransaction - -___ - -### makeArbitraryTransaction(address,bytes) - -▸ **makeArbitraryTransaction(address,bytes)**(`_to`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated Execute`** - -arbitrary transaction on behalf of the Colony - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_to` | `string` | Contract to receive the function call (cannot be this contract, network or token locking) | -| `_action` | `BytesLike` | Bytes array encoding the function call and arguments | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeArbitraryTransaction(address,bytes) - -___ - -### makeArbitraryTransactions - -▸ **makeArbitraryTransactions**(`_targets`, `_actions`, `_strict`, `overrides?`): `Promise`<`ContractTransaction`\> - -Execute arbitrary transactions on behalf of the Colony in series - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_targets` | `string`[] | Array of addressed to be targeted | -| `_actions` | `BytesLike`[] | Array of Bytes arrays encoding the function calls and arguments | -| `_strict` | `boolean` | Boolean indicating whether if one transaction fails, the whole call to this function should fail. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeArbitraryTransactions - -___ - -### makeArbitraryTransactions(address[],bytes[],bool) - -▸ **makeArbitraryTransactions(address[],bytes[],bool)**(`_targets`, `_actions`, `_strict`, `overrides?`): `Promise`<`ContractTransaction`\> - -Execute arbitrary transactions on behalf of the Colony in series - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_targets` | `string`[] | Array of addressed to be targeted | -| `_actions` | `BytesLike`[] | Array of Bytes arrays encoding the function calls and arguments | -| `_strict` | `boolean` | Boolean indicating whether if one transaction fails, the whole call to this function should fail. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeArbitraryTransactions(address[],bytes[],bool) - -___ - -### makeExpenditure - -▸ **makeExpenditure**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new expenditure in the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, (only used if `_permissionDomainId` is different to `_domainId`) | -| `_domainId` | `BigNumberish` | The domain where the expenditure belongs | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeExpenditure - -___ - -### makeExpenditure(uint256,uint256,uint256) - -▸ **makeExpenditure(uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new expenditure in the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, (only used if `_permissionDomainId` is different to `_domainId`) | -| `_domainId` | `BigNumberish` | The domain where the expenditure belongs | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeExpenditure(uint256,uint256,uint256) - -___ - -### makeExpenditureWithProofs - -▸ **makeExpenditureWithProofs**(`_domainId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [makeExpenditure](ColonyClientV10.md#makeexpenditure), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where the expenditure belongs | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -ColonyAugmentsV4.makeExpenditureWithProofs - -___ - -### makeSingleArbitraryTransaction - -▸ **makeSingleArbitraryTransaction**(`_target`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> - -Only callable by the colony itself. If you wish to use this functionality, you should use the makeAbitraryTransactions function -Executes a single arbitrary transaction - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_target` | `string` | Contract to receive the function call | -| `_action` | `BytesLike` | Bytes array encoding the function call and arguments | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeSingleArbitraryTransaction - -___ - -### makeSingleArbitraryTransaction(address,bytes) - -▸ **makeSingleArbitraryTransaction(address,bytes)**(`_target`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> - -Only callable by the colony itself. If you wish to use this functionality, you should use the makeAbitraryTransactions function -Executes a single arbitrary transaction - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_target` | `string` | Contract to receive the function call | -| `_action` | `BytesLike` | Bytes array encoding the function call and arguments | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeSingleArbitraryTransaction(address,bytes) - -___ - -### makeTask - -▸ **makeTask**(`_permissionDomainId`, `_childSkillIndex`, `_specificationHash`, `_domainId`, `_skillId`, `_dueDate`, `overrides?`): `Promise`<`ContractTransaction`\> - -Make a new task in the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_specificationHash` | `BytesLike` | Database identifier where the task specification is stored | -| `_domainId` | `BigNumberish` | The domain where the task belongs | -| `_skillId` | `BigNumberish` | The skill associated with the task, can set to `0` for no-op | -| `_dueDate` | `BigNumberish` | The due date of the task, can set to `0` for no-op | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeTask - -___ - -### makeTask(uint256,uint256,bytes32,uint256,uint256,uint256) - -▸ **makeTask(uint256,uint256,bytes32,uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_specificationHash`, `_domainId`, `_skillId`, `_dueDate`, `overrides?`): `Promise`<`ContractTransaction`\> - -Make a new task in the colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_specificationHash` | `BytesLike` | Database identifier where the task specification is stored | -| `_domainId` | `BigNumberish` | The domain where the task belongs | -| `_skillId` | `BigNumberish` | The skill associated with the task, can set to `0` for no-op | -| `_dueDate` | `BigNumberish` | The due date of the task, can set to `0` for no-op | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeTask(uint256,uint256,bytes32,uint256,uint256,uint256) - -___ - -### makeTaskWithProofs - -▸ **makeTaskWithProofs**(`_specificationHash`, `_domainId`, `_skillId`, `_dueDate`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [makeTask](ColonyClientV10.md#maketask), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_specificationHash` | `BytesLike` | Database identifier where the task specification is stored | -| `_domainId` | `BigNumberish` | The domain where the task belongs | -| `_skillId` | `BigNumberish` | The skill associated with the task, can set to `0` for no-op | -| `_dueDate` | `BigNumberish` | The due date of the task, can set to `0` for no-op | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.makeTaskWithProofs - -___ - -### mintTokens - -▸ **mintTokens**(`_wad`, `overrides?`): `Promise`<`ContractTransaction`\> - -Mint `_wad` amount of colony tokens. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_wad` | `BigNumberish` | Amount to mint | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.mintTokens - -___ - -### mintTokens(uint256) - -▸ **mintTokens(uint256)**(`_wad`, `overrides?`): `Promise`<`ContractTransaction`\> - -Mint `_wad` amount of colony tokens. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_wad` | `BigNumberish` | Amount to mint | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.mintTokens(uint256) - -___ - -### mintTokensFor - -▸ **mintTokensFor**(`_guy`, `_wad`, `overrides?`): `Promise`<`ContractTransaction`\> - -Mint `_wad` amount of colony tokens and send to `_guy`. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_guy` | `string` | Recipient of new tokens | -| `_wad` | `BigNumberish` | Amount to mint | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.mintTokensFor - -___ - -### mintTokensFor(address,uint256) - -▸ **mintTokensFor(address,uint256)**(`_guy`, `_wad`, `overrides?`): `Promise`<`ContractTransaction`\> - -Mint `_wad` amount of colony tokens and send to `_guy`. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_guy` | `string` | Recipient of new tokens | -| `_wad` | `BigNumberish` | Amount to mint | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.mintTokensFor(address,uint256) - -___ - -### moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,address) - -▸ **moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,address)**(`_permissionDomainId`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_fromPot`, `_toPot`, `_amount`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated Move`** - -a given amount: `_amount` of `_token` funds from funding pot with id `_fromPot` to one with id `_toPot`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_fromChildSkillIndex` | `BigNumberish` | The child index in `_permissionDomainId` where we can find the domain for `_fromPotId` | -| `_toChildSkillIndex` | `BigNumberish` | The child index in `_permissionDomainId` where we can find the domain for `_toPotId` | -| `_fromPot` | `BigNumberish` | Funding pot id providing the funds | -| `_toPot` | `BigNumberish` | Funding pot id receiving the funds | -| `_amount` | `BigNumberish` | Amount of funds | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,address) - -___ - -### moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address) - -▸ **moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address)**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_fromPot`, `_toPot`, `_amount`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Move a given amount: `_amount` of `_token` funds from funding pot with id `_fromPot` to one with id `_toPot`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The child index in _permissionDomainId where I will be taking this action | -| `_domainId` | `BigNumberish` | The domain where I am taking this action, pointed to by _permissionDomainId and _childSkillIndex | -| `_fromChildSkillIndex` | `BigNumberish` | In the array of child skills for the skill associated with the domain pointed to by _permissionDomainId + _childSkillIndex, the index of the skill associated with the domain that contains _fromPot | -| `_toChildSkillIndex` | `BigNumberish` | The same, but for the _toPot which the funds are being moved to | -| `_fromPot` | `BigNumberish` | Funding pot id providing the funds | -| `_toPot` | `BigNumberish` | Funding pot id receiving the funds | -| `_amount` | `BigNumberish` | Amount of funds | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address) - -___ - -### moveFundsBetweenPotsWithProofs(uint256,uint256,uint256,address) - -▸ **moveFundsBetweenPotsWithProofs(uint256,uint256,uint256,address)**(`_fromPot`, `_toPot`, `_amount`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated`** - -Same as [moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,address)](ColonyClientV10.md#movefundsbetweenpots(uint256,uint256,uint256,uint256,uint256,uint256,address)), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fromPot` | `BigNumberish` | Funding pot id providing the funds | -| `_toPot` | `BigNumberish` | Funding pot id receiving the funds | -| `_amount` | `BigNumberish` | Amount of funds | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -MoveFundsBetweenPotsAugmentsB.moveFundsBetweenPotsWithProofs(uint256,uint256,uint256,address) - -___ - -### moveFundsBetweenPotsWithProofs(uint256,uint256,uint256,uint256,address) - -▸ **moveFundsBetweenPotsWithProofs(uint256,uint256,uint256,uint256,address)**(`_domainId`, `_fromPot`, `_toPot`, `_amount`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [moveFundsBetweenPots(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address)](ColonyClientV10.md#movefundsbetweenpots(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address)), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where I am taking this action, pointed to by _permissionDomainId and _childSkillIndex | -| `_fromPot` | `BigNumberish` | Funding pot id providing the funds | -| `_toPot` | `BigNumberish` | Funding pot id receiving the funds | -| `_amount` | `BigNumberish` | Amount of funds | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -MoveFundsBetweenPotsAugmentsB.moveFundsBetweenPotsWithProofs(uint256,uint256,uint256,uint256,address) - -___ - -### numRecoveryRoles - -▸ **numRecoveryRoles**(`overrides?`): `Promise`<`BigNumber`\> - -Return number of recovery roles. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.numRecoveryRoles - -___ - -### numRecoveryRoles() - -▸ **numRecoveryRoles()**(`overrides?`): `Promise`<`BigNumber`\> - -Return number of recovery roles. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of the account we are obligating. | -| `_domainId` | `BigNumberish` | Domain in which we are obligating the user. | -| `_amount` | `BigNumberish` | Amount of internal token we are obligating. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.obligateStake - -___ - -### obligateStake(address,uint256,uint256) - -▸ **obligateStake(address,uint256,uint256)**(`_user`, `_domainId`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Obligate the user some amount of tokens as a stake. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of the account we are obligating. | -| `_domainId` | `BigNumberish` | Domain in which we are obligating the user. | -| `_amount` | `BigNumberish` | Amount of internal token we are obligating. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.obligateStake(address,uint256,uint256) - -___ - -### owner - -▸ **owner**(`overrides?`): `Promise`<`string`\> - -Used for testing. -Get the colony `owner` address. This should be address(0x0) at all times. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.owner - -___ - -### owner() - -▸ **owner()**(`overrides?`): `Promise`<`string`\> - -Used for testing. -Get the colony `owner` address. This should be address(0x0) at all times. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedIColony.owner() - -___ - -### queryFilter - -▸ **queryFilter**<`TEvent`\>(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<`TEvent`[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `TypedEventFilter`<`TEvent`\> | -| `fromBlockOrBlockhash?` | `string` \| `number` | -| `toBlock?` | `string` \| `number` | - -#### Returns - -`Promise`<`TEvent`[]\> - -#### Inherited from - -AugmentedIColony.queryFilter - -___ - -### registerColonyLabel - -▸ **registerColonyLabel**(`colonyName`, `orbitdb`, `overrides?`): `Promise`<`ContractTransaction`\> - -Register colony's ENS label. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `colonyName` | `string` | The label to register. | -| `orbitdb` | `string` | The path of the orbitDB database associated with the colony name | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.registerColonyLabel - -___ - -### registerColonyLabel(string,string) - -▸ **registerColonyLabel(string,string)**(`colonyName`, `orbitdb`, `overrides?`): `Promise`<`ContractTransaction`\> - -Register colony's ENS label. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `colonyName` | `string` | The label to register. | -| `orbitdb` | `string` | The path of the orbitDB database associated with the colony name | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.registerColonyLabel(string,string) - -___ - -### removeAllListeners - -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`ColonyClientV10`](ColonyClientV10.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -[`ColonyClientV10`](ColonyClientV10.md) - -#### Inherited from - -AugmentedIColony.removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`ColonyClientV10`](ColonyClientV10.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -[`ColonyClientV10`](ColonyClientV10.md) - -#### Inherited from - -AugmentedIColony.removeAllListeners - -___ - -### removeRecoveryRole - -▸ **removeRecoveryRole**(`_user`, `overrides?`): `Promise`<`ContractTransaction`\> - -Remove colony recovery role. Can only be called by root role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to remove recovery role from | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.removeRecoveryRole - -___ - -### removeRecoveryRole(address) - -▸ **removeRecoveryRole(address)**(`_user`, `overrides?`): `Promise`<`ContractTransaction`\> - -Remove colony recovery role. Can only be called by root role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to remove recovery role from | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.removeRecoveryRole(address) - -___ - -### removeTaskEvaluatorRole - -▸ **removeTaskEvaluatorRole**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Removing evaluator role. Agreed between manager and currently assigned evaluator. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.removeTaskEvaluatorRole - -___ - -### removeTaskEvaluatorRole(uint256) - -▸ **removeTaskEvaluatorRole(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Removing evaluator role. Agreed between manager and currently assigned evaluator. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.removeTaskEvaluatorRole(uint256) - -___ - -### removeTaskWorkerRole - -▸ **removeTaskWorkerRole**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Removing worker role. Agreed between manager and currently assigned worker. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.removeTaskWorkerRole - -___ - -### removeTaskWorkerRole(uint256) - -▸ **removeTaskWorkerRole(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Removing worker role. Agreed between manager and currently assigned worker. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.removeTaskWorkerRole(uint256) - -___ - -### revealTaskWorkRating - -▸ **revealTaskWorkRating**(`_id`, `_role`, `_rating`, `_salt`, `overrides?`): `Promise`<`ContractTransaction`\> - -Compares the `keccak256(_salt, _rating)` output with the previously submitted rating secret and if they match, sets the task role properties `rated` to `true` and `rating` to `_rating`. -Reveal the secret rating submitted in `IColony.submitTaskWorkRating` for task `_id` and task role with id `_role`. Allowed within 5 days period starting which whichever is first from either both rating secrets being submitted (via `IColony.submitTaskWorkRating`) or the 5 day rating period expiring. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `_rating` | `BigNumberish` | 0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50) | -| `_salt` | `BytesLike` | Salt value used to generate the rating secret | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.revealTaskWorkRating - -___ - -### revealTaskWorkRating(uint256,uint8,uint8,bytes32) - -▸ **revealTaskWorkRating(uint256,uint8,uint8,bytes32)**(`_id`, `_role`, `_rating`, `_salt`, `overrides?`): `Promise`<`ContractTransaction`\> - -Compares the `keccak256(_salt, _rating)` output with the previously submitted rating secret and if they match, sets the task role properties `rated` to `true` and `rating` to `_rating`. -Reveal the secret rating submitted in `IColony.submitTaskWorkRating` for task `_id` and task role with id `_role`. Allowed within 5 days period starting which whichever is first from either both rating secrets being submitted (via `IColony.submitTaskWorkRating`) or the 5 day rating period expiring. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `_rating` | `BigNumberish` | 0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50) | -| `_salt` | `BytesLike` | Salt value used to generate the rating secret | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.revealTaskWorkRating(uint256,uint8,uint8,bytes32) - -___ - -### setAdministrationRole - -▸ **setAdministrationRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony admin role. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root/architecture role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give an admin role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setAdministrationRole - -___ - -### setAdministrationRole(uint256,uint256,address,uint256,bool) - -▸ **setAdministrationRole(uint256,uint256,address,uint256,bool)**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony admin role. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root/architecture role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give an admin role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setAdministrationRole(uint256,uint256,address,uint256,bool) - -___ - -### setAdministrationRoleWithProofs - -▸ **setAdministrationRoleWithProofs**(`_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setAdministrationRole](ColonyClientV10.md#setadministrationrole), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give an admin role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setAdministrationRoleWithProofs - -___ - -### setAllTaskPayouts - -▸ **setAllTaskPayouts**(`_id`, `_token`, `_managerAmount`, `_evaluatorAmount`, `_workerAmount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only call if evaluator and worker are unassigned or manager, otherwise need signature. -Set `_token` payout for all roles in task `_id` to the respective amounts. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_managerAmount` | `BigNumberish` | Payout amount for manager | -| `_evaluatorAmount` | `BigNumberish` | Payout amount for evaluator | -| `_workerAmount` | `BigNumberish` | Payout amount for worker | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setAllTaskPayouts - -___ - -### setAllTaskPayouts(uint256,address,uint256,uint256,uint256) - -▸ **setAllTaskPayouts(uint256,address,uint256,uint256,uint256)**(`_id`, `_token`, `_managerAmount`, `_evaluatorAmount`, `_workerAmount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only call if evaluator and worker are unassigned or manager, otherwise need signature. -Set `_token` payout for all roles in task `_id` to the respective amounts. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_managerAmount` | `BigNumberish` | Payout amount for manager | -| `_evaluatorAmount` | `BigNumberish` | Payout amount for evaluator | -| `_workerAmount` | `BigNumberish` | Payout amount for worker | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setAllTaskPayouts(uint256,address,uint256,uint256,uint256) - -___ - -### setArbitrationRole - -▸ **setArbitrationRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony arbitration role. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give an arbitration role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setArbitrationRole - -___ - -### setArbitrationRole(uint256,uint256,address,uint256,bool) - -▸ **setArbitrationRole(uint256,uint256,address,uint256,bool)**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony arbitration role. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give an arbitration role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setArbitrationRole(uint256,uint256,address,uint256,bool) - -___ - -### setArbitrationRoleWithProofs - -▸ **setArbitrationRoleWithProofs**(`_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setArbitrationRole](ColonyClientV10.md#setarbitrationrole), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give an arbitration role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -ColonyAugmentsV3.setArbitrationRoleWithProofs - -___ - -### setArchitectureRole - -▸ **setArchitectureRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony architecture role. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root/architecture role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give an architecture role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setArchitectureRole - -___ - -### setArchitectureRole(uint256,uint256,address,uint256,bool) - -▸ **setArchitectureRole(uint256,uint256,address,uint256,bool)**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony architecture role. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root/architecture role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give an architecture role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setArchitectureRole(uint256,uint256,address,uint256,bool) - -___ - -### setArchitectureRoleWithProofs - -▸ **setArchitectureRoleWithProofs**(`_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setArchitectureRole](ColonyClientV10.md#setarchitecturerole), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give an architecture role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setArchitectureRoleWithProofs - -___ - -### setDefaultGlobalClaimDelay - -▸ **setDefaultGlobalClaimDelay**(`_globalClaimDelay`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the default global claim delay for expenditures - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_globalClaimDelay` | `BigNumberish` | The new default global claim delay | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setDefaultGlobalClaimDelay - -___ - -### setDefaultGlobalClaimDelay(uint256) - -▸ **setDefaultGlobalClaimDelay(uint256)**(`_globalClaimDelay`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the default global claim delay for expenditures - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_globalClaimDelay` | `BigNumberish` | The new default global claim delay | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setDefaultGlobalClaimDelay(uint256) - -___ - -### setExpenditureClaimDelay - -▸ **setExpenditureClaimDelay**(`_id`, `_slot`, `_claimDelay`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated Sets`** - -the claim delay on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Number of the slot | -| `_claimDelay` | `BigNumberish` | Duration of time (in seconds) to delay | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureClaimDelay - -___ - -### setExpenditureClaimDelay(uint256,uint256,uint256) - -▸ **setExpenditureClaimDelay(uint256,uint256,uint256)**(`_id`, `_slot`, `_claimDelay`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated Sets`** - -the claim delay on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Number of the slot | -| `_claimDelay` | `BigNumberish` | Duration of time (in seconds) to delay | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureClaimDelay(uint256,uint256,uint256) - -___ - -### setExpenditureClaimDelays - -▸ **setExpenditureClaimDelays**(`_id`, `_slots`, `_claimDelays`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the claim delays in given expenditure slots. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slots` | `BigNumberish`[] | Array of slots to set claim delays | -| `_claimDelays` | `BigNumberish`[] | Durations of time (in seconds) to delay | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureClaimDelays - -___ - -### setExpenditureClaimDelays(uint256,uint256[],uint256[]) - -▸ **setExpenditureClaimDelays(uint256,uint256[],uint256[])**(`_id`, `_slots`, `_claimDelays`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the claim delays in given expenditure slots. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slots` | `BigNumberish`[] | Array of slots to set claim delays | -| `_claimDelays` | `BigNumberish`[] | Durations of time (in seconds) to delay | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureClaimDelays(uint256,uint256[],uint256[]) - -___ - -### setExpenditureMetadata(uint256,string) - -▸ **setExpenditureMetadata(uint256,string)**(`_id`, `_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called while expenditure is in draft state. -Sets the metadata for an expenditure. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_metadata` | `string` | IPFS hash of the metadata | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureMetadata(uint256,string) - -___ - -### setExpenditureMetadata(uint256,uint256,uint256,string) - -▸ **setExpenditureMetadata(uint256,uint256,uint256,string)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the metadata for an expenditure. Can only be called by Arbitration role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_metadata` | `string` | IPFS hash of the metadata | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureMetadata(uint256,uint256,uint256,string) - -___ - -### setExpenditurePayout(uint256,uint256,address,uint256) - -▸ **setExpenditurePayout(uint256,uint256,address,uint256)**(`_id`, `_slot`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called while expenditure is in draft state. - -**`Deprecated Set`** - -the token payout on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slot` | `BigNumberish` | Number of the slot | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditurePayout(uint256,uint256,address,uint256) - -___ - -### setExpenditurePayout(uint256,uint256,uint256,uint256,address,uint256) - -▸ **setExpenditurePayout(uint256,uint256,uint256,uint256,address,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_slot`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the token payout in a given expenditure slot. Can only be called by an Arbitration user. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slot` | `BigNumberish` | The slot to set the payout | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditurePayout(uint256,uint256,uint256,uint256,address,uint256) - -___ - -### setExpenditurePayoutModifiers - -▸ **setExpenditurePayoutModifiers**(`_id`, `_slots`, `_payoutModifiers`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the payout modifiers in given expenditure slots. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slots` | `BigNumberish`[] | Array of slots to set payout modifiers | -| `_payoutModifiers` | `BigNumberish`[] | Values (between +/- WAD) to modify the payout & reputation bonus | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditurePayoutModifiers - -___ - -### setExpenditurePayoutModifiers(uint256,uint256[],int256[]) - -▸ **setExpenditurePayoutModifiers(uint256,uint256[],int256[])**(`_id`, `_slots`, `_payoutModifiers`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the payout modifiers in given expenditure slots. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slots` | `BigNumberish`[] | Array of slots to set payout modifiers | -| `_payoutModifiers` | `BigNumberish`[] | Values (between +/- WAD) to modify the payout & reputation bonus | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditurePayoutModifiers(uint256,uint256[],int256[]) - -___ - -### setExpenditurePayoutWithProofs - -▸ **setExpenditurePayoutWithProofs**(`_id`, `_slot`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as the permissioned overload of [setExpenditurePayout(uint256,uint256,uint256,uint256,address,uint256)](ColonyClientV10.md#setexpenditurepayout(uint256,uint256,uint256,uint256,address,uint256)), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slot` | `BigNumberish` | Number of the slot | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -ColonyAugmentsV7.setExpenditurePayoutWithProofs - -___ - -### setExpenditurePayouts - -▸ **setExpenditurePayouts**(`_id`, `_slots`, `_token`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called while expenditure is in draft state. -Set the token payouts in given expenditure slots. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slots` | `BigNumberish`[] | Array of slots to set payouts | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amounts` | `BigNumberish`[] | Payout amounts | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditurePayouts - -___ - -### setExpenditurePayouts(uint256,uint256[],address,uint256[]) - -▸ **setExpenditurePayouts(uint256,uint256[],address,uint256[])**(`_id`, `_slots`, `_token`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called while expenditure is in draft state. -Set the token payouts in given expenditure slots. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slots` | `BigNumberish`[] | Array of slots to set payouts | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amounts` | `BigNumberish`[] | Payout amounts | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditurePayouts(uint256,uint256[],address,uint256[]) - -___ - -### setExpenditureRecipient - -▸ **setExpenditureRecipient**(`_id`, `_slot`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called while expenditure is in draft state. - -**`Deprecated Sets`** - -the recipient on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slot` | `BigNumberish` | Slot for the recipient address | -| `_recipient` | `string` | Address of the recipient | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureRecipient - -___ - -### setExpenditureRecipient(uint256,uint256,address) - -▸ **setExpenditureRecipient(uint256,uint256,address)**(`_id`, `_slot`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called while expenditure is in draft state. - -**`Deprecated Sets`** - -the recipient on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slot` | `BigNumberish` | Slot for the recipient address | -| `_recipient` | `string` | Address of the recipient | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureRecipient(uint256,uint256,address) - -___ - -### setExpenditureRecipients - -▸ **setExpenditureRecipients**(`_id`, `_slots`, `_recipients`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called while expenditure is in draft state. -Sets the recipients in given expenditure slots. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slots` | `BigNumberish`[] | Array of slots to set recipients | -| `_recipients` | `string`[] | Addresses of the recipients | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureRecipients - -___ - -### setExpenditureRecipients(uint256,uint256[],address[]) - -▸ **setExpenditureRecipients(uint256,uint256[],address[])**(`_id`, `_slots`, `_recipients`, `overrides?`): `Promise`<`ContractTransaction`\> - -Can only be called while expenditure is in draft state. -Sets the recipients in given expenditure slots. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the expenditure | -| `_slots` | `BigNumberish`[] | Array of slots to set recipients | -| `_recipients` | `string`[] | Addresses of the recipients | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureRecipients(uint256,uint256[],address[]) - -___ - -### setExpenditureSkill - -▸ **setExpenditureSkill**(`_id`, `_slot`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated Sets`** - -the skill on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Number of the slot | -| `_skillId` | `BigNumberish` | Id of the new skill to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureSkill - -___ - -### setExpenditureSkill(uint256,uint256,uint256) - -▸ **setExpenditureSkill(uint256,uint256,uint256)**(`_id`, `_slot`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated Sets`** - -the skill on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slot` | `BigNumberish` | Number of the slot | -| `_skillId` | `BigNumberish` | Id of the new skill to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureSkill(uint256,uint256,uint256) - -___ - -### setExpenditureSkills - -▸ **setExpenditureSkills**(`_id`, `_slots`, `_skillIds`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the skill on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slots` | `BigNumberish`[] | Array of slots to set skills | -| `_skillIds` | `BigNumberish`[] | Ids of the new skills to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureSkills - -___ - -### setExpenditureSkills(uint256,uint256[],uint256[]) - -▸ **setExpenditureSkills(uint256,uint256[],uint256[])**(`_id`, `_slots`, `_skillIds`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the skill on an expenditure slot. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_slots` | `BigNumberish`[] | Array of slots to set skills | -| `_skillIds` | `BigNumberish`[] | Ids of the new skills to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureSkills(uint256,uint256[],uint256[]) - -___ - -### 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, (only used if `_permissionDomainId` is different to `_domainId`) | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_storageSlot` | `BigNumberish` | Number of the top-level storage slot (25, 26, or 27) | -| `_mask` | `boolean`[] | Array of booleans indicated whether a key is a mapping (F) or an array index (T). | -| `_keys` | `BytesLike`[] | Array of additional keys (for mappings & arrays) | -| `_value` | `BytesLike` | Value to set at location | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureState - -___ - -### setExpenditureState(uint256,uint256,uint256,uint256,bool[],bytes32[],bytes32) - -▸ **setExpenditureState(uint256,uint256,uint256,uint256,bool[],bytes32[],bytes32)**(`_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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, (only used if `_permissionDomainId` is different to `_domainId`) | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_storageSlot` | `BigNumberish` | Number of the top-level storage slot (25, 26, or 27) | -| `_mask` | `boolean`[] | Array of booleans indicated whether a key is a mapping (F) or an array index (T). | -| `_keys` | `BytesLike`[] | Array of additional keys (for mappings & arrays) | -| `_value` | `BytesLike` | Value to set at location | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureState(uint256,uint256,uint256,uint256,bool[],bytes32[],bytes32) - -___ - -### setExpenditureStateWithProofs - -▸ **setExpenditureStateWithProofs**(`_id`, `_storageSlot`, `_mask`, `_keys`, `_value`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [editDomain](ColonyClientV10.md#editdomain), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_storageSlot` | `BigNumberish` | Number of the top-level storage slot (25, 26, or 27) | -| `_mask` | `boolean`[] | Array of booleans indicated whether a key is a mapping (F) or an array index (T). | -| `_keys` | `BytesLike`[] | Array of additional keys (for mappings & arrays) | -| `_value` | `BytesLike` | Value to set at location | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -ColonyAugmentsV5.setExpenditureStateWithProofs - -___ - -### setExpenditureValues - -▸ **setExpenditureValues**(`_id`, `_recipientSlots`, `_recipients`, `_skillIdSlots`, `_skillIds`, `_claimDelaySlots`, `_claimDelays`, `_payoutModifierSlots`, `_payoutModifiers`, `_payoutTokens`, `_payoutSlots`, `_payoutValues`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set many values of an expenditure simultaneously. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_recipientSlots` | `BigNumberish`[] | Array of slots to set recipients | -| `_recipients` | `string`[] | Addresses of the recipients | -| `_skillIdSlots` | `BigNumberish`[] | Array of slots to set skills | -| `_skillIds` | `BigNumberish`[] | Ids of the new skills to set | -| `_claimDelaySlots` | `BigNumberish`[] | Array of slots to set claim delays | -| `_claimDelays` | `BigNumberish`[] | Durations of time (in seconds) to delay | -| `_payoutModifierSlots` | `BigNumberish`[] | Array of slots to set payout modifiers | -| `_payoutModifiers` | `BigNumberish`[] | Values (between +/- WAD) to modify the payout & reputation bonus | -| `_payoutTokens` | `string`[] | Addresses of the tokens, `0x0` value indicates Ether | -| `_payoutSlots` | `BigNumberish`[][] | 2-dimensional array of slots to set payouts | -| `_payoutValues` | `BigNumberish`[][] | 2-dimensional array of the payout amounts | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureValues - -___ - -### setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][]) - -▸ **setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][])**(`_id`, `_recipientSlots`, `_recipients`, `_skillIdSlots`, `_skillIds`, `_claimDelaySlots`, `_claimDelays`, `_payoutModifierSlots`, `_payoutModifiers`, `_payoutTokens`, `_payoutSlots`, `_payoutValues`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set many values of an expenditure simultaneously. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_recipientSlots` | `BigNumberish`[] | Array of slots to set recipients | -| `_recipients` | `string`[] | Addresses of the recipients | -| `_skillIdSlots` | `BigNumberish`[] | Array of slots to set skills | -| `_skillIds` | `BigNumberish`[] | Ids of the new skills to set | -| `_claimDelaySlots` | `BigNumberish`[] | Array of slots to set claim delays | -| `_claimDelays` | `BigNumberish`[] | Durations of time (in seconds) to delay | -| `_payoutModifierSlots` | `BigNumberish`[] | Array of slots to set payout modifiers | -| `_payoutModifiers` | `BigNumberish`[] | Values (between +/- WAD) to modify the payout & reputation bonus | -| `_payoutTokens` | `string`[] | Addresses of the tokens, `0x0` value indicates Ether | -| `_payoutSlots` | `BigNumberish`[][] | 2-dimensional array of slots to set payouts | -| `_payoutValues` | `BigNumberish`[][] | 2-dimensional array of the payout amounts | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][]) - -___ - -### setFundingRole - -▸ **setFundingRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony funding role. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root/architecture role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give an funding role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setFundingRole - -___ - -### setFundingRole(uint256,uint256,address,uint256,bool) - -▸ **setFundingRole(uint256,uint256,address,uint256,bool)**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony funding role. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root/architecture role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give an funding role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setFundingRole(uint256,uint256,address,uint256,bool) - -___ - -### setFundingRoleWithProofs - -▸ **setFundingRoleWithProofs**(`_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setFundingRole](ColonyClientV10.md#setfundingrole), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give an funding role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setFundingRoleWithProofs - -___ - -### setPaymentPayout - -▸ **setPaymentPayout**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the payout for a given token on an existing payment. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Payment identifier | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentPayout - -___ - -### setPaymentPayout(uint256,uint256,uint256,address,uint256) - -▸ **setPaymentPayout(uint256,uint256,uint256,address,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the payout for a given token on an existing payment. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Payment identifier | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentPayout(uint256,uint256,uint256,address,uint256) - -___ - -### setPaymentPayoutWithProofs - -▸ **setPaymentPayoutWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setPaymentPayout](ColonyClientV10.md#setpaymentpayout), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Payment identifier | -| `_token` | `BigNumberish` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentPayoutWithProofs - -___ - -### setPaymentRecipient - -▸ **setPaymentRecipient**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the recipient on an existing payment. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Payment identifier | -| `_recipient` | `string` | Address of the payment recipient | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentRecipient - -___ - -### setPaymentRecipient(uint256,uint256,uint256,address) - -▸ **setPaymentRecipient(uint256,uint256,uint256,address)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the recipient on an existing payment. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Payment identifier | -| `_recipient` | `string` | Address of the payment recipient | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentRecipient(uint256,uint256,uint256,address) - -___ - -### setPaymentRecipientWithProofs - -▸ **setPaymentRecipientWithProofs**(`_id`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setPaymentRecipient](ColonyClientV10.md#setpaymentrecipient), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Payment identifier | -| `_recipient` | `string` | Address of the payment recipient | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentRecipientWithProofs - -___ - -### setPaymentSkill - -▸ **setPaymentSkill**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the skill on an existing payment. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Payment identifier | -| `_skillId` | `BigNumberish` | Id of the new skill to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentSkill - -___ - -### setPaymentSkill(uint256,uint256,uint256,uint256) - -▸ **setPaymentSkill(uint256,uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Sets the skill on an existing payment. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_id` | `BigNumberish` | Payment identifier | -| `_skillId` | `BigNumberish` | Id of the new skill to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentSkill(uint256,uint256,uint256,uint256) - -___ - -### setPaymentSkillWithProofs - -▸ **setPaymentSkillWithProofs**(`_id`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setPaymentSkill](ColonyClientV10.md#setpaymentskill), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Payment identifier | -| `_skillId` | `BigNumberish` | Id of the new skill to set | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setPaymentSkillWithProofs - -___ - -### setRecoveryRole - -▸ **setRecoveryRole**(`_user`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony recovery role. Can be called by root. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give a recovery role to | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setRecoveryRole - -___ - -### setRecoveryRole(address) - -▸ **setRecoveryRole(address)**(`_user`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony recovery role. Can be called by root. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give a recovery role to | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setRecoveryRole(address) - -___ - -### setRewardInverse - -▸ **setRewardInverse**(`_rewardInverse`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the reward inverse to pay out from revenue. e.g. if the fee is 1% (or 0.01), set 100. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_rewardInverse` | `BigNumberish` | The inverse of the reward | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setRewardInverse - -___ - -### setRewardInverse(uint256) - -▸ **setRewardInverse(uint256)**(`_rewardInverse`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the reward inverse to pay out from revenue. e.g. if the fee is 1% (or 0.01), set 100. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_rewardInverse` | `BigNumberish` | The inverse of the reward | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setRewardInverse(uint256) - -___ - -### setRootRole - -▸ **setRootRole**(`_user`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony root role. Can be called by root role only. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give an root role to | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setRootRole - -___ - -### setRootRole(address,bool) - -▸ **setRootRole(address,bool)**(`_user`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set new colony root role. Can be called by root role only. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give an root role to | -| `_setTo` | `boolean` | The state of the role permission (true assign the permission, false revokes it) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setRootRole(address,bool) - -___ - -### setStorageSlotRecovery - -▸ **setStorageSlotRecovery**(`_slot`, `_value`, `overrides?`): `Promise`<`ContractTransaction`\> - -certain critical variables are protected from editing in this function -Update value of arbitrary storage variable. Can only be called by user with recovery role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_slot` | `BigNumberish` | Uint address of storage slot to be updated | -| `_value` | `BytesLike` | word of data to be set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setStorageSlotRecovery - -___ - -### setStorageSlotRecovery(uint256,bytes32) - -▸ **setStorageSlotRecovery(uint256,bytes32)**(`_slot`, `_value`, `overrides?`): `Promise`<`ContractTransaction`\> - -certain critical variables are protected from editing in this function -Update value of arbitrary storage variable. Can only be called by user with recovery role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_slot` | `BigNumberish` | Uint address of storage slot to be updated | -| `_value` | `BytesLike` | word of data to be set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setStorageSlotRecovery(uint256,bytes32) - -___ - -### setTaskBrief - -▸ **setTaskBrief**(`_id`, `_specificationHash`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the hash for the task brief, aka task work specification, which identifies the task brief content in ddb. Allowed before a task is finalized. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_specificationHash` | `BytesLike` | Unique hash of the task brief in ddb | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskBrief - -___ - -### setTaskBrief(uint256,bytes32) - -▸ **setTaskBrief(uint256,bytes32)**(`_id`, `_specificationHash`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the hash for the task brief, aka task work specification, which identifies the task brief content in ddb. Allowed before a task is finalized. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_specificationHash` | `BytesLike` | Unique hash of the task brief in ddb | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskBrief(uint256,bytes32) - -___ - -### setTaskDueDate - -▸ **setTaskDueDate**(`_id`, `_dueDate`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the due date on task `_id`. Allowed before a task is finalized. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_dueDate` | `BigNumberish` | Due date as seconds since unix epoch | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskDueDate - -___ - -### setTaskDueDate(uint256,uint256) - -▸ **setTaskDueDate(uint256,uint256)**(`_id`, `_dueDate`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the due date on task `_id`. Allowed before a task is finalized. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_dueDate` | `BigNumberish` | Due date as seconds since unix epoch | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskDueDate(uint256,uint256) - -___ - -### setTaskEvaluatorPayout - -▸ **setTaskEvaluatorPayout**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set `_token` payout for evaluator in task `_id` to `_amount`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskEvaluatorPayout - -___ - -### setTaskEvaluatorPayout(uint256,address,uint256) - -▸ **setTaskEvaluatorPayout(uint256,address,uint256)**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set `_token` payout for evaluator in task `_id` to `_amount`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskEvaluatorPayout(uint256,address,uint256) - -___ - -### setTaskEvaluatorRole - -▸ **setTaskEvaluatorRole**(`_id`, `_user`, `overrides?`): `Promise`<`ContractTransaction`\> - -This function can only be called through `executeTaskRoleAssignment`. -Assigning evaluator role. Can only be set if there is no one currently assigned to be an evaluator. Manager of the task and user we want to assign role to both need to agree. Managers can assign themselves to this role, if there is no one currently assigned to it. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_user` | `string` | Address of the user we want to give a evaluator role to | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskEvaluatorRole - -___ - -### setTaskEvaluatorRole(uint256,address) - -▸ **setTaskEvaluatorRole(uint256,address)**(`_id`, `_user`, `overrides?`): `Promise`<`ContractTransaction`\> - -This function can only be called through `executeTaskRoleAssignment`. -Assigning evaluator role. Can only be set if there is no one currently assigned to be an evaluator. Manager of the task and user we want to assign role to both need to agree. Managers can assign themselves to this role, if there is no one currently assigned to it. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_user` | `string` | Address of the user we want to give a evaluator role to | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskEvaluatorRole(uint256,address) - -___ - -### setTaskManagerPayout - -▸ **setTaskManagerPayout**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set `_token` payout for manager in task `_id` to `_amount`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskManagerPayout - -___ - -### setTaskManagerPayout(uint256,address,uint256) - -▸ **setTaskManagerPayout(uint256,address,uint256)**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set `_token` payout for manager in task `_id` to `_amount`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskManagerPayout(uint256,address,uint256) - -___ - -### setTaskManagerRole - -▸ **setTaskManagerRole**(`_id`, `_user`, `_permissionDomainId`, `_childSkillIndex`, `overrides?`): `Promise`<`ContractTransaction`\> - -This function can only be called through `executeTaskRoleAssignment`. -Assigning manager role. Current manager and user we want to assign role to both need to agree. User we want to set here also needs to be an admin. Note that the domain proof data comes at the end here to not interfere with the assembly argument unpacking. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_user` | `string` | Address of the user we want to give a manager role to | -| `_permissionDomainId` | `BigNumberish` | The domain ID in which _user has the Administration permission | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskManagerRole - -___ - -### setTaskManagerRole(uint256,address,uint256,uint256) - -▸ **setTaskManagerRole(uint256,address,uint256,uint256)**(`_id`, `_user`, `_permissionDomainId`, `_childSkillIndex`, `overrides?`): `Promise`<`ContractTransaction`\> - -This function can only be called through `executeTaskRoleAssignment`. -Assigning manager role. Current manager and user we want to assign role to both need to agree. User we want to set here also needs to be an admin. Note that the domain proof data comes at the end here to not interfere with the assembly argument unpacking. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_user` | `string` | Address of the user we want to give a manager role to | -| `_permissionDomainId` | `BigNumberish` | The domain ID in which _user has the Administration permission | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskManagerRole(uint256,address,uint256,uint256) - -___ - -### setTaskSkill - -▸ **setTaskSkill**(`_id`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Currently we only allow one skill per task although we have provisioned for an array of skills in `Task` struct. Allowed before a task is finalized. -Set the skill for task `_id`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_skillId` | `BigNumberish` | Id of the skill which has to be a global skill | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskSkill - -___ - -### setTaskSkill(uint256,uint256) - -▸ **setTaskSkill(uint256,uint256)**(`_id`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Currently we only allow one skill per task although we have provisioned for an array of skills in `Task` struct. Allowed before a task is finalized. -Set the skill for task `_id`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_skillId` | `BigNumberish` | Id of the skill which has to be a global skill | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskSkill(uint256,uint256) - -___ - -### setTaskWorkerPayout - -▸ **setTaskWorkerPayout**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set `_token` payout for worker in task `_id` to `_amount`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskWorkerPayout - -___ - -### setTaskWorkerPayout(uint256,address,uint256) - -▸ **setTaskWorkerPayout(uint256,address,uint256)**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set `_token` payout for worker in task `_id` to `_amount`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_token` | `string` | Address of the token, `0x0` value indicates Ether | -| `_amount` | `BigNumberish` | Payout amount | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskWorkerPayout(uint256,address,uint256) - -___ - -### setTaskWorkerRole - -▸ **setTaskWorkerRole**(`_id`, `_user`, `overrides?`): `Promise`<`ContractTransaction`\> - -This function can only be called through `executeTaskRoleAssignment`. -Assigning worker role. Can only be set if there is no one currently assigned to be a worker. Manager of the task and user we want to assign role to both need to agree. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_user` | `string` | Address of the user we want to give a worker role to | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskWorkerRole - -___ - -### setTaskWorkerRole(uint256,address) - -▸ **setTaskWorkerRole(uint256,address)**(`_id`, `_user`, `overrides?`): `Promise`<`ContractTransaction`\> - -This function can only be called through `executeTaskRoleAssignment`. -Assigning worker role. Can only be set if there is no one currently assigned to be a worker. Manager of the task and user we want to assign role to both need to agree. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_user` | `string` | Address of the user we want to give a worker role to | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setTaskWorkerRole(uint256,address) - -___ - -### 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root/architecture role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give a role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_roles` | `BytesLike` | Byte array representing the desired role setting (1 for on, 0 for off) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setUserRoles - -___ - -### setUserRoles(uint256,uint256,address,uint256,bytes32) - -▸ **setUserRoles(uint256,uint256,address,uint256,bytes32)**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_roles`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set several roles in one transaction. Can be called by root role or architecture role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | Domain in which the caller has root/architecture role | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId` | -| `_user` | `string` | User we want to give a role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_roles` | `BytesLike` | Byte array representing the desired role setting (1 for on, 0 for off) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setUserRoles(uint256,uint256,address,uint256,bytes32) - -___ - -### setUserRolesWithProofs - -▸ **setUserRolesWithProofs**(`_user`, `_domainId`, `_roles`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setUserRoles](ColonyClientV10.md#setuserroles), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | User we want to give a role to | -| `_domainId` | `BigNumberish` | Domain in which we are giving user the role | -| `_roles` | `BytesLike` | Byte array representing the desired role setting (1 for on, 0 for off) | -| `overrides?` | [`TxOverrides`](../README.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_token` | `string` | Address of the token used for reward payout | -| `key` | `BytesLike` | Some Reputation hash tree key | -| `value` | `BytesLike` | Reputation value | -| `branchMask` | `BigNumberish` | The branchmask of the proof | -| `siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.startNextRewardPayout - -___ - -### startNextRewardPayout(address,bytes,bytes,uint256,bytes32[]) - -▸ **startNextRewardPayout(address,bytes,bytes,uint256,bytes32[])**(`_token`, `key`, `value`, `branchMask`, `siblings`, `overrides?`): `Promise`<`ContractTransaction`\> - -Start next reward payout for `_token`. All funds in the reward pot for `_token` will become unavailable.Add a new payment in the colony. Can only be called by users with root permission. All tokens will be locked, and can be unlocked by calling `waiveRewardPayout` or `claimRewardPayout`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_token` | `string` | Address of the token used for reward payout | -| `key` | `BytesLike` | Some Reputation hash tree key | -| `value` | `BytesLike` | Reputation value | -| `branchMask` | `BigNumberish` | The branchmask of the proof | -| `siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.startNextRewardPayout(address,bytes,bytes,uint256,bytes32[]) - -___ - -### submitTaskDeliverable - -▸ **submitTaskDeliverable**(`_id`, `_deliverableHash`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the `task.deliverableHash` and `task.completionTimestamp` properties. -Submit the task deliverable, i.e. the output of the work performed for task `_id`. Submission is allowed only to the assigned worker before the task due date. Submissions cannot be overwritten. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_deliverableHash` | `BytesLike` | Unique hash of the task deliverable content in ddb | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.submitTaskDeliverable - -___ - -### submitTaskDeliverable(uint256,bytes32) - -▸ **submitTaskDeliverable(uint256,bytes32)**(`_id`, `_deliverableHash`, `overrides?`): `Promise`<`ContractTransaction`\> - -Set the `task.deliverableHash` and `task.completionTimestamp` properties. -Submit the task deliverable, i.e. the output of the work performed for task `_id`. Submission is allowed only to the assigned worker before the task due date. Submissions cannot be overwritten. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_deliverableHash` | `BytesLike` | Unique hash of the task deliverable content in ddb | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.submitTaskDeliverable(uint256,bytes32) - -___ - -### submitTaskDeliverableAndRating - -▸ **submitTaskDeliverableAndRating**(`_id`, `_deliverableHash`, `_ratingSecret`, `overrides?`): `Promise`<`ContractTransaction`\> - -Internally call `submitTaskDeliverable` and `submitTaskWorkRating` in sequence. -Submit the task deliverable for Worker and rating for Manager. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_deliverableHash` | `BytesLike` | Unique hash of the task deliverable content in ddb | -| `_ratingSecret` | `BytesLike` | Rating secret for manager | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.submitTaskDeliverableAndRating - -___ - -### submitTaskDeliverableAndRating(uint256,bytes32,bytes32) - -▸ **submitTaskDeliverableAndRating(uint256,bytes32,bytes32)**(`_id`, `_deliverableHash`, `_ratingSecret`, `overrides?`): `Promise`<`ContractTransaction`\> - -Internally call `submitTaskDeliverable` and `submitTaskWorkRating` in sequence. -Submit the task deliverable for Worker and rating for Manager. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_deliverableHash` | `BytesLike` | Unique hash of the task deliverable content in ddb | -| `_ratingSecret` | `BytesLike` | Rating secret for manager | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.submitTaskDeliverableAndRating(uint256,bytes32,bytes32) - -___ - -### submitTaskWorkRating - -▸ **submitTaskWorkRating**(`_id`, `_role`, `_ratingSecret`, `overrides?`): `Promise`<`ContractTransaction`\> - -Submit a hashed secret of the rating for work in task `_id` which was performed by user with task role id `_role`. Allowed within 5 days period starting which whichever is first from either the deliverable being submitted or the dueDate been reached. Allowed only for evaluator to rate worker and for worker to rate manager performance. Once submitted ratings can not be changed or overwritten. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `_ratingSecret` | `BytesLike` | `keccak256` hash of a salt and 0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50). Can be generated via `IColony.generateSecret` helper function. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.submitTaskWorkRating - -___ - -### submitTaskWorkRating(uint256,uint8,bytes32) - -▸ **submitTaskWorkRating(uint256,uint8,bytes32)**(`_id`, `_role`, `_ratingSecret`, `overrides?`): `Promise`<`ContractTransaction`\> - -Submit a hashed secret of the rating for work in task `_id` which was performed by user with task role id `_role`. Allowed within 5 days period starting which whichever is first from either the deliverable being submitted or the dueDate been reached. Allowed only for evaluator to rate worker and for worker to rate manager performance. Once submitted ratings can not be changed or overwritten. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Id of the task | -| `_role` | `BigNumberish` | Id of the role, as defined in TaskRole enum | -| `_ratingSecret` | `BytesLike` | `keccak256` hash of a salt and 0-50 rating score (in increments of 10, .e.g 0, 10, 20, 30, 40 or 50). Can be generated via `IColony.generateSecret` helper function. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.submitTaskWorkRating(uint256,uint8,bytes32) - -___ - -### transferExpenditure - -▸ **transferExpenditure**(`_id`, `_newOwner`, `overrides?`): `Promise`<`ContractTransaction`\> - -Updates the expenditure owner. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_newOwner` | `string` | New owner of expenditure | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.transferExpenditure - -___ - -### transferExpenditure(uint256,address) - -▸ **transferExpenditure(uint256,address)**(`_id`, `_newOwner`, `overrides?`): `Promise`<`ContractTransaction`\> - -Updates the expenditure owner. Can only be called by expenditure owner. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_newOwner` | `string` | New owner of expenditure | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.transferExpenditure(uint256,address) - -___ - -### transferExpenditureViaArbitration - -▸ **transferExpenditureViaArbitration**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_newOwner`, `overrides?`): `Promise`<`ContractTransaction`\> - -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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, (only used if `_permissionDomainId` is different to `_domainId`) | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_newOwner` | `string` | New owner of expenditure | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.transferExpenditureViaArbitration - -___ - -### transferExpenditureViaArbitration(uint256,uint256,uint256,address) - -▸ **transferExpenditureViaArbitration(uint256,uint256,uint256,address)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_newOwner`, `overrides?`): `Promise`<`ContractTransaction`\> - -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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action | -| `_childSkillIndex` | `BigNumberish` | The index that the `_domainId` is relative to `_permissionDomainId`, (only used if `_permissionDomainId` is different to `_domainId`) | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_newOwner` | `string` | New owner of expenditure | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.transferExpenditureViaArbitration(uint256,uint256,uint256,address) - -___ - -### transferExpenditureViaArbitrationWithProofs - -▸ **transferExpenditureViaArbitrationWithProofs**(`_id`, `_newOwner`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated`** - -Same as [transferExpenditureViaArbitration](ColonyClientV10.md#transferexpenditureviaarbitration), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | Expenditure identifier | -| `_newOwner` | `string` | New owner of expenditure | -| `overrides?` | [`TxOverrides`](../README.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action. | -| `_childSkillIndex` | `BigNumberish` | The child index in `_permissionDomainId` where we can find `_domainId`. | -| `_obligator` | `string` | Address of the account who set the obligation. | -| `_user` | `string` | Address of the account we are transferring. | -| `_domainId` | `BigNumberish` | Domain in which we are transferring the tokens. | -| `_amount` | `BigNumberish` | Amount of internal token we are transferring. | -| `_recipient` | `string` | Recipient of the transferred tokens. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.transferStake - -___ - -### transferStake(uint256,uint256,address,address,uint256,uint256,address) - -▸ **transferStake(uint256,uint256,address,address,uint256,uint256,address)**(`_permissionDomainId`, `_childSkillIndex`, `_obligator`, `_user`, `_domainId`, `_amount`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> - -Transfer some amount of obligated tokens. Can be called by the arbitration role. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which I have the permission to take this action. | -| `_childSkillIndex` | `BigNumberish` | The child index in `_permissionDomainId` where we can find `_domainId`. | -| `_obligator` | `string` | Address of the account who set the obligation. | -| `_user` | `string` | Address of the account we are transferring. | -| `_domainId` | `BigNumberish` | Domain in which we are transferring the tokens. | -| `_amount` | `BigNumberish` | Amount of internal token we are transferring. | -| `_recipient` | `string` | Recipient of the transferred tokens. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.transferStake(uint256,uint256,address,address,uint256,uint256,address) - -___ - -### transferStakeWithProofs - -▸ **transferStakeWithProofs**(`_obligator`, `_user`, `_domainId`, `_amount`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [transferStake](ColonyClientV10.md#transferstake), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_obligator` | `string` | Address of the account who set the obligation. | -| `_user` | `string` | Address of the account we are transferring. | -| `_domainId` | `BigNumberish` | Domain in which we are transferring the tokens. | -| `_amount` | `BigNumberish` | Amount of internal token we are transferring. | -| `_recipient` | `string` | Recipient of the transferred tokens. | -| `overrides?` | [`TxOverrides`](../README.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extensionId` | `BytesLike` | keccak256 hash of the extension name, used as an indentifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.uninstallExtension - -___ - -### uninstallExtension(bytes32) - -▸ **uninstallExtension(bytes32)**(`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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extensionId` | `BytesLike` | keccak256 hash of the extension name, used as an indentifier | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.uninstallExtension(bytes32) - -___ - -### unlockToken - -▸ **unlockToken**(`overrides?`): `Promise`<`ContractTransaction`\> - -unlock the native colony token, if possible - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.unlockToken - -___ - -### unlockToken() - -▸ **unlockToken()**(`overrides?`): `Promise`<`ContractTransaction`\> - -unlock the native colony token, if possible - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `user` | `string` | The user to unlock | -| `lockId` | `BigNumberish` | The specific lock to unlock | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.unlockTokenForUser - -___ - -### unlockTokenForUser(address,uint256) - -▸ **unlockTokenForUser(address,uint256)**(`user`, `lockId`, `overrides?`): `Promise`<`ContractTransaction`\> - -Unlock the colony's token for a user. Can only be called by a network-managed extension. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `user` | `string` | The user to unlock | -| `lockId` | `BigNumberish` | The specific lock to unlock | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.unlockTokenForUser(address,uint256) - -___ - -### updateApprovalAmount - -▸ **updateApprovalAmount**(`token`, `spender`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the internal bookkeeping around external ERC20 approvals - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | The address of the token which was approved | -| `spender` | `string` | The account we have approved | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.updateApprovalAmount - -___ - -### updateApprovalAmount(address,address) - -▸ **updateApprovalAmount(address,address)**(`token`, `spender`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the internal bookkeeping around external ERC20 approvals - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `token` | `string` | The address of the token which was approved | -| `spender` | `string` | The account we have approved | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.updateApprovalAmount(address,address) - -___ - -### updateColonyOrbitDB - -▸ **updateColonyOrbitDB**(`orbitdb`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update a colony's orbitdb address. Can only be called by a colony with a registered subdomain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orbitdb` | `string` | The path of the orbitDB database to be associated with the colony | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.updateColonyOrbitDB - -___ - -### updateColonyOrbitDB(string) - -▸ **updateColonyOrbitDB(string)**(`orbitdb`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update a colony's orbitdb address. Can only be called by a colony with a registered subdomain - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orbitdb` | `string` | The path of the orbitDB database to be associated with the colony | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.updateColonyOrbitDB(string) - -___ - -### upgrade - -▸ **upgrade**(`_newVersion`, `overrides?`): `Promise`<`ContractTransaction`\> - -Downgrades are not allowed, i.e. `_newVersion` should be higher than the currect colony version. -Upgrades a colony to a new Colony contract version `_newVersion`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_newVersion` | `BigNumberish` | The target version for the upgrade | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.upgrade - -___ - -### upgrade(uint256) - -▸ **upgrade(uint256)**(`_newVersion`, `overrides?`): `Promise`<`ContractTransaction`\> - -Downgrades are not allowed, i.e. `_newVersion` should be higher than the currect colony version. -Upgrades a colony to a new Colony contract version `_newVersion`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_newVersion` | `BigNumberish` | The target version for the upgrade | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.upgrade(uint256) - -___ - -### upgradeExtension - -▸ **upgradeExtension**(`extensionId`, `newVersion`, `overrides?`): `Promise`<`ContractTransaction`\> - -Upgrade an extension in a colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extensionId` | `BytesLike` | keccak256 hash of the extension name, used as an indentifier | -| `newVersion` | `BigNumberish` | The version to upgrade to (must be one larger than the current version) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.upgradeExtension - -___ - -### upgradeExtension(bytes32,uint256) - -▸ **upgradeExtension(bytes32,uint256)**(`extensionId`, `newVersion`, `overrides?`): `Promise`<`ContractTransaction`\> - -Upgrade an extension in a colony. Secured function to authorised members. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extensionId` | `BytesLike` | keccak256 hash of the extension name, used as an indentifier | -| `newVersion` | `BigNumberish` | The version to upgrade to (must be one larger than the current version) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.upgradeExtension(bytes32,uint256) - -___ - -### upgradeExtensionChecked - -▸ **upgradeExtensionChecked**(`extension`, `newVersion?`, `overrides?`): `Promise`<`ContractTransaction`\> - -Similar to [upgradeExtension](ColonyClientV10.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extension` | [`Extension`](../enums/Extension.md) | A [Extension](../enums/Extension.md) name | -| `newVersion?` | `number` | The desired version number of the extension you wish to upgrade | -| `overrides?` | [`TxOverrides`](../README.md#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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose permissions we want to check | -| `_domainId` | `BigNumberish` | Domain in which the caller has the role (currently Root or Architecture) | -| `_childSkillIndex` | `BigNumberish` | The index that the `_childDomainId` is relative to `_domainId` | -| `_childDomainId` | `BigNumberish` | The domain where we want to edit roles | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.userCanSetRoles - -___ - -### userCanSetRoles(address,uint256,uint256,uint256) - -▸ **userCanSetRoles(address,uint256,uint256,uint256)**(`_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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | The user whose permissions we want to check | -| `_domainId` | `BigNumberish` | Domain in which the caller has the role (currently Root or Architecture) | -| `_childSkillIndex` | `BigNumberish` | The index that the `_childDomainId` is relative to `_domainId` | -| `_childDomainId` | `BigNumberish` | The domain where we want to edit roles | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.userCanSetRoles(address,uint256,uint256,uint256) - -___ - -### 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `BytesLike` | The key of the element the proof is for. | -| `value` | `BytesLike` | The value of the element that the proof is for. | -| `branchMask` | `BigNumberish` | The branchmask of the proof | -| `siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.verifyReputationProof - -___ - -### verifyReputationProof(bytes,bytes,uint256,bytes32[]) - -▸ **verifyReputationProof(bytes,bytes,uint256,bytes32[])**(`key`, `value`, `branchMask`, `siblings`, `overrides?`): `Promise`<`boolean`\> - -For more detail about branchMask and siblings, examine the PatriciaTree implementation. While 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 - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `BytesLike` | The key of the element the proof is for. | -| `value` | `BytesLike` | The value of the element that the proof is for. | -| `branchMask` | `BigNumberish` | The branchmask of the proof | -| `siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedIColony.verifyReputationProof(bytes,bytes,uint256,bytes32[]) - -___ - -### version - -▸ **version**(`overrides?`): `Promise`<`BigNumber`\> - -Get the Colony contract version. Starts from 1 and is incremented with every deployed contract change. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.version - -___ - -### version() - -▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the Colony contract version. Starts from 1 and is incremented with every deployed contract change. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedIColony.version() diff --git a/packages/colony-js/docs/api/interfaces/ColonyClientV15.md b/packages/colony-js/docs/api/interfaces/ColonyClientV15.md index a29cf1fb9..f67cdd5db 100644 --- a/packages/colony-js/docs/api/interfaces/ColonyClientV15.md +++ b/packages/colony-js/docs/api/interfaces/ColonyClientV15.md @@ -5650,70 +5650,6 @@ ColonyAugmentsV5.setExpenditureStateWithProofs ___ -### setExpenditureValues - -▸ **setExpenditureValues**(`_id`, `_recipientSlots`, `_recipients`, `_skillIdSlots`, `_skillIds`, `_claimDelaySlots`, `_claimDelays`, `_payoutModifierSlots`, `_payoutModifiers`, `_payoutTokens`, `_payoutSlots`, `_payoutValues`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_id` | `BigNumberish` | -| `_recipientSlots` | `BigNumberish`[] | -| `_recipients` | `string`[] | -| `_skillIdSlots` | `BigNumberish`[] | -| `_skillIds` | `BigNumberish`[] | -| `_claimDelaySlots` | `BigNumberish`[] | -| `_claimDelays` | `BigNumberish`[] | -| `_payoutModifierSlots` | `BigNumberish`[] | -| `_payoutModifiers` | `BigNumberish`[] | -| `_payoutTokens` | `string`[] | -| `_payoutSlots` | `BigNumberish`[][] | -| `_payoutValues` | `BigNumberish`[][] | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureValues - -___ - -### setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][]) - -▸ **setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][])**(`_id`, `_recipientSlots`, `_recipients`, `_skillIdSlots`, `_skillIds`, `_claimDelaySlots`, `_claimDelays`, `_payoutModifierSlots`, `_payoutModifiers`, `_payoutTokens`, `_payoutSlots`, `_payoutValues`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_id` | `BigNumberish` | -| `_recipientSlots` | `BigNumberish`[] | -| `_recipients` | `string`[] | -| `_skillIdSlots` | `BigNumberish`[] | -| `_skillIds` | `BigNumberish`[] | -| `_claimDelaySlots` | `BigNumberish`[] | -| `_claimDelays` | `BigNumberish`[] | -| `_payoutModifierSlots` | `BigNumberish`[] | -| `_payoutModifiers` | `BigNumberish`[] | -| `_payoutTokens` | `string`[] | -| `_payoutSlots` | `BigNumberish`[][] | -| `_payoutValues` | `BigNumberish`[][] | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.setExpenditureValues(uint256,uint256[],address[],uint256[],uint256[],uint256[],uint256[],uint256[],int256[],address[],uint256[][],uint256[][]) - -___ - ### setFundingRole ▸ **setFundingRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> @@ -6736,6 +6672,52 @@ AugmentedIColony.userCanSetRoles(address,uint256,uint256,uint256) ___ +### validateDomainInheritance + +▸ **validateDomainInheritance**(`_permissionDomainId`, `_childSkillIndex`, `_childDomainId`, `overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_childDomainId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedIColony.validateDomainInheritance + +___ + +### validateDomainInheritance(uint256,uint256,uint256) + +▸ **validateDomainInheritance(uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_childDomainId`, `overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_childDomainId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedIColony.validateDomainInheritance(uint256,uint256,uint256) + +___ + ### verifyReputationProof ▸ **verifyReputationProof**(`key`, `value`, `branchMask`, `siblings`, `overrides?`): `Promise`<`boolean`\> diff --git a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV1.md b/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV1.md deleted file mode 100644 index 2fd1ca8b7..000000000 --- a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV1.md +++ /dev/null @@ -1,2289 +0,0 @@ -# Interface: StreamingPaymentsClientV1 - -## Hierarchy - -- `AugmentedStreamingPayments`<`StreamingPayments`\> - - ↳ **`StreamingPaymentsClientV1`** - -## Properties - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<`Contract`\> - -#### Inherited from - -AugmentedStreamingPayments.\_deployedPromise - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: `RunningEvent` - -#### Inherited from - -AugmentedStreamingPayments.\_runningEvents - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Inherited from - -AugmentedStreamingPayments.\_wrappedEmits - -___ - -### address - -• `Readonly` **address**: `string` - -#### Inherited from - -AugmentedStreamingPayments.address - -___ - -### callStatic - -• **callStatic**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `finishUpgrade` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `finishUpgrade()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PaymentTokenStructOutput`\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PaymentTokenStructOutput`\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StreamingPaymentStructOutput`\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StreamingPaymentStructOutput`\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `install` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `uninstall` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `uninstall()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `verify` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | - -#### Inherited from - -AugmentedStreamingPayments.callStatic - -___ - -### clientType - -• **clientType**: [`StreamingPaymentsClient`](../enums/ClientType.md#streamingpaymentsclient) - -#### Inherited from - -AugmentedStreamingPayments.clientType - -___ - -### clientVersion - -• **clientVersion**: ``1`` - -#### Overrides - -AugmentedStreamingPayments.clientVersion - -___ - -### colonyClient - -• **colonyClient**: `AugmentedIColony`<`ValidColony`\> - -An instance of the corresponding ColonyClient - -#### Inherited from - -AugmentedStreamingPayments.colonyClient - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: `TransactionResponse` - -#### Inherited from - -AugmentedStreamingPayments.deployTransaction - -___ - -### estimateGas - -• **estimateGas**: `Object` - -#### Inherited from - -AugmentedStreamingPayments.estimateGas - -___ - -### filters - -• **filters**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `ExtensionInitialised` | () => `ExtensionInitialisedEventFilter` | -| `ExtensionInitialised()` | () => `ExtensionInitialisedEventFilter` | -| `LogSetAuthority` | (`authority?`: ``null`` \| `string`) => `LogSetAuthorityEventFilter` | -| `LogSetAuthority(address)` | (`authority?`: ``null`` \| `string`) => `LogSetAuthorityEventFilter` | -| `LogSetOwner` | (`owner?`: ``null`` \| `string`) => `LogSetOwnerEventFilter` | -| `LogSetOwner(address)` | (`owner?`: ``null`` \| `string`) => `LogSetOwnerEventFilter` | -| `MetaTransactionExecuted` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `MetaTransactionExecuted(address,address,bytes)` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `PaymentTokenUpdated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | -| `PaymentTokenUpdated(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | -| `StreamingPaymentClaimed` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `StreamingPaymentClaimedEventFilter` | -| `StreamingPaymentClaimed(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `StreamingPaymentClaimedEventFilter` | -| `StreamingPaymentCreated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => `StreamingPaymentCreatedEventFilter` | -| `StreamingPaymentCreated(address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => `StreamingPaymentCreatedEventFilter` | - -#### Inherited from - -AugmentedStreamingPayments.filters - -___ - -### functions - -• **functions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `numPayments`: `BigNumber` }\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `numPayments`: `BigNumber` }\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`PaymentTokenStructOutput`] & { `paymentToken`: `PaymentTokenStructOutput` }\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`PaymentTokenStructOutput`] & { `paymentToken`: `PaymentTokenStructOutput` }\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StreamingPaymentStructOutput`] & { `streamingPayment`: `StreamingPaymentStructOutput` }\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StreamingPaymentStructOutput`] & { `streamingPayment`: `StreamingPaymentStructOutput` }\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | -| `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `verify` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_version`: `BigNumber` }\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_version`: `BigNumber` }\> | - -#### Inherited from - -AugmentedStreamingPayments.functions - -___ - -### interface - -• **interface**: `StreamingPaymentsInterface` - -#### Inherited from - -AugmentedStreamingPayments.interface - -___ - -### off - -• **off**: `OnEvent`<[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md)\> - -#### Inherited from - -AugmentedStreamingPayments.off - -___ - -### on - -• **on**: `OnEvent`<[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md)\> - -#### Inherited from - -AugmentedStreamingPayments.on - -___ - -### once - -• **once**: `OnEvent`<[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md)\> - -#### Inherited from - -AugmentedStreamingPayments.once - -___ - -### populateTransaction - -• **populateTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `verify` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | - -#### Inherited from - -AugmentedStreamingPayments.populateTransaction - -___ - -### provider - -• `Readonly` **provider**: `Provider` - -#### Inherited from - -AugmentedStreamingPayments.provider - -___ - -### removeListener - -• **removeListener**: `OnEvent`<[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md)\> - -#### Inherited from - -AugmentedStreamingPayments.removeListener - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.resolvedAddress - -___ - -### signer - -• `Readonly` **signer**: `Signer` - -#### Inherited from - -AugmentedStreamingPayments.signer - -___ - -### streamingPaymentsEvents - -• **streamingPaymentsEvents**: `StreamingPaymentsEvents` - -The streamingPaymentsEvents contract supports all events across all versions. -Isn't that amazing? -It's an ethers contract with only events to filter - -#### Inherited from - -AugmentedStreamingPayments.streamingPaymentsEvents - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | `RunningEvent` | - -#### Returns - -`void` - -#### Inherited from - -AugmentedStreamingPayments.\_checkRunningEvents - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<`Contract`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | `BlockTag` | - -#### Returns - -`Promise`<`Contract`\> - -#### Inherited from - -AugmentedStreamingPayments.\_deployed - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): `Event` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | `RunningEvent` | -| `log` | `Log` | -| `listener` | `Listener` | - -#### Returns - -`Event` - -#### Inherited from - -AugmentedStreamingPayments.\_wrapEvent - -___ - -### addToken - -▸ **addToken**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new token/amount pair - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addToken - -___ - -### addToken(uint256,uint256,uint256,address,uint256) - -▸ **addToken(uint256,uint256,uint256,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new token/amount pair - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addToken(uint256,uint256,uint256,address,uint256) - -___ - -### addTokenWithProofs - -▸ **addTokenWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [addToken](StreamingPaymentsClientV1.md#addtoken), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addTokenWithProofs - -___ - -### attach - -▸ **attach**(`addressOrName`): [`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md) - -#### Inherited from - -AugmentedStreamingPayments.attach - -___ - -### authority - -▸ **authority**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.authority - -___ - -### authority() - -▸ **authority()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.authority() - -___ - -### cancel - -▸ **cancel**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancel - -___ - -### cancel(uint256,uint256,uint256) - -▸ **cancel(uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancel(uint256,uint256,uint256) - -___ - -### cancelAndWaive - -▸ **cancelAndWaive**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp, and waive claim to specified tokens already earned. Only callable by the recipient. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to waive any claims to. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelAndWaive - -___ - -### cancelAndWaive(uint256,address[]) - -▸ **cancelAndWaive(uint256,address[])**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp, and waive claim to specified tokens already earned. Only callable by the recipient. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to waive any claims to. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelAndWaive(uint256,address[]) - -___ - -### cancelWithProofs - -▸ **cancelWithProofs**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [cancel](StreamingPaymentsClientV1.md#cancel), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelWithProofs - -___ - -### claim - -▸ **claim**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim a streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId the payment is in | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claim - -___ - -### claim(uint256,uint256,uint256,uint256,uint256,address[]) - -▸ **claim(uint256,uint256,uint256,uint256,uint256,address[])**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim a streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId the payment is in | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claim(uint256,uint256,uint256,uint256,uint256,address[]) - -___ - -### claimWithProofs - -▸ **claimWithProofs**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [claim](StreamingPaymentsClientV1.md#claim), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claimWithProofs - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| `Signer` \| `Provider` | - -#### Returns - -[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md) - -#### Inherited from - -AugmentedStreamingPayments.connect - -___ - -### create - -▸ **create**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Creates a new streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.create - -___ - -### create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[]) - -▸ **create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Creates a new streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[]) - -___ - -### createWithProofs - -▸ **createWithProofs**(`_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [create](StreamingPaymentsClientV1.md#create), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.createWithProofs - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md)\> - -#### Returns - -`Promise`<[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md)\> - -#### Inherited from - -AugmentedStreamingPayments.deployed - -___ - -### deprecate - -▸ **deprecate**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Called when deprecating (or undeprecating) the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_deprecated` | `boolean` | Indicates whether the extension should be deprecated or undeprecated | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.deprecate - -___ - -### deprecate(bool) - -▸ **deprecate(bool)**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Called when deprecating (or undeprecating) the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_deprecated` | `boolean` | Indicates whether the extension should be deprecated or undeprecated | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.deprecate(bool) - -___ - -### emit - -▸ **emit**(`eventName`, `...args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `EventFilter` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -AugmentedStreamingPayments.emit - -___ - -### executeMetaTransaction - -▸ **executeMetaTransaction**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> - -Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of user trying to do meta transaction | -| `_payload` | `BytesLike` | Function call to make via meta transaction | -| `_sigR` | `BytesLike` | R part of the signature | -| `_sigS` | `BytesLike` | S part of the signature | -| `_sigV` | `BigNumberish` | V part of the signature | -| `overrides?` | `PayableOverrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.executeMetaTransaction - -___ - -### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) - -▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> - -Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of user trying to do meta transaction | -| `_payload` | `BytesLike` | Function call to make via meta transaction | -| `_sigR` | `BytesLike` | R part of the signature | -| `_sigS` | `BytesLike` | S part of the signature | -| `_sigV` | `BigNumberish` | V part of the signature | -| `overrides?` | `PayableOverrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `TransactionRequest` | - -#### Returns - -`Promise`<`TransactionResponse`\> - -#### Inherited from - -AugmentedStreamingPayments.fallback - -___ - -### finishUpgrade - -▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when upgrading the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.finishUpgrade - -___ - -### finishUpgrade() - -▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when upgrading the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.finishUpgrade() - -___ - -### getAmountEntitledFromStart - -▸ **getAmountEntitledFromStart**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the amount entitled to claim from the start of the stream - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getAmountEntitledFromStart - -___ - -### getAmountEntitledFromStart(uint256,address) - -▸ **getAmountEntitledFromStart(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the amount entitled to claim from the start of the stream - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getAmountEntitledFromStart(uint256,address) - -___ - -### getCapabilityRoles - -▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sig` | `BytesLike` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getCapabilityRoles - -___ - -### getCapabilityRoles(bytes4) - -▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sig` | `BytesLike` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getCapabilityRoles(bytes4) - -___ - -### getChainId - -▸ **getChainId**(`overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getChainId - -___ - -### getChainId() - -▸ **getChainId()**(`overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getChainId() - -___ - -### getColony - -▸ **getColony**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getColony - -___ - -### getColony() - -▸ **getColony()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getColony() - -___ - -### getDeprecated - -▸ **getDeprecated**(`overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.getDeprecated - -___ - -### getDeprecated() - -▸ **getDeprecated()**(`overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.getDeprecated() - -___ - -### getMetatransactionNonce - -▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_user` | `string` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getMetatransactionNonce - -___ - -### getMetatransactionNonce(address) - -▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_user` | `string` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getMetatransactionNonce(address) - -___ - -### getNumStreamingPayments - -▸ **getNumStreamingPayments**(`overrides?`): `Promise`<`BigNumber`\> - -Get the total number of streaming payments - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getNumStreamingPayments - -___ - -### getNumStreamingPayments() - -▸ **getNumStreamingPayments()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the total number of streaming payments - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getNumStreamingPayments() - -___ - -### getPaymentToken - -▸ **getPaymentToken**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> - -Get the payment token struct by Id and token - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`PaymentTokenStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getPaymentToken - -___ - -### getPaymentToken(uint256,address) - -▸ **getPaymentToken(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> - -Get the payment token struct by Id and token - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`PaymentTokenStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getPaymentToken(uint256,address) - -___ - -### getStreamingPayment - -▸ **getStreamingPayment**(`_id`, `overrides?`): `Promise`<`StreamingPaymentStructOutput`\> - -Get the streaming payment struct by Id - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`StreamingPaymentStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getStreamingPayment - -___ - -### getStreamingPayment(uint256) - -▸ **getStreamingPayment(uint256)**(`_id`, `overrides?`): `Promise`<`StreamingPaymentStructOutput`\> - -Get the streaming payment struct by Id - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`StreamingPaymentStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getStreamingPayment(uint256) - -___ - -### identifier - -▸ **identifier**(`overrides?`): `Promise`<`string`\> - -Returns the identifier of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.identifier - -___ - -### identifier() - -▸ **identifier()**(`overrides?`): `Promise`<`string`\> - -Returns the identifier of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.identifier() - -___ - -### install - -▸ **install**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> - -Configures the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_colony` | `string` | The colony in which the extension holds permissions | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.install - -___ - -### install(address) - -▸ **install(address)**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> - -Configures the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_colony` | `string` | The colony in which the extension holds permissions | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.install(address) - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| `EventFilter` | - -#### Returns - -`number` - -#### Inherited from - -AugmentedStreamingPayments.listenerCount - -___ - -### listeners - -▸ **listeners**<`TEvent`\>(`eventFilter?`): `TypedListener`<`TEvent`\>[] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter?` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -`TypedListener`<`TEvent`\>[] - -#### Inherited from - -AugmentedStreamingPayments.listeners - -▸ **listeners**(`eventName?`): `Listener`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -`Listener`[] - -#### Inherited from - -AugmentedStreamingPayments.listeners - -___ - -### owner - -▸ **owner**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.owner - -___ - -### owner() - -▸ **owner()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.owner() - -___ - -### queryFilter - -▸ **queryFilter**<`TEvent`\>(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<`TEvent`[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `TypedEventFilter`<`TEvent`\> | -| `fromBlockOrBlockhash?` | `string` \| `number` | -| `toBlock?` | `string` \| `number` | - -#### Returns - -`Promise`<`TEvent`[]\> - -#### Inherited from - -AugmentedStreamingPayments.queryFilter - -___ - -### removeAllListeners - -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md) - -#### Inherited from - -AugmentedStreamingPayments.removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -[`StreamingPaymentsClientV1`](StreamingPaymentsClientV1.md) - -#### Inherited from - -AugmentedStreamingPayments.removeAllListeners - -___ - -### setAuthority - -▸ **setAuthority**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authority_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setAuthority - -___ - -### setAuthority(address) - -▸ **setAuthority(address)**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authority_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setAuthority(address) - -___ - -### setEndTime - -▸ **setEndTime**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the endTime, only if the new endTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTime - -___ - -### setEndTime(uint256,uint256,uint256,uint256) - -▸ **setEndTime(uint256,uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the endTime, only if the new endTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTime(uint256,uint256,uint256,uint256) - -___ - -### setEndTimeWithProofs - -▸ **setEndTimeWithProofs**(`_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setEndTime](StreamingPaymentsClientV1.md#setendtime), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTimeWithProofs - -___ - -### setOwner - -▸ **setOwner**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setOwner - -___ - -### setOwner(address) - -▸ **setOwner(address)**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setOwner(address) - -___ - -### setStartTime - -▸ **setStartTime**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the startTime, only if the current startTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTime - -___ - -### setStartTime(uint256,uint256,uint256,uint256) - -▸ **setStartTime(uint256,uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the startTime, only if the current startTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTime(uint256,uint256,uint256,uint256) - -___ - -### setStartTimeWithProofs - -▸ **setStartTimeWithProofs**(`_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setStartTime](StreamingPaymentsClientV1.md#setstarttime), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTimeWithProofs - -___ - -### setTokenAmount - -▸ **setTokenAmount**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the token amount to be paid out. Claims existing payout prior to the change - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmount - -___ - -### setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) - -▸ **setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the token amount to be paid out. Claims existing payout prior to the change - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) - -___ - -### setTokenAmountWithProofs - -▸ **setTokenAmountWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setTokenAmount](StreamingPaymentsClientV1.md#settokenamount), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmountWithProofs - -___ - -### uninstall - -▸ **uninstall**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when uninstalling the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.uninstall - -___ - -### uninstall() - -▸ **uninstall()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when uninstalling the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.uninstall() - -___ - -### verify - -▸ **verify**(`_owner`, `_nonce`, `_chainId`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_owner` | `string` | -| `_nonce` | `BigNumberish` | -| `_chainId` | `BigNumberish` | -| `_payload` | `BytesLike` | -| `_sigR` | `BytesLike` | -| `_sigS` | `BytesLike` | -| `_sigV` | `BigNumberish` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.verify - -___ - -### verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) - -▸ **verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)**(`_owner`, `_nonce`, `_chainId`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_owner` | `string` | -| `_nonce` | `BigNumberish` | -| `_chainId` | `BigNumberish` | -| `_payload` | `BytesLike` | -| `_sigR` | `BytesLike` | -| `_sigS` | `BytesLike` | -| `_sigV` | `BigNumberish` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) - -___ - -### version - -▸ **version**(`overrides?`): `Promise`<`BigNumber`\> - -Returns the version of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.version - -___ - -### version() - -▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> - -Returns the version of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.version() diff --git a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV2.md b/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV2.md deleted file mode 100644 index 0243dd981..000000000 --- a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV2.md +++ /dev/null @@ -1,2337 +0,0 @@ -# Interface: StreamingPaymentsClientV2 - -## Hierarchy - -- `AugmentedStreamingPayments`<`StreamingPayments`\> - - ↳ **`StreamingPaymentsClientV2`** - -## Properties - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<`Contract`\> - -#### Inherited from - -AugmentedStreamingPayments.\_deployedPromise - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: `RunningEvent` - -#### Inherited from - -AugmentedStreamingPayments.\_runningEvents - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Inherited from - -AugmentedStreamingPayments.\_wrappedEmits - -___ - -### address - -• `Readonly` **address**: `string` - -#### Inherited from - -AugmentedStreamingPayments.address - -___ - -### callStatic - -• **callStatic**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `finishUpgrade` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `finishUpgrade()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PaymentTokenStructOutput`\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PaymentTokenStructOutput`\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StreamingPaymentStructOutput`\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StreamingPaymentStructOutput`\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `install` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `multicall` | (`data`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`string`[]\> | -| `multicall(bytes[])` | (`data`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`string`[]\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `uninstall` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `uninstall()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `verify` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | - -#### Inherited from - -AugmentedStreamingPayments.callStatic - -___ - -### clientType - -• **clientType**: [`StreamingPaymentsClient`](../enums/ClientType.md#streamingpaymentsclient) - -#### Inherited from - -AugmentedStreamingPayments.clientType - -___ - -### clientVersion - -• **clientVersion**: ``2`` - -#### Overrides - -AugmentedStreamingPayments.clientVersion - -___ - -### colonyClient - -• **colonyClient**: `AugmentedIColony`<`ValidColony`\> - -An instance of the corresponding ColonyClient - -#### Inherited from - -AugmentedStreamingPayments.colonyClient - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: `TransactionResponse` - -#### Inherited from - -AugmentedStreamingPayments.deployTransaction - -___ - -### estimateGas - -• **estimateGas**: `Object` - -#### Inherited from - -AugmentedStreamingPayments.estimateGas - -___ - -### filters - -• **filters**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `ExtensionInitialised` | () => `ExtensionInitialisedEventFilter` | -| `ExtensionInitialised()` | () => `ExtensionInitialisedEventFilter` | -| `LogSetAuthority` | (`authority?`: ``null`` \| `string`) => `LogSetAuthorityEventFilter` | -| `LogSetAuthority(address)` | (`authority?`: ``null`` \| `string`) => `LogSetAuthorityEventFilter` | -| `LogSetOwner` | (`owner?`: ``null`` \| `string`) => `LogSetOwnerEventFilter` | -| `LogSetOwner(address)` | (`owner?`: ``null`` \| `string`) => `LogSetOwnerEventFilter` | -| `MetaTransactionExecuted` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `MetaTransactionExecuted(address,address,bytes)` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `PaymentTokenUpdated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | -| `PaymentTokenUpdated(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | -| `StreamingPaymentClaimed` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `StreamingPaymentClaimedEventFilter` | -| `StreamingPaymentClaimed(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `StreamingPaymentClaimedEventFilter` | -| `StreamingPaymentCreated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => `StreamingPaymentCreatedEventFilter` | -| `StreamingPaymentCreated(address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => `StreamingPaymentCreatedEventFilter` | - -#### Inherited from - -AugmentedStreamingPayments.filters - -___ - -### functions - -• **functions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `numPayments`: `BigNumber` }\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `numPayments`: `BigNumber` }\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`PaymentTokenStructOutput`] & { `paymentToken`: `PaymentTokenStructOutput` }\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`PaymentTokenStructOutput`] & { `paymentToken`: `PaymentTokenStructOutput` }\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StreamingPaymentStructOutput`] & { `streamingPayment`: `StreamingPaymentStructOutput` }\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StreamingPaymentStructOutput`] & { `streamingPayment`: `StreamingPaymentStructOutput` }\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | -| `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `multicall` | (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `multicall(bytes[])` | (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `verify` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_version`: `BigNumber` }\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_version`: `BigNumber` }\> | - -#### Inherited from - -AugmentedStreamingPayments.functions - -___ - -### interface - -• **interface**: `StreamingPaymentsInterface` - -#### Inherited from - -AugmentedStreamingPayments.interface - -___ - -### off - -• **off**: `OnEvent`<[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md)\> - -#### Inherited from - -AugmentedStreamingPayments.off - -___ - -### on - -• **on**: `OnEvent`<[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md)\> - -#### Inherited from - -AugmentedStreamingPayments.on - -___ - -### once - -• **once**: `OnEvent`<[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md)\> - -#### Inherited from - -AugmentedStreamingPayments.once - -___ - -### populateTransaction - -• **populateTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `multicall` | (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `multicall(bytes[])` | (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `verify` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_owner`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | - -#### Inherited from - -AugmentedStreamingPayments.populateTransaction - -___ - -### provider - -• `Readonly` **provider**: `Provider` - -#### Inherited from - -AugmentedStreamingPayments.provider - -___ - -### removeListener - -• **removeListener**: `OnEvent`<[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md)\> - -#### Inherited from - -AugmentedStreamingPayments.removeListener - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.resolvedAddress - -___ - -### signer - -• `Readonly` **signer**: `Signer` - -#### Inherited from - -AugmentedStreamingPayments.signer - -___ - -### streamingPaymentsEvents - -• **streamingPaymentsEvents**: `StreamingPaymentsEvents` - -The streamingPaymentsEvents contract supports all events across all versions. -Isn't that amazing? -It's an ethers contract with only events to filter - -#### Inherited from - -AugmentedStreamingPayments.streamingPaymentsEvents - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | `RunningEvent` | - -#### Returns - -`void` - -#### Inherited from - -AugmentedStreamingPayments.\_checkRunningEvents - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<`Contract`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | `BlockTag` | - -#### Returns - -`Promise`<`Contract`\> - -#### Inherited from - -AugmentedStreamingPayments.\_deployed - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): `Event` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | `RunningEvent` | -| `log` | `Log` | -| `listener` | `Listener` | - -#### Returns - -`Event` - -#### Inherited from - -AugmentedStreamingPayments.\_wrapEvent - -___ - -### addToken - -▸ **addToken**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new token/amount pair - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addToken - -___ - -### addToken(uint256,uint256,uint256,address,uint256) - -▸ **addToken(uint256,uint256,uint256,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new token/amount pair - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addToken(uint256,uint256,uint256,address,uint256) - -___ - -### addTokenWithProofs - -▸ **addTokenWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [addToken](StreamingPaymentsClientV2.md#addtoken), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addTokenWithProofs - -___ - -### attach - -▸ **attach**(`addressOrName`): [`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md) - -#### Inherited from - -AugmentedStreamingPayments.attach - -___ - -### authority - -▸ **authority**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.authority - -___ - -### authority() - -▸ **authority()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.authority() - -___ - -### cancel - -▸ **cancel**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancel - -___ - -### cancel(uint256,uint256,uint256) - -▸ **cancel(uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancel(uint256,uint256,uint256) - -___ - -### cancelAndWaive - -▸ **cancelAndWaive**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp, and waive claim to specified tokens already earned. Only callable by the recipient. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to waive any claims to. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelAndWaive - -___ - -### cancelAndWaive(uint256,address[]) - -▸ **cancelAndWaive(uint256,address[])**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp, and waive claim to specified tokens already earned. Only callable by the recipient. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to waive any claims to. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelAndWaive(uint256,address[]) - -___ - -### cancelWithProofs - -▸ **cancelWithProofs**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [cancel](StreamingPaymentsClientV2.md#cancel), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelWithProofs - -___ - -### claim - -▸ **claim**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim a streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId the payment is in | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claim - -___ - -### claim(uint256,uint256,uint256,uint256,uint256,address[]) - -▸ **claim(uint256,uint256,uint256,uint256,uint256,address[])**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim a streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId the payment is in | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claim(uint256,uint256,uint256,uint256,uint256,address[]) - -___ - -### claimWithProofs - -▸ **claimWithProofs**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [claim](StreamingPaymentsClientV2.md#claim), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claimWithProofs - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| `Signer` \| `Provider` | - -#### Returns - -[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md) - -#### Inherited from - -AugmentedStreamingPayments.connect - -___ - -### create - -▸ **create**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Creates a new streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.create - -___ - -### create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[]) - -▸ **create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Creates a new streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[]) - -___ - -### createWithProofs - -▸ **createWithProofs**(`_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [create](StreamingPaymentsClientV2.md#create), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.createWithProofs - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md)\> - -#### Returns - -`Promise`<[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md)\> - -#### Inherited from - -AugmentedStreamingPayments.deployed - -___ - -### deprecate - -▸ **deprecate**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Called when deprecating (or undeprecating) the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_deprecated` | `boolean` | Indicates whether the extension should be deprecated or undeprecated | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.deprecate - -___ - -### deprecate(bool) - -▸ **deprecate(bool)**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Called when deprecating (or undeprecating) the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_deprecated` | `boolean` | Indicates whether the extension should be deprecated or undeprecated | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.deprecate(bool) - -___ - -### emit - -▸ **emit**(`eventName`, `...args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `EventFilter` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -AugmentedStreamingPayments.emit - -___ - -### executeMetaTransaction - -▸ **executeMetaTransaction**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> - -Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of user trying to do meta transaction | -| `_payload` | `BytesLike` | Function call to make via meta transaction | -| `_sigR` | `BytesLike` | R part of the signature | -| `_sigS` | `BytesLike` | S part of the signature | -| `_sigV` | `BigNumberish` | V part of the signature | -| `overrides?` | `PayableOverrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.executeMetaTransaction - -___ - -### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) - -▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> - -Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of user trying to do meta transaction | -| `_payload` | `BytesLike` | Function call to make via meta transaction | -| `_sigR` | `BytesLike` | R part of the signature | -| `_sigS` | `BytesLike` | S part of the signature | -| `_sigV` | `BigNumberish` | V part of the signature | -| `overrides?` | `PayableOverrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `TransactionRequest` | - -#### Returns - -`Promise`<`TransactionResponse`\> - -#### Inherited from - -AugmentedStreamingPayments.fallback - -___ - -### finishUpgrade - -▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when upgrading the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.finishUpgrade - -___ - -### finishUpgrade() - -▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when upgrading the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.finishUpgrade() - -___ - -### getAmountEntitledFromStart - -▸ **getAmountEntitledFromStart**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the amount entitled to claim from the start of the stream - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getAmountEntitledFromStart - -___ - -### getAmountEntitledFromStart(uint256,address) - -▸ **getAmountEntitledFromStart(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the amount entitled to claim from the start of the stream - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getAmountEntitledFromStart(uint256,address) - -___ - -### getCapabilityRoles - -▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sig` | `BytesLike` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getCapabilityRoles - -___ - -### getCapabilityRoles(bytes4) - -▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sig` | `BytesLike` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getCapabilityRoles(bytes4) - -___ - -### getChainId - -▸ **getChainId**(`overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getChainId - -___ - -### getChainId() - -▸ **getChainId()**(`overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getChainId() - -___ - -### getColony - -▸ **getColony**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getColony - -___ - -### getColony() - -▸ **getColony()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getColony() - -___ - -### getDeprecated - -▸ **getDeprecated**(`overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.getDeprecated - -___ - -### getDeprecated() - -▸ **getDeprecated()**(`overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.getDeprecated() - -___ - -### getMetatransactionNonce - -▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_user` | `string` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getMetatransactionNonce - -___ - -### getMetatransactionNonce(address) - -▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_user` | `string` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getMetatransactionNonce(address) - -___ - -### getNumStreamingPayments - -▸ **getNumStreamingPayments**(`overrides?`): `Promise`<`BigNumber`\> - -Get the total number of streaming payments - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getNumStreamingPayments - -___ - -### getNumStreamingPayments() - -▸ **getNumStreamingPayments()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the total number of streaming payments - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getNumStreamingPayments() - -___ - -### getPaymentToken - -▸ **getPaymentToken**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> - -Get the payment token struct by Id and token - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`PaymentTokenStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getPaymentToken - -___ - -### getPaymentToken(uint256,address) - -▸ **getPaymentToken(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> - -Get the payment token struct by Id and token - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`PaymentTokenStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getPaymentToken(uint256,address) - -___ - -### getStreamingPayment - -▸ **getStreamingPayment**(`_id`, `overrides?`): `Promise`<`StreamingPaymentStructOutput`\> - -Get the streaming payment struct by Id - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`StreamingPaymentStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getStreamingPayment - -___ - -### getStreamingPayment(uint256) - -▸ **getStreamingPayment(uint256)**(`_id`, `overrides?`): `Promise`<`StreamingPaymentStructOutput`\> - -Get the streaming payment struct by Id - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`StreamingPaymentStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getStreamingPayment(uint256) - -___ - -### identifier - -▸ **identifier**(`overrides?`): `Promise`<`string`\> - -Returns the identifier of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.identifier - -___ - -### identifier() - -▸ **identifier()**(`overrides?`): `Promise`<`string`\> - -Returns the identifier of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.identifier() - -___ - -### install - -▸ **install**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> - -Configures the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_colony` | `string` | The colony in which the extension holds permissions | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.install - -___ - -### install(address) - -▸ **install(address)**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> - -Configures the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_colony` | `string` | The colony in which the extension holds permissions | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.install(address) - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| `EventFilter` | - -#### Returns - -`number` - -#### Inherited from - -AugmentedStreamingPayments.listenerCount - -___ - -### listeners - -▸ **listeners**<`TEvent`\>(`eventFilter?`): `TypedListener`<`TEvent`\>[] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter?` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -`TypedListener`<`TEvent`\>[] - -#### Inherited from - -AugmentedStreamingPayments.listeners - -▸ **listeners**(`eventName?`): `Listener`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -`Listener`[] - -#### Inherited from - -AugmentedStreamingPayments.listeners - -___ - -### multicall - -▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `BytesLike`[] | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.multicall - -___ - -### multicall(bytes[]) - -▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `BytesLike`[] | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.multicall(bytes[]) - -___ - -### owner - -▸ **owner**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.owner - -___ - -### owner() - -▸ **owner()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.owner() - -___ - -### queryFilter - -▸ **queryFilter**<`TEvent`\>(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<`TEvent`[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `TypedEventFilter`<`TEvent`\> | -| `fromBlockOrBlockhash?` | `string` \| `number` | -| `toBlock?` | `string` \| `number` | - -#### Returns - -`Promise`<`TEvent`[]\> - -#### Inherited from - -AugmentedStreamingPayments.queryFilter - -___ - -### removeAllListeners - -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md) - -#### Inherited from - -AugmentedStreamingPayments.removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -[`StreamingPaymentsClientV2`](StreamingPaymentsClientV2.md) - -#### Inherited from - -AugmentedStreamingPayments.removeAllListeners - -___ - -### setAuthority - -▸ **setAuthority**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authority_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setAuthority - -___ - -### setAuthority(address) - -▸ **setAuthority(address)**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authority_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setAuthority(address) - -___ - -### setEndTime - -▸ **setEndTime**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the endTime, only if the new endTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTime - -___ - -### setEndTime(uint256,uint256,uint256,uint256) - -▸ **setEndTime(uint256,uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the endTime, only if the new endTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTime(uint256,uint256,uint256,uint256) - -___ - -### setEndTimeWithProofs - -▸ **setEndTimeWithProofs**(`_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setEndTime](StreamingPaymentsClientV2.md#setendtime), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTimeWithProofs - -___ - -### setOwner - -▸ **setOwner**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setOwner - -___ - -### setOwner(address) - -▸ **setOwner(address)**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setOwner(address) - -___ - -### setStartTime - -▸ **setStartTime**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the startTime, only if the current startTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTime - -___ - -### setStartTime(uint256,uint256,uint256,uint256) - -▸ **setStartTime(uint256,uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the startTime, only if the current startTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTime(uint256,uint256,uint256,uint256) - -___ - -### setStartTimeWithProofs - -▸ **setStartTimeWithProofs**(`_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setStartTime](StreamingPaymentsClientV2.md#setstarttime), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTimeWithProofs - -___ - -### setTokenAmount - -▸ **setTokenAmount**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the token amount to be paid out. Claims existing payout prior to the change - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmount - -___ - -### setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) - -▸ **setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the token amount to be paid out. Claims existing payout prior to the change - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) - -___ - -### setTokenAmountWithProofs - -▸ **setTokenAmountWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setTokenAmount](StreamingPaymentsClientV2.md#settokenamount), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmountWithProofs - -___ - -### uninstall - -▸ **uninstall**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when uninstalling the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.uninstall - -___ - -### uninstall() - -▸ **uninstall()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when uninstalling the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.uninstall() - -___ - -### verify - -▸ **verify**(`_owner`, `_nonce`, `_chainId`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_owner` | `string` | -| `_nonce` | `BigNumberish` | -| `_chainId` | `BigNumberish` | -| `_payload` | `BytesLike` | -| `_sigR` | `BytesLike` | -| `_sigS` | `BytesLike` | -| `_sigV` | `BigNumberish` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.verify - -___ - -### verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) - -▸ **verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)**(`_owner`, `_nonce`, `_chainId`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_owner` | `string` | -| `_nonce` | `BigNumberish` | -| `_chainId` | `BigNumberish` | -| `_payload` | `BytesLike` | -| `_sigR` | `BytesLike` | -| `_sigS` | `BytesLike` | -| `_sigV` | `BigNumberish` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) - -___ - -### version - -▸ **version**(`overrides?`): `Promise`<`BigNumber`\> - -Returns the version of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.version - -___ - -### version() - -▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> - -Returns the version of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.version() diff --git a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV3.md b/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV3.md deleted file mode 100644 index d27c1a7e2..000000000 --- a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV3.md +++ /dev/null @@ -1,2337 +0,0 @@ -# Interface: StreamingPaymentsClientV3 - -## Hierarchy - -- `AugmentedStreamingPayments`<`StreamingPayments`\> - - ↳ **`StreamingPaymentsClientV3`** - -## Properties - -### \_deployedPromise - -• **\_deployedPromise**: `Promise`<`Contract`\> - -#### Inherited from - -AugmentedStreamingPayments.\_deployedPromise - -___ - -### \_runningEvents - -• **\_runningEvents**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: `RunningEvent` - -#### Inherited from - -AugmentedStreamingPayments.\_runningEvents - -___ - -### \_wrappedEmits - -• **\_wrappedEmits**: `Object` - -#### Index signature - -▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` - -#### Inherited from - -AugmentedStreamingPayments.\_wrappedEmits - -___ - -### address - -• `Readonly` **address**: `string` - -#### Inherited from - -AugmentedStreamingPayments.address - -___ - -### callStatic - -• **callStatic**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `finishUpgrade` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `finishUpgrade()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PaymentTokenStructOutput`\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PaymentTokenStructOutput`\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StreamingPaymentStructOutput`\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StreamingPaymentStructOutput`\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `install` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `multicall` | (`data`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`string`[]\> | -| `multicall(bytes[])` | (`data`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`string`[]\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `uninstall` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `uninstall()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `verify` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | - -#### Inherited from - -AugmentedStreamingPayments.callStatic - -___ - -### clientType - -• **clientType**: [`StreamingPaymentsClient`](../enums/ClientType.md#streamingpaymentsclient) - -#### Inherited from - -AugmentedStreamingPayments.clientType - -___ - -### clientVersion - -• **clientVersion**: ``3`` - -#### Overrides - -AugmentedStreamingPayments.clientVersion - -___ - -### colonyClient - -• **colonyClient**: `AugmentedIColony`<`ValidColony`\> - -An instance of the corresponding ColonyClient - -#### Inherited from - -AugmentedStreamingPayments.colonyClient - -___ - -### deployTransaction - -• `Readonly` **deployTransaction**: `TransactionResponse` - -#### Inherited from - -AugmentedStreamingPayments.deployTransaction - -___ - -### estimateGas - -• **estimateGas**: `Object` - -#### Inherited from - -AugmentedStreamingPayments.estimateGas - -___ - -### filters - -• **filters**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `ExtensionInitialised` | () => `ExtensionInitialisedEventFilter` | -| `ExtensionInitialised()` | () => `ExtensionInitialisedEventFilter` | -| `LogSetAuthority` | (`authority?`: ``null`` \| `string`) => `LogSetAuthorityEventFilter` | -| `LogSetAuthority(address)` | (`authority?`: ``null`` \| `string`) => `LogSetAuthorityEventFilter` | -| `LogSetOwner` | (`owner?`: ``null`` \| `string`) => `LogSetOwnerEventFilter` | -| `LogSetOwner(address)` | (`owner?`: ``null`` \| `string`) => `LogSetOwnerEventFilter` | -| `MetaTransactionExecuted` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `MetaTransactionExecuted(address,address,bytes)` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `PaymentTokenUpdated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | -| `PaymentTokenUpdated(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | -| `StreamingPaymentClaimed` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `StreamingPaymentClaimedEventFilter` | -| `StreamingPaymentClaimed(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `StreamingPaymentClaimedEventFilter` | -| `StreamingPaymentCreated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => `StreamingPaymentCreatedEventFilter` | -| `StreamingPaymentCreated(address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => `StreamingPaymentCreatedEventFilter` | - -#### Inherited from - -AugmentedStreamingPayments.filters - -___ - -### functions - -• **functions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `numPayments`: `BigNumber` }\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `numPayments`: `BigNumber` }\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`PaymentTokenStructOutput`] & { `paymentToken`: `PaymentTokenStructOutput` }\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`PaymentTokenStructOutput`] & { `paymentToken`: `PaymentTokenStructOutput` }\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StreamingPaymentStructOutput`] & { `streamingPayment`: `StreamingPaymentStructOutput` }\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StreamingPaymentStructOutput`] & { `streamingPayment`: `StreamingPaymentStructOutput` }\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | -| `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `multicall` | (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `multicall(bytes[])` | (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `verify` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_version`: `BigNumber` }\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_version`: `BigNumber` }\> | - -#### Inherited from - -AugmentedStreamingPayments.functions - -___ - -### interface - -• **interface**: `StreamingPaymentsInterface` - -#### Inherited from - -AugmentedStreamingPayments.interface - -___ - -### off - -• **off**: `OnEvent`<[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md)\> - -#### Inherited from - -AugmentedStreamingPayments.off - -___ - -### on - -• **on**: `OnEvent`<[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md)\> - -#### Inherited from - -AugmentedStreamingPayments.on - -___ - -### once - -• **once**: `OnEvent`<[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md)\> - -#### Inherited from - -AugmentedStreamingPayments.once - -___ - -### populateTransaction - -• **populateTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getChainId` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getChainId()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `multicall` | (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `multicall(bytes[])` | (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `owner` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `owner()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setEndTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setEndTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setOwner` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `verify` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | - -#### Inherited from - -AugmentedStreamingPayments.populateTransaction - -___ - -### provider - -• `Readonly` **provider**: `Provider` - -#### Inherited from - -AugmentedStreamingPayments.provider - -___ - -### removeListener - -• **removeListener**: `OnEvent`<[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md)\> - -#### Inherited from - -AugmentedStreamingPayments.removeListener - -___ - -### resolvedAddress - -• `Readonly` **resolvedAddress**: `Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.resolvedAddress - -___ - -### signer - -• `Readonly` **signer**: `Signer` - -#### Inherited from - -AugmentedStreamingPayments.signer - -___ - -### streamingPaymentsEvents - -• **streamingPaymentsEvents**: `StreamingPaymentsEvents` - -The streamingPaymentsEvents contract supports all events across all versions. -Isn't that amazing? -It's an ethers contract with only events to filter - -#### Inherited from - -AugmentedStreamingPayments.streamingPaymentsEvents - -## Methods - -### \_checkRunningEvents - -▸ **_checkRunningEvents**(`runningEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | `RunningEvent` | - -#### Returns - -`void` - -#### Inherited from - -AugmentedStreamingPayments.\_checkRunningEvents - -___ - -### \_deployed - -▸ **_deployed**(`blockTag?`): `Promise`<`Contract`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blockTag?` | `BlockTag` | - -#### Returns - -`Promise`<`Contract`\> - -#### Inherited from - -AugmentedStreamingPayments.\_deployed - -___ - -### \_wrapEvent - -▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): `Event` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `runningEvent` | `RunningEvent` | -| `log` | `Log` | -| `listener` | `Listener` | - -#### Returns - -`Event` - -#### Inherited from - -AugmentedStreamingPayments.\_wrapEvent - -___ - -### addToken - -▸ **addToken**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new token/amount pair - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addToken - -___ - -### addToken(uint256,uint256,uint256,address,uint256) - -▸ **addToken(uint256,uint256,uint256,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Add a new token/amount pair - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addToken(uint256,uint256,uint256,address,uint256) - -___ - -### addTokenWithProofs - -▸ **addTokenWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [addToken](StreamingPaymentsClientV3.md#addtoken), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addTokenWithProofs - -___ - -### attach - -▸ **attach**(`addressOrName`): [`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md) - -#### Inherited from - -AugmentedStreamingPayments.attach - -___ - -### authority - -▸ **authority**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.authority - -___ - -### authority() - -▸ **authority()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.authority() - -___ - -### cancel - -▸ **cancel**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancel - -___ - -### cancel(uint256,uint256,uint256) - -▸ **cancel(uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancel(uint256,uint256,uint256) - -___ - -### cancelAndWaive - -▸ **cancelAndWaive**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp, and waive claim to specified tokens already earned. Only callable by the recipient. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to waive any claims to. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelAndWaive - -___ - -### cancelAndWaive(uint256,address[]) - -▸ **cancelAndWaive(uint256,address[])**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Cancel the streaming payment, specifically by setting endTime to block.timestamp, and waive claim to specified tokens already earned. Only callable by the recipient. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to waive any claims to. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelAndWaive(uint256,address[]) - -___ - -### cancelWithProofs - -▸ **cancelWithProofs**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [cancel](StreamingPaymentsClientV3.md#cancel), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.cancelWithProofs - -___ - -### claim - -▸ **claim**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim a streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId the payment is in | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claim - -___ - -### claim(uint256,uint256,uint256,uint256,uint256,address[]) - -▸ **claim(uint256,uint256,uint256,uint256,uint256,address[])**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim a streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId the payment is in | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claim(uint256,uint256,uint256,uint256,uint256,address[]) - -___ - -### claimWithProofs - -▸ **claimWithProofs**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [claim](StreamingPaymentsClientV3.md#claim), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.claimWithProofs - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| `Signer` \| `Provider` | - -#### Returns - -[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md) - -#### Inherited from - -AugmentedStreamingPayments.connect - -___ - -### create - -▸ **create**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Creates a new streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.create - -___ - -### create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[]) - -▸ **create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Creates a new streaming payment - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[]) - -___ - -### createWithProofs - -▸ **createWithProofs**(`_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [create](StreamingPaymentsClientV3.md#create), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain out of which the streaming payment will be paid | -| `_startTime` | `BigNumberish` | The time at which the payment begins paying out | -| `_endTime` | `BigNumberish` | The time at which the payment ends paying out | -| `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | -| `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.createWithProofs - -___ - -### deployed - -▸ **deployed**(): `Promise`<[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md)\> - -#### Returns - -`Promise`<[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md)\> - -#### Inherited from - -AugmentedStreamingPayments.deployed - -___ - -### deprecate - -▸ **deprecate**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Called when deprecating (or undeprecating) the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_deprecated` | `boolean` | Indicates whether the extension should be deprecated or undeprecated | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.deprecate - -___ - -### deprecate(bool) - -▸ **deprecate(bool)**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> - -Called when deprecating (or undeprecating) the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_deprecated` | `boolean` | Indicates whether the extension should be deprecated or undeprecated | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.deprecate(bool) - -___ - -### emit - -▸ **emit**(`eventName`, `...args`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `EventFilter` | -| `...args` | `any`[] | - -#### Returns - -`boolean` - -#### Inherited from - -AugmentedStreamingPayments.emit - -___ - -### executeMetaTransaction - -▸ **executeMetaTransaction**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> - -Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of user trying to do meta transaction | -| `_payload` | `BytesLike` | Function call to make via meta transaction | -| `_sigR` | `BytesLike` | R part of the signature | -| `_sigS` | `BytesLike` | S part of the signature | -| `_sigV` | `BigNumberish` | V part of the signature | -| `overrides?` | `PayableOverrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.executeMetaTransaction - -___ - -### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) - -▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> - -Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_user` | `string` | Address of user trying to do meta transaction | -| `_payload` | `BytesLike` | Function call to make via meta transaction | -| `_sigR` | `BytesLike` | R part of the signature | -| `_sigS` | `BytesLike` | S part of the signature | -| `_sigV` | `BigNumberish` | V part of the signature | -| `overrides?` | `PayableOverrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) - -___ - -### fallback - -▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `TransactionRequest` | - -#### Returns - -`Promise`<`TransactionResponse`\> - -#### Inherited from - -AugmentedStreamingPayments.fallback - -___ - -### finishUpgrade - -▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when upgrading the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.finishUpgrade - -___ - -### finishUpgrade() - -▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when upgrading the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.finishUpgrade() - -___ - -### getAmountEntitledFromStart - -▸ **getAmountEntitledFromStart**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the amount entitled to claim from the start of the stream - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getAmountEntitledFromStart - -___ - -### getAmountEntitledFromStart(uint256,address) - -▸ **getAmountEntitledFromStart(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> - -Get the amount entitled to claim from the start of the stream - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getAmountEntitledFromStart(uint256,address) - -___ - -### getCapabilityRoles - -▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sig` | `BytesLike` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getCapabilityRoles - -___ - -### getCapabilityRoles(bytes4) - -▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sig` | `BytesLike` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getCapabilityRoles(bytes4) - -___ - -### getChainId - -▸ **getChainId**(`overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getChainId - -___ - -### getChainId() - -▸ **getChainId()**(`overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getChainId() - -___ - -### getColony - -▸ **getColony**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getColony - -___ - -### getColony() - -▸ **getColony()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.getColony() - -___ - -### getDeprecated - -▸ **getDeprecated**(`overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.getDeprecated - -___ - -### getDeprecated() - -▸ **getDeprecated()**(`overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.getDeprecated() - -___ - -### getMetatransactionNonce - -▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_user` | `string` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getMetatransactionNonce - -___ - -### getMetatransactionNonce(address) - -▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_user` | `string` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getMetatransactionNonce(address) - -___ - -### getNumStreamingPayments - -▸ **getNumStreamingPayments**(`overrides?`): `Promise`<`BigNumber`\> - -Get the total number of streaming payments - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getNumStreamingPayments - -___ - -### getNumStreamingPayments() - -▸ **getNumStreamingPayments()**(`overrides?`): `Promise`<`BigNumber`\> - -Get the total number of streaming payments - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.getNumStreamingPayments() - -___ - -### getPaymentToken - -▸ **getPaymentToken**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> - -Get the payment token struct by Id and token - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`PaymentTokenStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getPaymentToken - -___ - -### getPaymentToken(uint256,address) - -▸ **getPaymentToken(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> - -Get the payment token struct by Id and token - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`PaymentTokenStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getPaymentToken(uint256,address) - -___ - -### getStreamingPayment - -▸ **getStreamingPayment**(`_id`, `overrides?`): `Promise`<`StreamingPaymentStructOutput`\> - -Get the streaming payment struct by Id - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`StreamingPaymentStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getStreamingPayment - -___ - -### getStreamingPayment(uint256) - -▸ **getStreamingPayment(uint256)**(`_id`, `overrides?`): `Promise`<`StreamingPaymentStructOutput`\> - -Get the streaming payment struct by Id - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `overrides?` | `CallOverrides` | - | - -#### Returns - -`Promise`<`StreamingPaymentStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getStreamingPayment(uint256) - -___ - -### identifier - -▸ **identifier**(`overrides?`): `Promise`<`string`\> - -Returns the identifier of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.identifier - -___ - -### identifier() - -▸ **identifier()**(`overrides?`): `Promise`<`string`\> - -Returns the identifier of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.identifier() - -___ - -### install - -▸ **install**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> - -Configures the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_colony` | `string` | The colony in which the extension holds permissions | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.install - -___ - -### install(address) - -▸ **install(address)**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> - -Configures the extension - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_colony` | `string` | The colony in which the extension holds permissions | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.install(address) - -___ - -### listenerCount - -▸ **listenerCount**(`eventName?`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` \| `EventFilter` | - -#### Returns - -`number` - -#### Inherited from - -AugmentedStreamingPayments.listenerCount - -___ - -### listeners - -▸ **listeners**<`TEvent`\>(`eventFilter?`): `TypedListener`<`TEvent`\>[] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter?` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -`TypedListener`<`TEvent`\>[] - -#### Inherited from - -AugmentedStreamingPayments.listeners - -▸ **listeners**(`eventName?`): `Listener`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -`Listener`[] - -#### Inherited from - -AugmentedStreamingPayments.listeners - -___ - -### multicall - -▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `BytesLike`[] | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.multicall - -___ - -### multicall(bytes[]) - -▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `BytesLike`[] | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.multicall(bytes[]) - -___ - -### owner - -▸ **owner**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.owner - -___ - -### owner() - -▸ **owner()**(`overrides?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -AugmentedStreamingPayments.owner() - -___ - -### queryFilter - -▸ **queryFilter**<`TEvent`\>(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<`TEvent`[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `TypedEventFilter`<`TEvent`\> | -| `fromBlockOrBlockhash?` | `string` \| `number` | -| `toBlock?` | `string` \| `number` | - -#### Returns - -`Promise`<`TEvent`[]\> - -#### Inherited from - -AugmentedStreamingPayments.queryFilter - -___ - -### removeAllListeners - -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md) - -#### Inherited from - -AugmentedStreamingPayments.removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -[`StreamingPaymentsClientV3`](StreamingPaymentsClientV3.md) - -#### Inherited from - -AugmentedStreamingPayments.removeAllListeners - -___ - -### setAuthority - -▸ **setAuthority**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authority_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setAuthority - -___ - -### setAuthority(address) - -▸ **setAuthority(address)**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `authority_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setAuthority(address) - -___ - -### setEndTime - -▸ **setEndTime**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the endTime, only if the new endTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTime - -___ - -### setEndTime(uint256,uint256,uint256,uint256) - -▸ **setEndTime(uint256,uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the endTime, only if the new endTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTime(uint256,uint256,uint256,uint256) - -___ - -### setEndTimeWithProofs - -▸ **setEndTimeWithProofs**(`_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setEndTime](StreamingPaymentsClientV3.md#setendtime), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_endTime` | `BigNumberish` | The new endTime to set | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setEndTimeWithProofs - -___ - -### setOwner - -▸ **setOwner**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setOwner - -___ - -### setOwner(address) - -▸ **setOwner(address)**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner_` | `string` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setOwner(address) - -___ - -### setStartTime - -▸ **setStartTime**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the startTime, only if the current startTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTime - -___ - -### setStartTime(uint256,uint256,uint256,uint256) - -▸ **setStartTime(uint256,uint256,uint256,uint256)**(`_adminPermissionDomainId`, `_adminChildSkillIndex`, `_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the startTime, only if the current startTime is in the future - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_adminPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the admin permission | -| `_adminChildSkillIndex` | `BigNumberish` | The index linking the adminPermissionDomainId to the domainId | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTime(uint256,uint256,uint256,uint256) - -___ - -### setStartTimeWithProofs - -▸ **setStartTimeWithProofs**(`_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setStartTime](StreamingPaymentsClientV3.md#setstarttime), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_startTime` | `BigNumberish` | The new startTime to set | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setStartTimeWithProofs - -___ - -### setTokenAmount - -▸ **setTokenAmount**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the token amount to be paid out. Claims existing payout prior to the change - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmount - -___ - -### setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) - -▸ **setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Update the token amount to be paid out. Claims existing payout prior to the change - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | The domain in which the caller holds the funding permission | -| `_fundingChildSkillIndex` | `BigNumberish` | The index linking the fundingPermissionDomainId to the domainId | -| `_permissionDomainId` | `BigNumberish` | The domain in which the extension holds the funding & admin permissions | -| `_childSkillIndex` | `BigNumberish` | The index linking the permissionDomainId to the domainId | -| `_fromChildSkillIndex` | `BigNumberish` | The linking the domainId to the fromPot domain | -| `_toChildSkillIndex` | `BigNumberish` | The linking the domainId to the toPot domain | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) - -___ - -### setTokenAmountWithProofs - -▸ **setTokenAmountWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [setTokenAmount](StreamingPaymentsClientV3.md#settokenamount), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The new amount to pay out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.setTokenAmountWithProofs - -___ - -### uninstall - -▸ **uninstall**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when uninstalling the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.uninstall - -___ - -### uninstall() - -▸ **uninstall()**(`overrides?`): `Promise`<`ContractTransaction`\> - -Called when uninstalling the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.uninstall() - -___ - -### verify - -▸ **verify**(`_user`, `_nonce`, `_chainId`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_user` | `string` | -| `_nonce` | `BigNumberish` | -| `_chainId` | `BigNumberish` | -| `_payload` | `BytesLike` | -| `_sigR` | `BytesLike` | -| `_sigS` | `BytesLike` | -| `_sigV` | `BigNumberish` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.verify - -___ - -### verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) - -▸ **verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)**(`_user`, `_nonce`, `_chainId`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_user` | `string` | -| `_nonce` | `BigNumberish` | -| `_chainId` | `BigNumberish` | -| `_payload` | `BytesLike` | -| `_sigR` | `BytesLike` | -| `_sigS` | `BytesLike` | -| `_sigV` | `BigNumberish` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -AugmentedStreamingPayments.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) - -___ - -### version - -▸ **version**(`overrides?`): `Promise`<`BigNumber`\> - -Returns the version of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.version - -___ - -### version() - -▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> - -Returns the version of the extension - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`BigNumber`\> - -#### Inherited from - -AugmentedStreamingPayments.version() diff --git a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV4.md b/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV5.md similarity index 65% rename from packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV4.md rename to packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV5.md index fb34b4b89..32715d12b 100644 --- a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV4.md +++ b/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV5.md @@ -1,10 +1,10 @@ -# Interface: StreamingPaymentsClientV4 +# Interface: StreamingPaymentsClientV5 ## Hierarchy - `AugmentedStreamingPayments`<`StreamingPayments`\> - ↳ **`StreamingPaymentsClientV4`** + ↳ **`StreamingPaymentsClientV5`** ## Properties @@ -64,26 +64,24 @@ ___ | Name | Type | | :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `cancelAndWaive` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `cancelAndWaive(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `claim(uint256,uint256,uint256,uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `finishUpgrade` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `finishUpgrade()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getAmountEntitledFromStart(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | @@ -94,8 +92,6 @@ ___ | `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PaymentTokenStructOutput`\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PaymentTokenStructOutput`\> | | `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StreamingPaymentStructOutput`\> | | `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StreamingPaymentStructOutput`\> | | `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | @@ -114,8 +110,8 @@ ___ | `setOwner(address)` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `uninstall` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `uninstall()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `verify` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | @@ -141,7 +137,7 @@ ___ ### clientVersion -• **clientVersion**: ``4`` +• **clientVersion**: ``5`` #### Overrides @@ -173,7 +169,7 @@ ___ ### estimateGas -• **estimateGas**: `Object` +• **estimateGas**: { `authority`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `authority()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `cancel`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `cancel(uint256,uint256,uint256)`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `cancelAndWaive`: (`_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `cancelAndWaive(uint256)`: (`_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `claim`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `claim(uint256,uint256,uint256,uint256,uint256)`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `create`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address,uint256)`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `deprecate`: (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `deprecate(bool)`: (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `executeMetaTransaction`: (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)`: (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `finishUpgrade`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `finishUpgrade()`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `getAmountEntitledFromStart`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getAmountEntitledFromStart(uint256)`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getColony`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getColony()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDeprecated`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDeprecated()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMetatransactionNonce`: (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMetatransactionNonce(address)`: (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getNumStreamingPayments`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getNumStreamingPayments()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getStreamingPayment`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getStreamingPayment(uint256)`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `identifier`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `identifier()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `install`: (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `install(address)`: (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `multicall`: (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `multicall(bytes[])`: (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `owner`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `owner()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setEndTime`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setEndTime(uint256,uint256,uint256,uint256)`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setOwner`: (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setOwner(address)`: (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setStartTime`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setStartTime(uint256,uint256,uint256,uint256)`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setTokenAmount`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `uninstall`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `uninstall()`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `verify`: (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)`: (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `version`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `version()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> } & { `authority`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `authority()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `cancel`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `cancel(uint256,uint256,uint256)`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `cancelAndWaive`: (`_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `cancelAndWaive(uint256)`: (`_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `claim`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `claim(uint256,uint256,uint256,uint256,uint256)`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `create`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address,uint256)`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `deprecate`: (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `deprecate(bool)`: (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `executeMetaTransaction`: (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)`: (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `finishUpgrade`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `finishUpgrade()`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `getAmountEntitledFromStart`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getAmountEntitledFromStart(uint256)`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getColony`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getColony()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDeprecated`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDeprecated()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMetatransactionNonce`: (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMetatransactionNonce(address)`: (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getNumStreamingPayments`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getNumStreamingPayments()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getStreamingPayment`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getStreamingPayment(uint256)`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `identifier`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `identifier()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `install`: (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `install(address)`: (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `multicall`: (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `multicall(bytes[])`: (`data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `owner`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `owner()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setEndTime`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setEndTime(uint256,uint256,uint256,uint256)`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setOwner`: (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setOwner(address)`: (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setStartTime`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setStartTime(uint256,uint256,uint256,uint256)`: (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setTokenAmount`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `uninstall`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `uninstall()`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `verify`: (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)`: (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `version`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `version()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> } & { `cancelWithProofs`: (`_id`: `BigNumberish`, `overrides?`: [`TxOverrides`](../README.md#txoverrides)) => `Promise`<`BigNumber`\> ; `claimWithProofs`: (`_id`: `BigNumberish`, `overrides?`: [`TxOverrides`](../README.md#txoverrides)) => `Promise`<`BigNumber`\> ; `createWithProofs`: (`_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: [`TxOverrides`](../README.md#txoverrides)) => `Promise`<`BigNumber`\> ; `setEndTimeWithProofs`: (`_id`: `BigNumberish`, `_endTime`: `BigNumberish`, `overrides?`: [`TxOverrides`](../README.md#txoverrides)) => `Promise`<`BigNumber`\> ; `setStartTimeWithProofs`: (`_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: [`TxOverrides`](../README.md#txoverrides)) => `Promise`<`BigNumber`\> ; `setTokenAmountWithProofs`: (`_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: [`TxOverrides`](../README.md#txoverrides)) => `Promise`<`BigNumber`\> } #### Inherited from @@ -189,6 +185,10 @@ ___ | Name | Type | | :------ | :------ | +| `ClaimWaived` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`) => `ClaimWaivedEventFilter` | +| `ClaimWaived(address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`) => `ClaimWaivedEventFilter` | +| `EndTimeSet` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `endTime?`: ``null``) => `EndTimeSetEventFilter` | +| `EndTimeSet(address,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `endTime?`: ``null``) => `EndTimeSetEventFilter` | | `ExtensionInitialised` | () => `ExtensionInitialisedEventFilter` | | `ExtensionInitialised()` | () => `ExtensionInitialisedEventFilter` | | `LogSetAuthority` | (`authority?`: ``null`` \| `string`) => `LogSetAuthorityEventFilter` | @@ -197,8 +197,10 @@ ___ | `LogSetOwner(address)` | (`owner?`: ``null`` \| `string`) => `LogSetOwnerEventFilter` | | `MetaTransactionExecuted` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => `MetaTransactionExecutedEventFilter` | | `MetaTransactionExecuted(address,address,bytes)` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => `MetaTransactionExecutedEventFilter` | -| `PaymentTokenUpdated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | -| `PaymentTokenUpdated(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | +| `PaymentTokenUpdated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | +| `PaymentTokenUpdated(address,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `amount?`: ``null``) => `PaymentTokenUpdatedEventFilter` | +| `StartTimeSet` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `startTime?`: ``null``) => `StartTimeSetEventFilter` | +| `StartTimeSet(address,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `startTime?`: ``null``) => `StartTimeSetEventFilter` | | `StreamingPaymentClaimed` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `StreamingPaymentClaimedEventFilter` | | `StreamingPaymentClaimed(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `StreamingPaymentClaimedEventFilter` | | `StreamingPaymentCreated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => `StreamingPaymentCreatedEventFilter` | @@ -218,26 +220,24 @@ ___ | Name | Type | | :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `authority` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `cancelAndWaive` | (`_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `cancelAndWaive(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `claim(uint256,uint256,uint256,uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | +| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | +| `getAmountEntitledFromStart(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | @@ -248,8 +248,6 @@ ___ | `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | | `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `numPayments`: `BigNumber` }\> | | `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `numPayments`: `BigNumber` }\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`PaymentTokenStructOutput`] & { `paymentToken`: `PaymentTokenStructOutput` }\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`PaymentTokenStructOutput`] & { `paymentToken`: `PaymentTokenStructOutput` }\> | | `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StreamingPaymentStructOutput`] & { `streamingPayment`: `StreamingPaymentStructOutput` }\> | | `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StreamingPaymentStructOutput`] & { `streamingPayment`: `StreamingPaymentStructOutput` }\> | | `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | @@ -268,8 +266,8 @@ ___ | `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `verify` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | @@ -295,7 +293,7 @@ ___ ### off -• **off**: `OnEvent`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +• **off**: `OnEvent`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -305,7 +303,7 @@ ___ ### on -• **on**: `OnEvent`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +• **on**: `OnEvent`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -315,7 +313,7 @@ ___ ### once -• **once**: `OnEvent`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +• **once**: `OnEvent`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -331,26 +329,24 @@ ___ | Name | Type | | :------ | :------ | -| `addToken` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `addToken(uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `cancel` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `cancel(uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancelAndWaive` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `cancelAndWaive(uint256,address[])` | (`_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `claim(uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `cancelAndWaive` | (`_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `cancelAndWaive(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `claim` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `claim(uint256,uint256,uint256,uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `create` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_startTime`: `BigNumberish`, `_endTime`: `BigNumberish`, `_interval`: `BigNumberish`, `_recipient`: `string`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `executeMetaTransaction` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`_user`: `string`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getAmountEntitledFromStart(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getAmountEntitledFromStart` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getAmountEntitledFromStart(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -361,8 +357,6 @@ ___ | `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getNumStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getNumStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getPaymentToken` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getPaymentToken(uint256,address)` | (`_id`: `BigNumberish`, `_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getStreamingPayment` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getStreamingPayment(uint256)` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -381,8 +375,8 @@ ___ | `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `setStartTime` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `setStartTime(uint256,uint256,uint256,uint256)` | (`_adminPermissionDomainId`: `BigNumberish`, `_adminChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_startTime`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_token`: `string`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setTokenAmount` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `verify` | (`_user`: `string`, `_nonce`: `BigNumberish`, `_chainId`: `BigNumberish`, `_payload`: `BytesLike`, `_sigR`: `BytesLike`, `_sigS`: `BytesLike`, `_sigV`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -408,7 +402,7 @@ ___ ### removeListener -• **removeListener**: `OnEvent`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +• **removeListener**: `OnEvent`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -512,85 +506,9 @@ AugmentedStreamingPayments.\_wrapEvent ___ -### addToken - -▸ **addToken**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | -| `_fundingChildSkillIndex` | `BigNumberish` | -| `_id` | `BigNumberish` | -| `_token` | `string` | -| `_amount` | `BigNumberish` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addToken - -___ - -### addToken(uint256,uint256,uint256,address,uint256) - -▸ **addToken(uint256,uint256,uint256,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_fundingPermissionDomainId` | `BigNumberish` | -| `_fundingChildSkillIndex` | `BigNumberish` | -| `_id` | `BigNumberish` | -| `_token` | `string` | -| `_amount` | `BigNumberish` | -| `overrides?` | `Overrides` & { `from?`: `string` } | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addToken(uint256,uint256,uint256,address,uint256) - -___ - -### addTokenWithProofs - -▸ **addTokenWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> - -Same as [addToken](StreamingPaymentsClientV4.md#addtoken), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | -| `_amount` | `BigNumberish` | The amount to pay out | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedStreamingPayments.addTokenWithProofs - -___ - ### attach -▸ **attach**(`addressOrName`): [`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +▸ **attach**(`addressOrName`): [`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Parameters @@ -600,7 +518,7 @@ ___ #### Returns -[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Inherited from @@ -696,14 +614,13 @@ ___ ### cancelAndWaive -▸ **cancelAndWaive**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **cancelAndWaive**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters | Name | Type | | :------ | :------ | | `_id` | `BigNumberish` | -| `_tokens` | `string`[] | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -716,16 +633,15 @@ AugmentedStreamingPayments.cancelAndWaive ___ -### cancelAndWaive(uint256,address[]) +### cancelAndWaive(uint256) -▸ **cancelAndWaive(uint256,address[])**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **cancelAndWaive(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters | Name | Type | | :------ | :------ | | `_id` | `BigNumberish` | -| `_tokens` | `string`[] | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -734,7 +650,7 @@ ___ #### Inherited from -AugmentedStreamingPayments.cancelAndWaive(uint256,address[]) +AugmentedStreamingPayments.cancelAndWaive(uint256) ___ @@ -742,7 +658,7 @@ ___ ▸ **cancelWithProofs**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [cancel](StreamingPaymentsClientV4.md#cancel), but let colonyJS figure out the permission proofs for you. +Same as [cancel](StreamingPaymentsClientV5.md#cancel), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -764,7 +680,7 @@ ___ ### claim -▸ **claim**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **claim**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -775,7 +691,6 @@ ___ | `_fromChildSkillIndex` | `BigNumberish` | | `_toChildSkillIndex` | `BigNumberish` | | `_id` | `BigNumberish` | -| `_tokens` | `string`[] | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -788,9 +703,9 @@ AugmentedStreamingPayments.claim ___ -### claim(uint256,uint256,uint256,uint256,uint256,address[]) +### claim(uint256,uint256,uint256,uint256,uint256) -▸ **claim(uint256,uint256,uint256,uint256,uint256,address[])**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **claim(uint256,uint256,uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -801,7 +716,6 @@ ___ | `_fromChildSkillIndex` | `BigNumberish` | | `_toChildSkillIndex` | `BigNumberish` | | `_id` | `BigNumberish` | -| `_tokens` | `string`[] | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -810,15 +724,15 @@ ___ #### Inherited from -AugmentedStreamingPayments.claim(uint256,uint256,uint256,uint256,uint256,address[]) +AugmentedStreamingPayments.claim(uint256,uint256,uint256,uint256,uint256) ___ ### claimWithProofs -▸ **claimWithProofs**(`_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **claimWithProofs**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [claim](StreamingPaymentsClientV4.md#claim), but let colonyJS figure out the permission proofs for you. +Same as [claim](StreamingPaymentsClientV5.md#claim), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -826,7 +740,6 @@ Always prefer this method, except when you have good reason not to. | Name | Type | Description | | :------ | :------ | :------ | | `_id` | `BigNumberish` | The id of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | | `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | #### Returns @@ -841,7 +754,7 @@ ___ ### connect -▸ **connect**(`signerOrProvider`): [`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +▸ **connect**(`signerOrProvider`): [`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Parameters @@ -851,7 +764,7 @@ ___ #### Returns -[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Inherited from @@ -861,7 +774,7 @@ ___ ### create -▸ **create**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **create**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -876,8 +789,8 @@ ___ | `_endTime` | `BigNumberish` | | `_interval` | `BigNumberish` | | `_recipient` | `string` | -| `_tokens` | `string`[] | -| `_amounts` | `BigNumberish`[] | +| `_token` | `string` | +| `_amount` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -890,9 +803,9 @@ AugmentedStreamingPayments.create ___ -### create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[]) +### create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address,uint256) -▸ **create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_adminPermissionDomainId`, `_adminChildSkillIndex`, `_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -907,8 +820,8 @@ ___ | `_endTime` | `BigNumberish` | | `_interval` | `BigNumberish` | | `_recipient` | `string` | -| `_tokens` | `string`[] | -| `_amounts` | `BigNumberish`[] | +| `_token` | `string` | +| `_amount` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -917,15 +830,15 @@ ___ #### Inherited from -AugmentedStreamingPayments.create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[]) +AugmentedStreamingPayments.create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address,uint256) ___ ### createWithProofs -▸ **createWithProofs**(`_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_tokens`, `_amounts`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **createWithProofs**(`_domainId`, `_startTime`, `_endTime`, `_interval`, `_recipient`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [create](StreamingPaymentsClientV4.md#create), but let colonyJS figure out the permission proofs for you. +Same as [create](StreamingPaymentsClientV5.md#create), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -937,8 +850,8 @@ Always prefer this method, except when you have good reason not to. | `_endTime` | `BigNumberish` | The time at which the payment ends paying out | | `_interval` | `BigNumberish` | The period of time over which _amounts are paid out | | `_recipient` | `string` | The recipient of the streaming payment | -| `_tokens` | `string`[] | The tokens to be paid out | -| `_amounts` | `BigNumberish`[] | The amounts to be paid out (per _interval of time) | +| `_token` | `string` | - | +| `_amount` | `BigNumberish` | - | | `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | #### Returns @@ -953,11 +866,11 @@ ___ ### deployed -▸ **deployed**(): `Promise`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +▸ **deployed**(): `Promise`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Returns -`Promise`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +`Promise`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -1140,14 +1053,13 @@ ___ ### getAmountEntitledFromStart -▸ **getAmountEntitledFromStart**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> +▸ **getAmountEntitledFromStart**(`_id`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | | `_id` | `BigNumberish` | -| `_token` | `string` | | `overrides?` | `CallOverrides` | #### Returns @@ -1160,16 +1072,15 @@ AugmentedStreamingPayments.getAmountEntitledFromStart ___ -### getAmountEntitledFromStart(uint256,address) +### getAmountEntitledFromStart(uint256) -▸ **getAmountEntitledFromStart(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> +▸ **getAmountEntitledFromStart(uint256)**(`_id`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | | `_id` | `BigNumberish` | -| `_token` | `string` | | `overrides?` | `CallOverrides` | #### Returns @@ -1178,7 +1089,7 @@ ___ #### Inherited from -AugmentedStreamingPayments.getAmountEntitledFromStart(uint256,address) +AugmentedStreamingPayments.getAmountEntitledFromStart(uint256) ___ @@ -1386,50 +1297,6 @@ AugmentedStreamingPayments.getNumStreamingPayments() ___ -### getPaymentToken - -▸ **getPaymentToken**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_id` | `BigNumberish` | -| `_token` | `string` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`PaymentTokenStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getPaymentToken - -___ - -### getPaymentToken(uint256,address) - -▸ **getPaymentToken(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_id` | `BigNumberish` | -| `_token` | `string` | -| `overrides?` | `CallOverrides` | - -#### Returns - -`Promise`<`PaymentTokenStructOutput`\> - -#### Inherited from - -AugmentedStreamingPayments.getPaymentToken(uint256,address) - -___ - ### getStreamingPayment ▸ **getStreamingPayment**(`_id`, `overrides?`): `Promise`<`StreamingPaymentStructOutput`\> @@ -1728,7 +1595,7 @@ ___ ### removeAllListeners -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Type parameters @@ -1744,13 +1611,13 @@ ___ #### Returns -[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Inherited from AugmentedStreamingPayments.removeAllListeners -▸ **removeAllListeners**(`eventName?`): [`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +▸ **removeAllListeners**(`eventName?`): [`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Parameters @@ -1760,7 +1627,7 @@ AugmentedStreamingPayments.removeAllListeners #### Returns -[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Inherited from @@ -1862,7 +1729,7 @@ ___ ▸ **setEndTimeWithProofs**(`_id`, `_endTime`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [setEndTime](StreamingPaymentsClientV4.md#setendtime), but let colonyJS figure out the permission proofs for you. +Same as [setEndTime](StreamingPaymentsClientV5.md#setendtime), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -1977,7 +1844,7 @@ ___ ▸ **setStartTimeWithProofs**(`_id`, `_startTime`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [setStartTime](StreamingPaymentsClientV4.md#setstarttime), but let colonyJS figure out the permission proofs for you. +Same as [setStartTime](StreamingPaymentsClientV5.md#setstarttime), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -2000,7 +1867,7 @@ ___ ### setTokenAmount -▸ **setTokenAmount**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **setTokenAmount**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -2013,7 +1880,6 @@ ___ | `_fromChildSkillIndex` | `BigNumberish` | | `_toChildSkillIndex` | `BigNumberish` | | `_id` | `BigNumberish` | -| `_token` | `string` | | `_amount` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | @@ -2027,9 +1893,9 @@ AugmentedStreamingPayments.setTokenAmount ___ -### setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) +### setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256) -▸ **setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -2042,7 +1908,6 @@ ___ | `_fromChildSkillIndex` | `BigNumberish` | | `_toChildSkillIndex` | `BigNumberish` | | `_id` | `BigNumberish` | -| `_token` | `string` | | `_amount` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | @@ -2052,15 +1917,15 @@ ___ #### Inherited from -AugmentedStreamingPayments.setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) +AugmentedStreamingPayments.setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256) ___ ### setTokenAmountWithProofs -▸ **setTokenAmountWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **setTokenAmountWithProofs**(`_id`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [setTokenAmount](StreamingPaymentsClientV4.md#settokenamount), but let colonyJS figure out the permission proofs for you. +Same as [setTokenAmount](StreamingPaymentsClientV5.md#settokenamount), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -2068,7 +1933,6 @@ Always prefer this method, except when you have good reason not to. | Name | Type | Description | | :------ | :------ | :------ | | `_id` | `BigNumberish` | The id of the streaming payment | -| `_token` | `string` | The address of the token | | `_amount` | `BigNumberish` | The new amount to pay out | | `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | diff --git a/packages/colony-js/docs/api/interfaces/VotingReputationClientV11.md b/packages/colony-js/docs/api/interfaces/VotingReputationClientV11.md index ca5647db8..72f1ad91f 100644 --- a/packages/colony-js/docs/api/interfaces/VotingReputationClientV11.md +++ b/packages/colony-js/docs/api/interfaces/VotingReputationClientV11.md @@ -88,8 +88,8 @@ ___ | `finalizeMotionWithoutFailure(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `finishUpgrade` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `finishUpgrade()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `getActionSummary` | (`_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`ActionSummaryStructOutput`\> | -| `getActionSummary(bytes,address)` | (`_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`ActionSummaryStructOutput`\> | +| `getActionSummary` | (`_colonyNetwork`: `string`, `_colony`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`ActionSummaryStructOutput`\> | +| `getActionSummary(address,address,bytes,address)` | (`_colonyNetwork`: `string`, `_colony`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`ActionSummaryStructOutput`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | @@ -274,8 +274,8 @@ ___ | `finalizeMotionWithoutFailure(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `getActionSummary` | (`_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`ActionSummaryStructOutput`] & { `_summary`: `ActionSummaryStructOutput` }\> | -| `getActionSummary(bytes,address)` | (`_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`ActionSummaryStructOutput`] & { `_summary`: `ActionSummaryStructOutput` }\> | +| `getActionSummary` | (`_colonyNetwork`: `string`, `_colony`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`ActionSummaryStructOutput`] & { `_summary`: `ActionSummaryStructOutput` }\> | +| `getActionSummary(address,address,bytes,address)` | (`_colonyNetwork`: `string`, `_colony`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`ActionSummaryStructOutput`] & { `_summary`: `ActionSummaryStructOutput` }\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | @@ -415,8 +415,8 @@ ___ | `finalizeMotionWithoutFailure(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `getActionSummary` | (`_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getActionSummary(bytes,address)` | (`_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getActionSummary` | (`_colonyNetwork`: `string`, `_colony`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getActionSummary(address,address,bytes,address)` | (`_colonyNetwork`: `string`, `_colony`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -1272,12 +1272,14 @@ ___ ### getActionSummary -▸ **getActionSummary**(`_action`, `_altTarget`, `overrides?`): `Promise`<`ActionSummaryStructOutput`\> +▸ **getActionSummary**(`_colonyNetwork`, `_colony`, `_action`, `_altTarget`, `overrides?`): `Promise`<`ActionSummaryStructOutput`\> #### Parameters | Name | Type | | :------ | :------ | +| `_colonyNetwork` | `string` | +| `_colony` | `string` | | `_action` | `BytesLike` | | `_altTarget` | `string` | | `overrides?` | `CallOverrides` | @@ -1292,14 +1294,16 @@ AugmentedVotingReputation.getActionSummary ___ -### getActionSummary(bytes,address) +### getActionSummary(address,address,bytes,address) -▸ **getActionSummary(bytes,address)**(`_action`, `_altTarget`, `overrides?`): `Promise`<`ActionSummaryStructOutput`\> +▸ **getActionSummary(address,address,bytes,address)**(`_colonyNetwork`, `_colony`, `_action`, `_altTarget`, `overrides?`): `Promise`<`ActionSummaryStructOutput`\> #### Parameters | Name | Type | | :------ | :------ | +| `_colonyNetwork` | `string` | +| `_colony` | `string` | | `_action` | `BytesLike` | | `_altTarget` | `string` | | `overrides?` | `CallOverrides` | @@ -1310,7 +1314,7 @@ ___ #### Inherited from -AugmentedVotingReputation.getActionSummary(bytes,address) +AugmentedVotingReputation.getActionSummary(address,address,bytes,address) ___ diff --git a/packages/sdk/docs/api/README.md b/packages/sdk/docs/api/README.md index dc1568a05..783222d92 100644 --- a/packages/sdk/docs/api/README.md +++ b/packages/sdk/docs/api/README.md @@ -54,6 +54,7 @@ - [IpfsMetadata](classes/IpfsMetadata.md) - [MetaTxCreator](classes/MetaTxCreator.md) - [MetaTxTokenEvents\_\_factory](classes/MetaTxTokenEvents__factory.md) +- [MultisigPermissionsEvents\_\_factory](classes/MultisigPermissionsEvents__factory.md) - [OneTxPayment](classes/OneTxPayment.md) - [OneTxPaymentEvents\_\_factory](classes/OneTxPaymentEvents__factory.md) - [PinataAdapter](classes/PinataAdapter.md) @@ -208,7 +209,7 @@ Latest versions of all extension contracts | `ReputationBootstrapper` | ``1`` \| ``2`` \| ``3`` \| ``4`` | | `StagedExpenditure` | ``1`` \| ``2`` | | `StakedExpenditure` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` | -| `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` | +| `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` | | `TokenSupplier` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` | | `VotingReputation` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` | diff --git a/packages/sdk/docs/api/classes/MultisigPermissionsEvents__factory.md b/packages/sdk/docs/api/classes/MultisigPermissionsEvents__factory.md new file mode 100644 index 000000000..f41c2421b --- /dev/null +++ b/packages/sdk/docs/api/classes/MultisigPermissionsEvents__factory.md @@ -0,0 +1,40 @@ +# Class: MultisigPermissionsEvents\_\_factory + +## Constructors + +### constructor + +• **new MultisigPermissionsEvents__factory**() + +## Properties + +### abi + +▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"bytes32"`` ; `name`: ``"txHash"`` ; `type`: ``"bytes32"`` }, { `indexed`: ``false`` ; `internalType`: ``"string"`` ; `name`: ``"metadata"`` ; `type`: ``"string"`` }] ; `name`: ``"Annotation"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"motionId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint8"`` ; `name`: ``"role"`` ; `type`: ``"uint8"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"approval"`` ; `type`: ``"bool"`` }] ; `name`: ``"ApprovalChanged"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"skillId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"int256"`` ; `name`: ``"amount"`` ; `type`: ``"int256"`` }] ; `name`: ``"ArbitraryReputationUpdate"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"target"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes"`` ; `name`: ``"data"`` ; `type`: ``"bytes"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"success"`` ; `type`: ``"bool"`` }] ; `name`: ``"ArbitraryTransaction"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address[]"`` ; `name`: ``"users"`` ; `type`: ``"address[]"`` }, { `indexed`: ``false`` ; `internalType`: ``"int256[]"`` ; `name`: ``"amounts"`` ; `type`: ``"int256[]"`` }] ; `name`: ``"ColonyBootstrapped"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"fee"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"payoutRemainder"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ColonyFundsClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"fromPot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"toPot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }] ; `name`: ``"ColonyFundsMovedBetweenFundingPots"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"colonyNetwork"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }] ; `name`: ``"ColonyInitialised"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"string"`` ; `name`: ``"metadata"`` ; `type`: ``"string"`` }] ; `name`: ``"ColonyMetadata"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"string"`` ; `name`: ``"metadata"`` ; `type`: ``"string"`` }] ; `name`: ``"ColonyMetadataDelta"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"rewardInverse"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ColonyRewardInverseSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"domainId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint8"`` ; `name`: ``"role"`` ; `type`: ``"uint8"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"setTo"`` ; `type`: ``"bool"`` }] ; `name`: ``"ColonyRoleSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"oldVersion"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"newVersion"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ColonyUpgraded"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"domainId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"DomainAdded"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"domainId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"deprecated"`` ; `type`: ``"bool"`` }] ; `name`: ``"DomainDeprecated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"domainId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"string"`` ; `name`: ``"metadata"`` ; `type`: ``"string"`` }] ; `name`: ``"DomainMetadata"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"domainSkillId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"threshold"`` ; `type`: ``"uint256"`` }] ; `name`: ``"DomainSkillThresholdSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ExpenditureAdded"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ExpenditureCancelled"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"claimDelay"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ExpenditureClaimDelaySet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ExpenditureFinalized"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"globalClaimDelay"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ExpenditureGlobalClaimDelaySet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ExpenditureLocked"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"string"`` ; `name`: ``"metadata"`` ; `type`: ``"string"`` }] ; `name`: ``"ExpenditureMetadataSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"int256"`` ; `name`: ``"payoutModifier"`` ; `type`: ``"int256"`` }] ; `name`: ``"ExpenditurePayoutModifierSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ExpenditurePayoutSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"recipient"`` ; `type`: ``"address"`` }] ; `name`: ``"ExpenditureRecipientSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"skillId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ExpenditureSkillSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"storageSlot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool[]"`` ; `name`: ``"mask"`` ; `type`: ``"bool[]"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes32[]"`` ; `name`: ``"keys"`` ; `type`: ``"bytes32[]"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes32"`` ; `name`: ``"value"`` ; `type`: ``"bytes32"`` }] ; `name`: ``"ExpenditureStateChanged"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"`` }] ; `name`: ``"ExpenditureTransferred"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [] ; `name`: ``"ExtensionInitialised"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"fundingPotId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"FundingPotAdded"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"globalThreshold"`` ; `type`: ``"uint256"`` }] ; `name`: ``"GlobalThresholdSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"localSkillId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"LocalSkillAdded"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"localSkillId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"deprecated"`` ; `type`: ``"bool"`` }] ; `name`: ``"LocalSkillDeprecated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"authority"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetAuthority"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetOwner"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address payable"`` ; `name`: ``"relayerAddress"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes"`` ; `name`: ``"functionSignature"`` ; `type`: ``"bytes"`` }] ; `name`: ``"MetaTransactionExecuted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"motionId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"MotionCancelled"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"motionId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"MotionCreated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"motionId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"success"`` ; `type`: ``"bool"`` }] ; `name`: ``"MotionExecuted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"domainId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"roleId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"setTo"`` ; `type`: ``"bool"`` }] ; `name`: ``"MultisigRoleSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"paymentId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentAdded"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"paymentId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentFinalized"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"paymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentPayoutSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"paymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"recipient"`` ; `type`: ``"address"`` }] ; `name`: ``"PaymentRecipientSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"paymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"skillId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentSkillSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"fundingPotId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PayoutClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"id"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"tokenPayout"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PayoutClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"motionId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint8"`` ; `name`: ``"role"`` ; `type`: ``"uint8"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"approval"`` ; `type`: ``"bool"`` }] ; `name`: ``"RejectionChanged"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"rewardPayoutId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"fee"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"rewardRemainder"`` ; `type`: ``"uint256"`` }] ; `name`: ``"RewardPayoutClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"rewardPayoutId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"RewardPayoutCycleEnded"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"rewardPayoutId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"RewardPayoutCycleStarted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TaskAdded"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes32"`` ; `name`: ``"specificationHash"`` ; `type`: ``"bytes32"`` }] ; `name`: ``"TaskBriefSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TaskCanceled"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address[]"`` ; `name`: ``"reviewerAddresses"`` ; `type`: ``"address[]"`` }] ; `name`: ``"TaskChangedViaSignatures"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TaskCompleted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes32"`` ; `name`: ``"deliverableHash"`` ; `type`: ``"bytes32"`` }] ; `name`: ``"TaskDeliverableSubmitted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"dueDate"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TaskDueDateSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TaskFinalized"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` ; `name`: ``"role"`` ; `type`: ``"uint8"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TaskPayoutSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` ; `name`: ``"role"`` ; `type`: ``"uint8"`` }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }] ; `name`: ``"TaskRoleUserSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"skillId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TaskSkillSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"taskId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"enum ColonyDataTypes.TaskRole"`` ; `name`: ``"role"`` ; `type`: ``"uint8"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint8"`` ; `name`: ``"rating"`` ; `type`: ``"uint8"`` }] ; `name`: ``"TaskWorkRatingRevealed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }] ; `name`: ``"TokenUnlocked"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TokensBurned"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"who"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TokensMinted"`` ; `type`: ``"event"`` }] + +## Methods + +### connect + +▸ `Static` **connect**(`address`, `signerOrProvider`): `MultisigPermissionsEvents` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `signerOrProvider` | `Signer` \| `Provider` | + +#### Returns + +`MultisigPermissionsEvents` + +___ + +### createInterface + +▸ `Static` **createInterface**(): `MultisigPermissionsEventsInterface` + +#### Returns + +`MultisigPermissionsEventsInterface` diff --git a/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md b/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md index 30a5b8316..73d6a9d4c 100644 --- a/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md +++ b/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md @@ -10,7 +10,7 @@ ### abi -▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` ; `inputs`: readonly [] ; `name`: ``"ExtensionInitialised"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"authority"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetAuthority"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetOwner"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address payable"`` ; `name`: ``"relayerAddress"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes"`` ; `name`: ``"functionSignature"`` ; `type`: ``"bytes"`` }] ; `name`: ``"MetaTransactionExecuted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentTokenUpdated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StreamingPaymentClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StreamingPaymentCreated"`` ; `type`: ``"event"`` }] +▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` ; `inputs`: readonly [] ; `name`: ``"ExtensionInitialised"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"authority"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetAuthority"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"owner"`` ; `type`: ``"address"`` }] ; `name`: ``"LogSetOwner"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address payable"`` ; `name`: ``"relayerAddress"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"bytes"`` ; `name`: ``"functionSignature"`` ; `type`: ``"bytes"`` }] ; `name`: ``"MetaTransactionExecuted"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentTokenUpdated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StreamingPaymentClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StreamingPaymentCreated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"ClaimWaived"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"endTime"`` ; `type`: ``"uint256"`` }] ; `name`: ``"EndTimeSet"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentTokenUpdated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"streamingPaymentId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"startTime"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StartTimeSet"`` ; `type`: ``"event"`` }] ## Methods diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md new file mode 100644 index 000000000..26bf5a32e --- /dev/null +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md @@ -0,0 +1,15 @@ +# Interface: ClaimWaivedEventObject + +[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).ClaimWaivedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### streamingPaymentId + +• **streamingPaymentId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md new file mode 100644 index 000000000..42c0e18c3 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md @@ -0,0 +1,21 @@ +# Interface: EndTimeSetEventObject + +[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).EndTimeSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### endTime + +• **endTime**: `BigNumber` + +___ + +### streamingPaymentId + +• **streamingPaymentId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdatedEventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_address_uint256_EventObject.md similarity index 65% rename from packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdatedEventObject.md rename to packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_address_uint256_EventObject.md index 1b6bd6ae0..5a3765cd3 100644 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdatedEventObject.md +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_address_uint256_EventObject.md @@ -1,6 +1,6 @@ -# Interface: PaymentTokenUpdatedEventObject +# Interface: PaymentTokenUpdated\_address\_uint256\_address\_uint256\_EventObject -[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).PaymentTokenUpdatedEventObject +[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).PaymentTokenUpdated_address_uint256_address_uint256_EventObject ## Properties diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_uint256_EventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_uint256_EventObject.md new file mode 100644 index 000000000..f8d1149c3 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_uint256_EventObject.md @@ -0,0 +1,21 @@ +# Interface: PaymentTokenUpdated\_address\_uint256\_uint256\_EventObject + +[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).PaymentTokenUpdated_address_uint256_uint256_EventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### streamingPaymentId + +• **streamingPaymentId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md new file mode 100644 index 000000000..a7fdcfa15 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md @@ -0,0 +1,21 @@ +# Interface: StartTimeSetEventObject + +[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).StartTimeSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### startTime + +• **startTime**: `BigNumber` + +___ + +### streamingPaymentId + +• **streamingPaymentId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md index 309baf334..feb73f0de 100644 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md @@ -96,6 +96,10 @@ ___ | Name | Type | | :------ | :------ | +| `ClaimWaived` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`) => [`ClaimWaivedEventFilter`](../modules/StreamingPaymentsEvents.md#claimwaivedeventfilter) | +| `ClaimWaived(address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`) => [`ClaimWaivedEventFilter`](../modules/StreamingPaymentsEvents.md#claimwaivedeventfilter) | +| `EndTimeSet` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `endTime?`: ``null``) => [`EndTimeSetEventFilter`](../modules/StreamingPaymentsEvents.md#endtimeseteventfilter) | +| `EndTimeSet(address,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `endTime?`: ``null``) => [`EndTimeSetEventFilter`](../modules/StreamingPaymentsEvents.md#endtimeseteventfilter) | | `ExtensionInitialised` | () => [`ExtensionInitialisedEventFilter`](../modules/StreamingPaymentsEvents.md#extensioninitialisedeventfilter) | | `ExtensionInitialised()` | () => [`ExtensionInitialisedEventFilter`](../modules/StreamingPaymentsEvents.md#extensioninitialisedeventfilter) | | `LogSetAuthority` | (`authority?`: ``null`` \| `string`) => [`LogSetAuthorityEventFilter`](../modules/StreamingPaymentsEvents.md#logsetauthorityeventfilter) | @@ -104,8 +108,10 @@ ___ | `LogSetOwner(address)` | (`owner?`: ``null`` \| `string`) => [`LogSetOwnerEventFilter`](../modules/StreamingPaymentsEvents.md#logsetownereventfilter) | | `MetaTransactionExecuted` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => [`MetaTransactionExecutedEventFilter`](../modules/StreamingPaymentsEvents.md#metatransactionexecutedeventfilter) | | `MetaTransactionExecuted(address,address,bytes)` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => [`MetaTransactionExecutedEventFilter`](../modules/StreamingPaymentsEvents.md#metatransactionexecutedeventfilter) | -| `PaymentTokenUpdated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`PaymentTokenUpdatedEventFilter`](../modules/StreamingPaymentsEvents.md#paymenttokenupdatedeventfilter) | -| `PaymentTokenUpdated(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`PaymentTokenUpdatedEventFilter`](../modules/StreamingPaymentsEvents.md#paymenttokenupdatedeventfilter) | +| `PaymentTokenUpdated(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`PaymentTokenUpdated_address_uint256_address_uint256_EventFilter`](../modules/StreamingPaymentsEvents.md#paymenttokenupdated_address_uint256_address_uint256_eventfilter) | +| `PaymentTokenUpdated(address,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `amount?`: ``null``) => [`PaymentTokenUpdated_address_uint256_uint256_EventFilter`](../modules/StreamingPaymentsEvents.md#paymenttokenupdated_address_uint256_uint256_eventfilter) | +| `StartTimeSet` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `startTime?`: ``null``) => [`StartTimeSetEventFilter`](../modules/StreamingPaymentsEvents.md#starttimeseteventfilter) | +| `StartTimeSet(address,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `startTime?`: ``null``) => [`StartTimeSetEventFilter`](../modules/StreamingPaymentsEvents.md#starttimeseteventfilter) | | `StreamingPaymentClaimed` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`StreamingPaymentClaimedEventFilter`](../modules/StreamingPaymentsEvents.md#streamingpaymentclaimedeventfilter) | | `StreamingPaymentClaimed(address,uint256,address,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`StreamingPaymentClaimedEventFilter`](../modules/StreamingPaymentsEvents.md#streamingpaymentclaimedeventfilter) | | `StreamingPaymentCreated` | (`agent?`: ``null``, `streamingPaymentId?`: ``null``) => [`StreamingPaymentCreatedEventFilter`](../modules/StreamingPaymentsEvents.md#streamingpaymentcreatedeventfilter) | diff --git a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md index 4d250fe9c..61c693405 100644 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md @@ -62,11 +62,15 @@ ___ | Name | Type | | :------ | :------ | +| `ClaimWaived(address,uint256)` | `EventFragment` | +| `EndTimeSet(address,uint256,uint256)` | `EventFragment` | | `ExtensionInitialised()` | `EventFragment` | | `LogSetAuthority(address)` | `EventFragment` | | `LogSetOwner(address)` | `EventFragment` | | `MetaTransactionExecuted(address,address,bytes)` | `EventFragment` | | `PaymentTokenUpdated(address,uint256,address,uint256)` | `EventFragment` | +| `PaymentTokenUpdated(address,uint256,uint256)` | `EventFragment` | +| `StartTimeSet(address,uint256,uint256)` | `EventFragment` | | `StreamingPaymentClaimed(address,uint256,address,uint256)` | `EventFragment` | | `StreamingPaymentCreated(address,uint256)` | `EventFragment` | @@ -543,7 +547,7 @@ utils.Interface.getEvent | Name | Type | | :------ | :------ | -| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated"`` | +| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated(address,uint256,address,uint256)"`` | #### Returns @@ -559,7 +563,7 @@ utils.Interface.getEvent | Name | Type | | :------ | :------ | -| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated(address,uint256,address,uint256)"`` | +| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated(address,uint256,uint256)"`` | #### Returns @@ -633,6 +637,102 @@ utils.Interface.getEvent utils.Interface.getEvent +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ClaimWaived"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ClaimWaived(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"EndTimeSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"EndTimeSet(address,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"StartTimeSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"StartTimeSet(address,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + ___ ### getEventTopic diff --git a/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md b/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md index ef05ff79a..5c115d715 100644 --- a/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md +++ b/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md @@ -2,11 +2,15 @@ ## Interfaces +- [ClaimWaivedEventObject](../interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md) +- [EndTimeSetEventObject](../interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md) - [ExtensionInitialisedEventObject](../interfaces/StreamingPaymentsEvents.ExtensionInitialisedEventObject.md) - [LogSetAuthorityEventObject](../interfaces/StreamingPaymentsEvents.LogSetAuthorityEventObject.md) - [LogSetOwnerEventObject](../interfaces/StreamingPaymentsEvents.LogSetOwnerEventObject.md) - [MetaTransactionExecutedEventObject](../interfaces/StreamingPaymentsEvents.MetaTransactionExecutedEventObject.md) -- [PaymentTokenUpdatedEventObject](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdatedEventObject.md) +- [PaymentTokenUpdated\_address\_uint256\_address\_uint256\_EventObject](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_address_uint256_EventObject.md) +- [PaymentTokenUpdated\_address\_uint256\_uint256\_EventObject](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_uint256_EventObject.md) +- [StartTimeSetEventObject](../interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md) - [StreamingPaymentClaimedEventObject](../interfaces/StreamingPaymentsEvents.StreamingPaymentClaimedEventObject.md) - [StreamingPaymentCreatedEventObject](../interfaces/StreamingPaymentsEvents.StreamingPaymentCreatedEventObject.md) - [StreamingPaymentsEvents](../interfaces/StreamingPaymentsEvents.StreamingPaymentsEvents.md) @@ -14,6 +18,30 @@ ## Type Aliases +### ClaimWaivedEvent + +Ƭ **ClaimWaivedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`ClaimWaivedEventObject`](../interfaces/StreamingPaymentsEvents.ClaimWaivedEventObject.md)\> + +___ + +### ClaimWaivedEventFilter + +Ƭ **ClaimWaivedEventFilter**: `TypedEventFilter`<[`ClaimWaivedEvent`](StreamingPaymentsEvents.md#claimwaivedevent)\> + +___ + +### EndTimeSetEvent + +Ƭ **EndTimeSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`], [`EndTimeSetEventObject`](../interfaces/StreamingPaymentsEvents.EndTimeSetEventObject.md)\> + +___ + +### EndTimeSetEventFilter + +Ƭ **EndTimeSetEventFilter**: `TypedEventFilter`<[`EndTimeSetEvent`](StreamingPaymentsEvents.md#endtimesetevent)\> + +___ + ### ExtensionInitialisedEvent Ƭ **ExtensionInitialisedEvent**: `TypedEvent`<[], [`ExtensionInitialisedEventObject`](../interfaces/StreamingPaymentsEvents.ExtensionInitialisedEventObject.md)\> @@ -62,15 +90,39 @@ ___ ___ -### PaymentTokenUpdatedEvent +### PaymentTokenUpdated\_address\_uint256\_address\_uint256\_Event + +Ƭ **PaymentTokenUpdated\_address\_uint256\_address\_uint256\_Event**: `TypedEvent`<[`string`, `BigNumber`, `string`, `BigNumber`], [`PaymentTokenUpdated_address_uint256_address_uint256_EventObject`](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_address_uint256_EventObject.md)\> + +___ + +### PaymentTokenUpdated\_address\_uint256\_address\_uint256\_EventFilter + +Ƭ **PaymentTokenUpdated\_address\_uint256\_address\_uint256\_EventFilter**: `TypedEventFilter`<[`PaymentTokenUpdated_address_uint256_address_uint256_Event`](StreamingPaymentsEvents.md#paymenttokenupdated_address_uint256_address_uint256_event)\> + +___ + +### PaymentTokenUpdated\_address\_uint256\_uint256\_Event + +Ƭ **PaymentTokenUpdated\_address\_uint256\_uint256\_Event**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`], [`PaymentTokenUpdated_address_uint256_uint256_EventObject`](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_uint256_EventObject.md)\> + +___ + +### PaymentTokenUpdated\_address\_uint256\_uint256\_EventFilter + +Ƭ **PaymentTokenUpdated\_address\_uint256\_uint256\_EventFilter**: `TypedEventFilter`<[`PaymentTokenUpdated_address_uint256_uint256_Event`](StreamingPaymentsEvents.md#paymenttokenupdated_address_uint256_uint256_event)\> + +___ + +### StartTimeSetEvent -Ƭ **PaymentTokenUpdatedEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`, `BigNumber`], [`PaymentTokenUpdatedEventObject`](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdatedEventObject.md)\> +Ƭ **StartTimeSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`], [`StartTimeSetEventObject`](../interfaces/StreamingPaymentsEvents.StartTimeSetEventObject.md)\> ___ -### PaymentTokenUpdatedEventFilter +### StartTimeSetEventFilter -Ƭ **PaymentTokenUpdatedEventFilter**: `TypedEventFilter`<[`PaymentTokenUpdatedEvent`](StreamingPaymentsEvents.md#paymenttokenupdatedevent)\> +Ƭ **StartTimeSetEventFilter**: `TypedEventFilter`<[`StartTimeSetEvent`](StreamingPaymentsEvents.md#starttimesetevent)\> ___