diff --git a/.changeset/lovely-phones-compare.md b/.changeset/lovely-phones-compare.md new file mode 100644 index 000000000..4990f2797 --- /dev/null +++ b/.changeset/lovely-phones-compare.md @@ -0,0 +1,10 @@ +--- +"@colony/contractor": minor +"@colony/colony-js": minor +"@colony/events": minor +"@colony/tokens": minor +"@colony/core": minor +"@colony/sdk": minor +--- + +Add Streaming Payments v5 diff --git a/.changeset/ninety-tigers-argue.md b/.changeset/ninety-tigers-argue.md new file mode 100644 index 000000000..d9c23c4da --- /dev/null +++ b/.changeset/ninety-tigers-argue.md @@ -0,0 +1,10 @@ +--- +"@colony/events": major +"@colony/contractor": minor +"@colony/colony-js": minor +"@colony/core": minor +"@colony/sdk": minor +--- + +- Refactor events to namespace event object exports +- Add support for MultisigPermissions in `colony-js` diff --git a/.changeset/tall-cats-vanish.md b/.changeset/tall-cats-vanish.md new file mode 100644 index 000000000..be7de53b3 --- /dev/null +++ b/.changeset/tall-cats-vanish.md @@ -0,0 +1,8 @@ +--- +"@colony/contractor": minor +"@colony/colony-js": minor +"@colony/events": minor +"@colony/core": minor +--- + +Add support for colonyNetwork's imwss2 and abis@1.5.0 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index bbea811de..5afe9b8c2 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,8 +17,6 @@ jobs: uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} - - name: Set environment variables to include next versions of contracts - run: echo "COLONY_CONTRACTOR_INCLUDE_NEXT=true" >> $GITHUB_ENV - run: pnpm run bootstrap - run: pnpm run lint - run: pnpm run build diff --git a/packages/colony-js/docs/api/README.md b/packages/colony-js/docs/api/README.md index 24f296f9a..a50c1f2c5 100644 --- a/packages/colony-js/docs/api/README.md +++ b/packages/colony-js/docs/api/README.md @@ -37,12 +37,11 @@ ## Interfaces -- [ColonyClientV10](interfaces/ColonyClientV10.md) -- [ColonyClientV11](interfaces/ColonyClientV11.md) - [ColonyClientV12](interfaces/ColonyClientV12.md) - [ColonyClientV13](interfaces/ColonyClientV13.md) - [ColonyClientV14](interfaces/ColonyClientV14.md) - [ColonyClientV15](interfaces/ColonyClientV15.md) +- [ColonyClientV16](interfaces/ColonyClientV16.md) - [ColonyNetworkClient](interfaces/ColonyNetworkClient.md) - [ColonyToken](interfaces/ColonyToken.md) - [ColonyTokenClient](interfaces/ColonyTokenClient.md) @@ -53,37 +52,37 @@ - [Erc20TokenClient](interfaces/Erc20TokenClient.md) - [Erc2612TokenClient](interfaces/Erc2612TokenClient.md) - [IBasicMetaTransaction](interfaces/IBasicMetaTransaction.md) +- [MultisigPermissionsClientV1](interfaces/MultisigPermissionsClientV1.md) - [NetworkClientOptions](interfaces/NetworkClientOptions.md) -- [OneTxPaymentClientV2](interfaces/OneTxPaymentClientV2.md) - [OneTxPaymentClientV3](interfaces/OneTxPaymentClientV3.md) - [OneTxPaymentClientV4](interfaces/OneTxPaymentClientV4.md) - [OneTxPaymentClientV5](interfaces/OneTxPaymentClientV5.md) - [OneTxPaymentClientV6](interfaces/OneTxPaymentClientV6.md) - [OneTxPaymentClientV7](interfaces/OneTxPaymentClientV7.md) +- [OneTxPaymentClientV8](interfaces/OneTxPaymentClientV8.md) - [StagedExpenditureClientV1](interfaces/StagedExpenditureClientV1.md) - [StagedExpenditureClientV2](interfaces/StagedExpenditureClientV2.md) +- [StagedExpenditureClientV3](interfaces/StagedExpenditureClientV3.md) - [StakedExpenditureClientV1](interfaces/StakedExpenditureClientV1.md) - [StakedExpenditureClientV2](interfaces/StakedExpenditureClientV2.md) - [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) +- [StakedExpenditureClientV6](interfaces/StakedExpenditureClientV6.md) +- [StreamingPaymentsClientV5](interfaces/StreamingPaymentsClientV5.md) - [Token](interfaces/Token.md) - [TokenAuthority](interfaces/TokenAuthority.md) - [TokenLocking](interfaces/TokenLocking.md) - [TokenLockingClient](interfaces/TokenLockingClient.md) -- [TokenSupplierClientV2](interfaces/TokenSupplierClientV2.md) - [TokenSupplierClientV3](interfaces/TokenSupplierClientV3.md) - [TokenSupplierClientV4](interfaces/TokenSupplierClientV4.md) - [TokenSupplierClientV5](interfaces/TokenSupplierClientV5.md) - [TokenSupplierClientV6](interfaces/TokenSupplierClientV6.md) - [TokenSupplierClientV7](interfaces/TokenSupplierClientV7.md) +- [TokenSupplierClientV8](interfaces/TokenSupplierClientV8.md) - [VotingReputationClientV10](interfaces/VotingReputationClientV10.md) - [VotingReputationClientV11](interfaces/VotingReputationClientV11.md) -- [VotingReputationClientV6](interfaces/VotingReputationClientV6.md) +- [VotingReputationClientV12](interfaces/VotingReputationClientV12.md) - [VotingReputationClientV7](interfaces/VotingReputationClientV7.md) - [VotingReputationClientV8](interfaces/VotingReputationClientV8.md) - [VotingReputationClientV9](interfaces/VotingReputationClientV9.md) @@ -122,43 +121,49 @@ 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**: [`ColonyClientV12`](interfaces/ColonyClientV12.md) \| [`ColonyClientV13`](interfaces/ColonyClientV13.md) \| [`ColonyClientV14`](interfaces/ColonyClientV14.md) \| [`ColonyClientV15`](interfaces/ColonyClientV15.md) \| [`ColonyClientV16`](interfaces/ColonyClientV16.md) + +___ + +### AnyMultisigPermissionsClient + +Ƭ **AnyMultisigPermissionsClient**: [`MultisigPermissionsClientV1`](interfaces/MultisigPermissionsClientV1.md) ___ ### AnyOneTxPaymentClient -Ƭ **AnyOneTxPaymentClient**: [`OneTxPaymentClientV2`](interfaces/OneTxPaymentClientV2.md) \| [`OneTxPaymentClientV3`](interfaces/OneTxPaymentClientV3.md) \| [`OneTxPaymentClientV4`](interfaces/OneTxPaymentClientV4.md) \| [`OneTxPaymentClientV5`](interfaces/OneTxPaymentClientV5.md) \| [`OneTxPaymentClientV6`](interfaces/OneTxPaymentClientV6.md) \| [`OneTxPaymentClientV7`](interfaces/OneTxPaymentClientV7.md) +Ƭ **AnyOneTxPaymentClient**: [`OneTxPaymentClientV3`](interfaces/OneTxPaymentClientV3.md) \| [`OneTxPaymentClientV4`](interfaces/OneTxPaymentClientV4.md) \| [`OneTxPaymentClientV5`](interfaces/OneTxPaymentClientV5.md) \| [`OneTxPaymentClientV6`](interfaces/OneTxPaymentClientV6.md) \| [`OneTxPaymentClientV7`](interfaces/OneTxPaymentClientV7.md) \| [`OneTxPaymentClientV8`](interfaces/OneTxPaymentClientV8.md) ___ ### AnyStagedExpenditureClient -Ƭ **AnyStagedExpenditureClient**: [`StagedExpenditureClientV1`](interfaces/StagedExpenditureClientV1.md) \| [`StagedExpenditureClientV2`](interfaces/StagedExpenditureClientV2.md) +Ƭ **AnyStagedExpenditureClient**: [`StagedExpenditureClientV1`](interfaces/StagedExpenditureClientV1.md) \| [`StagedExpenditureClientV2`](interfaces/StagedExpenditureClientV2.md) \| [`StagedExpenditureClientV3`](interfaces/StagedExpenditureClientV3.md) ___ ### AnyStakedExpenditureClient -Ƭ **AnyStakedExpenditureClient**: [`StakedExpenditureClientV1`](interfaces/StakedExpenditureClientV1.md) \| [`StakedExpenditureClientV2`](interfaces/StakedExpenditureClientV2.md) \| [`StakedExpenditureClientV3`](interfaces/StakedExpenditureClientV3.md) \| [`StakedExpenditureClientV4`](interfaces/StakedExpenditureClientV4.md) \| [`StakedExpenditureClientV5`](interfaces/StakedExpenditureClientV5.md) +Ƭ **AnyStakedExpenditureClient**: [`StakedExpenditureClientV1`](interfaces/StakedExpenditureClientV1.md) \| [`StakedExpenditureClientV2`](interfaces/StakedExpenditureClientV2.md) \| [`StakedExpenditureClientV3`](interfaces/StakedExpenditureClientV3.md) \| [`StakedExpenditureClientV4`](interfaces/StakedExpenditureClientV4.md) \| [`StakedExpenditureClientV5`](interfaces/StakedExpenditureClientV5.md) \| [`StakedExpenditureClientV6`](interfaces/StakedExpenditureClientV6.md) ___ ### AnyStreamingPaymentsClient -Ƭ **AnyStreamingPaymentsClient**: [`StreamingPaymentsClientV1`](interfaces/StreamingPaymentsClientV1.md) \| [`StreamingPaymentsClientV2`](interfaces/StreamingPaymentsClientV2.md) \| [`StreamingPaymentsClientV3`](interfaces/StreamingPaymentsClientV3.md) \| [`StreamingPaymentsClientV4`](interfaces/StreamingPaymentsClientV4.md) +Ƭ **AnyStreamingPaymentsClient**: [`StreamingPaymentsClientV5`](interfaces/StreamingPaymentsClientV5.md) ___ ### AnyTokenSupplierClient -Ƭ **AnyTokenSupplierClient**: [`TokenSupplierClientV2`](interfaces/TokenSupplierClientV2.md) \| [`TokenSupplierClientV3`](interfaces/TokenSupplierClientV3.md) \| [`TokenSupplierClientV4`](interfaces/TokenSupplierClientV4.md) \| [`TokenSupplierClientV5`](interfaces/TokenSupplierClientV5.md) \| [`TokenSupplierClientV6`](interfaces/TokenSupplierClientV6.md) \| [`TokenSupplierClientV7`](interfaces/TokenSupplierClientV7.md) +Ƭ **AnyTokenSupplierClient**: [`TokenSupplierClientV3`](interfaces/TokenSupplierClientV3.md) \| [`TokenSupplierClientV4`](interfaces/TokenSupplierClientV4.md) \| [`TokenSupplierClientV5`](interfaces/TokenSupplierClientV5.md) \| [`TokenSupplierClientV6`](interfaces/TokenSupplierClientV6.md) \| [`TokenSupplierClientV7`](interfaces/TokenSupplierClientV7.md) \| [`TokenSupplierClientV8`](interfaces/TokenSupplierClientV8.md) ___ ### AnyVotingReputationClient -Ƭ **AnyVotingReputationClient**: [`VotingReputationClientV6`](interfaces/VotingReputationClientV6.md) \| [`VotingReputationClientV7`](interfaces/VotingReputationClientV7.md) \| [`VotingReputationClientV8`](interfaces/VotingReputationClientV8.md) \| [`VotingReputationClientV9`](interfaces/VotingReputationClientV9.md) \| [`VotingReputationClientV10`](interfaces/VotingReputationClientV10.md) \| [`VotingReputationClientV11`](interfaces/VotingReputationClientV11.md) +Ƭ **AnyVotingReputationClient**: [`VotingReputationClientV7`](interfaces/VotingReputationClientV7.md) \| [`VotingReputationClientV8`](interfaces/VotingReputationClientV8.md) \| [`VotingReputationClientV9`](interfaces/VotingReputationClientV9.md) \| [`VotingReputationClientV10`](interfaces/VotingReputationClientV10.md) \| [`VotingReputationClientV11`](interfaces/VotingReputationClientV11.md) \| [`VotingReputationClientV12`](interfaces/VotingReputationClientV12.md) ___ @@ -207,19 +212,19 @@ ___ ### EventsClient -Ƭ **EventsClient**: `EvaluatedExpenditureEvents.EvaluatedExpenditureEvents` \| `ColonyEvents.IColonyEvents` \| `ColonyNetworkEvents.IColonyNetworkEvents` \| `VotingReputationEvents.IVotingReputationEvents` \| `MetaTxTokenEvents.MetaTxTokenEvents` \| `OneTxPaymentEvents.OneTxPaymentEvents` \| `StakedExpenditureEvents.StakedExpenditureEvents` \| `StreamingPaymentsEvents.StreamingPaymentsEvents` \| `TokenSupplierEvents.TokenSupplierEvents` \| `VotingReputationEvents.IVotingReputationEvents` +Ƭ **EventsClient**: `EvaluatedExpenditureEvents.EvaluatedExpenditureEvents` \| `ColonyEvents.IColonyEvents` \| `ColonyNetworkEvents.IColonyNetworkEvents` \| `VotingReputationEvents.IVotingReputationEvents` \| `MetaTxTokenEvents.MetaTxTokenEvents` \| `MultisigPermissionsEvents.MultisigPermissionsEvents` \| `OneTxPaymentEvents.OneTxPaymentEvents` \| `StakedExpenditureEvents.StakedExpenditureEvents` \| `StreamingPaymentsEvents.StreamingPaymentsEvents` \| `TokenSupplierEvents.TokenSupplierEvents` \| `VotingReputationEvents.IVotingReputationEvents` ___ ### ExtensionClient -Ƭ **ExtensionClient**: `AnyFundingQueueClient` \| [`AnyOneTxPaymentClient`](README.md#anyonetxpaymentclient) \| `AnyReputationBootstrapperClient` \| [`AnyStagedExpenditureClient`](README.md#anystagedexpenditureclient) \| [`AnyStakedExpenditureClient`](README.md#anystakedexpenditureclient) \| [`AnyStreamingPaymentsClient`](README.md#anystreamingpaymentsclient) \| [`AnyTokenSupplierClient`](README.md#anytokensupplierclient) \| [`AnyVotingReputationClient`](README.md#anyvotingreputationclient) +Ƭ **ExtensionClient**: `AnyFundingQueueClient` \| [`AnyMultisigPermissionsClient`](README.md#anymultisigpermissionsclient) \| [`AnyOneTxPaymentClient`](README.md#anyonetxpaymentclient) \| `AnyReputationBootstrapperClient` \| [`AnyStagedExpenditureClient`](README.md#anystagedexpenditureclient) \| [`AnyStakedExpenditureClient`](README.md#anystakedexpenditureclient) \| [`AnyStreamingPaymentsClient`](README.md#anystreamingpaymentsclient) \| [`AnyTokenSupplierClient`](README.md#anytokensupplierclient) \| [`AnyVotingReputationClient`](README.md#anyvotingreputationclient) ___ ### ExtensionVersion -Ƭ **ExtensionVersion**: [`FundingQueueVersion`](README.md#fundingqueueversion) \| [`OneTxPaymentVersion`](README.md#onetxpaymentversion) \| [`ReputationBootstrapperVersion`](README.md#reputationbootstrapperversion) \| [`StagedExpenditureVersion`](README.md#stagedexpenditureversion) \| [`StakedExpenditureVersion`](README.md#stakedexpenditureversion) \| `StreamingPaymentsVersion` \| [`TokenSupplierVersion`](README.md#tokensupplierversion) \| [`VotingReputationVersion`](README.md#votingreputationversion) +Ƭ **ExtensionVersion**: [`FundingQueueVersion`](README.md#fundingqueueversion) \| [`MultisigPermissionsVersion`](README.md#multisigpermissionsversion) \| [`OneTxPaymentVersion`](README.md#onetxpaymentversion) \| [`ReputationBootstrapperVersion`](README.md#reputationbootstrapperversion) \| [`StagedExpenditureVersion`](README.md#stagedexpenditureversion) \| [`StakedExpenditureVersion`](README.md#stakedexpenditureversion) \| `StreamingPaymentsVersion` \| [`TokenSupplierVersion`](README.md#tokensupplierversion) \| [`VotingReputationVersion`](README.md#votingreputationversion) All possible extension versions @@ -231,6 +236,12 @@ ___ ___ +### MultisigPermissionsVersion + +Ƭ **MultisigPermissionsVersion**: typeof `MULTISIG_PERMISSIONS_VERSIONS`[`number`] + +___ + ### OneTxPaymentVersion Ƭ **OneTxPaymentVersion**: typeof `ONE_TX_PAYMENT_VERSIONS`[`number`] @@ -338,15 +349,16 @@ Latest versions of all extension contracts | Name | Type | | :------ | :------ | -| `FundingQueue` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` | -| `IVotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` | -| `OneTxPayment` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` | -| `ReputationBootstrapper` | ``1`` \| ``2`` \| ``3`` \| ``4`` | -| `StagedExpenditure` | ``1`` \| ``2`` | -| `StakedExpenditure` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` | -| `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` | -| `TokenSupplier` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` | -| `VotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` | +| `FundingQueue` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` | +| `IVotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` | +| `MultisigPermissions` | ``1`` | +| `OneTxPayment` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` | +| `ReputationBootstrapper` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` | +| `StagedExpenditure` | ``1`` \| ``2`` \| ``3`` | +| `StakedExpenditure` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` | +| `StreamingPayments` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` | +| `TokenSupplier` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` | +| `VotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` | ___ @@ -650,6 +662,27 @@ A hash to identify the extension on the contracts ___ +### getExtensionLowestCompatibleColonyVersion + +▸ **getExtensionLowestCompatibleColonyVersion**(`extension`, `extensionVersion`): ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` \| ``16`` + +Calculates and returns the lowest compatible colony version for a given version of an extension + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `extension` | [`Extension`](enums/Extension.md) | A valid `Extension` contract name | +| `extensionVersion` | [`ExtensionVersion`](README.md#extensionversion) | The version of the extension to check | + +#### Returns + +``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` \| ``16`` + +the lowest compatible colony version for a given version of an extension + +___ + ### getHistoricColonyRoles ▸ **getHistoricColonyRoles**(`client`, `fromBlock?`, `toBlock?`): `Promise`<[`ColonyRoles`](README.md#colonyroles)\> @@ -864,7 +897,7 @@ Returns `true` if an extension version is compatible with the given colony versi | :------ | :------ | :------ | | `extension` | [`Extension`](enums/Extension.md) | A valid `Extension` contract name | | `extensionVersion` | [`ExtensionVersion`](README.md#extensionversion) | The version of the extension to check against the colony | -| `colonyVersion` | ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` | The version of the colony to check for | +| `colonyVersion` | ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` \| ``16`` | The version of the colony to check for | #### Returns diff --git a/packages/colony-js/docs/api/classes/ColonyFactory.md b/packages/colony-js/docs/api/classes/ColonyFactory.md index 5cd371dad..83fd7aceb 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`: ``"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/classes/factories.TokenLocking__factory.md b/packages/colony-js/docs/api/classes/factories.TokenLocking__factory.md index c39edb2a0..e3f257407 100644 --- a/packages/colony-js/docs/api/classes/factories.TokenLocking__factory.md +++ b/packages/colony-js/docs/api/classes/factories.TokenLocking__factory.md @@ -12,7 +12,7 @@ ### abi -▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"colonyNetwork"`` ; `type`: ``"address"`` }] ; `name`: ``"ColonyNetworkSet"`` ; `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`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"by"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"from"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"to"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StakeTransferred"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"lockedBy"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"lockCount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TokenLocked"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"approvedBy"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenApproved"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"obligatedBy"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenDeobligated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenDeposited"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"obligatedBy"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenObligated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"recipient"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenTransferred"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"lockId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenUnlocked"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenWithdrawn"`` ; `type`: ``"event"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"approveStake"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [] ; `name`: ``"authority"`` ; `outputs`: readonly [{ `internalType`: ``"contract DSAuthority"`` ; `name`: ``""`` ; `type`: ``"address"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"deobligateStake"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"bool"`` ; `name`: ``"_force"`` ; `type`: ``"bool"`` }] ; `name`: ``"deposit"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"deposit"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_recipient"`` ; `type`: ``"address"`` }] ; `name`: ``"depositFor"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"bytes"`` ; `name`: ``"_payload"`` ; `type`: ``"bytes"`` }, { `internalType`: ``"bytes32"`` ; `name`: ``"_sigR"`` ; `type`: ``"bytes32"`` }, { `internalType`: ``"bytes32"`` ; `name`: ``"_sigS"`` ; `type`: ``"bytes32"`` }, { `internalType`: ``"uint8"`` ; `name`: ``"_sigV"`` ; `type`: ``"uint8"`` }] ; `name`: ``"executeMetaTransaction"`` ; `outputs`: readonly [{ `internalType`: ``"bytes"`` ; `name`: ``""`` ; `type`: ``"bytes"`` }] ; `stateMutability`: ``"payable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_obligator"`` ; `type`: ``"address"`` }] ; `name`: ``"getApproval"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [] ; `name`: ``"getColonyNetwork"`` ; `outputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``""`` ; `type`: ``"address"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"userAddress"`` ; `type`: ``"address"`` }] ; `name`: ``"getMetatransactionNonce"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``"nonce"`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_obligator"`` ; `type`: ``"address"`` }] ; `name`: ``"getObligation"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"getTotalLockCount"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"getTotalObligation"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }] ; `name`: ``"getUserLock"`` ; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``"lockCount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"balance"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"DEPRECATED_timestamp"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"pendingBalance"`` ; `type`: ``"uint256"`` }] ; `internalType`: ``"struct TokenLockingDataTypes.Lock"`` ; `name`: ``"lock"`` ; `type`: ``"tuple"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_lockId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"incrementLockCounterTo"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"lockToken"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"obligateStake"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [] ; `name`: ``"owner"`` ; `outputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``""`` ; `type`: ``"address"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_recipient"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"reward"`` ; `outputs`: readonly [] ; `stateMutability`: ``"pure"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"contract DSAuthority"`` ; `name`: ``"authority_"`` ; `type`: ``"address"`` }] ; `name`: ``"setAuthority"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_colonyNetwork"`` ; `type`: ``"address"`` }] ; `name`: ``"setColonyNetwork"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"owner_"`` ; `type`: ``"address"`` }] ; `name`: ``"setOwner"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_recipient"`` ; `type`: ``"address"`` }, { `internalType`: ``"bool"`` ; `name`: ``"_force"`` ; `type`: ``"bool"`` }] ; `name`: ``"transfer"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_recipient"`` ; `type`: ``"address"`` }] ; `name`: ``"transferStake"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_lockId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"unlockTokenForUser"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_nonce"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_chainId"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"bytes"`` ; `name`: ``"_payload"`` ; `type`: ``"bytes"`` }, { `internalType`: ``"bytes32"`` ; `name`: ``"_sigR"`` ; `type`: ``"bytes32"`` }, { `internalType`: ``"bytes32"`` ; `name`: ``"_sigS"`` ; `type`: ``"bytes32"`` }, { `internalType`: ``"uint8"`` ; `name`: ``"_sigV"`` ; `type`: ``"uint8"`` }] ; `name`: ``"verify"`` ; `outputs`: readonly [{ `internalType`: ``"bool"`` ; `name`: ``""`` ; `type`: ``"bool"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"bool"`` ; `name`: ``"_force"`` ; `type`: ``"bool"`` }] ; `name`: ``"withdraw"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"withdraw"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }] +▪ `Static` `Readonly` **abi**: readonly [{ `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"colonyNetwork"`` ; `type`: ``"address"`` }] ; `name`: ``"ColonyNetworkSet"`` ; `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`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"by"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"from"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"to"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StakeTransferred"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"address"`` ; `name`: ``"lockedBy"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"lockCount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"TokenLocked"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"approvedBy"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenApproved"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenClaimed"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"obligatedBy"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenDeobligated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenDeposited"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"obligatedBy"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenObligated"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"recipient"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenTransferred"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"lockId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenUnlocked"`` ; `type`: ``"event"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"token"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"user"`` ; `type`: ``"address"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"UserTokenWithdrawn"`` ; `type`: ``"event"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"approveStake"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [] ; `name`: ``"authority"`` ; `outputs`: readonly [{ `internalType`: ``"contract DSAuthority"`` ; `name`: ``""`` ; `type`: ``"address"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"deobligateStake"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"bool"`` ; `name`: ``"_force"`` ; `type`: ``"bool"`` }] ; `name`: ``"deposit"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"deposit"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_recipient"`` ; `type`: ``"address"`` }] ; `name`: ``"depositFor"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"bytes"`` ; `name`: ``"_payload"`` ; `type`: ``"bytes"`` }, { `internalType`: ``"bytes32"`` ; `name`: ``"_sigR"`` ; `type`: ``"bytes32"`` }, { `internalType`: ``"bytes32"`` ; `name`: ``"_sigS"`` ; `type`: ``"bytes32"`` }, { `internalType`: ``"uint8"`` ; `name`: ``"_sigV"`` ; `type`: ``"uint8"`` }] ; `name`: ``"executeMetaTransaction"`` ; `outputs`: readonly [{ `internalType`: ``"bytes"`` ; `name`: ``""`` ; `type`: ``"bytes"`` }] ; `stateMutability`: ``"payable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_obligator"`` ; `type`: ``"address"`` }] ; `name`: ``"getApproval"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [] ; `name`: ``"getColonyNetwork"`` ; `outputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``""`` ; `type`: ``"address"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }] ; `name`: ``"getMetatransactionNonce"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``"nonce"`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_obligator"`` ; `type`: ``"address"`` }] ; `name`: ``"getObligation"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"getTotalLockCount"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"getTotalObligation"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }] ; `name`: ``"getUserLock"`` ; `outputs`: readonly [{ `components`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``"lockCount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"balance"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"DEPRECATED_timestamp"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"pendingBalance"`` ; `type`: ``"uint256"`` }] ; `internalType`: ``"struct TokenLockingDataTypes.Lock"`` ; `name`: ``"lock"`` ; `type`: ``"tuple"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_lockId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"incrementLockCounterTo"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"lockToken"`` ; `outputs`: readonly [{ `internalType`: ``"uint256"`` ; `name`: ``""`` ; `type`: ``"uint256"`` }] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }] ; `name`: ``"obligateStake"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [] ; `name`: ``"owner"`` ; `outputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``""`` ; `type`: ``"address"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_recipient"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"reward"`` ; `outputs`: readonly [] ; `stateMutability`: ``"pure"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"contract DSAuthority"`` ; `name`: ``"authority_"`` ; `type`: ``"address"`` }] ; `name`: ``"setAuthority"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_colonyNetwork"`` ; `type`: ``"address"`` }] ; `name`: ``"setColonyNetwork"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"owner_"`` ; `type`: ``"address"`` }] ; `name`: ``"setOwner"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_recipient"`` ; `type`: ``"address"`` }, { `internalType`: ``"bool"`` ; `name`: ``"_force"`` ; `type`: ``"bool"`` }] ; `name`: ``"transfer"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_recipient"`` ; `type`: ``"address"`` }] ; `name`: ``"transferStake"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_lockId"`` ; `type`: ``"uint256"`` }] ; `name`: ``"unlockTokenForUser"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_user"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_nonce"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_chainId"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"bytes"`` ; `name`: ``"_payload"`` ; `type`: ``"bytes"`` }, { `internalType`: ``"bytes32"`` ; `name`: ``"_sigR"`` ; `type`: ``"bytes32"`` }, { `internalType`: ``"bytes32"`` ; `name`: ``"_sigS"`` ; `type`: ``"bytes32"`` }, { `internalType`: ``"uint8"`` ; `name`: ``"_sigV"`` ; `type`: ``"uint8"`` }] ; `name`: ``"verify"`` ; `outputs`: readonly [{ `internalType`: ``"bool"`` ; `name`: ``""`` ; `type`: ``"bool"`` }] ; `stateMutability`: ``"view"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }, { `internalType`: ``"bool"`` ; `name`: ``"_force"`` ; `type`: ``"bool"`` }] ; `name`: ``"withdraw"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }, { `inputs`: readonly [{ `internalType`: ``"address"`` ; `name`: ``"_token"`` ; `type`: ``"address"`` }, { `internalType`: ``"uint256"`` ; `name`: ``"_amount"`` ; `type`: ``"uint256"`` }] ; `name`: ``"withdraw"`` ; `outputs`: readonly [] ; `stateMutability`: ``"nonpayable"`` ; `type`: ``"function"`` }] ## Methods diff --git a/packages/colony-js/docs/api/enums/ClientType.md b/packages/colony-js/docs/api/enums/ClientType.md index e1ccaf703..497f81526 100644 --- a/packages/colony-js/docs/api/enums/ClientType.md +++ b/packages/colony-js/docs/api/enums/ClientType.md @@ -27,6 +27,12 @@ ___ ___ +### MultisigPermissionsClient + +• **MultisigPermissionsClient** = ``"MultisigPermissionsClient"`` + +___ + ### NetworkClient • **NetworkClient** = ``"NetworkClient"`` diff --git a/packages/colony-js/docs/api/enums/Extension.md b/packages/colony-js/docs/api/enums/Extension.md index adc87b392..743a94842 100644 --- a/packages/colony-js/docs/api/enums/Extension.md +++ b/packages/colony-js/docs/api/enums/Extension.md @@ -16,6 +16,12 @@ ___ ___ +### MultisigPermissions + +• **MultisigPermissions** = ``"MultisigPermissions"`` + +___ + ### OneTxPayment • **OneTxPayment** = ``"OneTxPayment"`` 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/ColonyClientV11.md b/packages/colony-js/docs/api/interfaces/ColonyClientV11.md deleted file mode 100644 index 1a3645cf7..000000000 --- a/packages/colony-js/docs/api/interfaces/ColonyClientV11.md +++ /dev/null @@ -1,8852 +0,0 @@ -# Interface: ColonyClientV11 - -## Hierarchy - -- `AugmentedIColony`<`IColony`\> - -- `ColonyAugmentsV3`<`IColony`\> - -- `ColonyAugmentsV4`<`IColony`\> - -- `ColonyAugmentsV5`<`IColony`\> - -- `ColonyAugmentsV6`<`IColony`\> - -- `ColonyAugmentsV7`<`IColony`\> - -- `AddDomainAugmentsB`<`IColony`\> - -- `MoveFundsBetweenPotsAugmentsB`<`IColony`\> - - ↳ **`ColonyClientV11`** - -## 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**: ``11`` - -#### 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**: `ColonyClientV11Estimate` - -#### 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` | -| `ArbitraryTransaction` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => `ArbitraryTransactionEventFilter` | -| `ArbitraryTransaction(address,bytes,bool)` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => `ArbitraryTransactionEventFilter` | -| `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`<[`ColonyClientV11`](ColonyClientV11.md)\> - -#### Inherited from - -AugmentedIColony.off - -___ - -### on - -• **on**: `OnEvent`<[`ColonyClientV11`](ColonyClientV11.md)\> - -#### Inherited from - -AugmentedIColony.on - -___ - -### once - -• **once**: `OnEvent`<[`ColonyClientV11`](ColonyClientV11.md)\> - -#### Inherited from - -AugmentedIColony.once - -___ - -### provider - -• `Readonly` **provider**: `Provider` - -#### Inherited from - -AugmentedIColony.provider - -___ - -### removeListener - -• **removeListener**: `OnEvent`<[`ColonyClientV11`](ColonyClientV11.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)](ColonyClientV11.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)](ColonyClientV11.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`): [`ColonyClientV11`](ColonyClientV11.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressOrName` | `string` | - -#### Returns - -[`ColonyClientV11`](ColonyClientV11.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`): [`ColonyClientV11`](ColonyClientV11.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| `Signer` \| `Provider` | - -#### Returns - -[`ColonyClientV11`](ColonyClientV11.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`<[`ColonyClientV11`](ColonyClientV11.md)\> - -#### Returns - -`Promise`<[`ColonyClientV11`](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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)](ColonyClientV11.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)](ColonyClientV11.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) - -___ - -### multicall - -▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> - -The `msg.value` should not be trusted for any method callable from multicall. -Call multiple functions in the current contract and return the data from all of them if they all succeed - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike`[] | The encoded function data for each of the calls to make to this contract | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.multicall - -___ - -### multicall(bytes[]) - -▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> - -The `msg.value` should not be trusted for any method callable from multicall. -Call multiple functions in the current contract and return the data from all of them if they all succeed - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike`[] | The encoded function data for each of the calls to make to this contract | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedIColony.multicall(bytes[]) - -___ - -### 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`): [`ColonyClientV11`](ColonyClientV11.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEvent` | extends `TypedEvent`<`any`, `any`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventFilter` | `TypedEventFilter`<`TEvent`\> | - -#### Returns - -[`ColonyClientV11`](ColonyClientV11.md) - -#### Inherited from - -AugmentedIColony.removeAllListeners - -▸ **removeAllListeners**(`eventName?`): [`ColonyClientV11`](ColonyClientV11.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName?` | `string` | - -#### Returns - -[`ColonyClientV11`](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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)](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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](ColonyClientV11.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..a807e855b 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`\> diff --git a/packages/colony-js/docs/api/interfaces/ColonyClientV16.md b/packages/colony-js/docs/api/interfaces/ColonyClientV16.md new file mode 100644 index 000000000..88d44a6c6 --- /dev/null +++ b/packages/colony-js/docs/api/interfaces/ColonyClientV16.md @@ -0,0 +1,6805 @@ +# Interface: ColonyClientV16 + +## Hierarchy + +- `AugmentedIColony`<`IColony`\> + +- `ColonyAugmentsV3`<`IColony`\> + +- `ColonyAugmentsV4`<`IColony`\> + +- `ColonyAugmentsV5`<`IColony`\> + +- `ColonyAugmentsV6`<`IColony`\> + +- `ColonyAugmentsV7`<`IColony`\> + +- `AddDomainAugmentsB`<`IColony`\> + +- `MoveFundsBetweenPotsAugmentsB`<`IColony`\> + + ↳ **`ColonyClientV16`** + +## 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**: ``16`` + +#### 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**: `ColonyClientV16Estimate` + +#### 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` | +| `ArbitraryTransaction` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => `ArbitraryTransactionEventFilter` | +| `ArbitraryTransaction(address,bytes,bool)` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => `ArbitraryTransactionEventFilter` | +| `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(address,uint256,address,uint256)` | (`agent?`: ``null``, `fundingPotId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PayoutClaimed_address_uint256_address_uint256_EventFilter` | +| `PayoutClaimed(address,uint256,uint256,address,uint256)` | (`agent?`: ``null``, `id?`: ``null``, `slot?`: ``null``, `token?`: ``null``, `tokenPayout?`: ``null``) => `PayoutClaimed_address_uint256_uint256_address_uint256_EventFilter` | +| `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`<[`ColonyClientV16`](ColonyClientV16.md)\> + +#### Inherited from + +AugmentedIColony.off + +___ + +### on + +• **on**: `OnEvent`<[`ColonyClientV16`](ColonyClientV16.md)\> + +#### Inherited from + +AugmentedIColony.on + +___ + +### once + +• **once**: `OnEvent`<[`ColonyClientV16`](ColonyClientV16.md)\> + +#### Inherited from + +AugmentedIColony.once + +___ + +### provider + +• `Readonly` **provider**: `Provider` + +#### Inherited from + +AugmentedIColony.provider + +___ + +### removeListener + +• **removeListener**: `OnEvent`<[`ColonyClientV16`](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_parentDomainId` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_parentDomainId` | `BigNumberish` | +| `_metadata` | `string` | +| `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)](ColonyClientV16.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)](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.addLocalSkill + +___ + +### addLocalSkill() + +▸ **addLocalSkill()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.addLocalSkill() + +___ + +### annotateTransaction + +▸ **annotateTransaction**(`_txHash`, `_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_txHash` | `BytesLike` | +| `_metadata` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.annotateTransaction + +___ + +### annotateTransaction(bytes32,string) + +▸ **annotateTransaction(bytes32,string)**(`_txHash`, `_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_txHash` | `BytesLike` | +| `_metadata` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.annotateTransaction(bytes32,string) + +___ + +### approveExitRecovery + +▸ **approveExitRecovery**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.approveExitRecovery + +___ + +### approveExitRecovery() + +▸ **approveExitRecovery()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.approveExitRecovery() + +___ + +### approveStake + +▸ **approveStake**(`_approvee`, `_domainId`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_approvee` | `string` | +| `_domainId` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_approvee` | `string` | +| `_domainId` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.approveStake(address,uint256,uint256) + +___ + +### attach + +▸ **attach**(`addressOrName`): [`ColonyClientV16`](ColonyClientV16.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `addressOrName` | `string` | + +#### Returns + +[`ColonyClientV16`](ColonyClientV16.md) + +#### Inherited from + +AugmentedIColony.attach + +___ + +### authority + +▸ **authority**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.authority + +___ + +### authority() + +▸ **authority()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.authority() + +___ + +### bootstrapColony + +▸ **bootstrapColony**(`_users`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_users` | `string`[] | +| `_amount` | `BigNumberish`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.bootstrapColony + +___ + +### bootstrapColony(address[],int256[]) + +▸ **bootstrapColony(address[],int256[])**(`_users`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_users` | `string`[] | +| `_amount` | `BigNumberish`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.bootstrapColony(address[],int256[]) + +___ + +### burnTokens + +▸ **burnTokens**(`token`, `amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `amount` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.burnTokens + +___ + +### burnTokens(address,uint256) + +▸ **burnTokens(address,uint256)**(`token`, `amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `amount` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.burnTokens(address,uint256) + +___ + +### cancelExpenditure + +▸ **cancelExpenditure**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.cancelExpenditure + +___ + +### cancelExpenditure(uint256) + +▸ **cancelExpenditure(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.cancelExpenditure(uint256) + +___ + +### cancelExpenditureViaArbitration + +▸ **cancelExpenditureViaArbitration**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.cancelExpenditureViaArbitration + +___ + +### cancelExpenditureViaArbitration(uint256,uint256,uint256) + +▸ **cancelExpenditureViaArbitration(uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.cancelExpenditureViaArbitration(uint256,uint256,uint256) + +___ + +### checkNotAdditionalProtectedVariable + +▸ **checkNotAdditionalProtectedVariable**(`_slot`, `overrides?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_slot` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +AugmentedIColony.checkNotAdditionalProtectedVariable + +___ + +### checkNotAdditionalProtectedVariable(uint256) + +▸ **checkNotAdditionalProtectedVariable(uint256)**(`_slot`, `overrides?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_slot` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +AugmentedIColony.checkNotAdditionalProtectedVariable(uint256) + +___ + +### claimColonyFunds + +▸ **claimColonyFunds**(`_token`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_token` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.claimColonyFunds + +___ + +### claimColonyFunds(address) + +▸ **claimColonyFunds(address)**(`_token`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_token` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.claimColonyFunds(address) + +___ + +### claimExpenditurePayout + +▸ **claimExpenditurePayout**(`_id`, `_slot`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_token` | `string` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_token` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.claimExpenditurePayout(uint256,uint256,address) + +___ + +### claimRewardPayout + +▸ **claimRewardPayout**(`_payoutId`, `_squareRoots`, `key`, `value`, `branchMask`, `siblings`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_payoutId` | `BigNumberish` | +| `_squareRoots` | `BigNumberish`[] | +| `key` | `BytesLike` | +| `value` | `BytesLike` | +| `branchMask` | `BigNumberish` | +| `siblings` | `BytesLike`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_payoutId` | `BigNumberish` | +| `_squareRoots` | `BigNumberish`[] | +| `key` | `BytesLike` | +| `value` | `BytesLike` | +| `branchMask` | `BigNumberish` | +| `siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.claimRewardPayout(uint256,uint256[7],bytes,bytes,uint256,bytes32[]) + +___ + +### connect + +▸ **connect**(`signerOrProvider`): [`ColonyClientV16`](ColonyClientV16.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerOrProvider` | `string` \| `Signer` \| `Provider` | + +#### Returns + +[`ColonyClientV16`](ColonyClientV16.md) + +#### Inherited from + +AugmentedIColony.connect + +___ + +### deobligateStake + +▸ **deobligateStake**(`_user`, `_domainId`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.deobligateStake(address,uint256,uint256) + +___ + +### deployed + +▸ **deployed**(): `Promise`<[`ColonyClientV16`](ColonyClientV16.md)\> + +#### Returns + +`Promise`<[`ColonyClientV16`](ColonyClientV16.md)\> + +#### Inherited from + +AugmentedIColony.deployed + +___ + +### deprecateDomain + +▸ **deprecateDomain**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_deprecated` | `boolean` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_deprecated` | `boolean` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extensionId` | `BytesLike` | +| `deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.deprecateExtension + +___ + +### deprecateExtension(bytes32,bool) + +▸ **deprecateExtension(bytes32,bool)**(`extensionId`, `deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extensionId` | `BytesLike` | +| `deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.deprecateExtension(bytes32,bool) + +___ + +### deprecateLocalSkill + +▸ **deprecateLocalSkill**(`localSkillId`, `deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localSkillId` | `BigNumberish` | +| `deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.deprecateLocalSkill + +___ + +### deprecateLocalSkill(uint256,bool) + +▸ **deprecateLocalSkill(uint256,bool)**(`localSkillId`, `deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localSkillId` | `BigNumberish` | +| `deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.deprecateLocalSkill(uint256,bool) + +___ + +### editColony + +▸ **editColony**(`_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_metadata` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.editColony + +___ + +### editColony(string) + +▸ **editColony(string)**(`_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_metadata` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.editColony(string) + +___ + +### editColonyByDelta + +▸ **editColonyByDelta**(`_metadataDelta`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_metadataDelta` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.editColonyByDelta + +___ + +### editColonyByDelta(string) + +▸ **editColonyByDelta(string)**(`_metadataDelta`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_metadataDelta` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.editColonyByDelta(string) + +___ + +### editDomain + +▸ **editDomain**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `_metadata`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_metadata` | `string` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_metadata` | `string` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_user` | `string` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_user` | `string` | +| `_amount` | `BigNumberish` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_domainId` | `BigNumberish` | +| `_user` | `string` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_domainId` | `BigNumberish` | +| `_user` | `string` | +| `_amount` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.emitDomainReputationReward(uint256,address,int256) + +___ + +### emitSkillReputationPenalty + +▸ **emitSkillReputationPenalty**(`_skillId`, `_user`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_skillId` | `BigNumberish` | +| `_user` | `string` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_skillId` | `BigNumberish` | +| `_user` | `string` | +| `_amount` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.emitSkillReputationPenalty(uint256,address,int256) + +___ + +### emitSkillReputationReward + +▸ **emitSkillReputationReward**(`_skillId`, `_user`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_skillId` | `BigNumberish` | +| `_user` | `string` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_skillId` | `BigNumberish` | +| `_user` | `string` | +| `_amount` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.emitSkillReputationReward(uint256,address,int256) + +___ + +### enterRecoveryMode + +▸ **enterRecoveryMode**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.enterRecoveryMode + +___ + +### enterRecoveryMode() + +▸ **enterRecoveryMode()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.enterRecoveryMode() + +___ + +### executeMetaTransaction + +▸ **executeMetaTransaction**(`userAddress`, `payload`, `sigR`, `sigS`, `sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userAddress` | `string` | +| `payload` | `BytesLike` | +| `sigR` | `BytesLike` | +| `sigS` | `BytesLike` | +| `sigV` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userAddress` | `string` | +| `payload` | `BytesLike` | +| `sigR` | `BytesLike` | +| `sigS` | `BytesLike` | +| `sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +___ + +### exitRecoveryMode + +▸ **exitRecoveryMode**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.exitRecoveryMode + +___ + +### exitRecoveryMode() + +▸ **exitRecoveryMode()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### 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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finalizeExpenditure + +___ + +### finalizeExpenditure(uint256) + +▸ **finalizeExpenditure(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finalizeExpenditure(uint256) + +___ + +### finalizeExpenditureViaArbitration + +▸ **finalizeExpenditureViaArbitration**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finalizeExpenditureViaArbitration + +___ + +### finalizeExpenditureViaArbitration(uint256,uint256,uint256) + +▸ **finalizeExpenditureViaArbitration(uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finalizeExpenditureViaArbitration(uint256,uint256,uint256) + +___ + +### finalizePaymentWithProofs + +▸ **finalizePaymentWithProofs**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as finalizePayment, but let colonyJS figure out the permission proofs for you. +Always prefer this method, except when you have good reason not to. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `_id` | `BigNumberish` | Payment identifier | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finalizePaymentWithProofs + +___ + +### finalizeRewardPayout + +▸ **finalizeRewardPayout**(`_payoutId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_payoutId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finalizeRewardPayout + +___ + +### finalizeRewardPayout(uint256) + +▸ **finalizeRewardPayout(uint256)**(`_payoutId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_payoutId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finalizeRewardPayout(uint256) + +___ + +### finishUpgrade + +▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finishUpgrade + +___ + +### finishUpgrade() + +▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.finishUpgrade() + +___ + +### getApproval + +▸ **getApproval**(`_user`, `_obligator`, `_domainId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_obligator` | `string` | +| `_domainId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getApproval + +___ + +### getApproval(address,address,uint256) + +▸ **getApproval(address,address,uint256)**(`_user`, `_obligator`, `_domainId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_obligator` | `string` | +| `_domainId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getApproval(address,address,uint256) + +___ + +### getCapabilityRoles + +▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getCapabilityRoles + +___ + +### getCapabilityRoles(bytes4) + +▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getCapabilityRoles(bytes4) + +___ + +### getColonyNetwork + +▸ **getColonyNetwork**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getColonyNetwork + +___ + +### getColonyNetwork() + +▸ **getColonyNetwork()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getColonyNetwork() + +___ + +### getDomain + +▸ **getDomain**(`_id`, `overrides?`): `Promise`<`DomainStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`DomainStructOutput`\> + +#### Inherited from + +AugmentedIColony.getDomain + +___ + +### getDomain(uint256) + +▸ **getDomain(uint256)**(`_id`, `overrides?`): `Promise`<`DomainStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`DomainStructOutput`\> + +#### Inherited from + +AugmentedIColony.getDomain(uint256) + +___ + +### getDomainCount + +▸ **getDomainCount**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getDomainCount + +___ + +### getDomainCount() + +▸ **getDomainCount()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getDomainCount() + +___ + +### getDomainFromFundingPot + +▸ **getDomainFromFundingPot**(`_fundingPotId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_fundingPotId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getDomainFromFundingPot + +___ + +### getDomainFromFundingPot(uint256) + +▸ **getDomainFromFundingPot(uint256)**(`_fundingPotId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_fundingPotId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getDomainFromFundingPot(uint256) + +___ + +### getExpenditure + +▸ **getExpenditure**(`_id`, `overrides?`): `Promise`<`ExpenditureStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`ExpenditureStructOutput`\> + +#### Inherited from + +AugmentedIColony.getExpenditure + +___ + +### getExpenditure(uint256) + +▸ **getExpenditure(uint256)**(`_id`, `overrides?`): `Promise`<`ExpenditureStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`ExpenditureStructOutput`\> + +#### Inherited from + +AugmentedIColony.getExpenditure(uint256) + +___ + +### getExpenditureCount + +▸ **getExpenditureCount**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getExpenditureCount + +___ + +### getExpenditureCount() + +▸ **getExpenditureCount()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getExpenditureCount() + +___ + +### getExpenditureSlot + +▸ **getExpenditureSlot**(`_id`, `_slot`, `overrides?`): `Promise`<`ExpenditureSlotStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`ExpenditureSlotStructOutput`\> + +#### Inherited from + +AugmentedIColony.getExpenditureSlot + +___ + +### getExpenditureSlot(uint256,uint256) + +▸ **getExpenditureSlot(uint256,uint256)**(`_id`, `_slot`, `overrides?`): `Promise`<`ExpenditureSlotStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`ExpenditureSlotStructOutput`\> + +#### Inherited from + +AugmentedIColony.getExpenditureSlot(uint256,uint256) + +___ + +### getExpenditureSlotPayout + +▸ **getExpenditureSlotPayout**(`_id`, `_slot`, `_token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_token` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getExpenditureSlotPayout + +___ + +### getExpenditureSlotPayout(uint256,uint256,address) + +▸ **getExpenditureSlotPayout(uint256,uint256,address)**(`_id`, `_slot`, `_token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_token` | `string` | +| `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` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `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` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_potId` | `BigNumberish` | +| `_token` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getFundingPotBalance + +___ + +### getFundingPotBalance(uint256,address) + +▸ **getFundingPotBalance(uint256,address)**(`_potId`, `_token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_potId` | `BigNumberish` | +| `_token` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getFundingPotBalance(uint256,address) + +___ + +### getFundingPotCount + +▸ **getFundingPotCount**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getFundingPotCount + +___ + +### getFundingPotCount() + +▸ **getFundingPotCount()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getFundingPotCount() + +___ + +### getFundingPotPayout + +▸ **getFundingPotPayout**(`_potId`, `_token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_potId` | `BigNumberish` | +| `_token` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getFundingPotPayout + +___ + +### getFundingPotPayout(uint256,address) + +▸ **getFundingPotPayout(uint256,address)**(`_potId`, `_token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_potId` | `BigNumberish` | +| `_token` | `string` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userAddress` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getMetatransactionNonce + +___ + +### getMetatransactionNonce(address) + +▸ **getMetatransactionNonce(address)**(`userAddress`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userAddress` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getMetatransactionNonce(address) + +___ + +### getNonRewardPotsTotal + +▸ **getNonRewardPotsTotal**(`_token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_token` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getNonRewardPotsTotal + +___ + +### getNonRewardPotsTotal(address) + +▸ **getNonRewardPotsTotal(address)**(`_token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_token` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getNonRewardPotsTotal(address) + +___ + +### getObligation + +▸ **getObligation**(`_user`, `_obligator`, `_domainId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_obligator` | `string` | +| `_domainId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getObligation + +___ + +### getObligation(address,address,uint256) + +▸ **getObligation(address,address,uint256)**(`_user`, `_obligator`, `_domainId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_obligator` | `string` | +| `_domainId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getObligation(address,address,uint256) + +___ + +### getPayment + +▸ **getPayment**(`_id`, `overrides?`): `Promise`<`PaymentStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`PaymentStructOutput`\> + +#### Inherited from + +AugmentedIColony.getPayment + +___ + +### getPayment(uint256) + +▸ **getPayment(uint256)**(`_id`, `overrides?`): `Promise`<`PaymentStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`PaymentStructOutput`\> + +#### Inherited from + +AugmentedIColony.getPayment(uint256) + +___ + +### getPaymentCount + +▸ **getPaymentCount**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getPaymentCount + +___ + +### getPaymentCount() + +▸ **getPaymentCount()**(`overrides?`): `Promise`<`BigNumber`\> + +#### 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](ColonyClientV16.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](ColonyClientV16.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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getRewardInverse + +___ + +### getRewardInverse() + +▸ **getRewardInverse()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getRewardInverse() + +___ + +### getRewardPayoutInfo + +▸ **getRewardPayoutInfo**(`_payoutId`, `overrides?`): `Promise`<`RewardPayoutCycleStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_payoutId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`RewardPayoutCycleStructOutput`\> + +#### Inherited from + +AugmentedIColony.getRewardPayoutInfo + +___ + +### getRewardPayoutInfo(uint256) + +▸ **getRewardPayoutInfo(uint256)**(`_payoutId`, `overrides?`): `Promise`<`RewardPayoutCycleStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_payoutId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`RewardPayoutCycleStructOutput`\> + +#### Inherited from + +AugmentedIColony.getRewardPayoutInfo(uint256) + +___ + +### getRootLocalSkill + +▸ **getRootLocalSkill**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getRootLocalSkill + +___ + +### getRootLocalSkill() + +▸ **getRootLocalSkill()**(`overrides?`): `Promise`<`BigNumber`\> + +#### 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` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `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` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getTaskChangeNonce + +___ + +### getTaskChangeNonce(uint256) + +▸ **getTaskChangeNonce(uint256)**(`_id`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getTaskChangeNonce(uint256) + +___ + +### getTaskCount + +▸ **getTaskCount**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getTaskCount + +___ + +### getTaskCount() + +▸ **getTaskCount()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getTaskCount() + +___ + +### getTaskRole + +▸ **getTaskRole**(`_id`, `_role`, `overrides?`): `Promise`<`RoleStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`RoleStructOutput`\> + +#### Inherited from + +AugmentedIColony.getTaskRole + +___ + +### getTaskRole(uint256,uint8) + +▸ **getTaskRole(uint256,uint8)**(`_id`, `_role`, `overrides?`): `Promise`<`RoleStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`RoleStructOutput`\> + +#### Inherited from + +AugmentedIColony.getTaskRole(uint256,uint8) + +___ + +### getTaskWorkRatingSecret + +▸ **getTaskWorkRatingSecret**(`_id`, `_role`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getTaskWorkRatingSecret + +___ + +### getTaskWorkRatingSecret(uint256,uint8) + +▸ **getTaskWorkRatingSecret(uint256,uint8)**(`_id`, `_role`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getTaskWorkRatingSecret(uint256,uint8) + +___ + +### getTaskWorkRatingSecretsInfo + +▸ **getTaskWorkRatingSecretsInfo**(`_id`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`] & { `lastSubmittedAt`: `BigNumber` ; `nSecrets`: `BigNumber` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `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` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<[`BigNumber`, `BigNumber`] & { `lastSubmittedAt`: `BigNumber` ; `nSecrets`: `BigNumber` }\> + +#### Inherited from + +AugmentedIColony.getTaskWorkRatingSecretsInfo(uint256) + +___ + +### getToken + +▸ **getToken**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getToken + +___ + +### getToken() + +▸ **getToken()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getToken() + +___ + +### getTokenApproval + +▸ **getTokenApproval**(`token`, `spender`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `spender` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getTokenApproval + +___ + +### getTokenApproval(address,address) + +▸ **getTokenApproval(address,address)**(`token`, `spender`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `spender` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getTokenApproval(address,address) + +___ + +### getTotalTokenApproval + +▸ **getTotalTokenApproval**(`token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getTotalTokenApproval + +___ + +### getTotalTokenApproval(address) + +▸ **getTotalTokenApproval(address)**(`token`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.getTotalTokenApproval(address) + +___ + +### getUserRoles + +▸ **getUserRoles**(`_user`, `_domain`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domain` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getUserRoles + +___ + +### getUserRoles(address,uint256) + +▸ **getUserRoles(address,uint256)**(`_user`, `_domain`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domain` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.getUserRoles(address,uint256) + +___ + +### hasInheritedUserRole + +▸ **hasInheritedUserRole**(`_user`, `_domainId`, `_role`, `_childSkillIndex`, `_childDomainId`, `overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_childDomainId` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_childDomainId` | `BigNumberish` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedIColony.hasUserRole + +___ + +### hasUserRole(address,uint256,uint8) + +▸ **hasUserRole(address,uint256,uint8)**(`_user`, `_domainId`, `_role`, `overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedIColony.hasUserRole(address,uint256,uint8) + +___ + +### initialiseColony + +▸ **initialiseColony**(`_colonyNetworkAddress`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_colonyNetworkAddress` | `string` | +| `_token` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.initialiseColony + +___ + +### initialiseColony(address,address) + +▸ **initialiseColony(address,address)**(`_colonyNetworkAddress`, `_token`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_colonyNetworkAddress` | `string` | +| `_token` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.initialiseColony(address,address) + +___ + +### initialiseRootLocalSkill + +▸ **initialiseRootLocalSkill**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.initialiseRootLocalSkill + +___ + +### initialiseRootLocalSkill() + +▸ **initialiseRootLocalSkill()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.initialiseRootLocalSkill() + +___ + +### installExtension + +▸ **installExtension**(`extensionId`, `version`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extensionId` | `BytesLike` | +| `version` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.installExtension + +___ + +### installExtension(bytes32,uint256) + +▸ **installExtension(bytes32,uint256)**(`extensionId`, `version`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extensionId` | `BytesLike` | +| `version` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.installExtension(bytes32,uint256) + +___ + +### installExtensionChecked + +▸ **installExtensionChecked**(`extension`, `version?`, `overrides?`): `Promise`<`ContractTransaction`\> + +Similar to [installExtension](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedIColony.isInRecoveryMode + +___ + +### isInRecoveryMode() + +▸ **isInRecoveryMode()**(`overrides?`): `Promise`<`boolean`\> + +#### 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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.lockExpenditure + +___ + +### lockExpenditure(uint256) + +▸ **lockExpenditure(uint256)**(`_id`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.lockExpenditure(uint256) + +___ + +### lockToken + +▸ **lockToken**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.lockToken + +___ + +### lockToken() + +▸ **lockToken()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.lockToken() + +___ + +### makeArbitraryTransaction + +▸ **makeArbitraryTransaction**(`_to`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_to` | `string` | +| `_action` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.makeArbitraryTransaction + +___ + +### makeArbitraryTransaction(address,bytes) + +▸ **makeArbitraryTransaction(address,bytes)**(`_to`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_to` | `string` | +| `_action` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.makeArbitraryTransaction(address,bytes) + +___ + +### makeArbitraryTransactions + +▸ **makeArbitraryTransactions**(`_targets`, `_actions`, `_strict`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_targets` | `string`[] | +| `_actions` | `BytesLike`[] | +| `_strict` | `boolean` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_targets` | `string`[] | +| `_actions` | `BytesLike`[] | +| `_strict` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.makeArbitraryTransactions(address[],bytes[],bool) + +___ + +### makeExpenditure + +▸ **makeExpenditure**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.makeExpenditure(uint256,uint256,uint256) + +___ + +### makeExpenditureWithProofs + +▸ **makeExpenditureWithProofs**(`_domainId`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as [makeExpenditure](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_target` | `string` | +| `_action` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.makeSingleArbitraryTransaction + +___ + +### makeSingleArbitraryTransaction(address,bytes) + +▸ **makeSingleArbitraryTransaction(address,bytes)**(`_target`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_target` | `string` | +| `_action` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.makeSingleArbitraryTransaction(address,bytes) + +___ + +### makeTaskWithProofs + +▸ **makeTaskWithProofs**(`_specificationHash`, `_domainId`, `_skillId`, `_dueDate`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as makeTask, but let colonyJS figure out the permission proofs for you. +Always prefer this method, except when you have good reason not to. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `_specificationHash` | `BytesLike` | Database identifier where the task specification is stored | +| `_domainId` | `BigNumberish` | The domain where the task belongs | +| `_skillId` | `BigNumberish` | The skill associated with the task, can set to `0` for no-op | +| `_dueDate` | `BigNumberish` | The due date of the task, can set to `0` for no-op | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.makeTaskWithProofs + +___ + +### mintTokens + +▸ **mintTokens**(`_wad`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_wad` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.mintTokens + +___ + +### mintTokens(uint256) + +▸ **mintTokens(uint256)**(`_wad`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_wad` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.mintTokens(uint256) + +___ + +### mintTokensFor + +▸ **mintTokensFor**(`_guy`, `_wad`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_guy` | `string` | +| `_wad` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.mintTokensFor + +___ + +### mintTokensFor(address,uint256) + +▸ **mintTokensFor(address,uint256)**(`_guy`, `_wad`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_guy` | `string` | +| `_wad` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_fromChildSkillIndex` | `BigNumberish` | +| `_toChildSkillIndex` | `BigNumberish` | +| `_fromPot` | `BigNumberish` | +| `_toPot` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `_token` | `string` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_fromChildSkillIndex` | `BigNumberish` | +| `_toChildSkillIndex` | `BigNumberish` | +| `_fromPot` | `BigNumberish` | +| `_toPot` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `_token` | `string` | +| `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)](ColonyClientV16.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)](ColonyClientV16.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) + +___ + +### multicall + +▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.multicall + +___ + +### multicall(bytes[]) + +▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.multicall(bytes[]) + +___ + +### numRecoveryRoles + +▸ **numRecoveryRoles**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.numRecoveryRoles + +___ + +### numRecoveryRoles() + +▸ **numRecoveryRoles()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.numRecoveryRoles() + +___ + +### obligateStake + +▸ **obligateStake**(`_user`, `_domainId`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.obligateStake(address,uint256,uint256) + +___ + +### owner + +▸ **owner**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedIColony.owner + +___ + +### owner() + +▸ **owner()**(`overrides?`): `Promise`<`string`\> + +#### 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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `colonyName` | `string` | +| `orbitdb` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.registerColonyLabel + +___ + +### registerColonyLabel(string,string) + +▸ **registerColonyLabel(string,string)**(`colonyName`, `orbitdb`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `colonyName` | `string` | +| `orbitdb` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.registerColonyLabel(string,string) + +___ + +### removeAllListeners + +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`ColonyClientV16`](ColonyClientV16.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TEvent` | extends `TypedEvent`<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFilter` | `TypedEventFilter`<`TEvent`\> | + +#### Returns + +[`ColonyClientV16`](ColonyClientV16.md) + +#### Inherited from + +AugmentedIColony.removeAllListeners + +▸ **removeAllListeners**(`eventName?`): [`ColonyClientV16`](ColonyClientV16.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +[`ColonyClientV16`](ColonyClientV16.md) + +#### Inherited from + +AugmentedIColony.removeAllListeners + +___ + +### removeRecoveryRole + +▸ **removeRecoveryRole**(`_user`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.removeRecoveryRole + +___ + +### removeRecoveryRole(address) + +▸ **removeRecoveryRole(address)**(`_user`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.removeRecoveryRole(address) + +___ + +### setAdministrationRole + +▸ **setAdministrationRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_setTo` | `boolean` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_setTo` | `boolean` | +| `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](ColonyClientV16.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 + +___ + +### setArbitrationRole + +▸ **setArbitrationRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_setTo` | `boolean` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_setTo` | `boolean` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_setTo` | `boolean` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_setTo` | `boolean` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_globalClaimDelay` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setDefaultGlobalClaimDelay + +___ + +### setDefaultGlobalClaimDelay(uint256) + +▸ **setDefaultGlobalClaimDelay(uint256)**(`_globalClaimDelay`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_globalClaimDelay` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setDefaultGlobalClaimDelay(uint256) + +___ + +### setExpenditureClaimDelay + +▸ **setExpenditureClaimDelay**(`_id`, `_slot`, `_claimDelay`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_claimDelay` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_claimDelay` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setExpenditureClaimDelay(uint256,uint256,uint256) + +___ + +### setExpenditureClaimDelays + +▸ **setExpenditureClaimDelays**(`_id`, `_slots`, `_claimDelays`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_claimDelays` | `BigNumberish`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_claimDelays` | `BigNumberish`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_metadata` | `string` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `_metadata` | `string` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_token` | `string` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_token` | `string` | +| `_amount` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_payoutModifiers` | `BigNumberish`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_payoutModifiers` | `BigNumberish`[] | +| `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)](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_token` | `string` | +| `_amounts` | `BigNumberish`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_token` | `string` | +| `_amounts` | `BigNumberish`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setExpenditurePayouts(uint256,uint256[],address,uint256[]) + +___ + +### setExpenditureRecipient + +▸ **setExpenditureRecipient**(`_id`, `_slot`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_recipient` | `string` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_recipient` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setExpenditureRecipient(uint256,uint256,address) + +___ + +### setExpenditureRecipients + +▸ **setExpenditureRecipients**(`_id`, `_slots`, `_recipients`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_recipients` | `string`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_recipients` | `string`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setExpenditureRecipients(uint256,uint256[],address[]) + +___ + +### setExpenditureSkill + +▸ **setExpenditureSkill**(`_id`, `_slot`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_skillId` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_skillId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setExpenditureSkill(uint256,uint256,uint256) + +___ + +### setExpenditureSkills + +▸ **setExpenditureSkills**(`_id`, `_slots`, `_skillIds`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_skillIds` | `BigNumberish`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_slots` | `BigNumberish`[] | +| `_skillIds` | `BigNumberish`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `_storageSlot` | `BigNumberish` | +| `_mask` | `boolean`[] | +| `_keys` | `BytesLike`[] | +| `_value` | `BytesLike` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `_storageSlot` | `BigNumberish` | +| `_mask` | `boolean`[] | +| `_keys` | `BytesLike`[] | +| `_value` | `BytesLike` | +| `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](ColonyClientV16.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 + +___ + +### setFundingRole + +▸ **setFundingRole**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_setTo` | `boolean` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_setTo` | `boolean` | +| `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](ColonyClientV16.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 + +___ + +### setPaymentPayoutWithProofs + +▸ **setPaymentPayoutWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as setPaymentPayout, but let colonyJS figure out the permission proofs for you. +Always prefer this method, except when you have good reason not to. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `_id` | `BigNumberish` | Payment identifier | +| `_token` | `BigNumberish` | Address of the token, `0x0` value indicates Ether | +| `_amount` | `BigNumberish` | Payout amount | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setPaymentPayoutWithProofs + +___ + +### setPaymentRecipientWithProofs + +▸ **setPaymentRecipientWithProofs**(`_id`, `_recipient`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as setPaymentRecipient, but let colonyJS figure out the permission proofs for you. +Always prefer this method, except when you have good reason not to. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `_id` | `BigNumberish` | Payment identifier | +| `_recipient` | `string` | Address of the payment recipient | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setPaymentRecipientWithProofs + +___ + +### setPaymentSkillWithProofs + +▸ **setPaymentSkillWithProofs**(`_id`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as setPaymentSkill, but let colonyJS figure out the permission proofs for you. +Always prefer this method, except when you have good reason not to. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `_id` | `BigNumberish` | Payment identifier | +| `_skillId` | `BigNumberish` | Id of the new skill to set | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setPaymentSkillWithProofs + +___ + +### setRecoveryRole + +▸ **setRecoveryRole**(`_user`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setRecoveryRole + +___ + +### setRecoveryRole(address) + +▸ **setRecoveryRole(address)**(`_user`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setRecoveryRole(address) + +___ + +### setRewardInverse + +▸ **setRewardInverse**(`_rewardInverse`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_rewardInverse` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setRewardInverse + +___ + +### setRewardInverse(uint256) + +▸ **setRewardInverse(uint256)**(`_rewardInverse`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_rewardInverse` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setRewardInverse(uint256) + +___ + +### setRootRole + +▸ **setRootRole**(`_user`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_setTo` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setRootRole + +___ + +### setRootRole(address,bool) + +▸ **setRootRole(address,bool)**(`_user`, `_setTo`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_setTo` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setRootRole(address,bool) + +___ + +### setStorageSlotRecovery + +▸ **setStorageSlotRecovery**(`_slot`, `_value`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_slot` | `BigNumberish` | +| `_value` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setStorageSlotRecovery + +___ + +### setStorageSlotRecovery(uint256,bytes32) + +▸ **setStorageSlotRecovery(uint256,bytes32)**(`_slot`, `_value`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_slot` | `BigNumberish` | +| `_value` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.setStorageSlotRecovery(uint256,bytes32) + +___ + +### setUserRoles + +▸ **setUserRoles**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_roles`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_roles` | `BytesLike` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_roles` | `BytesLike` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_token` | `string` | +| `key` | `BytesLike` | +| `value` | `BytesLike` | +| `branchMask` | `BigNumberish` | +| `siblings` | `BytesLike`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_token` | `string` | +| `key` | `BytesLike` | +| `value` | `BytesLike` | +| `branchMask` | `BigNumberish` | +| `siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.startNextRewardPayout(address,bytes,bytes,uint256,bytes32[]) + +___ + +### transferExpenditure + +▸ **transferExpenditure**(`_id`, `_newOwner`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_newOwner` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.transferExpenditure + +___ + +### transferExpenditure(uint256,address) + +▸ **transferExpenditure(uint256,address)**(`_id`, `_newOwner`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `_newOwner` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.transferExpenditure(uint256,address) + +___ + +### transferExpenditureViaArbitration + +▸ **transferExpenditureViaArbitration**(`_permissionDomainId`, `_childSkillIndex`, `_id`, `_newOwner`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `_newOwner` | `string` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_id` | `BigNumberish` | +| `_newOwner` | `string` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_obligator` | `string` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `_recipient` | `string` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_obligator` | `string` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `_recipient` | `string` | +| `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](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extensionId` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.uninstallExtension + +___ + +### uninstallExtension(bytes32) + +▸ **uninstallExtension(bytes32)**(`extensionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extensionId` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.uninstallExtension(bytes32) + +___ + +### unlockToken + +▸ **unlockToken**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.unlockToken + +___ + +### unlockToken() + +▸ **unlockToken()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.unlockToken() + +___ + +### unlockTokenForUser + +▸ **unlockTokenForUser**(`user`, `lockId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `user` | `string` | +| `lockId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.unlockTokenForUser + +___ + +### unlockTokenForUser(address,uint256) + +▸ **unlockTokenForUser(address,uint256)**(`user`, `lockId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `user` | `string` | +| `lockId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.unlockTokenForUser(address,uint256) + +___ + +### updateApprovalAmount + +▸ **updateApprovalAmount**(`token`, `spender`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `spender` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.updateApprovalAmount + +___ + +### updateApprovalAmount(address,address) + +▸ **updateApprovalAmount(address,address)**(`token`, `spender`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `spender` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.updateApprovalAmount(address,address) + +___ + +### updateColonyOrbitDB + +▸ **updateColonyOrbitDB**(`orbitdb`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orbitdb` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.updateColonyOrbitDB + +___ + +### updateColonyOrbitDB(string) + +▸ **updateColonyOrbitDB(string)**(`orbitdb`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orbitdb` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.updateColonyOrbitDB(string) + +___ + +### upgrade + +▸ **upgrade**(`_newVersion`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_newVersion` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.upgrade + +___ + +### upgrade(uint256) + +▸ **upgrade(uint256)**(`_newVersion`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_newVersion` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.upgrade(uint256) + +___ + +### upgradeExtension + +▸ **upgradeExtension**(`extensionId`, `newVersion`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extensionId` | `BytesLike` | +| `newVersion` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.upgradeExtension + +___ + +### upgradeExtension(bytes32,uint256) + +▸ **upgradeExtension(bytes32,uint256)**(`extensionId`, `newVersion`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extensionId` | `BytesLike` | +| `newVersion` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedIColony.upgradeExtension(bytes32,uint256) + +___ + +### upgradeExtensionChecked + +▸ **upgradeExtensionChecked**(`extension`, `newVersion?`, `overrides?`): `Promise`<`ContractTransaction`\> + +Similar to [upgradeExtension](ColonyClientV16.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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_childDomainId` | `BigNumberish` | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_childDomainId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `BytesLike` | +| `value` | `BytesLike` | +| `branchMask` | `BigNumberish` | +| `siblings` | `BytesLike`[] | +| `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`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `BytesLike` | +| `value` | `BytesLike` | +| `branchMask` | `BigNumberish` | +| `siblings` | `BytesLike`[] | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedIColony.verifyReputationProof(bytes,bytes,uint256,bytes32[]) + +___ + +### version + +▸ **version**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.version + +___ + +### version() + +▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedIColony.version() diff --git a/packages/colony-js/docs/api/interfaces/MultisigPermissionsClientV1.md b/packages/colony-js/docs/api/interfaces/MultisigPermissionsClientV1.md new file mode 100644 index 000000000..2e1d3a8bd --- /dev/null +++ b/packages/colony-js/docs/api/interfaces/MultisigPermissionsClientV1.md @@ -0,0 +1,2408 @@ +# Interface: MultisigPermissionsClientV1 + +## Hierarchy + +- `AugmentedMultisigPermissions`<`MultisigPermissions`\> + + ↳ **`MultisigPermissionsClientV1`** + +## Properties + +### \_deployedPromise + +• **\_deployedPromise**: `Promise`<`Contract`\> + +#### Inherited from + +AugmentedMultisigPermissions.\_deployedPromise + +___ + +### \_runningEvents + +• **\_runningEvents**: `Object` + +#### Index signature + +▪ [eventTag: `string`]: `RunningEvent` + +#### Inherited from + +AugmentedMultisigPermissions.\_runningEvents + +___ + +### \_wrappedEmits + +• **\_wrappedEmits**: `Object` + +#### Index signature + +▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` + +#### Inherited from + +AugmentedMultisigPermissions.\_wrappedEmits + +___ + +### address + +• `Readonly` **address**: `string` + +#### Inherited from + +AugmentedMultisigPermissions.address + +___ + +### callStatic + +• **callStatic**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `cancel` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `cancel(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `changeVote` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `changeVote(uint256,uint256,uint256,uint8)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `createMotion` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `createMotion(uint256,uint256,address[],bytes[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `execute` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `execute(uint256)` | (`_motionId`: `BigNumberish`, `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`\> | +| `executeWithoutFailure` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `executeWithoutFailure(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `finishUpgrade` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `finishUpgrade()` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | +| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | +| `getDomainSkillRoleCounts` | (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getDomainSkillRoleCounts(uint256,uint8)` | (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getDomainSkillThreshold` | (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getDomainSkillThreshold(uint256)` | (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getGlobalThreshold` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getGlobalThreshold()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMotion` | (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`MotionStructOutput`\> | +| `getMotion(uint256)` | (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`MotionStructOutput`\> | +| `getMotionCount` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMotionCount()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMotionRoleVoteCount` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMotionRoleVoteCount(uint256,uint8,uint8)` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMotionVoteThreshold` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMotionVoteThreshold(uint256,uint8)` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getSingleActionSummary` | (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`ActionSummaryStructOutput`\> | +| `getSingleActionSummary(address,address,bytes,address)` | (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`ActionSummaryStructOutput`\> | +| `getUserRoles` | (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `getUserRoles(address,uint256)` | (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `getUserVote` | (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | +| `getUserVote(uint256,address,uint8,uint8)` | (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | +| `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`\> | +| `setDomainSkillThreshold` | (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setDomainSkillThreshold(uint256,uint256)` | (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setGlobalThreshold` | (`_globalThreshold`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setGlobalThreshold(uint256)` | (`_globalThreshold`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setOwner` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setUserRoles` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setUserRoles(uint256,uint256,address,uint256,bytes32)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `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 + +AugmentedMultisigPermissions.callStatic + +___ + +### clientType + +• **clientType**: [`MultisigPermissionsClient`](../enums/ClientType.md#multisigpermissionsclient) + +#### Inherited from + +AugmentedMultisigPermissions.clientType + +___ + +### clientVersion + +• **clientVersion**: ``1`` + +#### Overrides + +AugmentedMultisigPermissions.clientVersion + +___ + +### colonyClient + +• **colonyClient**: `AugmentedIColony`<`ValidColony`\> + +An instance of the corresponding ColonyClient + +#### Inherited from + +AugmentedMultisigPermissions.colonyClient + +___ + +### deployTransaction + +• `Readonly` **deployTransaction**: `TransactionResponse` + +#### Inherited from + +AugmentedMultisigPermissions.deployTransaction + +___ + +### estimateGas + +• **estimateGas**: { `authority`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `authority()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `cancel`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `cancel(uint256)`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `changeVote`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `changeVote(uint256,uint256,uint256,uint8)`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `createMotion`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `createMotion(uint256,uint256,address[],bytes[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `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`\> ; `execute`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `execute(uint256)`: (`_motionId`: `BigNumberish`, `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`\> ; `executeWithoutFailure`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `executeWithoutFailure(uint256)`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `finishUpgrade`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `finishUpgrade()`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `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`\> ; `getDomainSkillRoleCounts`: (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDomainSkillRoleCounts(uint256,uint8)`: (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDomainSkillThreshold`: (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDomainSkillThreshold(uint256)`: (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getGlobalThreshold`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getGlobalThreshold()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMetatransactionNonce`: (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMetatransactionNonce(address)`: (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotion`: (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotion(uint256)`: (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionCount`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionCount()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionRoleVoteCount`: (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionRoleVoteCount(uint256,uint8,uint8)`: (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionVoteThreshold`: (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionVoteThreshold(uint256,uint8)`: (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getSingleActionSummary`: (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getSingleActionSummary(address,address,bytes,address)`: (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getUserRoles`: (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getUserRoles(address,uint256)`: (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getUserVote`: (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getUserVote(uint256,address,uint8,uint8)`: (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `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`\> ; `setDomainSkillThreshold`: (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setDomainSkillThreshold(uint256,uint256)`: (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setGlobalThreshold`: (`_globalThreshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setGlobalThreshold(uint256)`: (`_globalThreshold`: `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`\> ; `setUserRoles`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setUserRoles(uint256,uint256,address,uint256,bytes32)`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `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`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `cancel(uint256)`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `changeVote`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `changeVote(uint256,uint256,uint256,uint8)`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `createMotion`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `createMotion(uint256,uint256,address[],bytes[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `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`\> ; `execute`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `execute(uint256)`: (`_motionId`: `BigNumberish`, `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`\> ; `executeWithoutFailure`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `executeWithoutFailure(uint256)`: (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `finishUpgrade`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `finishUpgrade()`: (`overrides?`: `Overrides` & { `from?`: `string` }) => `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`\> ; `getDomainSkillRoleCounts`: (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDomainSkillRoleCounts(uint256,uint8)`: (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDomainSkillThreshold`: (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getDomainSkillThreshold(uint256)`: (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getGlobalThreshold`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getGlobalThreshold()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMetatransactionNonce`: (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMetatransactionNonce(address)`: (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotion`: (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotion(uint256)`: (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionCount`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionCount()`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionRoleVoteCount`: (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionRoleVoteCount(uint256,uint8,uint8)`: (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionVoteThreshold`: (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getMotionVoteThreshold(uint256,uint8)`: (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getSingleActionSummary`: (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getSingleActionSummary(address,address,bytes,address)`: (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getUserRoles`: (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getUserRoles(address,uint256)`: (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getUserVote`: (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getUserVote(uint256,address,uint8,uint8)`: (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `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`\> ; `setDomainSkillThreshold`: (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setDomainSkillThreshold(uint256,uint256)`: (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setGlobalThreshold`: (`_globalThreshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setGlobalThreshold(uint256)`: (`_globalThreshold`: `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`\> ; `setUserRoles`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setUserRoles(uint256,uint256,address,uint256,bytes32)`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `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`\> } + +#### Inherited from + +AugmentedMultisigPermissions.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` | +| `ApprovalChanged` | (`agent?`: ``null``, `motionId?`: ``null``, `role?`: ``null``, `approval?`: ``null``) => `ApprovalChangedEventFilter` | +| `ApprovalChanged(address,uint256,uint8,bool)` | (`agent?`: ``null``, `motionId?`: ``null``, `role?`: ``null``, `approval?`: ``null``) => `ApprovalChangedEventFilter` | +| `ArbitraryReputationUpdate` | (`agent?`: ``null``, `user?`: ``null``, `skillId?`: ``null``, `amount?`: ``null``) => `ArbitraryReputationUpdateEventFilter` | +| `ArbitraryReputationUpdate(address,address,uint256,int256)` | (`agent?`: ``null``, `user?`: ``null``, `skillId?`: ``null``, `amount?`: ``null``) => `ArbitraryReputationUpdateEventFilter` | +| `ArbitraryTransaction` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => `ArbitraryTransactionEventFilter` | +| `ArbitraryTransaction(address,bytes,bool)` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => `ArbitraryTransactionEventFilter` | +| `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` | +| `DomainSkillThresholdSet` | (`domainSkillId?`: ``null``, `threshold?`: ``null``) => `DomainSkillThresholdSetEventFilter` | +| `DomainSkillThresholdSet(uint256,uint256)` | (`domainSkillId?`: ``null``, `threshold?`: ``null``) => `DomainSkillThresholdSetEventFilter` | +| `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` | +| `ExtensionInitialised` | () => `ExtensionInitialisedEventFilter` | +| `ExtensionInitialised()` | () => `ExtensionInitialisedEventFilter` | +| `FundingPotAdded` | (`fundingPotId?`: ``null``) => `FundingPotAddedEventFilter` | +| `FundingPotAdded(uint256)` | (`fundingPotId?`: ``null``) => `FundingPotAddedEventFilter` | +| `GlobalThresholdSet` | (`globalThreshold?`: ``null``) => `GlobalThresholdSetEventFilter` | +| `GlobalThresholdSet(uint256)` | (`globalThreshold?`: ``null``) => `GlobalThresholdSetEventFilter` | +| `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` | +| `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` | +| `MotionCancelled` | (`agent?`: ``null``, `motionId?`: ``null``) => `MotionCancelledEventFilter` | +| `MotionCancelled(address,uint256)` | (`agent?`: ``null``, `motionId?`: ``null``) => `MotionCancelledEventFilter` | +| `MotionCreated` | (`agent?`: ``null``, `motionId?`: ``null``) => `MotionCreatedEventFilter` | +| `MotionCreated(address,uint256)` | (`agent?`: ``null``, `motionId?`: ``null``) => `MotionCreatedEventFilter` | +| `MotionExecuted` | (`agent?`: ``null``, `motionId?`: ``null``, `success?`: ``null``) => `MotionExecutedEventFilter` | +| `MotionExecuted(address,uint256,bool)` | (`agent?`: ``null``, `motionId?`: ``null``, `success?`: ``null``) => `MotionExecutedEventFilter` | +| `MultisigRoleSet` | (`agent?`: ``null``, `user?`: ``null``, `domainId?`: ``null``, `roleId?`: ``null``, `setTo?`: ``null``) => `MultisigRoleSetEventFilter` | +| `MultisigRoleSet(address,address,uint256,uint256,bool)` | (`agent?`: ``null``, `user?`: ``null``, `domainId?`: ``null``, `roleId?`: ``null``, `setTo?`: ``null``) => `MultisigRoleSetEventFilter` | +| `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(address,uint256,address,uint256)` | (`agent?`: ``null``, `fundingPotId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PayoutClaimed_address_uint256_address_uint256_EventFilter` | +| `PayoutClaimed(address,uint256,uint256,address,uint256)` | (`agent?`: ``null``, `id?`: ``null``, `slot?`: ``null``, `token?`: ``null``, `tokenPayout?`: ``null``) => `PayoutClaimed_address_uint256_uint256_address_uint256_EventFilter` | +| `RejectionChanged` | (`agent?`: ``null``, `motionId?`: ``null``, `role?`: ``null``, `approval?`: ``null``) => `RejectionChangedEventFilter` | +| `RejectionChanged(address,uint256,uint8,bool)` | (`agent?`: ``null``, `motionId?`: ``null``, `role?`: ``null``, `approval?`: ``null``) => `RejectionChangedEventFilter` | +| `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 + +AugmentedMultisigPermissions.filters + +___ + +### functions + +• **functions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `cancel` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `cancel(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `changeVote` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `changeVote(uint256,uint256,uint256,uint8)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `createMotion` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `createMotion(uint256,uint256,address[],bytes[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `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`\> | +| `execute` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `execute(uint256)` | (`_motionId`: `BigNumberish`, `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`\> | +| `executeWithoutFailure` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `executeWithoutFailure(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | +| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | +| `getDomainSkillRoleCounts` | (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getDomainSkillRoleCounts(uint256,uint8)` | (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getDomainSkillThreshold` | (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getDomainSkillThreshold(uint256)` | (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getGlobalThreshold` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getGlobalThreshold()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_nonce`: `BigNumber` }\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_nonce`: `BigNumber` }\> | +| `getMotion` | (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`MotionStructOutput`]\> | +| `getMotion(uint256)` | (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`MotionStructOutput`]\> | +| `getMotionCount` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getMotionCount()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getMotionRoleVoteCount` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getMotionRoleVoteCount(uint256,uint8,uint8)` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getMotionVoteThreshold` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getMotionVoteThreshold(uint256,uint8)` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getSingleActionSummary` | (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`ActionSummaryStructOutput`]\> | +| `getSingleActionSummary(address,address,bytes,address)` | (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`ActionSummaryStructOutput`]\> | +| `getUserRoles` | (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getUserRoles(address,uint256)` | (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getUserVote` | (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | +| `getUserVote(uint256,address,uint8,uint8)` | (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | +| `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`\> | +| `setDomainSkillThreshold` | (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setDomainSkillThreshold(uint256,uint256)` | (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setGlobalThreshold` | (`_globalThreshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setGlobalThreshold(uint256)` | (`_globalThreshold`: `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`\> | +| `setUserRoles` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setUserRoles(uint256,uint256,address,uint256,bytes32)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `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 + +AugmentedMultisigPermissions.functions + +___ + +### interface + +• **interface**: `MultisigPermissionsInterface` + +#### Inherited from + +AugmentedMultisigPermissions.interface + +___ + +### multisigPermissionsEvents + +• **multisigPermissionsEvents**: `MultisigPermissionsEvents` + +The multisigPermissionsEvents contract supports all events across all versions. +Isn't that amazing? +It's an ethers contract with only events to filter + +#### Inherited from + +AugmentedMultisigPermissions.multisigPermissionsEvents + +___ + +### off + +• **off**: `OnEvent`<[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md)\> + +#### Inherited from + +AugmentedMultisigPermissions.off + +___ + +### on + +• **on**: `OnEvent`<[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md)\> + +#### Inherited from + +AugmentedMultisigPermissions.on + +___ + +### once + +• **once**: `OnEvent`<[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md)\> + +#### Inherited from + +AugmentedMultisigPermissions.once + +___ + +### populateTransaction + +• **populateTransaction**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `cancel` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `cancel(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `changeVote` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `changeVote(uint256,uint256,uint256,uint8)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_motionId`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `createMotion` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `createMotion(uint256,uint256,address[],bytes[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_targets`: `string`[], `_data`: `BytesLike`[], `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`\> | +| `execute` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `execute(uint256)` | (`_motionId`: `BigNumberish`, `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`\> | +| `executeWithoutFailure` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `executeWithoutFailure(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getDomainSkillRoleCounts` | (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getDomainSkillRoleCounts(uint256,uint8)` | (`_domainSkillId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getDomainSkillThreshold` | (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getDomainSkillThreshold(uint256)` | (`_domainSkillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getGlobalThreshold` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getGlobalThreshold()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMotion` | (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMotion(uint256)` | (`motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMotionCount` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMotionCount()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMotionRoleVoteCount` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMotionRoleVoteCount(uint256,uint8,uint8)` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMotionVoteThreshold` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMotionVoteThreshold(uint256,uint8)` | (`_motionId`: `BigNumberish`, `_role`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getSingleActionSummary` | (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getSingleActionSummary(address,address,bytes,address)` | (`colonyNetworkAddress`: `string`, `colonyAddress`: `string`, `_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getUserRoles` | (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getUserRoles(address,uint256)` | (`who`: `string`, `where`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getUserVote` | (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getUserVote(uint256,address,uint8,uint8)` | (`_motionId`: `BigNumberish`, `_user`: `string`, `_role`: `BigNumberish`, `_vote`: `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`\> | +| `setDomainSkillThreshold` | (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setDomainSkillThreshold(uint256,uint256)` | (`_domainSkillId`: `BigNumberish`, `_threshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setGlobalThreshold` | (`_globalThreshold`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setGlobalThreshold(uint256)` | (`_globalThreshold`: `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`\> | +| `setUserRoles` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setUserRoles(uint256,uint256,address,uint256,bytes32)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_user`: `string`, `_domainId`: `BigNumberish`, `_roles`: `BytesLike`, `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 + +AugmentedMultisigPermissions.populateTransaction + +___ + +### provider + +• `Readonly` **provider**: `Provider` + +#### Inherited from + +AugmentedMultisigPermissions.provider + +___ + +### removeListener + +• **removeListener**: `OnEvent`<[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md)\> + +#### Inherited from + +AugmentedMultisigPermissions.removeListener + +___ + +### resolvedAddress + +• `Readonly` **resolvedAddress**: `Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.resolvedAddress + +___ + +### signer + +• `Readonly` **signer**: `Signer` + +#### Inherited from + +AugmentedMultisigPermissions.signer + +## Methods + +### \_checkRunningEvents + +▸ **_checkRunningEvents**(`runningEvent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `runningEvent` | `RunningEvent` | + +#### Returns + +`void` + +#### Inherited from + +AugmentedMultisigPermissions.\_checkRunningEvents + +___ + +### \_deployed + +▸ **_deployed**(`blockTag?`): `Promise`<`Contract`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`<`Contract`\> + +#### Inherited from + +AugmentedMultisigPermissions.\_deployed + +___ + +### \_wrapEvent + +▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): `Event` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `runningEvent` | `RunningEvent` | +| `log` | `Log` | +| `listener` | `Listener` | + +#### Returns + +`Event` + +#### Inherited from + +AugmentedMultisigPermissions.\_wrapEvent + +___ + +### attach + +▸ **attach**(`addressOrName`): [`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `addressOrName` | `string` | + +#### Returns + +[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md) + +#### Inherited from + +AugmentedMultisigPermissions.attach + +___ + +### authority + +▸ **authority**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.authority + +___ + +### authority() + +▸ **authority()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.authority() + +___ + +### cancel + +▸ **cancel**(`_motionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.cancel + +___ + +### cancel(uint256) + +▸ **cancel(uint256)**(`_motionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.cancel(uint256) + +___ + +### changeVote + +▸ **changeVote**(`_permissionDomainId`, `_childSkillIndex`, `_motionId`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_motionId` | `BigNumberish` | +| `_vote` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.changeVote + +___ + +### changeVote(uint256,uint256,uint256,uint8) + +▸ **changeVote(uint256,uint256,uint256,uint8)**(`_permissionDomainId`, `_childSkillIndex`, `_motionId`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_motionId` | `BigNumberish` | +| `_vote` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.changeVote(uint256,uint256,uint256,uint8) + +___ + +### connect + +▸ **connect**(`signerOrProvider`): [`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerOrProvider` | `string` \| `Signer` \| `Provider` | + +#### Returns + +[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md) + +#### Inherited from + +AugmentedMultisigPermissions.connect + +___ + +### createMotion + +▸ **createMotion**(`_permissionDomainId`, `_childSkillIndex`, `_targets`, `_data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_targets` | `string`[] | +| `_data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.createMotion + +___ + +### createMotion(uint256,uint256,address[],bytes[]) + +▸ **createMotion(uint256,uint256,address[],bytes[])**(`_permissionDomainId`, `_childSkillIndex`, `_targets`, `_data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_targets` | `string`[] | +| `_data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.createMotion(uint256,uint256,address[],bytes[]) + +___ + +### deployed + +▸ **deployed**(): `Promise`<[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md)\> + +#### Returns + +`Promise`<[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md)\> + +#### Inherited from + +AugmentedMultisigPermissions.deployed + +___ + +### deprecate + +▸ **deprecate**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.deprecate + +___ + +### deprecate(bool) + +▸ **deprecate(bool)**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.deprecate(bool) + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `EventFilter` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +AugmentedMultisigPermissions.emit + +___ + +### execute + +▸ **execute**(`_motionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.execute + +___ + +### execute(uint256) + +▸ **execute(uint256)**(`_motionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.execute(uint256) + +___ + +### executeMetaTransaction + +▸ **executeMetaTransaction**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.executeMetaTransaction + +___ + +### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +___ + +### executeWithoutFailure + +▸ **executeWithoutFailure**(`_motionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.executeWithoutFailure + +___ + +### executeWithoutFailure(uint256) + +▸ **executeWithoutFailure(uint256)**(`_motionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.executeWithoutFailure(uint256) + +___ + +### fallback + +▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `TransactionRequest` | + +#### Returns + +`Promise`<`TransactionResponse`\> + +#### Inherited from + +AugmentedMultisigPermissions.fallback + +___ + +### finishUpgrade + +▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.finishUpgrade + +___ + +### finishUpgrade() + +▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.finishUpgrade() + +___ + +### getCapabilityRoles + +▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.getCapabilityRoles + +___ + +### getCapabilityRoles(bytes4) + +▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.getCapabilityRoles(bytes4) + +___ + +### getColony + +▸ **getColony**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.getColony + +___ + +### getColony() + +▸ **getColony()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.getColony() + +___ + +### getDeprecated + +▸ **getDeprecated**(`overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedMultisigPermissions.getDeprecated + +___ + +### getDeprecated() + +▸ **getDeprecated()**(`overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedMultisigPermissions.getDeprecated() + +___ + +### getDomainSkillRoleCounts + +▸ **getDomainSkillRoleCounts**(`_domainSkillId`, `_role`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_domainSkillId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getDomainSkillRoleCounts + +___ + +### getDomainSkillRoleCounts(uint256,uint8) + +▸ **getDomainSkillRoleCounts(uint256,uint8)**(`_domainSkillId`, `_role`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_domainSkillId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getDomainSkillRoleCounts(uint256,uint8) + +___ + +### getDomainSkillThreshold + +▸ **getDomainSkillThreshold**(`_domainSkillId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_domainSkillId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getDomainSkillThreshold + +___ + +### getDomainSkillThreshold(uint256) + +▸ **getDomainSkillThreshold(uint256)**(`_domainSkillId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_domainSkillId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getDomainSkillThreshold(uint256) + +___ + +### getGlobalThreshold + +▸ **getGlobalThreshold**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getGlobalThreshold + +___ + +### getGlobalThreshold() + +▸ **getGlobalThreshold()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getGlobalThreshold() + +___ + +### getMetatransactionNonce + +▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMetatransactionNonce + +___ + +### getMetatransactionNonce(address) + +▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMetatransactionNonce(address) + +___ + +### getMotion + +▸ **getMotion**(`motionId`, `overrides?`): `Promise`<`MotionStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `motionId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`MotionStructOutput`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMotion + +___ + +### getMotion(uint256) + +▸ **getMotion(uint256)**(`motionId`, `overrides?`): `Promise`<`MotionStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `motionId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`MotionStructOutput`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMotion(uint256) + +___ + +### getMotionCount + +▸ **getMotionCount**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMotionCount + +___ + +### getMotionCount() + +▸ **getMotionCount()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMotionCount() + +___ + +### getMotionRoleVoteCount + +▸ **getMotionRoleVoteCount**(`_motionId`, `_role`, `_vote`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `_vote` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMotionRoleVoteCount + +___ + +### getMotionRoleVoteCount(uint256,uint8,uint8) + +▸ **getMotionRoleVoteCount(uint256,uint8,uint8)**(`_motionId`, `_role`, `_vote`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `_vote` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMotionRoleVoteCount(uint256,uint8,uint8) + +___ + +### getMotionVoteThreshold + +▸ **getMotionVoteThreshold**(`_motionId`, `_role`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMotionVoteThreshold + +___ + +### getMotionVoteThreshold(uint256,uint8) + +▸ **getMotionVoteThreshold(uint256,uint8)**(`_motionId`, `_role`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_role` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.getMotionVoteThreshold(uint256,uint8) + +___ + +### getSingleActionSummary + +▸ **getSingleActionSummary**(`colonyNetworkAddress`, `colonyAddress`, `_action`, `_altTarget`, `overrides?`): `Promise`<`ActionSummaryStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `colonyNetworkAddress` | `string` | +| `colonyAddress` | `string` | +| `_action` | `BytesLike` | +| `_altTarget` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`ActionSummaryStructOutput`\> + +#### Inherited from + +AugmentedMultisigPermissions.getSingleActionSummary + +___ + +### getSingleActionSummary(address,address,bytes,address) + +▸ **getSingleActionSummary(address,address,bytes,address)**(`colonyNetworkAddress`, `colonyAddress`, `_action`, `_altTarget`, `overrides?`): `Promise`<`ActionSummaryStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `colonyNetworkAddress` | `string` | +| `colonyAddress` | `string` | +| `_action` | `BytesLike` | +| `_altTarget` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`ActionSummaryStructOutput`\> + +#### Inherited from + +AugmentedMultisigPermissions.getSingleActionSummary(address,address,bytes,address) + +___ + +### getUserRoles + +▸ **getUserRoles**(`who`, `where`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `who` | `string` | +| `where` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.getUserRoles + +___ + +### getUserRoles(address,uint256) + +▸ **getUserRoles(address,uint256)**(`who`, `where`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `who` | `string` | +| `where` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.getUserRoles(address,uint256) + +___ + +### getUserVote + +▸ **getUserVote**(`_motionId`, `_user`, `_role`, `_vote`, `overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_user` | `string` | +| `_role` | `BigNumberish` | +| `_vote` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedMultisigPermissions.getUserVote + +___ + +### getUserVote(uint256,address,uint8,uint8) + +▸ **getUserVote(uint256,address,uint8,uint8)**(`_motionId`, `_user`, `_role`, `_vote`, `overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_user` | `string` | +| `_role` | `BigNumberish` | +| `_vote` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedMultisigPermissions.getUserVote(uint256,address,uint8,uint8) + +___ + +### identifier + +▸ **identifier**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.identifier + +___ + +### identifier() + +▸ **identifier()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.identifier() + +___ + +### install + +▸ **install**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.install + +___ + +### install(address) + +▸ **install(address)**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.install(address) + +___ + +### listenerCount + +▸ **listenerCount**(`eventName?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` \| `EventFilter` | + +#### Returns + +`number` + +#### Inherited from + +AugmentedMultisigPermissions.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 + +AugmentedMultisigPermissions.listeners + +▸ **listeners**(`eventName?`): `Listener`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +`Listener`[] + +#### Inherited from + +AugmentedMultisigPermissions.listeners + +___ + +### multicall + +▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.multicall + +___ + +### multicall(bytes[]) + +▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.multicall(bytes[]) + +___ + +### owner + +▸ **owner**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.owner + +___ + +### owner() + +▸ **owner()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedMultisigPermissions.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 + +AugmentedMultisigPermissions.queryFilter + +___ + +### removeAllListeners + +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TEvent` | extends `TypedEvent`<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFilter` | `TypedEventFilter`<`TEvent`\> | + +#### Returns + +[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md) + +#### Inherited from + +AugmentedMultisigPermissions.removeAllListeners + +▸ **removeAllListeners**(`eventName?`): [`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +[`MultisigPermissionsClientV1`](MultisigPermissionsClientV1.md) + +#### Inherited from + +AugmentedMultisigPermissions.removeAllListeners + +___ + +### setAuthority + +▸ **setAuthority**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `authority_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setAuthority + +___ + +### setAuthority(address) + +▸ **setAuthority(address)**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `authority_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setAuthority(address) + +___ + +### setDomainSkillThreshold + +▸ **setDomainSkillThreshold**(`_domainSkillId`, `_threshold`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_domainSkillId` | `BigNumberish` | +| `_threshold` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setDomainSkillThreshold + +___ + +### setDomainSkillThreshold(uint256,uint256) + +▸ **setDomainSkillThreshold(uint256,uint256)**(`_domainSkillId`, `_threshold`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_domainSkillId` | `BigNumberish` | +| `_threshold` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setDomainSkillThreshold(uint256,uint256) + +___ + +### setGlobalThreshold + +▸ **setGlobalThreshold**(`_globalThreshold`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_globalThreshold` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setGlobalThreshold + +___ + +### setGlobalThreshold(uint256) + +▸ **setGlobalThreshold(uint256)**(`_globalThreshold`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_globalThreshold` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setGlobalThreshold(uint256) + +___ + +### setOwner + +▸ **setOwner**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setOwner + +___ + +### setOwner(address) + +▸ **setOwner(address)**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setOwner(address) + +___ + +### setUserRoles + +▸ **setUserRoles**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_roles`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_roles` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setUserRoles + +___ + +### setUserRoles(uint256,uint256,address,uint256,bytes32) + +▸ **setUserRoles(uint256,uint256,address,uint256,bytes32)**(`_permissionDomainId`, `_childSkillIndex`, `_user`, `_domainId`, `_roles`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_user` | `string` | +| `_domainId` | `BigNumberish` | +| `_roles` | `BytesLike` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.setUserRoles(uint256,uint256,address,uint256,bytes32) + +___ + +### uninstall + +▸ **uninstall**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.uninstall + +___ + +### uninstall() + +▸ **uninstall()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedMultisigPermissions.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 + +AugmentedMultisigPermissions.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 + +AugmentedMultisigPermissions.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) + +___ + +### version + +▸ **version**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.version + +___ + +### version() + +▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedMultisigPermissions.version() diff --git a/packages/colony-js/docs/api/interfaces/OneTxPaymentClientV2.md b/packages/colony-js/docs/api/interfaces/OneTxPaymentClientV8.md similarity index 72% rename from packages/colony-js/docs/api/interfaces/OneTxPaymentClientV2.md rename to packages/colony-js/docs/api/interfaces/OneTxPaymentClientV8.md index 4a129e087..2a21d9029 100644 --- a/packages/colony-js/docs/api/interfaces/OneTxPaymentClientV2.md +++ b/packages/colony-js/docs/api/interfaces/OneTxPaymentClientV8.md @@ -1,10 +1,10 @@ -# Interface: OneTxPaymentClientV2 +# Interface: OneTxPaymentClientV8 ## Hierarchy - `AugmentedOneTxPayment`<`OneTxPayment`\> - ↳ **`OneTxPaymentClientV2`** + ↳ **`OneTxPaymentClientV8`** ## Properties @@ -68,6 +68,8 @@ ___ | `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `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`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | @@ -76,6 +78,8 @@ ___ | `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`\> | | `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `install` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | @@ -84,6 +88,8 @@ ___ | `makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `makePaymentFundedFromDomain` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `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`\> | @@ -92,6 +98,8 @@ ___ | `setOwner(address)` | (`owner_`: `string`, `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`\> | @@ -113,7 +121,7 @@ ___ ### clientVersion -• **clientVersion**: ``2`` +• **clientVersion**: ``8`` #### Overrides @@ -167,6 +175,8 @@ ___ | `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` | | `OneTxPaymentMade` | (`agent?`: ``null``, `fundamentalId?`: ``null``, `nPayouts?`: ``null``) => `OneTxPaymentMadeEventFilter` | | `OneTxPaymentMade(address,uint256,uint256)` | (`agent?`: ``null``, `fundamentalId?`: ``null``, `nPayouts?`: ``null``) => `OneTxPaymentMadeEventFilter` | @@ -188,22 +198,28 @@ ___ | `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `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`\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_roles`: `string` }\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_roles`: `string` }\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | | `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_nonce`: `BigNumber` }\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_nonce`: `BigNumber` }\> | +| `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`\> | | `makePayment` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `makePaymentFundedFromDomain` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `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`\> | @@ -212,8 +228,10 @@ ___ | `setOwner(address)` | (`owner_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `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 @@ -233,7 +251,7 @@ ___ ### off -• **off**: `OnEvent`<[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md)\> +• **off**: `OnEvent`<[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md)\> #### Inherited from @@ -243,7 +261,7 @@ ___ ### on -• **on**: `OnEvent`<[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md)\> +• **on**: `OnEvent`<[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md)\> #### Inherited from @@ -253,7 +271,7 @@ ___ ### once -• **once**: `OnEvent`<[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md)\> +• **once**: `OnEvent`<[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md)\> #### Inherited from @@ -287,6 +305,8 @@ ___ | `authority()` | (`overrides?`: `CallOverrides`) => `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`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -295,6 +315,8 @@ ___ | `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`\> | | `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | @@ -303,6 +325,8 @@ ___ | `makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `makePaymentFundedFromDomain` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_workers`: `string`[], `_tokens`: `string`[], `_amounts`: `BigNumberish`[], `_domainId`: `BigNumberish`, `_skillId`: `BigNumberish`, `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`\> | @@ -311,6 +335,8 @@ ___ | `setOwner(address)` | (`owner_`: `string`, `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`\> | @@ -332,7 +358,7 @@ ___ ### removeListener -• **removeListener**: `OnEvent`<[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md)\> +• **removeListener**: `OnEvent`<[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md)\> #### Inherited from @@ -424,7 +450,7 @@ ___ ### attach -▸ **attach**(`addressOrName`): [`OneTxPaymentClientV2`](OneTxPaymentClientV2.md) +▸ **attach**(`addressOrName`): [`OneTxPaymentClientV8`](OneTxPaymentClientV8.md) #### Parameters @@ -434,7 +460,7 @@ ___ #### Returns -[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md) +[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md) #### Inherited from @@ -484,7 +510,7 @@ ___ ### connect -▸ **connect**(`signerOrProvider`): [`OneTxPaymentClientV2`](OneTxPaymentClientV2.md) +▸ **connect**(`signerOrProvider`): [`OneTxPaymentClientV8`](OneTxPaymentClientV8.md) #### Parameters @@ -494,7 +520,7 @@ ___ #### Returns -[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md) +[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md) #### Inherited from @@ -504,11 +530,11 @@ ___ ### deployed -▸ **deployed**(): `Promise`<[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md)\> +▸ **deployed**(): `Promise`<[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md)\> #### Returns -`Promise`<[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md)\> +`Promise`<[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md)\> #### Inherited from @@ -520,8 +546,6 @@ ___ ▸ **deprecate**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> -Called when deprecating (or undeprecating) the extension - #### Parameters | Name | Type | @@ -543,8 +567,6 @@ ___ ▸ **deprecate(bool)**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> -Called when deprecating (or undeprecating) the extension - #### Parameters | Name | Type | @@ -583,6 +605,56 @@ AugmentedOneTxPayment.emit ___ +### executeMetaTransaction + +▸ **executeMetaTransaction**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedOneTxPayment.executeMetaTransaction + +___ + +### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedOneTxPayment.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +___ + ### fallback ▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> @@ -607,8 +679,6 @@ ___ ▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> -Called when upgrading the extension - #### Parameters | Name | Type | @@ -629,8 +699,6 @@ ___ ▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> -Called when upgrading the extension - #### Parameters | Name | Type | @@ -651,14 +719,12 @@ ___ ▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> -Return the permissions required for each function - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_sig` | `BytesLike` | The function signature | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | #### Returns @@ -674,14 +740,12 @@ ___ ▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> -Return the permissions required for each function - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_sig` | `BytesLike` | The function signature | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | #### Returns @@ -773,12 +837,52 @@ AugmentedOneTxPayment.getDeprecated() ___ +### getMetatransactionNonce + +▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedOneTxPayment.getMetatransactionNonce + +___ + +### getMetatransactionNonce(address) + +▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedOneTxPayment.getMetatransactionNonce(address) + +___ + ### identifier ▸ **identifier**(`overrides?`): `Promise`<`string`\> -Returns the identifier of the extension - #### Parameters | Name | Type | @@ -799,8 +903,6 @@ ___ ▸ **identifier()**(`overrides?`): `Promise`<`string`\> -Returns the identifier of the extension - #### Parameters | Name | Type | @@ -821,14 +923,12 @@ ___ ▸ **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` } | - | +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -844,14 +944,12 @@ ___ ▸ **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` } | - | +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -929,23 +1027,20 @@ ___ ▸ **makePayment**(`_permissionDomainId`, `_childSkillIndex`, `_callerPermissionDomainId`, `_callerChildSkillIndex`, `_workers`, `_tokens`, `_amounts`, `_domainId`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> -Assumes that each entity holds administration and funding roles in the root domain -Completes a colony payment in a single transaction - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which the _contract_ has permissions to add a payment and fund it | -| `_childSkillIndex` | `BigNumberish` | Index of the _permissionDomainId skill.children array to get | -| `_callerPermissionDomainId` | `BigNumberish` | The domainId in which the _caller_ has the administration permission (must have funding in root) | -| `_callerChildSkillIndex` | `BigNumberish` | Index of the _callerPermissionDomainId skill.children array to get | -| `_workers` | `string`[] | The addresses of the recipients of the payment | -| `_tokens` | `string`[] | Addresses of the tokens the payments are being made in. 0x00 for Ether. | -| `_amounts` | `BigNumberish`[] | amounts of the tokens being paid out | -| `_domainId` | `BigNumberish` | The domainId the payment should be coming from | -| `_skillId` | `BigNumberish` | The skillId that the payment should be marked with, possibly awarding reputation in this skill. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_callerPermissionDomainId` | `BigNumberish` | +| `_callerChildSkillIndex` | `BigNumberish` | +| `_workers` | `string`[] | +| `_tokens` | `string`[] | +| `_amounts` | `BigNumberish`[] | +| `_domainId` | `BigNumberish` | +| `_skillId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -961,23 +1056,20 @@ ___ ▸ **makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_callerPermissionDomainId`, `_callerChildSkillIndex`, `_workers`, `_tokens`, `_amounts`, `_domainId`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> -Assumes that each entity holds administration and funding roles in the root domain -Completes a colony payment in a single transaction - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which the _contract_ has permissions to add a payment and fund it | -| `_childSkillIndex` | `BigNumberish` | Index of the _permissionDomainId skill.children array to get | -| `_callerPermissionDomainId` | `BigNumberish` | The domainId in which the _caller_ has the administration permission (must have funding in root) | -| `_callerChildSkillIndex` | `BigNumberish` | Index of the _callerPermissionDomainId skill.children array to get | -| `_workers` | `string`[] | The addresses of the recipients of the payment | -| `_tokens` | `string`[] | Addresses of the tokens the payments are being made in. 0x00 for Ether. | -| `_amounts` | `BigNumberish`[] | amounts of the tokens being paid out | -| `_domainId` | `BigNumberish` | The domainId the payment should be coming from | -| `_skillId` | `BigNumberish` | The skillId that the payment should be marked with, possibly awarding reputation in this skill. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_callerPermissionDomainId` | `BigNumberish` | +| `_callerChildSkillIndex` | `BigNumberish` | +| `_workers` | `string`[] | +| `_tokens` | `string`[] | +| `_amounts` | `BigNumberish`[] | +| `_domainId` | `BigNumberish` | +| `_skillId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -993,23 +1085,20 @@ ___ ▸ **makePaymentFundedFromDomain**(`_permissionDomainId`, `_childSkillIndex`, `_callerPermissionDomainId`, `_callerChildSkillIndex`, `_workers`, `_tokens`, `_amounts`, `_domainId`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> -Assumes that each entity holds administration and funding roles in the same domain, although contract and caller can have the permissions in different domains. Payment is taken from domain funds - if the domain does not have sufficient funds, call will fail. -Completes a colony payment in a single transaction - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which the _contract_ has permissions to add a payment and fund it | -| `_childSkillIndex` | `BigNumberish` | Index of the _permissionDomainId skill.children array to get | -| `_callerPermissionDomainId` | `BigNumberish` | The domainId in which the _caller_ has permissions to add a payment and fund it | -| `_callerChildSkillIndex` | `BigNumberish` | Index of the _callerPermissionDomainId skill.children array to get | -| `_workers` | `string`[] | The addresses of the recipients of the payment | -| `_tokens` | `string`[] | The addresses of the token the payments are being made in. 0x00 for Ether. | -| `_amounts` | `BigNumberish`[] | The amounts of the tokens being paid out | -| `_domainId` | `BigNumberish` | The domainId the payment should be coming from | -| `_skillId` | `BigNumberish` | The skillId that the payment should be marked with, possibly awarding reputation in this skill. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_callerPermissionDomainId` | `BigNumberish` | +| `_callerChildSkillIndex` | `BigNumberish` | +| `_workers` | `string`[] | +| `_tokens` | `string`[] | +| `_amounts` | `BigNumberish`[] | +| `_domainId` | `BigNumberish` | +| `_skillId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1025,23 +1114,20 @@ ___ ▸ **makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_callerPermissionDomainId`, `_callerChildSkillIndex`, `_workers`, `_tokens`, `_amounts`, `_domainId`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> -Assumes that each entity holds administration and funding roles in the same domain, although contract and caller can have the permissions in different domains. Payment is taken from domain funds - if the domain does not have sufficient funds, call will fail. -Completes a colony payment in a single transaction - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_permissionDomainId` | `BigNumberish` | The domainId in which the _contract_ has permissions to add a payment and fund it | -| `_childSkillIndex` | `BigNumberish` | Index of the _permissionDomainId skill.children array to get | -| `_callerPermissionDomainId` | `BigNumberish` | The domainId in which the _caller_ has permissions to add a payment and fund it | -| `_callerChildSkillIndex` | `BigNumberish` | Index of the _callerPermissionDomainId skill.children array to get | -| `_workers` | `string`[] | The addresses of the recipients of the payment | -| `_tokens` | `string`[] | The addresses of the token the payments are being made in. 0x00 for Ether. | -| `_amounts` | `BigNumberish`[] | The amounts of the tokens being paid out | -| `_domainId` | `BigNumberish` | The domainId the payment should be coming from | -| `_skillId` | `BigNumberish` | The skillId that the payment should be marked with, possibly awarding reputation in this skill. | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_callerPermissionDomainId` | `BigNumberish` | +| `_callerChildSkillIndex` | `BigNumberish` | +| `_workers` | `string`[] | +| `_tokens` | `string`[] | +| `_amounts` | `BigNumberish`[] | +| `_domainId` | `BigNumberish` | +| `_skillId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1057,7 +1143,7 @@ ___ ▸ **makePaymentFundedFromDomainWithProofs**(`_workers`, `_tokens`, `_amounts`, `_domainId`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [makePaymentFundedFromDomain](OneTxPaymentClientV2.md#makepaymentfundedfromdomain), but let colonyJS figure out the permission proofs for you. +Same as [makePaymentFundedFromDomain](OneTxPaymentClientV8.md#makepaymentfundedfromdomain), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -1085,7 +1171,7 @@ ___ ▸ **makePaymentWithProofs**(`_workers`, `_tokens`, `_amounts`, `_domainId`, `_skillId`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [makePayment](OneTxPaymentClientV2.md#makepayment), but let colonyJS figure out the permission proofs for you. +Same as [makePayment](OneTxPaymentClientV8.md#makepayment), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -1109,6 +1195,48 @@ AugmentedOneTxPayment.makePaymentWithProofs ___ +### multicall + +▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedOneTxPayment.multicall + +___ + +### multicall(bytes[]) + +▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedOneTxPayment.multicall(bytes[]) + +___ + ### owner ▸ **owner**(`overrides?`): `Promise`<`string`\> @@ -1179,7 +1307,7 @@ ___ ### removeAllListeners -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`OneTxPaymentClientV2`](OneTxPaymentClientV2.md) +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`OneTxPaymentClientV8`](OneTxPaymentClientV8.md) #### Type parameters @@ -1195,13 +1323,13 @@ ___ #### Returns -[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md) +[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md) #### Inherited from AugmentedOneTxPayment.removeAllListeners -▸ **removeAllListeners**(`eventName?`): [`OneTxPaymentClientV2`](OneTxPaymentClientV2.md) +▸ **removeAllListeners**(`eventName?`): [`OneTxPaymentClientV8`](OneTxPaymentClientV8.md) #### Parameters @@ -1211,7 +1339,7 @@ AugmentedOneTxPayment.removeAllListeners #### Returns -[`OneTxPaymentClientV2`](OneTxPaymentClientV2.md) +[`OneTxPaymentClientV8`](OneTxPaymentClientV8.md) #### Inherited from @@ -1307,8 +1435,6 @@ ___ ▸ **uninstall**(`overrides?`): `Promise`<`ContractTransaction`\> -Called when uninstalling the extension - #### Parameters | Name | Type | @@ -1329,8 +1455,6 @@ ___ ▸ **uninstall()**(`overrides?`): `Promise`<`ContractTransaction`\> -Called when uninstalling the extension - #### Parameters | Name | Type | @@ -1347,12 +1471,64 @@ AugmentedOneTxPayment.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 + +AugmentedOneTxPayment.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 + +AugmentedOneTxPayment.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) + +___ + ### version ▸ **version**(`overrides?`): `Promise`<`BigNumber`\> -Returns the version of the extension - #### Parameters | Name | Type | @@ -1373,8 +1549,6 @@ ___ ▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> -Returns the version of the extension - #### Parameters | Name | Type | diff --git a/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV1.md b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV1.md index 7fbe76ffd..bb3b18c6f 100644 --- a/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV1.md +++ b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV1.md @@ -135,7 +135,7 @@ ___ ### colonyClient -• **colonyClient**: `AugmentedIColony`<`IColony`\> +• **colonyClient**: `AugmentedIColony`<`ValidColony`\> An instance of the corresponding ColonyClient @@ -157,7 +157,7 @@ ___ ### estimateGas -• **estimateGas**: { `authority`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `authority()`: (`overrides?`: `CallOverrides`) => `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`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId()`: (`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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId()`: (`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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> } +• **estimateGas**: { `authority`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `authority()`: (`overrides?`: `CallOverrides`) => `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`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId()`: (`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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId()`: (`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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId()`: (`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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> } #### Inherited from diff --git a/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV2.md b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV2.md index ce862b495..303f1d941 100644 --- a/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV2.md +++ b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV2.md @@ -133,7 +133,7 @@ ___ ### colonyClient -• **colonyClient**: `AugmentedIColony`<`IColony`\> +• **colonyClient**: `AugmentedIColony`<`ValidColony`\> An instance of the corresponding ColonyClient @@ -155,7 +155,7 @@ ___ ### estimateGas -• **estimateGas**: { `authority`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `authority()`: (`overrides?`: `CallOverrides`) => `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId()`: (`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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> } +• **estimateGas**: { `authority`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `authority()`: (`overrides?`: `CallOverrides`) => `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId()`: (`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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> } #### Inherited from diff --git a/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV3.md b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV3.md new file mode 100644 index 000000000..01cbbdfa2 --- /dev/null +++ b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV3.md @@ -0,0 +1,1658 @@ +# Interface: StagedExpenditureClientV3 + +## Hierarchy + +- `AugmentedStagedExpenditure`<`StagedExpenditure`\> + + ↳ **`StagedExpenditureClientV3`** + +## Properties + +### \_deployedPromise + +• **\_deployedPromise**: `Promise`<`Contract`\> + +#### Inherited from + +AugmentedStagedExpenditure.\_deployedPromise + +___ + +### \_runningEvents + +• **\_runningEvents**: `Object` + +#### Index signature + +▪ [eventTag: `string`]: `RunningEvent` + +#### Inherited from + +AugmentedStagedExpenditure.\_runningEvents + +___ + +### \_wrappedEmits + +• **\_wrappedEmits**: `Object` + +#### Index signature + +▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` + +#### Inherited from + +AugmentedStagedExpenditure.\_wrappedEmits + +___ + +### address + +• `Readonly` **address**: `string` + +#### Inherited from + +AugmentedStagedExpenditure.address + +___ + +### callStatic + +• **callStatic**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `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`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `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`\> | +| `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`\> | +| `releaseStagedPayment` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `releaseStagedPaymentViaArbitration` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setAuthority` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setExpenditureStaged` | (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setExpenditureStaged(uint256,bool)` | (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setOwner` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setOwner(address)` | (`owner_`: `string`, `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 + +AugmentedStagedExpenditure.callStatic + +___ + +### clientType + +• **clientType**: [`StagedExpenditureClient`](../enums/ClientType.md#stagedexpenditureclient) + +#### Inherited from + +AugmentedStagedExpenditure.clientType + +___ + +### clientVersion + +• **clientVersion**: ``3`` + +#### Overrides + +AugmentedStagedExpenditure.clientVersion + +___ + +### colonyClient + +• **colonyClient**: `AugmentedIColony`<`ValidColony`\> + +An instance of the corresponding ColonyClient + +#### Inherited from + +AugmentedStagedExpenditure.colonyClient + +___ + +### deployTransaction + +• `Readonly` **deployTransaction**: `TransactionResponse` + +#### Inherited from + +AugmentedStagedExpenditure.deployTransaction + +___ + +### estimateGas + +• **estimateGas**: { `authority`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `authority()`: (`overrides?`: `CallOverrides`) => `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `getCapabilityRoles`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getCapabilityRoles(bytes4)`: (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getChainId()`: (`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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> ; `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`\> ; `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`\> ; `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`\> ; `releaseStagedPayment`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])`: (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setAuthority(address)`: (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setExpenditureStaged(uint256,bool)`: (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> ; `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`\> } + +#### Inherited from + +AugmentedStagedExpenditure.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` | +| `ArbitraryTransaction` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => `ArbitraryTransactionEventFilter` | +| `ArbitraryTransaction(address,bytes,bool)` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => `ArbitraryTransactionEventFilter` | +| `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` | +| `ExpenditureMadeStaged` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `staged?`: ``null``) => `ExpenditureMadeStagedEventFilter` | +| `ExpenditureMadeStaged(address,uint256,bool)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `staged?`: ``null``) => `ExpenditureMadeStagedEventFilter` | +| `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` | +| `ExtensionInitialised` | () => `ExtensionInitialisedEventFilter` | +| `ExtensionInitialised()` | () => `ExtensionInitialisedEventFilter` | +| `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` | +| `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` | +| `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(address,uint256,address,uint256)` | (`agent?`: ``null``, `fundingPotId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => `PayoutClaimed_address_uint256_address_uint256_EventFilter` | +| `PayoutClaimed(address,uint256,uint256,address,uint256)` | (`agent?`: ``null``, `id?`: ``null``, `slot?`: ``null``, `token?`: ``null``, `tokenPayout?`: ``null``) => `PayoutClaimed_address_uint256_uint256_address_uint256_EventFilter` | +| `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` | +| `StagedPaymentReleased` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null``) => `StagedPaymentReleasedEventFilter` | +| `StagedPaymentReleased(address,uint256,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null``) => `StagedPaymentReleasedEventFilter` | +| `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 + +AugmentedStagedExpenditure.filters + +___ + +### functions + +• **functions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `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`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `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` }\> | +| `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`]\> | +| `releaseStagedPayment` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `releaseStagedPaymentViaArbitration` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setExpenditureStaged` | (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setExpenditureStaged(uint256,bool)` | (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> | +| `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 + +AugmentedStagedExpenditure.functions + +___ + +### interface + +• **interface**: `StagedExpenditureInterface` + +#### Inherited from + +AugmentedStagedExpenditure.interface + +___ + +### off + +• **off**: `OnEvent`<[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md)\> + +#### Inherited from + +AugmentedStagedExpenditure.off + +___ + +### on + +• **on**: `OnEvent`<[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md)\> + +#### Inherited from + +AugmentedStagedExpenditure.on + +___ + +### once + +• **once**: `OnEvent`<[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md)\> + +#### Inherited from + +AugmentedStagedExpenditure.once + +___ + +### populateTransaction + +• **populateTransaction**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `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`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `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`\> | +| `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`\> | +| `releaseStagedPayment` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `releaseStagedPayment(uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `releaseStagedPaymentViaArbitration` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_extensionPermissionDomainId`: `BigNumberish`, `_extensionChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_slot`: `BigNumberish`, `_tokens`: `string`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setExpenditureStaged` | (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setExpenditureStaged(uint256,bool)` | (`_expenditureId`: `BigNumberish`, `_staged`: `boolean`, `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`\> | +| `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 + +AugmentedStagedExpenditure.populateTransaction + +___ + +### provider + +• `Readonly` **provider**: `Provider` + +#### Inherited from + +AugmentedStagedExpenditure.provider + +___ + +### removeListener + +• **removeListener**: `OnEvent`<[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md)\> + +#### Inherited from + +AugmentedStagedExpenditure.removeListener + +___ + +### resolvedAddress + +• `Readonly` **resolvedAddress**: `Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.resolvedAddress + +___ + +### signer + +• `Readonly` **signer**: `Signer` + +#### Inherited from + +AugmentedStagedExpenditure.signer + +___ + +### stagedExpenditureEvents + +• **stagedExpenditureEvents**: `StagedExpenditureEvents` + +The stagedExpenditureEvents contract supports all events across all versions. +Isn't that amazing? +It's an ethers contract with only events to filter + +#### Inherited from + +AugmentedStagedExpenditure.stagedExpenditureEvents + +## Methods + +### \_checkRunningEvents + +▸ **_checkRunningEvents**(`runningEvent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `runningEvent` | `RunningEvent` | + +#### Returns + +`void` + +#### Inherited from + +AugmentedStagedExpenditure.\_checkRunningEvents + +___ + +### \_deployed + +▸ **_deployed**(`blockTag?`): `Promise`<`Contract`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`<`Contract`\> + +#### Inherited from + +AugmentedStagedExpenditure.\_deployed + +___ + +### \_wrapEvent + +▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): `Event` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `runningEvent` | `RunningEvent` | +| `log` | `Log` | +| `listener` | `Listener` | + +#### Returns + +`Event` + +#### Inherited from + +AugmentedStagedExpenditure.\_wrapEvent + +___ + +### attach + +▸ **attach**(`addressOrName`): [`StagedExpenditureClientV3`](StagedExpenditureClientV3.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `addressOrName` | `string` | + +#### Returns + +[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md) + +#### Inherited from + +AugmentedStagedExpenditure.attach + +___ + +### authority + +▸ **authority**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.authority + +___ + +### authority() + +▸ **authority()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.authority() + +___ + +### connect + +▸ **connect**(`signerOrProvider`): [`StagedExpenditureClientV3`](StagedExpenditureClientV3.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerOrProvider` | `string` \| `Signer` \| `Provider` | + +#### Returns + +[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md) + +#### Inherited from + +AugmentedStagedExpenditure.connect + +___ + +### deployed + +▸ **deployed**(): `Promise`<[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md)\> + +#### Returns + +`Promise`<[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md)\> + +#### Inherited from + +AugmentedStagedExpenditure.deployed + +___ + +### deprecate + +▸ **deprecate**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.deprecate + +___ + +### deprecate(bool) + +▸ **deprecate(bool)**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.deprecate(bool) + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `EventFilter` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +AugmentedStagedExpenditure.emit + +___ + +### executeMetaTransaction + +▸ **executeMetaTransaction**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.executeMetaTransaction + +___ + +### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +___ + +### fallback + +▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `TransactionRequest` | + +#### Returns + +`Promise`<`TransactionResponse`\> + +#### Inherited from + +AugmentedStagedExpenditure.fallback + +___ + +### finishUpgrade + +▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.finishUpgrade + +___ + +### finishUpgrade() + +▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.finishUpgrade() + +___ + +### getCapabilityRoles + +▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.getCapabilityRoles + +___ + +### getCapabilityRoles(bytes4) + +▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.getCapabilityRoles(bytes4) + +___ + +### getColony + +▸ **getColony**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.getColony + +___ + +### getColony() + +▸ **getColony()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.getColony() + +___ + +### getDeprecated + +▸ **getDeprecated**(`overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedStagedExpenditure.getDeprecated + +___ + +### getDeprecated() + +▸ **getDeprecated()**(`overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedStagedExpenditure.getDeprecated() + +___ + +### getMetatransactionNonce + +▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStagedExpenditure.getMetatransactionNonce + +___ + +### getMetatransactionNonce(address) + +▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStagedExpenditure.getMetatransactionNonce(address) + +___ + +### identifier + +▸ **identifier**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.identifier + +___ + +### identifier() + +▸ **identifier()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.identifier() + +___ + +### install + +▸ **install**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.install + +___ + +### install(address) + +▸ **install(address)**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.install(address) + +___ + +### listenerCount + +▸ **listenerCount**(`eventName?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` \| `EventFilter` | + +#### Returns + +`number` + +#### Inherited from + +AugmentedStagedExpenditure.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 + +AugmentedStagedExpenditure.listeners + +▸ **listeners**(`eventName?`): `Listener`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +`Listener`[] + +#### Inherited from + +AugmentedStagedExpenditure.listeners + +___ + +### multicall + +▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.multicall + +___ + +### multicall(bytes[]) + +▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.multicall(bytes[]) + +___ + +### owner + +▸ **owner**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.owner + +___ + +### owner() + +▸ **owner()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStagedExpenditure.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 + +AugmentedStagedExpenditure.queryFilter + +___ + +### releaseStagedPayment + +▸ **releaseStagedPayment**(`_permissionDomainId`, `_childSkillIndex`, `_expenditureId`, `_slot`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_expenditureId` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_tokens` | `string`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.releaseStagedPayment + +___ + +### releaseStagedPayment(uint256,uint256,uint256,uint256,address[]) + +▸ **releaseStagedPayment(uint256,uint256,uint256,uint256,address[])**(`_permissionDomainId`, `_childSkillIndex`, `_expenditureId`, `_slot`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_expenditureId` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_tokens` | `string`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.releaseStagedPayment(uint256,uint256,uint256,uint256,address[]) + +___ + +### releaseStagedPaymentViaArbitration + +▸ **releaseStagedPaymentViaArbitration**(`_permissionDomainId`, `_childSkillIndex`, `_extensionPermissionDomainId`, `_extensionChildSkillIndex`, `_expenditureId`, `_slot`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_extensionPermissionDomainId` | `BigNumberish` | +| `_extensionChildSkillIndex` | `BigNumberish` | +| `_expenditureId` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_tokens` | `string`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.releaseStagedPaymentViaArbitration + +___ + +### releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[]) + +▸ **releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[])**(`_permissionDomainId`, `_childSkillIndex`, `_extensionPermissionDomainId`, `_extensionChildSkillIndex`, `_expenditureId`, `_slot`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_extensionPermissionDomainId` | `BigNumberish` | +| `_extensionChildSkillIndex` | `BigNumberish` | +| `_expenditureId` | `BigNumberish` | +| `_slot` | `BigNumberish` | +| `_tokens` | `string`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.releaseStagedPaymentViaArbitration(uint256,uint256,uint256,uint256,uint256,uint256,address[]) + +___ + +### removeAllListeners + +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StagedExpenditureClientV3`](StagedExpenditureClientV3.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TEvent` | extends `TypedEvent`<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFilter` | `TypedEventFilter`<`TEvent`\> | + +#### Returns + +[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md) + +#### Inherited from + +AugmentedStagedExpenditure.removeAllListeners + +▸ **removeAllListeners**(`eventName?`): [`StagedExpenditureClientV3`](StagedExpenditureClientV3.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +[`StagedExpenditureClientV3`](StagedExpenditureClientV3.md) + +#### Inherited from + +AugmentedStagedExpenditure.removeAllListeners + +___ + +### setAuthority + +▸ **setAuthority**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `authority_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.setAuthority + +___ + +### setAuthority(address) + +▸ **setAuthority(address)**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `authority_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.setAuthority(address) + +___ + +### setExpenditureStaged + +▸ **setExpenditureStaged**(`_expenditureId`, `_staged`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `_staged` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.setExpenditureStaged + +___ + +### setExpenditureStaged(uint256,bool) + +▸ **setExpenditureStaged(uint256,bool)**(`_expenditureId`, `_staged`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `_staged` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.setExpenditureStaged(uint256,bool) + +___ + +### setOwner + +▸ **setOwner**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.setOwner + +___ + +### setOwner(address) + +▸ **setOwner(address)**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.setOwner(address) + +___ + +### uninstall + +▸ **uninstall**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.uninstall + +___ + +### uninstall() + +▸ **uninstall()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStagedExpenditure.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 + +AugmentedStagedExpenditure.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 + +AugmentedStagedExpenditure.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) + +___ + +### version + +▸ **version**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStagedExpenditure.version + +___ + +### version() + +▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStagedExpenditure.version() diff --git a/packages/colony-js/docs/api/interfaces/StakedExpenditureClientV6.md b/packages/colony-js/docs/api/interfaces/StakedExpenditureClientV6.md new file mode 100644 index 000000000..00beea3d9 --- /dev/null +++ b/packages/colony-js/docs/api/interfaces/StakedExpenditureClientV6.md @@ -0,0 +1,1873 @@ +# Interface: StakedExpenditureClientV6 + +## Hierarchy + +- `AugmentedStakedExpenditure`<`StakedExpenditure`\> + + ↳ **`StakedExpenditureClientV6`** + +## Properties + +### \_deployedPromise + +• **\_deployedPromise**: `Promise`<`Contract`\> + +#### Inherited from + +AugmentedStakedExpenditure.\_deployedPromise + +___ + +### \_runningEvents + +• **\_runningEvents**: `Object` + +#### Index signature + +▪ [eventTag: `string`]: `RunningEvent` + +#### Inherited from + +AugmentedStakedExpenditure.\_runningEvents + +___ + +### \_wrappedEmits + +• **\_wrappedEmits**: `Object` + +#### Index signature + +▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` + +#### Inherited from + +AugmentedStakedExpenditure.\_wrappedEmits + +___ + +### address + +• `Readonly` **address**: `string` + +#### Inherited from + +AugmentedStakedExpenditure.address + +___ + +### callStatic + +• **callStatic**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `cancelAndPunish` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_punish`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `cancelAndPunish(uint256,uint256,uint256,uint256,uint256,bool)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_punish`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `cancelAndReclaimStake` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `cancelAndReclaimStake(uint256,uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `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`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `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`\> | +| `getStake` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StakeStructOutput`\> | +| `getStake(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`StakeStructOutput`\> | +| `getStakeFraction` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getStakeFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | +| `initialise` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `initialise(uint256)` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `install` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `install(address)` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `makeExpenditureWithStake` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `makeExpenditureWithStake(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `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`\> | +| `reclaimStake` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `reclaimStake(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setAuthority` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setAuthority(address)` | (`authority_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setOwner` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setOwner(address)` | (`owner_`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setStakeFraction` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setStakeFraction(uint256)` | (`_stakeFraction`: `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 + +AugmentedStakedExpenditure.callStatic + +___ + +### clientType + +• **clientType**: [`StakedExpenditureClient`](../enums/ClientType.md#stakedexpenditureclient) + +#### Inherited from + +AugmentedStakedExpenditure.clientType + +___ + +### clientVersion + +• **clientVersion**: ``6`` + +#### Overrides + +AugmentedStakedExpenditure.clientVersion + +___ + +### colonyClient + +• **colonyClient**: `AugmentedIColony`<`ValidColony`\> + +An instance of the corresponding ColonyClient + +#### Inherited from + +AugmentedStakedExpenditure.colonyClient + +___ + +### deployTransaction + +• `Readonly` **deployTransaction**: `TransactionResponse` + +#### Inherited from + +AugmentedStakedExpenditure.deployTransaction + +___ + +### estimateGas + +• **estimateGas**: `Object` + +#### Inherited from + +AugmentedStakedExpenditure.estimateGas + +___ + +### filters + +• **filters**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `ExpenditureCancelled` | (`agent?`: ``null``, `expenditureId?`: ``null``) => `ExpenditureCancelledEventFilter` | +| `ExpenditureCancelled(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null``) => `ExpenditureCancelledEventFilter` | +| `ExpenditureMadeViaStake` | (`creator?`: ``null`` \| `string`, `expenditureId?`: ``null``, `stake?`: ``null``) => `ExpenditureMadeViaStakeEventFilter` | +| `ExpenditureMadeViaStake(address,uint256,uint256)` | (`creator?`: ``null`` \| `string`, `expenditureId?`: ``null``, `stake?`: ``null``) => `ExpenditureMadeViaStakeEventFilter` | +| `ExpenditureStakerPunished` | (`agent?`: ``null``, `expenditureId?`: ``null``, `punished?`: ``null``) => `ExpenditureStakerPunishedEventFilter` | +| `ExpenditureStakerPunished(address,uint256,bool)` | (`agent?`: ``null``, `expenditureId?`: ``null``, `punished?`: ``null``) => `ExpenditureStakerPunishedEventFilter` | +| `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` | +| `StakeFractionSet` | (`agent?`: ``null``, `stakeFraction?`: ``null``) => `StakeFractionSetEventFilter` | +| `StakeFractionSet(address,uint256)` | (`agent?`: ``null``, `stakeFraction?`: ``null``) => `StakeFractionSetEventFilter` | +| `StakeReclaimed` | (`expenditureId?`: ``null``) => `StakeReclaimedEventFilter` | +| `StakeReclaimed(uint256)` | (`expenditureId?`: ``null``) => `StakeReclaimedEventFilter` | + +#### Inherited from + +AugmentedStakedExpenditure.filters + +___ + +### functions + +• **functions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `cancelAndPunish` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_punish`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `cancelAndPunish(uint256,uint256,uint256,uint256,uint256,bool)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_punish`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `cancelAndReclaimStake` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `cancelAndReclaimStake(uint256,uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `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`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `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` }\> | +| `getStake` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StakeStructOutput`] & { `stake`: `StakeStructOutput` }\> | +| `getStake(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`StakeStructOutput`] & { `stake`: `StakeStructOutput` }\> | +| `getStakeFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_stakeFraction`: `BigNumber` }\> | +| `getStakeFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_stakeFraction`: `BigNumber` }\> | +| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | +| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | +| `initialise` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `initialise(uint256)` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `makeExpenditureWithStake` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `makeExpenditureWithStake(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `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`]\> | +| `reclaimStake` | (`_expenditureId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `reclaimStake(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setAuthority(address)` | (`authority_`: `string`, `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`\> | +| `setStakeFraction` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setStakeFraction(uint256)` | (`_stakeFraction`: `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 + +AugmentedStakedExpenditure.functions + +___ + +### interface + +• **interface**: `StakedExpenditureInterface` + +#### Inherited from + +AugmentedStakedExpenditure.interface + +___ + +### off + +• **off**: `OnEvent`<[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md)\> + +#### Inherited from + +AugmentedStakedExpenditure.off + +___ + +### on + +• **on**: `OnEvent`<[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md)\> + +#### Inherited from + +AugmentedStakedExpenditure.on + +___ + +### once + +• **once**: `OnEvent`<[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md)\> + +#### Inherited from + +AugmentedStakedExpenditure.once + +___ + +### populateTransaction + +• **populateTransaction**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `authority` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `cancelAndPunish` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_punish`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `cancelAndPunish(uint256,uint256,uint256,uint256,uint256,bool)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_callerPermissionDomainId`: `BigNumberish`, `_callerChildSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `_punish`: `boolean`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `cancelAndReclaimStake` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `cancelAndReclaimStake(uint256,uint256,uint256)` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_expenditureId`: `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`\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `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`\> | +| `getStake` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getStake(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getStakeFraction` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getStakeFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `initialise` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `initialise(uint256)` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `makeExpenditureWithStake` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `makeExpenditureWithStake(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])` | (`_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_domainId`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `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`\> | +| `reclaimStake` | (`_expenditureId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `reclaimStake(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setAuthority` | (`authority_`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setAuthority(address)` | (`authority_`: `string`, `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`\> | +| `setStakeFraction` | (`_stakeFraction`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setStakeFraction(uint256)` | (`_stakeFraction`: `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 + +AugmentedStakedExpenditure.populateTransaction + +___ + +### provider + +• `Readonly` **provider**: `Provider` + +#### Inherited from + +AugmentedStakedExpenditure.provider + +___ + +### removeListener + +• **removeListener**: `OnEvent`<[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md)\> + +#### Inherited from + +AugmentedStakedExpenditure.removeListener + +___ + +### resolvedAddress + +• `Readonly` **resolvedAddress**: `Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.resolvedAddress + +___ + +### signer + +• `Readonly` **signer**: `Signer` + +#### Inherited from + +AugmentedStakedExpenditure.signer + +___ + +### stakedExpenditureEvents + +• **stakedExpenditureEvents**: `StakedExpenditureEvents` + +The stakedExpenditureEvents contract supports all events across all versions. +Isn't that amazing? +It's an ethers contract with only events to filter + +#### Inherited from + +AugmentedStakedExpenditure.stakedExpenditureEvents + +## Methods + +### \_checkRunningEvents + +▸ **_checkRunningEvents**(`runningEvent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `runningEvent` | `RunningEvent` | + +#### Returns + +`void` + +#### Inherited from + +AugmentedStakedExpenditure.\_checkRunningEvents + +___ + +### \_deployed + +▸ **_deployed**(`blockTag?`): `Promise`<`Contract`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`<`Contract`\> + +#### Inherited from + +AugmentedStakedExpenditure.\_deployed + +___ + +### \_wrapEvent + +▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): `Event` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `runningEvent` | `RunningEvent` | +| `log` | `Log` | +| `listener` | `Listener` | + +#### Returns + +`Event` + +#### Inherited from + +AugmentedStakedExpenditure.\_wrapEvent + +___ + +### attach + +▸ **attach**(`addressOrName`): [`StakedExpenditureClientV6`](StakedExpenditureClientV6.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `addressOrName` | `string` | + +#### Returns + +[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md) + +#### Inherited from + +AugmentedStakedExpenditure.attach + +___ + +### authority + +▸ **authority**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.authority + +___ + +### authority() + +▸ **authority()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.authority() + +___ + +### cancelAndPunish + +▸ **cancelAndPunish**(`_permissionDomainId`, `_childSkillIndex`, `_callerPermissionDomainId`, `_callerChildSkillIndex`, `_expenditureId`, `_punish`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_callerPermissionDomainId` | `BigNumberish` | +| `_callerChildSkillIndex` | `BigNumberish` | +| `_expenditureId` | `BigNumberish` | +| `_punish` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.cancelAndPunish + +___ + +### cancelAndPunish(uint256,uint256,uint256,uint256,uint256,bool) + +▸ **cancelAndPunish(uint256,uint256,uint256,uint256,uint256,bool)**(`_permissionDomainId`, `_childSkillIndex`, `_callerPermissionDomainId`, `_callerChildSkillIndex`, `_expenditureId`, `_punish`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_callerPermissionDomainId` | `BigNumberish` | +| `_callerChildSkillIndex` | `BigNumberish` | +| `_expenditureId` | `BigNumberish` | +| `_punish` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.cancelAndPunish(uint256,uint256,uint256,uint256,uint256,bool) + +___ + +### cancelAndPunishWithProofs + +▸ **cancelAndPunishWithProofs**(`_expenditureId`, `_punish`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as [cancelAndPunish](StakedExpenditureClientV6.md#cancelandpunish), 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 | +| :------ | :------ | :------ | +| `_expenditureId` | `BigNumberish` | The id of the expenditure | +| `_punish` | `boolean` | Whether the staker should be punished by losing an amount of reputation equal to the stake | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.cancelAndPunishWithProofs + +___ + +### cancelAndReclaimStake + +▸ **cancelAndReclaimStake**(`_permissionDomainId`, `_childSkillIndex`, `_expenditureId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.cancelAndReclaimStake + +___ + +### cancelAndReclaimStake(uint256,uint256,uint256) + +▸ **cancelAndReclaimStake(uint256,uint256,uint256)**(`_permissionDomainId`, `_childSkillIndex`, `_expenditureId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.cancelAndReclaimStake(uint256,uint256,uint256) + +___ + +### cancelAndReclaimStakeWithProofs + +▸ **cancelAndReclaimStakeWithProofs**(`_expenditureId`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as [cancelAndReclaimStake](StakedExpenditureClientV6.md#cancelandreclaimstake), 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 | +| :------ | :------ | :------ | +| `_expenditureId` | `BigNumberish` | The id of the expenditure | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.cancelAndReclaimStakeWithProofs + +___ + +### connect + +▸ **connect**(`signerOrProvider`): [`StakedExpenditureClientV6`](StakedExpenditureClientV6.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerOrProvider` | `string` \| `Signer` \| `Provider` | + +#### Returns + +[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md) + +#### Inherited from + +AugmentedStakedExpenditure.connect + +___ + +### deployed + +▸ **deployed**(): `Promise`<[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md)\> + +#### Returns + +`Promise`<[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md)\> + +#### Inherited from + +AugmentedStakedExpenditure.deployed + +___ + +### deprecate + +▸ **deprecate**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.deprecate + +___ + +### deprecate(bool) + +▸ **deprecate(bool)**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_deprecated` | `boolean` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.deprecate(bool) + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `EventFilter` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +AugmentedStakedExpenditure.emit + +___ + +### executeMetaTransaction + +▸ **executeMetaTransaction**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.executeMetaTransaction + +___ + +### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +___ + +### fallback + +▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `TransactionRequest` | + +#### Returns + +`Promise`<`TransactionResponse`\> + +#### Inherited from + +AugmentedStakedExpenditure.fallback + +___ + +### finishUpgrade + +▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.finishUpgrade + +___ + +### finishUpgrade() + +▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.finishUpgrade() + +___ + +### getCapabilityRoles + +▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.getCapabilityRoles + +___ + +### getCapabilityRoles(bytes4) + +▸ **getCapabilityRoles(bytes4)**(`_sig`, `overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_sig` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.getCapabilityRoles(bytes4) + +___ + +### getColony + +▸ **getColony**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.getColony + +___ + +### getColony() + +▸ **getColony()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.getColony() + +___ + +### getDeprecated + +▸ **getDeprecated**(`overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedStakedExpenditure.getDeprecated + +___ + +### getDeprecated() + +▸ **getDeprecated()**(`overrides?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +AugmentedStakedExpenditure.getDeprecated() + +___ + +### getMetatransactionNonce + +▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStakedExpenditure.getMetatransactionNonce + +___ + +### getMetatransactionNonce(address) + +▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStakedExpenditure.getMetatransactionNonce(address) + +___ + +### getStake + +▸ **getStake**(`_expenditureId`, `overrides?`): `Promise`<`StakeStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`StakeStructOutput`\> + +#### Inherited from + +AugmentedStakedExpenditure.getStake + +___ + +### getStake(uint256) + +▸ **getStake(uint256)**(`_expenditureId`, `overrides?`): `Promise`<`StakeStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`StakeStructOutput`\> + +#### Inherited from + +AugmentedStakedExpenditure.getStake(uint256) + +___ + +### getStakeFraction + +▸ **getStakeFraction**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStakedExpenditure.getStakeFraction + +___ + +### getStakeFraction() + +▸ **getStakeFraction()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStakedExpenditure.getStakeFraction() + +___ + +### identifier + +▸ **identifier**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.identifier + +___ + +### identifier() + +▸ **identifier()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.identifier() + +___ + +### initialise + +▸ **initialise**(`_stakeFraction`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_stakeFraction` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.initialise + +___ + +### initialise(uint256) + +▸ **initialise(uint256)**(`_stakeFraction`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_stakeFraction` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.initialise(uint256) + +___ + +### install + +▸ **install**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.install + +___ + +### install(address) + +▸ **install(address)**(`_colony`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.install(address) + +___ + +### listenerCount + +▸ **listenerCount**(`eventName?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` \| `EventFilter` | + +#### Returns + +`number` + +#### Inherited from + +AugmentedStakedExpenditure.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 + +AugmentedStakedExpenditure.listeners + +▸ **listeners**(`eventName?`): `Listener`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +`Listener`[] + +#### Inherited from + +AugmentedStakedExpenditure.listeners + +___ + +### makeExpenditureWithStake + +▸ **makeExpenditureWithStake**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.makeExpenditureWithStake + +___ + +### makeExpenditureWithStake(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[]) + +▸ **makeExpenditureWithStake(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])**(`_permissionDomainId`, `_childSkillIndex`, `_domainId`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_domainId` | `BigNumberish` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.makeExpenditureWithStake(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[]) + +___ + +### makeExpenditureWithStakeWithProofs + +▸ **makeExpenditureWithStakeWithProofs**(`_domainId`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> + +Same as [makeExpenditureWithStake](StakedExpenditureClientV6.md#makeexpenditurewithstake), 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 | +| `_key` | `BytesLike` | A reputation hash tree key, of the total reputation in _domainId | +| `_value` | `BytesLike` | Reputation value indicating the total reputation in _domainId | +| `_branchMask` | `BigNumberish` | The branchmask of the proof | +| `_siblings` | `BytesLike`[] | The siblings of the proof | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.makeExpenditureWithStakeWithProofs + +___ + +### multicall + +▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.multicall + +___ + +### multicall(bytes[]) + +▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.multicall(bytes[]) + +___ + +### owner + +▸ **owner**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.owner + +___ + +### owner() + +▸ **owner()**(`overrides?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +AugmentedStakedExpenditure.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 + +AugmentedStakedExpenditure.queryFilter + +___ + +### reclaimStake + +▸ **reclaimStake**(`_expenditureId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.reclaimStake + +___ + +### reclaimStake(uint256) + +▸ **reclaimStake(uint256)**(`_expenditureId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.reclaimStake(uint256) + +___ + +### removeAllListeners + +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StakedExpenditureClientV6`](StakedExpenditureClientV6.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TEvent` | extends `TypedEvent`<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFilter` | `TypedEventFilter`<`TEvent`\> | + +#### Returns + +[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md) + +#### Inherited from + +AugmentedStakedExpenditure.removeAllListeners + +▸ **removeAllListeners**(`eventName?`): [`StakedExpenditureClientV6`](StakedExpenditureClientV6.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +[`StakedExpenditureClientV6`](StakedExpenditureClientV6.md) + +#### Inherited from + +AugmentedStakedExpenditure.removeAllListeners + +___ + +### setAuthority + +▸ **setAuthority**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `authority_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.setAuthority + +___ + +### setAuthority(address) + +▸ **setAuthority(address)**(`authority_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `authority_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.setAuthority(address) + +___ + +### setOwner + +▸ **setOwner**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.setOwner + +___ + +### setOwner(address) + +▸ **setOwner(address)**(`owner_`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `owner_` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.setOwner(address) + +___ + +### setStakeFraction + +▸ **setStakeFraction**(`_stakeFraction`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_stakeFraction` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.setStakeFraction + +___ + +### setStakeFraction(uint256) + +▸ **setStakeFraction(uint256)**(`_stakeFraction`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_stakeFraction` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.setStakeFraction(uint256) + +___ + +### uninstall + +▸ **uninstall**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.uninstall + +___ + +### uninstall() + +▸ **uninstall()**(`overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedStakedExpenditure.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 + +AugmentedStakedExpenditure.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 + +AugmentedStakedExpenditure.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) + +___ + +### version + +▸ **version**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStakedExpenditure.version + +___ + +### version() + +▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStakedExpenditure.version() 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 63% rename from packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV4.md rename to packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV5.md index fb34b4b89..2c7208e8c 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,26 @@ ___ | 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`\> | +| `getAmountClaimableLifetime` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getAmountClaimableLifetime(uint256)` | (`_id`: `BigNumberish`, `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`\> | @@ -92,10 +92,10 @@ ___ | `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | | `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getNUnresolvedStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getNUnresolvedStreamingPayments()` | (`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 +114,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`, `_interval`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `_interval`: `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 +141,7 @@ ___ ### clientVersion -• **clientVersion**: ``4`` +• **clientVersion**: ``5`` #### Overrides @@ -173,7 +173,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`\> ; `getAmountClaimableLifetime`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getAmountClaimableLifetime(uint256)`: (`_id`: `BigNumberish`, `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`<`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`\> ; `getNUnresolvedStreamingPayments`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getNUnresolvedStreamingPayments()`: (`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`, `_interval`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `_interval`: `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`\> ; `getAmountClaimableLifetime`: (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getAmountClaimableLifetime(uint256)`: (`_id`: `BigNumberish`, `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`<`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`\> ; `getNUnresolvedStreamingPayments`: (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> ; `getNUnresolvedStreamingPayments()`: (`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`, `_interval`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> ; `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)`: (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `_interval`: `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`, `_interval`: `BigNumberish`, `overrides?`: [`TxOverrides`](../README.md#txoverrides)) => `Promise`<`BigNumber`\> } #### Inherited from @@ -189,6 +189,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 +201,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``, `interval?`: ``null``) => `PaymentTokenUpdatedEventFilter` | +| `PaymentTokenUpdated(address,uint256,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `amount?`: ``null``, `interval?`: ``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,38 +224,38 @@ ___ | 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` }\> | +| `getAmountClaimableLifetime` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `amount`: `BigNumber` }\> | +| `getAmountClaimableLifetime(uint256)` | (`_id`: `BigNumberish`, `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`]\> | | `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` }\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_nonce`: `BigNumber` }\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_nonce`: `BigNumber` }\> | +| `getNUnresolvedStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nUnresolvedPayments`: `BigNumber` }\> | +| `getNUnresolvedStreamingPayments()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nUnresolvedPayments`: `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 +274,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`, `_interval`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `_interval`: `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 +301,7 @@ ___ ### off -• **off**: `OnEvent`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +• **off**: `OnEvent`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -305,7 +311,7 @@ ___ ### on -• **on**: `OnEvent`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +• **on**: `OnEvent`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -315,7 +321,7 @@ ___ ### once -• **once**: `OnEvent`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +• **once**: `OnEvent`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -331,26 +337,26 @@ ___ | 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`\> | +| `getAmountClaimableLifetime` | (`_id`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getAmountClaimableLifetime(uint256)` | (`_id`: `BigNumberish`, `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`\> | @@ -359,10 +365,10 @@ ___ | `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getNUnresolvedStreamingPayments` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getNUnresolvedStreamingPayments()` | (`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 +387,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`, `_interval`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_fundingPermissionDomainId`: `BigNumberish`, `_fundingChildSkillIndex`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_fromChildSkillIndex`: `BigNumberish`, `_toChildSkillIndex`: `BigNumberish`, `_id`: `BigNumberish`, `_amount`: `BigNumberish`, `_interval`: `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 +414,7 @@ ___ ### removeListener -• **removeListener**: `OnEvent`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +• **removeListener**: `OnEvent`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -512,85 +518,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 +530,7 @@ ___ #### Returns -[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Inherited from @@ -696,14 +626,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 +645,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 +662,7 @@ ___ #### Inherited from -AugmentedStreamingPayments.cancelAndWaive(uint256,address[]) +AugmentedStreamingPayments.cancelAndWaive(uint256) ___ @@ -742,7 +670,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 +692,7 @@ ___ ### claim -▸ **claim**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_tokens`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **claim**(`_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -775,7 +703,6 @@ ___ | `_fromChildSkillIndex` | `BigNumberish` | | `_toChildSkillIndex` | `BigNumberish` | | `_id` | `BigNumberish` | -| `_tokens` | `string`[] | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -788,9 +715,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 +728,6 @@ ___ | `_fromChildSkillIndex` | `BigNumberish` | | `_toChildSkillIndex` | `BigNumberish` | | `_id` | `BigNumberish` | -| `_tokens` | `string`[] | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -810,15 +736,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 +752,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 +766,7 @@ ___ ### connect -▸ **connect**(`signerOrProvider`): [`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +▸ **connect**(`signerOrProvider`): [`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Parameters @@ -851,7 +776,7 @@ ___ #### Returns -[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Inherited from @@ -861,7 +786,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 +801,8 @@ ___ | `_endTime` | `BigNumberish` | | `_interval` | `BigNumberish` | | `_recipient` | `string` | -| `_tokens` | `string`[] | -| `_amounts` | `BigNumberish`[] | +| `_token` | `string` | +| `_amount` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -890,9 +815,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 +832,8 @@ ___ | `_endTime` | `BigNumberish` | | `_interval` | `BigNumberish` | | `_recipient` | `string` | -| `_tokens` | `string`[] | -| `_amounts` | `BigNumberish`[] | +| `_token` | `string` | +| `_amount` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -917,15 +842,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 +862,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 +878,11 @@ ___ ### deployed -▸ **deployed**(): `Promise`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +▸ **deployed**(): `Promise`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Returns -`Promise`<[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md)\> +`Promise`<[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md)\> #### Inherited from @@ -1138,16 +1063,57 @@ AugmentedStreamingPayments.finishUpgrade() ___ +### getAmountClaimableLifetime + +▸ **getAmountClaimableLifetime**(`_id`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStreamingPayments.getAmountClaimableLifetime + +___ + +### getAmountClaimableLifetime(uint256) + +▸ **getAmountClaimableLifetime(uint256)**(`_id`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_id` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedStreamingPayments.getAmountClaimableLifetime(uint256) + +___ + ### getAmountEntitledFromStart -▸ **getAmountEntitledFromStart**(`_id`, `_token`, `overrides?`): `Promise`<`BigNumber`\> +▸ **getAmountEntitledFromStart**(`_id`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | | `_id` | `BigNumberish` | -| `_token` | `string` | | `overrides?` | `CallOverrides` | #### Returns @@ -1160,16 +1126,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 +1143,7 @@ ___ #### Inherited from -AugmentedStreamingPayments.getAmountEntitledFromStart(uint256,address) +AugmentedStreamingPayments.getAmountEntitledFromStart(uint256) ___ @@ -1346,9 +1311,9 @@ AugmentedStreamingPayments.getMetatransactionNonce(address) ___ -### getNumStreamingPayments +### getNUnresolvedStreamingPayments -▸ **getNumStreamingPayments**(`overrides?`): `Promise`<`BigNumber`\> +▸ **getNUnresolvedStreamingPayments**(`overrides?`): `Promise`<`BigNumber`\> #### Parameters @@ -1362,13 +1327,13 @@ ___ #### Inherited from -AugmentedStreamingPayments.getNumStreamingPayments +AugmentedStreamingPayments.getNUnresolvedStreamingPayments ___ -### getNumStreamingPayments() +### getNUnresolvedStreamingPayments() -▸ **getNumStreamingPayments()**(`overrides?`): `Promise`<`BigNumber`\> +▸ **getNUnresolvedStreamingPayments()**(`overrides?`): `Promise`<`BigNumber`\> #### Parameters @@ -1382,51 +1347,47 @@ ___ #### Inherited from -AugmentedStreamingPayments.getNumStreamingPayments() +AugmentedStreamingPayments.getNUnresolvedStreamingPayments() ___ -### getPaymentToken +### getNumStreamingPayments -▸ **getPaymentToken**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> +▸ **getNumStreamingPayments**(`overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | -| `_id` | `BigNumberish` | -| `_token` | `string` | | `overrides?` | `CallOverrides` | #### Returns -`Promise`<`PaymentTokenStructOutput`\> +`Promise`<`BigNumber`\> #### Inherited from -AugmentedStreamingPayments.getPaymentToken +AugmentedStreamingPayments.getNumStreamingPayments ___ -### getPaymentToken(uint256,address) +### getNumStreamingPayments() -▸ **getPaymentToken(uint256,address)**(`_id`, `_token`, `overrides?`): `Promise`<`PaymentTokenStructOutput`\> +▸ **getNumStreamingPayments()**(`overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | -| `_id` | `BigNumberish` | -| `_token` | `string` | | `overrides?` | `CallOverrides` | #### Returns -`Promise`<`PaymentTokenStructOutput`\> +`Promise`<`BigNumber`\> #### Inherited from -AugmentedStreamingPayments.getPaymentToken(uint256,address) +AugmentedStreamingPayments.getNumStreamingPayments() ___ @@ -1728,7 +1689,7 @@ ___ ### removeAllListeners -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Type parameters @@ -1744,13 +1705,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 +1721,7 @@ AugmentedStreamingPayments.removeAllListeners #### Returns -[`StreamingPaymentsClientV4`](StreamingPaymentsClientV4.md) +[`StreamingPaymentsClientV5`](StreamingPaymentsClientV5.md) #### Inherited from @@ -1862,7 +1823,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 +1938,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 +1961,7 @@ ___ ### setTokenAmount -▸ **setTokenAmount**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **setTokenAmount**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_amount`, `_interval`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -2013,8 +1974,8 @@ ___ | `_fromChildSkillIndex` | `BigNumberish` | | `_toChildSkillIndex` | `BigNumberish` | | `_id` | `BigNumberish` | -| `_token` | `string` | | `_amount` | `BigNumberish` | +| `_interval` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2027,9 +1988,9 @@ AugmentedStreamingPayments.setTokenAmount ___ -### setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) +### setTokenAmount(uint256,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,uint256)**(`_fundingPermissionDomainId`, `_fundingChildSkillIndex`, `_permissionDomainId`, `_childSkillIndex`, `_fromChildSkillIndex`, `_toChildSkillIndex`, `_id`, `_amount`, `_interval`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters @@ -2042,8 +2003,8 @@ ___ | `_fromChildSkillIndex` | `BigNumberish` | | `_toChildSkillIndex` | `BigNumberish` | | `_id` | `BigNumberish` | -| `_token` | `string` | | `_amount` | `BigNumberish` | +| `_interval` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2052,15 +2013,15 @@ ___ #### Inherited from -AugmentedStreamingPayments.setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256) +AugmentedStreamingPayments.setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256) ___ ### setTokenAmountWithProofs -▸ **setTokenAmountWithProofs**(`_id`, `_token`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **setTokenAmountWithProofs**(`_id`, `_amount`, `_interval`, `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,8 +2029,8 @@ 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 | +| `_interval` | `BigNumberish` | - | | `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | #### Returns diff --git a/packages/colony-js/docs/api/interfaces/TokenLocking.md b/packages/colony-js/docs/api/interfaces/TokenLocking.md index f630abfee..da6dbfd30 100644 --- a/packages/colony-js/docs/api/interfaces/TokenLocking.md +++ b/packages/colony-js/docs/api/interfaces/TokenLocking.md @@ -82,8 +82,8 @@ ___ | `getApproval(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getColonyNetwork` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `getColonyNetwork()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getObligation` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getObligation(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTotalLockCount` | (`_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -159,8 +159,8 @@ ___ | `getApproval(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getColonyNetwork` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getColonyNetwork()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getObligation` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getObligation(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTotalLockCount` | (`_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -269,8 +269,8 @@ ___ | `getApproval(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | | `getColonyNetwork` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getColonyNetwork()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | | `getObligation` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | | `getObligation(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | | `getTotalLockCount` | (`_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | @@ -376,8 +376,8 @@ ___ | `getApproval(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getColonyNetwork` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getColonyNetwork()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getObligation` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getObligation(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getTotalLockCount` | (`_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -913,13 +913,13 @@ ___ ### getMetatransactionNonce -▸ **getMetatransactionNonce**(`userAddress`, `overrides?`): `Promise`<`BigNumber`\> +▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | -| `userAddress` | `string` | +| `_user` | `string` | | `overrides?` | `CallOverrides` | #### Returns @@ -930,13 +930,13 @@ ___ ### getMetatransactionNonce(address) -▸ **getMetatransactionNonce(address)**(`userAddress`, `overrides?`): `Promise`<`BigNumber`\> +▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | -| `userAddress` | `string` | +| `_user` | `string` | | `overrides?` | `CallOverrides` | #### Returns diff --git a/packages/colony-js/docs/api/interfaces/TokenLockingClient.md b/packages/colony-js/docs/api/interfaces/TokenLockingClient.md index 7f3f86bf3..8b0e8c743 100644 --- a/packages/colony-js/docs/api/interfaces/TokenLockingClient.md +++ b/packages/colony-js/docs/api/interfaces/TokenLockingClient.md @@ -80,8 +80,8 @@ ___ | `getApproval(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getColonyNetwork` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `getColonyNetwork()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getObligation` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getObligation(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTotalLockCount` | (`_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -163,8 +163,8 @@ ___ | `getApproval(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getColonyNetwork` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getColonyNetwork()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getObligation` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getObligation(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTotalLockCount` | (`_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -273,8 +273,8 @@ ___ | `getApproval(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | | `getColonyNetwork` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getColonyNetwork()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | | `getObligation` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | | `getObligation(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | | `getTotalLockCount` | (`_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | @@ -380,8 +380,8 @@ ___ | `getApproval(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getColonyNetwork` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getColonyNetwork()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getObligation` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getObligation(address,address,address)` | (`_user`: `string`, `_token`: `string`, `_obligator`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getTotalLockCount` | (`_token`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -981,13 +981,13 @@ ___ ### getMetatransactionNonce -▸ **getMetatransactionNonce**(`userAddress`, `overrides?`): `Promise`<`BigNumber`\> +▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | -| `userAddress` | `string` | +| `_user` | `string` | | `overrides?` | `CallOverrides` | #### Returns @@ -1002,13 +1002,13 @@ ___ ### getMetatransactionNonce(address) -▸ **getMetatransactionNonce(address)**(`userAddress`, `overrides?`): `Promise`<`BigNumber`\> +▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters | Name | Type | | :------ | :------ | -| `userAddress` | `string` | +| `_user` | `string` | | `overrides?` | `CallOverrides` | #### Returns diff --git a/packages/colony-js/docs/api/interfaces/TokenSupplierClientV2.md b/packages/colony-js/docs/api/interfaces/TokenSupplierClientV8.md similarity index 74% rename from packages/colony-js/docs/api/interfaces/TokenSupplierClientV2.md rename to packages/colony-js/docs/api/interfaces/TokenSupplierClientV8.md index ab02de112..ae92f53bd 100644 --- a/packages/colony-js/docs/api/interfaces/TokenSupplierClientV2.md +++ b/packages/colony-js/docs/api/interfaces/TokenSupplierClientV8.md @@ -1,10 +1,10 @@ -# Interface: TokenSupplierClientV2 +# Interface: TokenSupplierClientV8 ## Hierarchy - `AugmentedTokenSupplier`<`TokenSupplier`\> - ↳ **`TokenSupplierClientV2`** + ↳ **`TokenSupplierClientV8`** ## Properties @@ -68,6 +68,8 @@ ___ | `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `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`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | @@ -80,6 +82,8 @@ ___ | `getLastPinged()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getLastRateUpdate` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getLastRateUpdate()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTokenIssuanceRate` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTokenIssuanceRate()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTokenSupplyCeiling` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -92,6 +96,8 @@ ___ | `install(address)` | (`_colony`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `issueTokens` | (`overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `issueTokens()` | (`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`\> | @@ -104,6 +110,8 @@ ___ | `setTokenSupplyCeiling(uint256)` | (`_tokenSupplyCeiling`: `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`\> | @@ -125,7 +133,7 @@ ___ ### clientVersion -• **clientVersion**: ``2`` +• **clientVersion**: ``8`` #### Overrides @@ -167,6 +175,8 @@ ___ | `authority()` | (`overrides?`: `CallOverrides`) => `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`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -179,6 +189,8 @@ ___ | `getLastPinged()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getLastRateUpdate` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getLastRateUpdate()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTokenIssuanceRate` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTokenIssuanceRate()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTokenSupplyCeiling` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -191,6 +203,8 @@ ___ | `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> | | `issueTokens` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`BigNumber`\> | | `issueTokens()` | (`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`\> | @@ -203,6 +217,8 @@ ___ | `setTokenSupplyCeiling(uint256)` | (`_tokenSupplyCeiling`: `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`\> | @@ -226,6 +242,8 @@ ___ | `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` | | `TokenIssuanceRateSet` | (`tokenIssuanceRate?`: ``null``) => `TokenIssuanceRateSetEventFilter` | | `TokenIssuanceRateSet(uint256)` | (`tokenIssuanceRate?`: ``null``) => `TokenIssuanceRateSetEventFilter` | | `TokenSupplyCeilingSet` | (`tokenSupplyCeiling?`: ``null``) => `TokenSupplyCeilingSetEventFilter` | @@ -251,6 +269,8 @@ ___ | `authority()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `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`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | @@ -259,22 +279,26 @@ ___ | `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | | `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | | `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getLastPinged` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getLastPinged()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getLastRateUpdate` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getLastRateUpdate()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getTokenIssuanceRate` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getTokenIssuanceRate()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getTokenSupplyCeiling` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getTokenSupplyCeiling()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getLastPinged` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `lastPinged`: `BigNumber` }\> | +| `getLastPinged()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `lastPinged`: `BigNumber` }\> | +| `getLastRateUpdate` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `lastUpdate`: `BigNumber` }\> | +| `getLastRateUpdate()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `lastUpdate`: `BigNumber` }\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_nonce`: `BigNumber` }\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_nonce`: `BigNumber` }\> | +| `getTokenIssuanceRate` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `issuanceRate`: `BigNumber` }\> | +| `getTokenIssuanceRate()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `issuanceRate`: `BigNumber` }\> | +| `getTokenSupplyCeiling` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `supplyCeiling`: `BigNumber` }\> | +| `getTokenSupplyCeiling()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `supplyCeiling`: `BigNumber` }\> | +| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | +| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }\> | | `initialise` | (`_tokenSupplyCeiling`: `BigNumberish`, `_tokenIssuanceRate`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `initialise(uint256,uint256)` | (`_tokenSupplyCeiling`: `BigNumberish`, `_tokenIssuanceRate`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `install` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `issueTokens` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `issueTokens()` | (`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`\> | @@ -287,8 +311,10 @@ ___ | `setTokenSupplyCeiling(uint256)` | (`_tokenSupplyCeiling`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `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 @@ -308,7 +334,7 @@ ___ ### off -• **off**: `OnEvent`<[`TokenSupplierClientV2`](TokenSupplierClientV2.md)\> +• **off**: `OnEvent`<[`TokenSupplierClientV8`](TokenSupplierClientV8.md)\> #### Inherited from @@ -318,7 +344,7 @@ ___ ### on -• **on**: `OnEvent`<[`TokenSupplierClientV2`](TokenSupplierClientV2.md)\> +• **on**: `OnEvent`<[`TokenSupplierClientV8`](TokenSupplierClientV8.md)\> #### Inherited from @@ -328,7 +354,7 @@ ___ ### once -• **once**: `OnEvent`<[`TokenSupplierClientV2`](TokenSupplierClientV2.md)\> +• **once**: `OnEvent`<[`TokenSupplierClientV8`](TokenSupplierClientV8.md)\> #### Inherited from @@ -348,6 +374,8 @@ ___ | `authority()` | (`overrides?`: `CallOverrides`) => `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`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -360,6 +388,8 @@ ___ | `getLastPinged()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getLastRateUpdate` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getLastRateUpdate()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMetatransactionNonce` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getMetatransactionNonce(address)` | (`_user`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getTokenIssuanceRate` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getTokenIssuanceRate()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getTokenSupplyCeiling` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -372,6 +402,8 @@ ___ | `install(address)` | (`_colony`: `string`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `issueTokens` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `issueTokens()` | (`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`\> | @@ -384,6 +416,8 @@ ___ | `setTokenSupplyCeiling(uint256)` | (`_tokenSupplyCeiling`: `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`\> | @@ -405,7 +439,7 @@ ___ ### removeListener -• **removeListener**: `OnEvent`<[`TokenSupplierClientV2`](TokenSupplierClientV2.md)\> +• **removeListener**: `OnEvent`<[`TokenSupplierClientV8`](TokenSupplierClientV8.md)\> #### Inherited from @@ -511,7 +545,7 @@ ___ ### attach -▸ **attach**(`addressOrName`): [`TokenSupplierClientV2`](TokenSupplierClientV2.md) +▸ **attach**(`addressOrName`): [`TokenSupplierClientV8`](TokenSupplierClientV8.md) #### Parameters @@ -521,7 +555,7 @@ ___ #### Returns -[`TokenSupplierClientV2`](TokenSupplierClientV2.md) +[`TokenSupplierClientV8`](TokenSupplierClientV8.md) #### Inherited from @@ -571,7 +605,7 @@ ___ ### connect -▸ **connect**(`signerOrProvider`): [`TokenSupplierClientV2`](TokenSupplierClientV2.md) +▸ **connect**(`signerOrProvider`): [`TokenSupplierClientV8`](TokenSupplierClientV8.md) #### Parameters @@ -581,7 +615,7 @@ ___ #### Returns -[`TokenSupplierClientV2`](TokenSupplierClientV2.md) +[`TokenSupplierClientV8`](TokenSupplierClientV8.md) #### Inherited from @@ -591,11 +625,11 @@ ___ ### deployed -▸ **deployed**(): `Promise`<[`TokenSupplierClientV2`](TokenSupplierClientV2.md)\> +▸ **deployed**(): `Promise`<[`TokenSupplierClientV8`](TokenSupplierClientV8.md)\> #### Returns -`Promise`<[`TokenSupplierClientV2`](TokenSupplierClientV2.md)\> +`Promise`<[`TokenSupplierClientV8`](TokenSupplierClientV8.md)\> #### Inherited from @@ -607,8 +641,6 @@ ___ ▸ **deprecate**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> -Called when deprecating (or undeprecating) the extension (currently a no-op) - #### Parameters | Name | Type | @@ -630,8 +662,6 @@ ___ ▸ **deprecate(bool)**(`_deprecated`, `overrides?`): `Promise`<`ContractTransaction`\> -Called when deprecating (or undeprecating) the extension (currently a no-op) - #### Parameters | Name | Type | @@ -670,6 +700,56 @@ AugmentedTokenSupplier.emit ___ +### executeMetaTransaction + +▸ **executeMetaTransaction**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedTokenSupplier.executeMetaTransaction + +___ + +### executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +▸ **executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)**(`_user`, `_payload`, `_sigR`, `_sigS`, `_sigV`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `_payload` | `BytesLike` | +| `_sigR` | `BytesLike` | +| `_sigS` | `BytesLike` | +| `_sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedTokenSupplier.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8) + +___ + ### fallback ▸ **fallback**(`overrides?`): `Promise`<`TransactionResponse`\> @@ -694,8 +774,6 @@ ___ ▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> -Called when upgrading the extension (currently a no-op) - #### Parameters | Name | Type | @@ -716,8 +794,6 @@ ___ ▸ **finishUpgrade()**(`overrides?`): `Promise`<`ContractTransaction`\> -Called when upgrading the extension (currently a no-op) - #### Parameters | Name | Type | @@ -936,6 +1012,48 @@ AugmentedTokenSupplier.getLastRateUpdate() ___ +### getMetatransactionNonce + +▸ **getMetatransactionNonce**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedTokenSupplier.getMetatransactionNonce + +___ + +### getMetatransactionNonce(address) + +▸ **getMetatransactionNonce(address)**(`_user`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_user` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedTokenSupplier.getMetatransactionNonce(address) + +___ + ### getTokenIssuanceRate ▸ **getTokenIssuanceRate**(`overrides?`): `Promise`<`BigNumber`\> @@ -1020,8 +1138,6 @@ ___ ▸ **identifier**(`overrides?`): `Promise`<`string`\> -Returns the identifier of the extension - #### Parameters | Name | Type | @@ -1042,8 +1158,6 @@ ___ ▸ **identifier()**(`overrides?`): `Promise`<`string`\> -Returns the identifier of the extension - #### Parameters | Name | Type | @@ -1064,15 +1178,13 @@ ___ ▸ **initialise**(`_tokenSupplyCeiling`, `_tokenIssuanceRate`, `overrides?`): `Promise`<`ContractTransaction`\> -Initialise the extension, must be called before any tokens can be issued - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_tokenSupplyCeiling` | `BigNumberish` | Total amount of tokens to issue | -| `_tokenIssuanceRate` | `BigNumberish` | Number of tokens to issue per day | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_tokenSupplyCeiling` | `BigNumberish` | +| `_tokenIssuanceRate` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1088,15 +1200,13 @@ ___ ▸ **initialise(uint256,uint256)**(`_tokenSupplyCeiling`, `_tokenIssuanceRate`, `overrides?`): `Promise`<`ContractTransaction`\> -Initialise the extension, must be called before any tokens can be issued - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_tokenSupplyCeiling` | `BigNumberish` | Total amount of tokens to issue | -| `_tokenIssuanceRate` | `BigNumberish` | Number of tokens to issue per day | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_tokenSupplyCeiling` | `BigNumberish` | +| `_tokenIssuanceRate` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1112,14 +1222,12 @@ ___ ▸ **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` } | - | +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1135,14 +1243,12 @@ ___ ▸ **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` } | - | +| Name | Type | +| :------ | :------ | +| `_colony` | `string` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1158,8 +1264,6 @@ ___ ▸ **issueTokens**(`overrides?`): `Promise`<`ContractTransaction`\> -Issue the appropriate amount of tokens - #### Parameters | Name | Type | @@ -1180,8 +1284,6 @@ ___ ▸ **issueTokens()**(`overrides?`): `Promise`<`ContractTransaction`\> -Issue the appropriate amount of tokens - #### Parameters | Name | Type | @@ -1260,6 +1362,48 @@ AugmentedTokenSupplier.listeners ___ +### multicall + +▸ **multicall**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedTokenSupplier.multicall + +___ + +### multicall(bytes[]) + +▸ **multicall(bytes[])**(`data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedTokenSupplier.multicall(bytes[]) + +___ + ### owner ▸ **owner**(`overrides?`): `Promise`<`string`\> @@ -1330,7 +1474,7 @@ ___ ### removeAllListeners -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`TokenSupplierClientV2`](TokenSupplierClientV2.md) +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`TokenSupplierClientV8`](TokenSupplierClientV8.md) #### Type parameters @@ -1346,13 +1490,13 @@ ___ #### Returns -[`TokenSupplierClientV2`](TokenSupplierClientV2.md) +[`TokenSupplierClientV8`](TokenSupplierClientV8.md) #### Inherited from AugmentedTokenSupplier.removeAllListeners -▸ **removeAllListeners**(`eventName?`): [`TokenSupplierClientV2`](TokenSupplierClientV2.md) +▸ **removeAllListeners**(`eventName?`): [`TokenSupplierClientV8`](TokenSupplierClientV8.md) #### Parameters @@ -1362,7 +1506,7 @@ AugmentedTokenSupplier.removeAllListeners #### Returns -[`TokenSupplierClientV2`](TokenSupplierClientV2.md) +[`TokenSupplierClientV8`](TokenSupplierClientV8.md) #### Inherited from @@ -1458,14 +1602,12 @@ ___ ▸ **setTokenIssuanceRate**(`_tokenIssuanceRate`, `overrides?`): `Promise`<`ContractTransaction`\> -Update the tokenIssuanceRate - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_tokenIssuanceRate` | `BigNumberish` | Number of tokens to issue per day | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_tokenIssuanceRate` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1481,14 +1623,12 @@ ___ ▸ **setTokenIssuanceRate(uint256)**(`_tokenIssuanceRate`, `overrides?`): `Promise`<`ContractTransaction`\> -Update the tokenIssuanceRate - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_tokenIssuanceRate` | `BigNumberish` | Number of tokens to issue per day | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_tokenIssuanceRate` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1504,14 +1644,12 @@ ___ ▸ **setTokenSupplyCeiling**(`_tokenSupplyCeiling`, `overrides?`): `Promise`<`ContractTransaction`\> -Update the tokenSupplyCeiling, cannot set below current tokenSupply - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_tokenSupplyCeiling` | `BigNumberish` | Total amount of tokens to issue | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_tokenSupplyCeiling` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1527,14 +1665,12 @@ ___ ▸ **setTokenSupplyCeiling(uint256)**(`_tokenSupplyCeiling`, `overrides?`): `Promise`<`ContractTransaction`\> -Update the tokenSupplyCeiling, cannot set below current tokenSupply - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_tokenSupplyCeiling` | `BigNumberish` | Total amount of tokens to issue | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_tokenSupplyCeiling` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1550,8 +1686,6 @@ ___ ▸ **uninstall**(`overrides?`): `Promise`<`ContractTransaction`\> -Called when uninstalling the extension - #### Parameters | Name | Type | @@ -1572,8 +1706,6 @@ ___ ▸ **uninstall()**(`overrides?`): `Promise`<`ContractTransaction`\> -Called when uninstalling the extension - #### Parameters | Name | Type | @@ -1590,12 +1722,64 @@ AugmentedTokenSupplier.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 + +AugmentedTokenSupplier.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 + +AugmentedTokenSupplier.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8) + +___ + ### version ▸ **version**(`overrides?`): `Promise`<`BigNumber`\> -Returns the version of the extension - #### Parameters | Name | Type | @@ -1616,8 +1800,6 @@ ___ ▸ **version()**(`overrides?`): `Promise`<`BigNumber`\> -Returns the version of the extension - #### Parameters | Name | Type | diff --git a/packages/colony-js/docs/api/interfaces/VotingReputationClientV6.md b/packages/colony-js/docs/api/interfaces/VotingReputationClientV12.md similarity index 70% rename from packages/colony-js/docs/api/interfaces/VotingReputationClientV6.md rename to packages/colony-js/docs/api/interfaces/VotingReputationClientV12.md index 7fd623c6e..eede2a8af 100644 --- a/packages/colony-js/docs/api/interfaces/VotingReputationClientV6.md +++ b/packages/colony-js/docs/api/interfaces/VotingReputationClientV12.md @@ -1,4 +1,4 @@ -# Interface: VotingReputationClientV6 +# Interface: VotingReputationClientV12 ## Hierarchy @@ -6,9 +6,9 @@ - `AugmentsV2`<`IVotingReputation`\> -- `CreateDomainMotionAugments`<`IVotingReputation`\> +- `AugmentsV3`<`IVotingReputation`\> - ↳ **`VotingReputationClientV6`** + ↳ **`VotingReputationClientV12`** ## Properties @@ -72,14 +72,8 @@ ___ | `claimMisalignedReward(uint256,uint256,uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `claimReward` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `claimReward(uint256,uint256,uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `createClaimDelayAction` | (`action`: `BytesLike`, `value`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `createClaimDelayAction(bytes,uint256)` | (`action`: `BytesLike`, `value`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | -| `createDomainMotion` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `createMotion` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `createRootMotion` | (`_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | -| `createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])` | (`_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `deprecate` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `deprecate(bool)` | (`_deprecated`: `boolean`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `escalateMotion` | (`_motionId`: `BigNumberish`, `_newDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | @@ -90,8 +84,12 @@ ___ | `failingExecutionAllowed(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`boolean`\> | | `finalizeMotion` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `finalizeMotion(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `finalizeMotionWithoutFailure` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | +| `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`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | @@ -102,8 +100,12 @@ ___ | `getEscalationPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getExpenditureMotionCount` | (`_structHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getExpenditureMotionCount(bytes32)` | (`_structHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getExpenditurePastVote` | (`_actionHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getExpenditurePastVote(bytes32)` | (`_actionHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getExpenditureMotionLock` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getExpenditureMotionLock(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getExpenditurePastVote` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getExpenditurePastVote(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getExpenditurePastVotes_DEPRECATED` | (`_slotSignature`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | +| `getExpenditurePastVotes_DEPRECATED(bytes32)` | (`_slotSignature`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getMaxVoteFraction` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getMaxVoteFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -120,8 +122,8 @@ ___ | `getStake(uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getStakePeriod` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getStakePeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getStakerReward` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`]\> | -| `getStakerReward(uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`]\> | +| `getStakerReward` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`] & { `_penalty`: `BigNumber` ; `_reward`: `BigNumber` }\> | +| `getStakerReward(uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`] & { `_penalty`: `BigNumber` ; `_reward`: `BigNumber` }\> | | `getSubmitPeriod` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getSubmitPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getTotalStakeFraction` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | @@ -132,14 +134,16 @@ ___ | `getVoterReward(uint256,uint256)` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getVoterRewardFraction` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | | `getVoterRewardFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`\> | -| `getVoterRewardRange` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `_voterAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`]\> | -| `getVoterRewardRange(uint256,uint256,address)` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `_voterAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`]\> | +| `getVoterRewardRange` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `_voterAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`] & { `_rewardMax`: `BigNumber` ; `_rewardMin`: `BigNumber` }\> | +| `getVoterRewardRange(uint256,uint256,address)` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `_voterAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`] & { `_rewardMax`: `BigNumber` ; `_rewardMin`: `BigNumber` }\> | | `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<`string`\> | | `initialise` | (`_totalStakeFraction`: `BigNumberish`, `_voterRewardFraction`: `BigNumberish`, `_userMinStakeFraction`: `BigNumberish`, `_maxVoteFraction`: `BigNumberish`, `_stakePeriod`: `BigNumberish`, `_submitPeriod`: `BigNumberish`, `_revealPeriod`: `BigNumberish`, `_escalationPeriod`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_totalStakeFraction`: `BigNumberish`, `_voterRewardFraction`: `BigNumberish`, `_userMinStakeFraction`: `BigNumberish`, `_maxVoteFraction`: `BigNumberish`, `_stakePeriod`: `BigNumberish`, `_submitPeriod`: `BigNumberish`, `_revealPeriod`: `BigNumberish`, `_escalationPeriod`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `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`[]\> | | `revealVote` | (`_motionId`: `BigNumberish`, `_salt`: `BytesLike`, `_vote`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])` | (`_motionId`: `BigNumberish`, `_salt`: `BytesLike`, `_vote`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | | `stakeMotion` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_vote`: `BigNumberish`, `_amount`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `CallOverrides`) => `Promise`<`void`\> | @@ -169,7 +173,7 @@ ___ ### clientVersion -• **clientVersion**: ``6`` +• **clientVersion**: ``12`` #### Overrides @@ -254,74 +258,78 @@ ___ | `claimMisalignedReward(uint256,uint256,uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `claimReward` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `claimReward(uint256,uint256,uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `createClaimDelayAction` | (`action`: `BytesLike`, `value`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `createClaimDelayAction(bytes,uint256)` | (`action`: `BytesLike`, `value`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `createDomainMotion` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `createMotion` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `createRootMotion` | (`_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])` | (`_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `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`\> | | `escalateMotion` | (`_motionId`: `BigNumberish`, `_newDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `escalateMotion(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])` | (`_motionId`: `BigNumberish`, `_newDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `executeMetaTransaction` | (`userAddress`: `string`, `payload`: `BytesLike`, `sigR`: `BytesLike`, `sigS`: `BytesLike`, `sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)` | (`userAddress`: `string`, `payload`: `BytesLike`, `sigR`: `BytesLike`, `sigS`: `BytesLike`, `sigV`: `BigNumberish`, `overrides?`: `PayableOverrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `failingExecutionAllowed` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `failingExecutionAllowed(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | +| `failingExecutionAllowed` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`] & { `_allowed`: `boolean` }\> | +| `failingExecutionAllowed(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`] & { `_allowed`: `boolean` }\> | | `finalizeMotion` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `finalizeMotion(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `finalizeMotionWithoutFailure` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | +| `finalizeMotionWithoutFailure(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `finishUpgrade` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `finishUpgrade()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]\> | -| `getEscalationPeriod` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getEscalationPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getExpenditureMotionCount` | (`_structHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getExpenditureMotionCount(bytes32)` | (`_structHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getExpenditurePastVote` | (`_actionHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getExpenditurePastVote(bytes32)` | (`_actionHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getMaxVoteFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getMaxVoteFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `getActionSummary` | (`_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`ActionSummaryStructOutput`] & { `_summary`: `ActionSummaryStructOutput` }\> | +| `getActionSummary(bytes,address)` | (`_action`: `BytesLike`, `_altTarget`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`ActionSummaryStructOutput`] & { `_summary`: `ActionSummaryStructOutput` }\> | +| `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `roles`: `string` }\> | +| `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `roles`: `string` }\> | +| `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `colony`: `string` }\> | +| `getColony()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `colony`: `string` }\> | +| `getDeprecated` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`] & { `deprecated`: `boolean` }\> | +| `getDeprecated()` | (`overrides?`: `CallOverrides`) => `Promise`<[`boolean`] & { `deprecated`: `boolean` }\> | +| `getEscalationPeriod` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_period`: `BigNumber` }\> | +| `getEscalationPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_period`: `BigNumber` }\> | +| `getExpenditureMotionCount` | (`_structHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_count`: `BigNumber` }\> | +| `getExpenditureMotionCount(bytes32)` | (`_structHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_count`: `BigNumber` }\> | +| `getExpenditureMotionLock` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_motionId`: `BigNumber` }\> | +| `getExpenditureMotionLock(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_motionId`: `BigNumber` }\> | +| `getExpenditurePastVote` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_vote`: `BigNumber` }\> | +| `getExpenditurePastVote(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_vote`: `BigNumber` }\> | +| `getExpenditurePastVotes_DEPRECATED` | (`_slotSignature`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_vote`: `BigNumber` }\> | +| `getExpenditurePastVotes_DEPRECATED(bytes32)` | (`_slotSignature`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_vote`: `BigNumber` }\> | +| `getMaxVoteFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_fraction`: `BigNumber` }\> | +| `getMaxVoteFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_fraction`: `BigNumber` }\> | | `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | | `getMetatransactionNonce(address)` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }\> | -| `getMotion` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`MotionStructOutput`] & { `motion`: `MotionStructOutput` }\> | -| `getMotion(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`MotionStructOutput`] & { `motion`: `MotionStructOutput` }\> | -| `getMotionCount` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getMotionCount()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getMotionState` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`number`]\> | -| `getMotionState(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`number`]\> | -| `getRevealPeriod` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getRevealPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getStake` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getStake(uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getStakePeriod` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getStakePeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getStakerReward` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`]\> | -| `getStakerReward(uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`]\> | -| `getSubmitPeriod` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getSubmitPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getTotalStakeFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getTotalStakeFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getUserMinStakeFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getUserMinStakeFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getVoterReward` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getVoterReward(uint256,uint256)` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getVoterRewardFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getVoterRewardFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `getVoterRewardRange` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `_voterAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`]\> | -| `getVoterRewardRange(uint256,uint256,address)` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `_voterAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`]\> | -| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | -| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`]\> | +| `getMotion` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`MotionStructOutput`] & { `_motion`: `MotionStructOutput` }\> | +| `getMotion(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`MotionStructOutput`] & { `_motion`: `MotionStructOutput` }\> | +| `getMotionCount` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_count`: `BigNumber` }\> | +| `getMotionCount()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_count`: `BigNumber` }\> | +| `getMotionState` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`number`] & { `_motionState`: `number` }\> | +| `getMotionState(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`number`] & { `_motionState`: `number` }\> | +| `getRevealPeriod` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_period`: `BigNumber` }\> | +| `getRevealPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_period`: `BigNumber` }\> | +| `getStake` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_stake`: `BigNumber` }\> | +| `getStake(uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_stake`: `BigNumber` }\> | +| `getStakePeriod` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_period`: `BigNumber` }\> | +| `getStakePeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_period`: `BigNumber` }\> | +| `getStakerReward` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`] & { `_penalty`: `BigNumber` ; `_reward`: `BigNumber` }\> | +| `getStakerReward(uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`] & { `_penalty`: `BigNumber` ; `_reward`: `BigNumber` }\> | +| `getSubmitPeriod` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_period`: `BigNumber` }\> | +| `getSubmitPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_period`: `BigNumber` }\> | +| `getTotalStakeFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_fraction`: `BigNumber` }\> | +| `getTotalStakeFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_fraction`: `BigNumber` }\> | +| `getUserMinStakeFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_fraction`: `BigNumber` }\> | +| `getUserMinStakeFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_fraction`: `BigNumber` }\> | +| `getVoterReward` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_reward`: `BigNumber` }\> | +| `getVoterReward(uint256,uint256)` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_reward`: `BigNumber` }\> | +| `getVoterRewardFraction` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_fraction`: `BigNumber` }\> | +| `getVoterRewardFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_fraction`: `BigNumber` }\> | +| `getVoterRewardRange` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `_voterAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`] & { `_rewardMax`: `BigNumber` ; `_rewardMin`: `BigNumber` }\> | +| `getVoterRewardRange(uint256,uint256,address)` | (`_motionId`: `BigNumberish`, `_voterRep`: `BigNumberish`, `_voterAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`, `BigNumber`] & { `_rewardMax`: `BigNumber` ; `_rewardMin`: `BigNumber` }\> | +| `identifier` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `identifier`: `string` }\> | +| `identifier()` | (`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `identifier`: `string` }\> | | `initialise` | (`_totalStakeFraction`: `BigNumberish`, `_voterRewardFraction`: `BigNumberish`, `_userMinStakeFraction`: `BigNumberish`, `_maxVoteFraction`: `BigNumberish`, `_stakePeriod`: `BigNumberish`, `_submitPeriod`: `BigNumberish`, `_revealPeriod`: `BigNumberish`, `_escalationPeriod`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_totalStakeFraction`: `BigNumberish`, `_voterRewardFraction`: `BigNumberish`, `_userMinStakeFraction`: `BigNumberish`, `_maxVoteFraction`: `BigNumberish`, `_stakePeriod`: `BigNumberish`, `_submitPeriod`: `BigNumberish`, `_revealPeriod`: `BigNumberish`, `_escalationPeriod`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `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`\> | | `revealVote` | (`_motionId`: `BigNumberish`, `_salt`: `BytesLike`, `_vote`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])` | (`_motionId`: `BigNumberish`, `_salt`: `BytesLike`, `_vote`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `stakeMotion` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_vote`: `BigNumberish`, `_amount`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | @@ -330,8 +338,8 @@ ___ | `submitVote(uint256,bytes32,bytes,bytes,uint256,bytes32[])` | (`_motionId`: `BigNumberish`, `_voteSecret`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `uninstall` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | | `uninstall()` | (`overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`ContractTransaction`\> | -| `version` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | -| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]\> | +| `version` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `version`: `BigNumber` }\> | +| `version()` | (`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `version`: `BigNumber` }\> | #### Inherited from @@ -351,7 +359,7 @@ ___ ### off -• **off**: `OnEvent`<[`VotingReputationClientV6`](VotingReputationClientV6.md)\> +• **off**: `OnEvent`<[`VotingReputationClientV12`](VotingReputationClientV12.md)\> #### Inherited from @@ -361,7 +369,7 @@ ___ ### on -• **on**: `OnEvent`<[`VotingReputationClientV6`](VotingReputationClientV6.md)\> +• **on**: `OnEvent`<[`VotingReputationClientV12`](VotingReputationClientV12.md)\> #### Inherited from @@ -371,7 +379,7 @@ ___ ### once -• **once**: `OnEvent`<[`VotingReputationClientV6`](VotingReputationClientV6.md)\> +• **once**: `OnEvent`<[`VotingReputationClientV12`](VotingReputationClientV12.md)\> #### Inherited from @@ -391,14 +399,8 @@ ___ | `claimMisalignedReward(uint256,uint256,uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `claimReward` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `claimReward(uint256,uint256,uint256,address,uint256)` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_staker`: `string`, `_vote`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `createClaimDelayAction` | (`action`: `BytesLike`, `value`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `createClaimDelayAction(bytes,uint256)` | (`action`: `BytesLike`, `value`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `createDomainMotion` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `createMotion` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])` | (`_domainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `createRootMotion` | (`_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | -| `createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])` | (`_altTarget`: `string`, `_action`: `BytesLike`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `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`\> | | `escalateMotion` | (`_motionId`: `BigNumberish`, `_newDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | @@ -409,8 +411,12 @@ ___ | `failingExecutionAllowed(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `finalizeMotion` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `finalizeMotion(uint256)` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `finalizeMotionWithoutFailure` | (`_motionId`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | +| `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`\> | | `getCapabilityRoles` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getCapabilityRoles(bytes4)` | (`_sig`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getColony` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -421,8 +427,12 @@ ___ | `getEscalationPeriod()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getExpenditureMotionCount` | (`_structHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getExpenditureMotionCount(bytes32)` | (`_structHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getExpenditurePastVote` | (`_actionHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | -| `getExpenditurePastVote(bytes32)` | (`_actionHash`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getExpenditureMotionLock` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getExpenditureMotionLock(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getExpenditurePastVote` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getExpenditurePastVote(uint256)` | (`_expenditureId`: `BigNumberish`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getExpenditurePastVotes_DEPRECATED` | (`_slotSignature`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | +| `getExpenditurePastVotes_DEPRECATED(bytes32)` | (`_slotSignature`: `BytesLike`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getMaxVoteFraction` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getMaxVoteFraction()` | (`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | | `getMetatransactionNonce` | (`userAddress`: `string`, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`\> | @@ -459,6 +469,8 @@ ___ | `initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)` | (`_totalStakeFraction`: `BigNumberish`, `_voterRewardFraction`: `BigNumberish`, `_userMinStakeFraction`: `BigNumberish`, `_maxVoteFraction`: `BigNumberish`, `_stakePeriod`: `BigNumberish`, `_submitPeriod`: `BigNumberish`, `_revealPeriod`: `BigNumberish`, `_escalationPeriod`: `BigNumberish`, `overrides?`: `Overrides` & { `from?`: `string` }) => `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`\> | | `revealVote` | (`_motionId`: `BigNumberish`, `_salt`: `BytesLike`, `_vote`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])` | (`_motionId`: `BigNumberish`, `_salt`: `BytesLike`, `_vote`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | | `stakeMotion` | (`_motionId`: `BigNumberish`, `_permissionDomainId`: `BigNumberish`, `_childSkillIndex`: `BigNumberish`, `_vote`: `BigNumberish`, `_amount`: `BigNumberish`, `_key`: `BytesLike`, `_value`: `BytesLike`, `_branchMask`: `BigNumberish`, `_siblings`: `BytesLike`[], `overrides?`: `Overrides` & { `from?`: `string` }) => `Promise`<`PopulatedTransaction`\> | @@ -488,7 +500,7 @@ ___ ### removeListener -• **removeListener**: `OnEvent`<[`VotingReputationClientV6`](VotingReputationClientV6.md)\> +• **removeListener**: `OnEvent`<[`VotingReputationClientV12`](VotingReputationClientV12.md)\> #### Inherited from @@ -594,7 +606,7 @@ ___ ### attach -▸ **attach**(`addressOrName`): [`VotingReputationClientV6`](VotingReputationClientV6.md) +▸ **attach**(`addressOrName`): [`VotingReputationClientV12`](VotingReputationClientV12.md) #### Parameters @@ -604,7 +616,7 @@ ___ #### Returns -[`VotingReputationClientV6`](VotingReputationClientV6.md) +[`VotingReputationClientV12`](VotingReputationClientV12.md) #### Inherited from @@ -662,65 +674,11 @@ AugmentedVotingReputation.claimMisalignedReward(uint256,uint256,uint256,address, ___ -### claimReward - -▸ **claimReward**(`_motionId`, `_permissionDomainId`, `_childSkillIndex`, `_staker`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the staker's reward - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_permissionDomainId` | `BigNumberish` | The domain where the extension has the arbitration permission | -| `_childSkillIndex` | `BigNumberish` | For the domain in which the motion is occurring | -| `_staker` | `string` | The staker whose reward is being claimed | -| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedVotingReputation.claimReward - -___ - -### claimReward(uint256,uint256,uint256,address,uint256) - -▸ **claimReward(uint256,uint256,uint256,address,uint256)**(`_motionId`, `_permissionDomainId`, `_childSkillIndex`, `_staker`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> - -Claim the staker's reward - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_permissionDomainId` | `BigNumberish` | The domain where the extension has the arbitration permission | -| `_childSkillIndex` | `BigNumberish` | For the domain in which the motion is occurring | -| `_staker` | `string` | The staker whose reward is being claimed | -| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedVotingReputation.claimReward(uint256,uint256,uint256,address,uint256) - -___ - -### claimRewardWithProofs +### claimMisalignedRewardWithProofs -▸ **claimRewardWithProofs**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **claimMisalignedRewardWithProofs**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [claimReward](VotingReputationClientV6.md#claimreward), but let colonyJS figure out the permission proofs for you. +Same as [claimMisalignedReward](VotingReputationClientV12.md#claimmisalignedreward), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -738,40 +696,23 @@ Always prefer this method, except when you have good reason not to. #### Inherited from -AugmentedVotingReputation.claimRewardWithProofs - -___ - -### connect - -▸ **connect**(`signerOrProvider`): [`VotingReputationClientV6`](VotingReputationClientV6.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signerOrProvider` | `string` \| `Signer` \| `Provider` | - -#### Returns - -[`VotingReputationClientV6`](VotingReputationClientV6.md) - -#### Inherited from - -AugmentedVotingReputation.connect +AugmentsV3.claimMisalignedRewardWithProofs ___ -### createClaimDelayAction +### claimReward -▸ **createClaimDelayAction**(`action`, `value`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **claimReward**(`_motionId`, `_permissionDomainId`, `_childSkillIndex`, `_staker`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters | Name | Type | | :------ | :------ | -| `action` | `BytesLike` | -| `value` | `BigNumberish` | +| `_motionId` | `BigNumberish` | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_staker` | `string` | +| `_vote` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -780,20 +721,23 @@ ___ #### Inherited from -AugmentedVotingReputation.createClaimDelayAction +AugmentedVotingReputation.claimReward ___ -### createClaimDelayAction(bytes,uint256) +### claimReward(uint256,uint256,uint256,address,uint256) -▸ **createClaimDelayAction(bytes,uint256)**(`action`, `value`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **claimReward(uint256,uint256,uint256,address,uint256)**(`_motionId`, `_permissionDomainId`, `_childSkillIndex`, `_staker`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> #### Parameters | Name | Type | | :------ | :------ | -| `action` | `BytesLike` | -| `value` | `BigNumberish` | +| `_motionId` | `BigNumberish` | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_staker` | `string` | +| `_vote` | `BigNumberish` | | `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -802,57 +746,25 @@ ___ #### Inherited from -AugmentedVotingReputation.createClaimDelayAction(bytes,uint256) - -___ - -### createDomainMotion - -▸ **createDomainMotion**(`_domainId`, `_childSkillIndex`, `_action`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> - -Create a motion in any domain (DEPRECATED) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where we vote on the motion | -| `_childSkillIndex` | `BigNumberish` | The childSkillIndex pointing to the domain of the action | -| `_action` | `BytesLike` | A bytes array encoding a function call | -| `_key` | `BytesLike` | Reputation tree key for the domain | -| `_value` | `BytesLike` | Reputation tree value for the domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedVotingReputation.createDomainMotion +AugmentedVotingReputation.claimReward(uint256,uint256,uint256,address,uint256) ___ -### createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[]) +### claimRewardWithProofs -▸ **createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])**(`_domainId`, `_childSkillIndex`, `_action`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> +▸ **claimRewardWithProofs**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<`ContractTransaction`\> -Create a motion in any domain (DEPRECATED) +Same as [claimReward](VotingReputationClientV12.md#claimreward), 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 we vote on the motion | -| `_childSkillIndex` | `BigNumberish` | The childSkillIndex pointing to the domain of the action | -| `_action` | `BytesLike` | A bytes array encoding a function call | -| `_key` | `BytesLike` | Reputation tree key for the domain | -| `_value` | `BytesLike` | Reputation tree value for the domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| `_motionId` | `BigNumberish` | The id of the motion | +| `_staker` | `string` | The staker whose reward is being claimed | +| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | +| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | #### Returns @@ -860,34 +772,27 @@ Create a motion in any domain (DEPRECATED) #### Inherited from -AugmentedVotingReputation.createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[]) +AugmentedVotingReputation.claimRewardWithProofs ___ -### createDomainMotionWithProofs - -▸ **createDomainMotionWithProofs**(`_domainId`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> - -**`Deprecated`** +### connect -Same as [createDomainMotion](VotingReputationClientV6.md#createdomainmotion), but let colonyJS figure out the permission proofs for you. -Always prefer this method, except when you have good reason not to. +▸ **connect**(`signerOrProvider`): [`VotingReputationClientV12`](VotingReputationClientV12.md) #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where we vote on the motion | -| `_action` | `BytesLike` | A bytes array encoding a function call | -| `overrides?` | [`TxOverrides`](../README.md#txoverrides) | - | +| Name | Type | +| :------ | :------ | +| `signerOrProvider` | `string` \| `Signer` \| `Provider` | #### Returns -`Promise`<`ContractTransaction`\> +[`VotingReputationClientV12`](VotingReputationClientV12.md) #### Inherited from -CreateDomainMotionAugments.createDomainMotionWithProofs +AugmentedVotingReputation.connect ___ @@ -895,21 +800,19 @@ ___ ▸ **createMotion**(`_domainId`, `_childSkillIndex`, `_altTarget`, `_action`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Create a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where we vote on the motion | -| `_childSkillIndex` | `BigNumberish` | The childSkillIndex pointing to the domain of the action | -| `_altTarget` | `string` | The contract to which we send the action (0x0 for the colony) | -| `_action` | `BytesLike` | A bytes array encoding a function call | -| `_key` | `BytesLike` | Reputation tree key for the root domain | -| `_value` | `BytesLike` | Reputation tree value for the root domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_domainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_altTarget` | `string` | +| `_action` | `BytesLike` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -925,21 +828,19 @@ ___ ▸ **createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])**(`_domainId`, `_childSkillIndex`, `_altTarget`, `_action`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Create a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_domainId` | `BigNumberish` | The domain where we vote on the motion | -| `_childSkillIndex` | `BigNumberish` | The childSkillIndex pointing to the domain of the action | -| `_altTarget` | `string` | The contract to which we send the action (0x0 for the colony) | -| `_action` | `BytesLike` | A bytes array encoding a function call | -| `_key` | `BytesLike` | Reputation tree key for the root domain | -| `_value` | `BytesLike` | Reputation tree value for the root domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_domainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_altTarget` | `string` | +| `_action` | `BytesLike` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -955,7 +856,7 @@ ___ ▸ **createMotionWithProofs**(`_domainId`, `_altTarget`, `_action`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [createMotion](VotingReputationClientV6.md#createmotion), but let colonyJS figure out the permission proofs for you. +Same as [createMotion](VotingReputationClientV12.md#createmotion), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -977,69 +878,13 @@ AugmentsV2.createMotionWithProofs ___ -### createRootMotion - -▸ **createRootMotion**(`_altTarget`, `_action`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> - -Create a motion in the root domain (DEPRECATED) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_altTarget` | `string` | The contract to which we send the action (0x0 for the colony) | -| `_action` | `BytesLike` | A bytes array encoding a function call | -| `_key` | `BytesLike` | Reputation tree key for the root domain | -| `_value` | `BytesLike` | Reputation tree value for the root domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedVotingReputation.createRootMotion - -___ - -### createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[]) - -▸ **createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])**(`_altTarget`, `_action`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> - -Create a motion in the root domain (DEPRECATED) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_altTarget` | `string` | The contract to which we send the action (0x0 for the colony) | -| `_action` | `BytesLike` | A bytes array encoding a function call | -| `_key` | `BytesLike` | Reputation tree key for the root domain | -| `_value` | `BytesLike` | Reputation tree value for the root domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | - -#### Returns - -`Promise`<`ContractTransaction`\> - -#### Inherited from - -AugmentedVotingReputation.createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[]) - -___ - ### deployed -▸ **deployed**(): `Promise`<[`VotingReputationClientV6`](VotingReputationClientV6.md)\> +▸ **deployed**(): `Promise`<[`VotingReputationClientV12`](VotingReputationClientV12.md)\> #### Returns -`Promise`<[`VotingReputationClientV6`](VotingReputationClientV6.md)\> +`Promise`<[`VotingReputationClientV12`](VotingReputationClientV12.md)\> #### Inherited from @@ -1114,20 +959,18 @@ ___ ▸ **escalateMotion**(`_motionId`, `_newDomainId`, `_childSkillIndex`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Escalate a motion to a higher domain - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_newDomainId` | `BigNumberish` | The desired domain of escalation | -| `_childSkillIndex` | `BigNumberish` | For the current domain, relative to the escalated domain | -| `_key` | `BytesLike` | Reputation tree key for the new domain | -| `_value` | `BytesLike` | Reputation tree value for the new domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_newDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1143,20 +986,18 @@ ___ ▸ **escalateMotion(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])**(`_motionId`, `_newDomainId`, `_childSkillIndex`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Escalate a motion to a higher domain - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_newDomainId` | `BigNumberish` | The desired domain of escalation | -| `_childSkillIndex` | `BigNumberish` | For the current domain, relative to the escalated domain | -| `_key` | `BytesLike` | Reputation tree key for the new domain | -| `_value` | `BytesLike` | Reputation tree value for the new domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_newDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -1172,7 +1013,7 @@ ___ ▸ **escalateMotionWithProofs**(`_motionId`, `_newDomainId`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [escalateMotion](VotingReputationClientV6.md#escalatemotion), but let colonyJS figure out the permission proofs for you. +Same as [escalateMotion](VotingReputationClientV12.md#escalatemotion), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -1197,18 +1038,16 @@ ___ ▸ **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` } | - | +| Name | Type | +| :------ | :------ | +| `userAddress` | `string` | +| `payload` | `BytesLike` | +| `sigR` | `BytesLike` | +| `sigS` | `BytesLike` | +| `sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | #### Returns @@ -1224,18 +1063,16 @@ ___ ▸ **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` } | - | +| Name | Type | +| :------ | :------ | +| `userAddress` | `string` | +| `payload` | `BytesLike` | +| `sigR` | `BytesLike` | +| `sigS` | `BytesLike` | +| `sigV` | `BigNumberish` | +| `overrides?` | `PayableOverrides` & { `from?`: `string` } | #### Returns @@ -1251,14 +1088,12 @@ ___ ▸ **failingExecutionAllowed**(`_motionId`, `overrides?`): `Promise`<`boolean`\> -We are only expecting this to be called from finalize motion in the contracts. It is marked as external only so that the frontend can use it. - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1274,14 +1109,12 @@ ___ ▸ **failingExecutionAllowed(uint256)**(`_motionId`, `overrides?`): `Promise`<`boolean`\> -We are only expecting this to be called from finalize motion in the contracts. It is marked as external only so that the frontend can use it. - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1355,6 +1188,48 @@ AugmentedVotingReputation.finalizeMotion(uint256) ___ +### finalizeMotionWithoutFailure + +▸ **finalizeMotionWithoutFailure**(`_motionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedVotingReputation.finalizeMotionWithoutFailure + +___ + +### finalizeMotionWithoutFailure(uint256) + +▸ **finalizeMotionWithoutFailure(uint256)**(`_motionId`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedVotingReputation.finalizeMotionWithoutFailure(uint256) + +___ + ### finishUpgrade ▸ **finishUpgrade**(`overrides?`): `Promise`<`ContractTransaction`\> @@ -1395,6 +1270,50 @@ AugmentedVotingReputation.finishUpgrade() ___ +### getActionSummary + +▸ **getActionSummary**(`_action`, `_altTarget`, `overrides?`): `Promise`<`ActionSummaryStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_action` | `BytesLike` | +| `_altTarget` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`ActionSummaryStructOutput`\> + +#### Inherited from + +AugmentedVotingReputation.getActionSummary + +___ + +### getActionSummary(bytes,address) + +▸ **getActionSummary(bytes,address)**(`_action`, `_altTarget`, `overrides?`): `Promise`<`ActionSummaryStructOutput`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_action` | `BytesLike` | +| `_altTarget` | `string` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`ActionSummaryStructOutput`\> + +#### Inherited from + +AugmentedVotingReputation.getActionSummary(bytes,address) + +___ + ### getCapabilityRoles ▸ **getCapabilityRoles**(`_sig`, `overrides?`): `Promise`<`string`\> @@ -1521,8 +1440,6 @@ ___ ▸ **getEscalationPeriod**(`overrides?`): `Promise`<`BigNumber`\> -Get the escalation period - #### Parameters | Name | Type | @@ -1543,8 +1460,6 @@ ___ ▸ **getEscalationPeriod()**(`overrides?`): `Promise`<`BigNumber`\> -Get the escalation period - #### Parameters | Name | Type | @@ -1565,14 +1480,96 @@ ___ ▸ **getExpenditureMotionCount**(`_structHash`, `overrides?`): `Promise`<`BigNumber`\> -Get the number of ongoing motions for a single expenditure / expenditure slot +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_structHash` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedVotingReputation.getExpenditureMotionCount + +___ + +### getExpenditureMotionCount(bytes32) + +▸ **getExpenditureMotionCount(bytes32)**(`_structHash`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_structHash` | `BytesLike` | The hash of the expenditureId or expenditureId*expenditureSlot | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_structHash` | `BytesLike` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedVotingReputation.getExpenditureMotionCount(bytes32) + +___ + +### getExpenditureMotionLock + +▸ **getExpenditureMotionLock**(`_expenditureId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedVotingReputation.getExpenditureMotionLock + +___ + +### getExpenditureMotionLock(uint256) + +▸ **getExpenditureMotionLock(uint256)**(`_expenditureId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | + +#### Returns + +`Promise`<`BigNumber`\> + +#### Inherited from + +AugmentedVotingReputation.getExpenditureMotionLock(uint256) + +___ + +### getExpenditurePastVote + +▸ **getExpenditurePastVote**(`_expenditureId`, `overrides?`): `Promise`<`BigNumber`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1580,22 +1577,20 @@ Get the number of ongoing motions for a single expenditure / expenditure slot #### Inherited from -AugmentedVotingReputation.getExpenditureMotionCount +AugmentedVotingReputation.getExpenditurePastVote ___ -### getExpenditureMotionCount(bytes32) - -▸ **getExpenditureMotionCount(bytes32)**(`_structHash`, `overrides?`): `Promise`<`BigNumber`\> +### getExpenditurePastVote(uint256) -Get the number of ongoing motions for a single expenditure / expenditure slot +▸ **getExpenditurePastVote(uint256)**(`_expenditureId`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_structHash` | `BytesLike` | The hash of the expenditureId or expenditureId*expenditureSlot | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_expenditureId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1603,22 +1598,20 @@ Get the number of ongoing motions for a single expenditure / expenditure slot #### Inherited from -AugmentedVotingReputation.getExpenditureMotionCount(bytes32) +AugmentedVotingReputation.getExpenditurePastVote(uint256) ___ -### getExpenditurePastVote - -▸ **getExpenditurePastVote**(`_actionHash`, `overrides?`): `Promise`<`BigNumber`\> +### getExpenditurePastVotes\_DEPRECATED -Get the largest past vote on a single expenditure variable +▸ **getExpenditurePastVotes_DEPRECATED**(`_slotSignature`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_actionHash` | `BytesLike` | The hash of the particular expenditure action | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_slotSignature` | `BytesLike` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1626,22 +1619,20 @@ Get the largest past vote on a single expenditure variable #### Inherited from -AugmentedVotingReputation.getExpenditurePastVote +AugmentedVotingReputation.getExpenditurePastVotes\_DEPRECATED ___ -### getExpenditurePastVote(bytes32) +### getExpenditurePastVotes\_DEPRECATED(bytes32) -▸ **getExpenditurePastVote(bytes32)**(`_actionHash`, `overrides?`): `Promise`<`BigNumber`\> - -Get the largest past vote on a single expenditure variable +▸ **getExpenditurePastVotes_DEPRECATED(bytes32)**(`_slotSignature`, `overrides?`): `Promise`<`BigNumber`\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_actionHash` | `BytesLike` | The hash of the particular expenditure action | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_slotSignature` | `BytesLike` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1649,7 +1640,7 @@ Get the largest past vote on a single expenditure variable #### Inherited from -AugmentedVotingReputation.getExpenditurePastVote(bytes32) +AugmentedVotingReputation.getExpenditurePastVotes\_DEPRECATED(bytes32) ___ @@ -1657,8 +1648,6 @@ ___ ▸ **getMaxVoteFraction**(`overrides?`): `Promise`<`BigNumber`\> -Get the max vote fraction - #### Parameters | Name | Type | @@ -1679,8 +1668,6 @@ ___ ▸ **getMaxVoteFraction()**(`overrides?`): `Promise`<`BigNumber`\> -Get the max vote fraction - #### Parameters | Name | Type | @@ -1701,14 +1688,12 @@ ___ ▸ **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` | - | +| Name | Type | +| :------ | :------ | +| `userAddress` | `string` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1724,14 +1709,12 @@ ___ ▸ **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` | - | +| Name | Type | +| :------ | :------ | +| `userAddress` | `string` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1747,14 +1730,12 @@ ___ ▸ **getMotion**(`_motionId`, `overrides?`): `Promise`<`MotionStructOutput`\> -Get the data for a single motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1770,14 +1751,12 @@ ___ ▸ **getMotion(uint256)**(`_motionId`, `overrides?`): `Promise`<`MotionStructOutput`\> -Get the data for a single motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1793,8 +1772,6 @@ ___ ▸ **getMotionCount**(`overrides?`): `Promise`<`BigNumber`\> -Get the total motion count - #### Parameters | Name | Type | @@ -1815,8 +1792,6 @@ ___ ▸ **getMotionCount()**(`overrides?`): `Promise`<`BigNumber`\> -Get the total motion count - #### Parameters | Name | Type | @@ -1837,8 +1812,6 @@ ___ ▸ **getMotionState**(`_motionId`, `overrides?`): `Promise`<`number`\> -Get the current state of the motion - #### Parameters | Name | Type | @@ -1860,8 +1833,6 @@ ___ ▸ **getMotionState(uint256)**(`_motionId`, `overrides?`): `Promise`<`number`\> -Get the current state of the motion - #### Parameters | Name | Type | @@ -1883,8 +1854,6 @@ ___ ▸ **getRevealPeriod**(`overrides?`): `Promise`<`BigNumber`\> -Get the reveal period - #### Parameters | Name | Type | @@ -1905,8 +1874,6 @@ ___ ▸ **getRevealPeriod()**(`overrides?`): `Promise`<`BigNumber`\> -Get the reveal period - #### Parameters | Name | Type | @@ -1927,16 +1894,14 @@ ___ ▸ **getStake**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<`BigNumber`\> -Get a user's stake on a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_staker` | `string` | The staker address | -| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_staker` | `string` | +| `_vote` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1952,16 +1917,14 @@ ___ ▸ **getStake(uint256,address,uint256)**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<`BigNumber`\> -Get a user's stake on a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_staker` | `string` | The staker address | -| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_staker` | `string` | +| `_vote` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -1977,8 +1940,6 @@ ___ ▸ **getStakePeriod**(`overrides?`): `Promise`<`BigNumber`\> -Get the stake period - #### Parameters | Name | Type | @@ -1999,8 +1960,6 @@ ___ ▸ **getStakePeriod()**(`overrides?`): `Promise`<`BigNumber`\> -Get the stake period - #### Parameters | Name | Type | @@ -2019,22 +1978,20 @@ ___ ### getStakerReward -▸ **getStakerReward**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`]\> - -Get the staker reward +▸ **getStakerReward**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`] & { `_penalty`: `BigNumber` ; `_reward`: `BigNumber` }\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_staker` | `string` | The staker's address | -| `_vote` | `BigNumberish` | The vote (0 = NAY, 1 = YAY) | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_staker` | `string` | +| `_vote` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns -`Promise`<[`BigNumber`, `BigNumber`]\> +`Promise`<[`BigNumber`, `BigNumber`] & { `_penalty`: `BigNumber` ; `_reward`: `BigNumber` }\> #### Inherited from @@ -2044,22 +2001,20 @@ ___ ### getStakerReward(uint256,address,uint256) -▸ **getStakerReward(uint256,address,uint256)**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`]\> - -Get the staker reward +▸ **getStakerReward(uint256,address,uint256)**(`_motionId`, `_staker`, `_vote`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`] & { `_penalty`: `BigNumber` ; `_reward`: `BigNumber` }\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_staker` | `string` | The staker's address | -| `_vote` | `BigNumberish` | The vote (0 = NAY, 1 = YAY) | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_staker` | `string` | +| `_vote` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns -`Promise`<[`BigNumber`, `BigNumber`]\> +`Promise`<[`BigNumber`, `BigNumber`] & { `_penalty`: `BigNumber` ; `_reward`: `BigNumber` }\> #### Inherited from @@ -2071,8 +2026,6 @@ ___ ▸ **getSubmitPeriod**(`overrides?`): `Promise`<`BigNumber`\> -Get the submit period - #### Parameters | Name | Type | @@ -2093,8 +2046,6 @@ ___ ▸ **getSubmitPeriod()**(`overrides?`): `Promise`<`BigNumber`\> -Get the submit period - #### Parameters | Name | Type | @@ -2115,8 +2066,6 @@ ___ ▸ **getTotalStakeFraction**(`overrides?`): `Promise`<`BigNumber`\> -Get the total stake fraction - #### Parameters | Name | Type | @@ -2137,8 +2086,6 @@ ___ ▸ **getTotalStakeFraction()**(`overrides?`): `Promise`<`BigNumber`\> -Get the total stake fraction - #### Parameters | Name | Type | @@ -2159,8 +2106,6 @@ ___ ▸ **getUserMinStakeFraction**(`overrides?`): `Promise`<`BigNumber`\> -Get the user min stake fraction - #### Parameters | Name | Type | @@ -2181,8 +2126,6 @@ ___ ▸ **getUserMinStakeFraction()**(`overrides?`): `Promise`<`BigNumber`\> -Get the user min stake fraction - #### Parameters | Name | Type | @@ -2203,15 +2146,13 @@ ___ ▸ **getVoterReward**(`_motionId`, `_voterRep`, `overrides?`): `Promise`<`BigNumber`\> -Get the voter reward NB This function will only return a meaningful value if in the reveal state. Prior to the reveal state, getVoterRewardRange should be used. - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_voterRep` | `BigNumberish` | The reputation the voter has in the domain | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_voterRep` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -2227,15 +2168,13 @@ ___ ▸ **getVoterReward(uint256,uint256)**(`_motionId`, `_voterRep`, `overrides?`): `Promise`<`BigNumber`\> -Get the voter reward NB This function will only return a meaningful value if in the reveal state. Prior to the reveal state, getVoterRewardRange should be used. - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_voterRep` | `BigNumberish` | The reputation the voter has in the domain | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_voterRep` | `BigNumberish` | +| `overrides?` | `CallOverrides` | #### Returns @@ -2251,8 +2190,6 @@ ___ ▸ **getVoterRewardFraction**(`overrides?`): `Promise`<`BigNumber`\> -Get the voter reward fraction - #### Parameters | Name | Type | @@ -2273,8 +2210,6 @@ ___ ▸ **getVoterRewardFraction()**(`overrides?`): `Promise`<`BigNumber`\> -Get the voter reward fraction - #### Parameters | Name | Type | @@ -2293,22 +2228,20 @@ ___ ### getVoterRewardRange -▸ **getVoterRewardRange**(`_motionId`, `_voterRep`, `_voterAddress`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`]\> - -Get the range of potential rewards for a voter on a specific motion, intended to be used when the motion is in the reveal state. Once a motion is in the reveal state the reward is known, and getVoterRewardRange should be used. +▸ **getVoterRewardRange**(`_motionId`, `_voterRep`, `_voterAddress`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`] & { `_rewardMax`: `BigNumber` ; `_rewardMin`: `BigNumber` }\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_voterRep` | `BigNumberish` | The reputation the voter has in the domain | -| `_voterAddress` | `string` | The address the user will be voting as | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_voterRep` | `BigNumberish` | +| `_voterAddress` | `string` | +| `overrides?` | `CallOverrides` | #### Returns -`Promise`<[`BigNumber`, `BigNumber`]\> +`Promise`<[`BigNumber`, `BigNumber`] & { `_rewardMax`: `BigNumber` ; `_rewardMin`: `BigNumber` }\> #### Inherited from @@ -2318,22 +2251,20 @@ ___ ### getVoterRewardRange(uint256,uint256,address) -▸ **getVoterRewardRange(uint256,uint256,address)**(`_motionId`, `_voterRep`, `_voterAddress`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`]\> - -Get the range of potential rewards for a voter on a specific motion, intended to be used when the motion is in the reveal state. Once a motion is in the reveal state the reward is known, and getVoterRewardRange should be used. +▸ **getVoterRewardRange(uint256,uint256,address)**(`_motionId`, `_voterRep`, `_voterAddress`, `overrides?`): `Promise`<[`BigNumber`, `BigNumber`] & { `_rewardMax`: `BigNumber` ; `_rewardMin`: `BigNumber` }\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_voterRep` | `BigNumberish` | The reputation the voter has in the domain | -| `_voterAddress` | `string` | The address the user will be voting as | -| `overrides?` | `CallOverrides` | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_voterRep` | `BigNumberish` | +| `_voterAddress` | `string` | +| `overrides?` | `CallOverrides` | #### Returns -`Promise`<[`BigNumber`, `BigNumber`]\> +`Promise`<[`BigNumber`, `BigNumber`] & { `_rewardMax`: `BigNumber` ; `_rewardMin`: `BigNumber` }\> #### Inherited from @@ -2385,21 +2316,19 @@ ___ ▸ **initialise**(`_totalStakeFraction`, `_voterRewardFraction`, `_userMinStakeFraction`, `_maxVoteFraction`, `_stakePeriod`, `_submitPeriod`, `_revealPeriod`, `_escalationPeriod`, `overrides?`): `Promise`<`ContractTransaction`\> -Initialise the extension - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_totalStakeFraction` | `BigNumberish` | The fraction of the domain's reputation we need to stake | -| `_voterRewardFraction` | `BigNumberish` | The fraction of the total stake paid out to voters as rewards | -| `_userMinStakeFraction` | `BigNumberish` | The minimum per-user stake as fraction of total stake | -| `_maxVoteFraction` | `BigNumberish` | The fraction of the domain's reputation which must submit for quick-end | -| `_stakePeriod` | `BigNumberish` | The length of the staking period in seconds | -| `_submitPeriod` | `BigNumberish` | The length of the submit period in seconds | -| `_revealPeriod` | `BigNumberish` | The length of the reveal period in seconds | -| `_escalationPeriod` | `BigNumberish` | The length of the escalation period in seconds | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_totalStakeFraction` | `BigNumberish` | +| `_voterRewardFraction` | `BigNumberish` | +| `_userMinStakeFraction` | `BigNumberish` | +| `_maxVoteFraction` | `BigNumberish` | +| `_stakePeriod` | `BigNumberish` | +| `_submitPeriod` | `BigNumberish` | +| `_revealPeriod` | `BigNumberish` | +| `_escalationPeriod` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2415,21 +2344,19 @@ ___ ▸ **initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)**(`_totalStakeFraction`, `_voterRewardFraction`, `_userMinStakeFraction`, `_maxVoteFraction`, `_stakePeriod`, `_submitPeriod`, `_revealPeriod`, `_escalationPeriod`, `overrides?`): `Promise`<`ContractTransaction`\> -Initialise the extension - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_totalStakeFraction` | `BigNumberish` | The fraction of the domain's reputation we need to stake | -| `_voterRewardFraction` | `BigNumberish` | The fraction of the total stake paid out to voters as rewards | -| `_userMinStakeFraction` | `BigNumberish` | The minimum per-user stake as fraction of total stake | -| `_maxVoteFraction` | `BigNumberish` | The fraction of the domain's reputation which must submit for quick-end | -| `_stakePeriod` | `BigNumberish` | The length of the staking period in seconds | -| `_submitPeriod` | `BigNumberish` | The length of the submit period in seconds | -| `_revealPeriod` | `BigNumberish` | The length of the reveal period in seconds | -| `_escalationPeriod` | `BigNumberish` | The length of the escalation period in seconds | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_totalStakeFraction` | `BigNumberish` | +| `_voterRewardFraction` | `BigNumberish` | +| `_userMinStakeFraction` | `BigNumberish` | +| `_maxVoteFraction` | `BigNumberish` | +| `_stakePeriod` | `BigNumberish` | +| `_submitPeriod` | `BigNumberish` | +| `_revealPeriod` | `BigNumberish` | +| `_escalationPeriod` | `BigNumberish` | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2545,6 +2472,48 @@ AugmentedVotingReputation.listeners ___ +### multicall + +▸ **multicall**(`_data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedVotingReputation.multicall + +___ + +### multicall(bytes[]) + +▸ **multicall(bytes[])**(`_data`, `overrides?`): `Promise`<`ContractTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_data` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | + +#### Returns + +`Promise`<`ContractTransaction`\> + +#### Inherited from + +AugmentedVotingReputation.multicall(bytes[]) + +___ + ### queryFilter ▸ **queryFilter**<`TEvent`\>(`event`, `fromBlockOrBlockhash?`, `toBlock?`): `Promise`<`TEvent`[]\> @@ -2575,7 +2544,7 @@ ___ ### removeAllListeners -▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`VotingReputationClientV6`](VotingReputationClientV6.md) +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`VotingReputationClientV12`](VotingReputationClientV12.md) #### Type parameters @@ -2591,13 +2560,13 @@ ___ #### Returns -[`VotingReputationClientV6`](VotingReputationClientV6.md) +[`VotingReputationClientV12`](VotingReputationClientV12.md) #### Inherited from AugmentedVotingReputation.removeAllListeners -▸ **removeAllListeners**(`eventName?`): [`VotingReputationClientV6`](VotingReputationClientV6.md) +▸ **removeAllListeners**(`eventName?`): [`VotingReputationClientV12`](VotingReputationClientV12.md) #### Parameters @@ -2607,7 +2576,7 @@ AugmentedVotingReputation.removeAllListeners #### Returns -[`VotingReputationClientV6`](VotingReputationClientV6.md) +[`VotingReputationClientV12`](VotingReputationClientV12.md) #### Inherited from @@ -2619,20 +2588,18 @@ ___ ▸ **revealVote**(`_motionId`, `_salt`, `_vote`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Reveal a vote secret for a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_salt` | `BytesLike` | The salt used to hash the vote | -| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | -| `_key` | `BytesLike` | Reputation tree key for the staker/domain | -| `_value` | `BytesLike` | Reputation tree value for the staker/domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_salt` | `BytesLike` | +| `_vote` | `BigNumberish` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2648,20 +2615,18 @@ ___ ▸ **revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])**(`_motionId`, `_salt`, `_vote`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Reveal a vote secret for a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_salt` | `BytesLike` | The salt used to hash the vote | -| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | -| `_key` | `BytesLike` | Reputation tree key for the staker/domain | -| `_value` | `BytesLike` | Reputation tree value for the staker/domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_salt` | `BytesLike` | +| `_vote` | `BigNumberish` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2677,22 +2642,20 @@ ___ ▸ **stakeMotion**(`_motionId`, `_permissionDomainId`, `_childSkillIndex`, `_vote`, `_amount`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Stake on a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_permissionDomainId` | `BigNumberish` | The domain where the extension has the arbitration permission | -| `_childSkillIndex` | `BigNumberish` | For the domain in which the motion is occurring | -| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | -| `_amount` | `BigNumberish` | The amount of tokens being staked | -| `_key` | `BytesLike` | Reputation tree key for the staker/domain | -| `_value` | `BytesLike` | Reputation tree value for the staker/domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_vote` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2708,22 +2671,20 @@ ___ ▸ **stakeMotion(uint256,uint256,uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])**(`_motionId`, `_permissionDomainId`, `_childSkillIndex`, `_vote`, `_amount`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Stake on a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_permissionDomainId` | `BigNumberish` | The domain where the extension has the arbitration permission | -| `_childSkillIndex` | `BigNumberish` | For the domain in which the motion is occurring | -| `_vote` | `BigNumberish` | The side being supported (0 = NAY, 1 = YAY) | -| `_amount` | `BigNumberish` | The amount of tokens being staked | -| `_key` | `BytesLike` | Reputation tree key for the staker/domain | -| `_value` | `BytesLike` | Reputation tree value for the staker/domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_permissionDomainId` | `BigNumberish` | +| `_childSkillIndex` | `BigNumberish` | +| `_vote` | `BigNumberish` | +| `_amount` | `BigNumberish` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2739,7 +2700,7 @@ ___ ▸ **stakeMotionWithProofs**(`_motionId`, `_vote`, `_amount`, `overrides?`): `Promise`<`ContractTransaction`\> -Same as [stakeMotion](VotingReputationClientV6.md#stakemotion), but let colonyJS figure out the permission proofs for you. +Same as [stakeMotion](VotingReputationClientV12.md#stakemotion), but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to. #### Parameters @@ -2765,19 +2726,17 @@ ___ ▸ **submitVote**(`_motionId`, `_voteSecret`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Submit a vote secret for a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_voteSecret` | `BytesLike` | The hashed vote secret | -| `_key` | `BytesLike` | Reputation tree key for the staker/domain | -| `_value` | `BytesLike` | Reputation tree value for the staker/domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_voteSecret` | `BytesLike` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns @@ -2793,19 +2752,17 @@ ___ ▸ **submitVote(uint256,bytes32,bytes,bytes,uint256,bytes32[])**(`_motionId`, `_voteSecret`, `_key`, `_value`, `_branchMask`, `_siblings`, `overrides?`): `Promise`<`ContractTransaction`\> -Submit a vote secret for a motion - #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `_motionId` | `BigNumberish` | The id of the motion | -| `_voteSecret` | `BytesLike` | The hashed vote secret | -| `_key` | `BytesLike` | Reputation tree key for the staker/domain | -| `_value` | `BytesLike` | Reputation tree value for the staker/domain | -| `_branchMask` | `BigNumberish` | The branchmask of the proof | -| `_siblings` | `BytesLike`[] | The siblings of the proof | -| `overrides?` | `Overrides` & { `from?`: `string` } | - | +| Name | Type | +| :------ | :------ | +| `_motionId` | `BigNumberish` | +| `_voteSecret` | `BytesLike` | +| `_key` | `BytesLike` | +| `_value` | `BytesLike` | +| `_branchMask` | `BigNumberish` | +| `_siblings` | `BytesLike`[] | +| `overrides?` | `Overrides` & { `from?`: `string` } | #### Returns diff --git a/packages/colony-js/src/clients/Core/ColonyClientV10.ts b/packages/colony-js/src/clients/Core/ColonyClientV10.ts index caf5121ef..240c45fa4 100644 --- a/packages/colony-js/src/clients/Core/ColonyClientV10.ts +++ b/packages/colony-js/src/clients/Core/ColonyClientV10.ts @@ -1,73 +1,26 @@ import type { SignerOrProvider } from '@colony/core'; import { IColony__factory as IColonyFactory } from '../../contracts/IColony/10/factories/IColony__factory.js'; -import { IColony } from '../../contracts/IColony/10/IColony.js'; import { ColonyNetworkClient } from '../ColonyNetworkClient.js'; -import { - AugmentedIColony, - AugmentedEstimate, -} from './augments/commonAugments.js'; -import { ColonyAugmentsV3 } from './augments/augmentsV3.js'; -import { ColonyAugmentsV4 } from './augments/augmentsV4.js'; -import { ColonyAugmentsV5 } from './augments/augmentsV5.js'; -import { ColonyAugmentsV6 } from './augments/augmentsV6.js'; -import { - addAugments, - ColonyAugmentsV7, - AugmentedEstimateV7, -} from './augments/augmentsV7.js'; -import { - AddDomainAugmentsB, - AddDomainEstimateGasB, - addAugmentsB as addAddDomainAugments, -} from './augments/AddDomain.js'; -import { - MoveFundsBetweenPotsAugmentsB, - MoveFundsBetweenPotsEstimateGasB, - addAugmentsB as addMoveFundsBetweenPotsAugments, -} from './augments/MoveFundsBetweenPots.js'; - -interface ColonyClientV10Estimate - extends AugmentedEstimate, - AugmentedEstimateV7, - AddDomainEstimateGasB, - MoveFundsBetweenPotsEstimateGasB {} - -export interface ColonyClientV10 - extends AugmentedIColony, - ColonyAugmentsV3, - ColonyAugmentsV4, - ColonyAugmentsV5, - ColonyAugmentsV6, - ColonyAugmentsV7, - AddDomainAugmentsB, - MoveFundsBetweenPotsAugmentsB { - clientVersion: 10; - estimateGas: ColonyClientV10Estimate; - - // This is only to hide certain internal ethers.js properties from the docs - /** @internal */ - callStatic: IColony['callStatic']; - /** @internal */ - functions: IColony['functions']; - /** @internal */ - populateTransaction: IColony['populateTransaction']; -} +import { UnknownIColonyClient } from './augments/commonAugments.js'; +import { addAugments } from './augments/augmentsV7.js'; +import { addAugmentsB as addAddDomainAugments } from './augments/AddDomain.js'; +import { addAugmentsB as addMoveFundsBetweenPotsAugments } from './augments/MoveFundsBetweenPots.js'; export default function getColonyClient( this: ColonyNetworkClient, address: string, signerOrProvider: SignerOrProvider, -): ColonyClientV10 { +) { const colonyClient = IColonyFactory.connect( address, signerOrProvider, - ) as ColonyClientV10; + ) as UnknownIColonyClient; colonyClient.clientVersion = 10; addAugments(colonyClient, this); addAddDomainAugments(colonyClient); addMoveFundsBetweenPotsAugments(colonyClient); - return colonyClient as ColonyClientV10; + return colonyClient; } diff --git a/packages/colony-js/src/clients/Core/ColonyClientV11.ts b/packages/colony-js/src/clients/Core/ColonyClientV11.ts index 9205d2d60..5fc36b89d 100644 --- a/packages/colony-js/src/clients/Core/ColonyClientV11.ts +++ b/packages/colony-js/src/clients/Core/ColonyClientV11.ts @@ -1,73 +1,26 @@ import type { SignerOrProvider } from '@colony/core'; import { IColony__factory as IColonyFactory } from '../../contracts/IColony/11/factories/IColony__factory.js'; -import { IColony } from '../../contracts/IColony/11/IColony.js'; import { ColonyNetworkClient } from '../ColonyNetworkClient.js'; -import { - AugmentedIColony, - AugmentedEstimate, -} from './augments/commonAugments.js'; -import { ColonyAugmentsV3 } from './augments/augmentsV3.js'; -import { ColonyAugmentsV4 } from './augments/augmentsV4.js'; -import { ColonyAugmentsV5 } from './augments/augmentsV5.js'; -import { ColonyAugmentsV6 } from './augments/augmentsV6.js'; -import { - addAugments, - ColonyAugmentsV7, - AugmentedEstimateV7, -} from './augments/augmentsV7.js'; -import { - AddDomainAugmentsB, - AddDomainEstimateGasB, - addAugmentsB as addAddDomainAugments, -} from './augments/AddDomain.js'; -import { - MoveFundsBetweenPotsAugmentsB, - MoveFundsBetweenPotsEstimateGasB, - addAugmentsB as addMoveFundsBetweenPotsAugments, -} from './augments/MoveFundsBetweenPots.js'; - -interface ColonyClientV11Estimate - extends AugmentedEstimate, - AugmentedEstimateV7, - AddDomainEstimateGasB, - MoveFundsBetweenPotsEstimateGasB {} - -export interface ColonyClientV11 - extends AugmentedIColony, - ColonyAugmentsV3, - ColonyAugmentsV4, - ColonyAugmentsV5, - ColonyAugmentsV6, - ColonyAugmentsV7, - AddDomainAugmentsB, - MoveFundsBetweenPotsAugmentsB { - clientVersion: 11; - estimateGas: ColonyClientV11Estimate; - - // This is only to hide certain internal ethers.js properties from the docs - /** @internal */ - callStatic: IColony['callStatic']; - /** @internal */ - functions: IColony['functions']; - /** @internal */ - populateTransaction: IColony['populateTransaction']; -} +import { UnknownIColonyClient } from './augments/commonAugments.js'; +import { addAugments } from './augments/augmentsV7.js'; +import { addAugmentsB as addAddDomainAugments } from './augments/AddDomain.js'; +import { addAugmentsB as addMoveFundsBetweenPotsAugments } from './augments/MoveFundsBetweenPots.js'; export default function getColonyClient( this: ColonyNetworkClient, address: string, signerOrProvider: SignerOrProvider, -): ColonyClientV11 { +) { const colonyClient = IColonyFactory.connect( address, signerOrProvider, - ) as ColonyClientV11; + ) as UnknownIColonyClient; colonyClient.clientVersion = 11; addAugments(colonyClient, this); addAddDomainAugments(colonyClient); addMoveFundsBetweenPotsAugments(colonyClient); - return colonyClient as ColonyClientV11; + return colonyClient; } diff --git a/packages/colony-js/src/clients/Core/ColonyClientV16.ts b/packages/colony-js/src/clients/Core/ColonyClientV16.ts new file mode 100644 index 000000000..79d348a6c --- /dev/null +++ b/packages/colony-js/src/clients/Core/ColonyClientV16.ts @@ -0,0 +1,73 @@ +import { SignerOrProvider } from '@colony/core'; + +import { IColony__factory as IColonyFactory } from '../../contracts/IColony/16/factories/IColony__factory.js'; +import { IColony } from '../../contracts/IColony/16/IColony.js'; +import { ColonyNetworkClient } from '../ColonyNetworkClient.js'; +import { + AugmentedIColony, + AugmentedEstimate, +} from './augments/commonAugments.js'; +import { ColonyAugmentsV3 } from './augments/augmentsV3.js'; +import { ColonyAugmentsV4 } from './augments/augmentsV4.js'; +import { ColonyAugmentsV5 } from './augments/augmentsV5.js'; +import { ColonyAugmentsV6 } from './augments/augmentsV6.js'; +import { + addAugments, + ColonyAugmentsV7, + AugmentedEstimateV7, +} from './augments/augmentsV7.js'; +import { + AddDomainAugmentsB, + AddDomainEstimateGasB, + addAugmentsB as addAddDomainAugments, +} from './augments/AddDomain.js'; +import { + MoveFundsBetweenPotsAugmentsB, + MoveFundsBetweenPotsEstimateGasB, + addAugmentsB as addMoveFundsBetweenPotsAugments, +} from './augments/MoveFundsBetweenPots.js'; + +interface ColonyClientV16Estimate + extends AugmentedEstimate, + AugmentedEstimateV7, + AddDomainEstimateGasB, + MoveFundsBetweenPotsEstimateGasB {} + +export interface ColonyClientV16 + extends AugmentedIColony, + ColonyAugmentsV3, + ColonyAugmentsV4, + ColonyAugmentsV5, + ColonyAugmentsV6, + ColonyAugmentsV7, + AddDomainAugmentsB, + MoveFundsBetweenPotsAugmentsB { + clientVersion: 16; + estimateGas: ColonyClientV16Estimate; + + // This is only to hide certain internal ethers.js properties from the docs + /** @internal */ + callStatic: IColony['callStatic']; + /** @internal */ + functions: IColony['functions']; + /** @internal */ + populateTransaction: IColony['populateTransaction']; +} + +export default function getColonyClient( + this: ColonyNetworkClient, + address: string, + signerOrProvider: SignerOrProvider, +): ColonyClientV16 { + const colonyClient = IColonyFactory.connect( + address, + signerOrProvider, + ) as ColonyClientV16; + + colonyClient.clientVersion = 16; + addAugments(colonyClient, this); + addAddDomainAugments(colonyClient); + addMoveFundsBetweenPotsAugments(colonyClient); + + return colonyClient as ColonyClientV16; +} diff --git a/packages/colony-js/src/clients/Core/augments/AddDomain.ts b/packages/colony-js/src/clients/Core/augments/AddDomain.ts index c55ac3e4a..d8a04f96a 100644 --- a/packages/colony-js/src/clients/Core/augments/AddDomain.ts +++ b/packages/colony-js/src/clients/Core/augments/AddDomain.ts @@ -7,11 +7,11 @@ import { import { IColonyV4, - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../contracts.js'; import type { AugmentedIColony, @@ -23,11 +23,11 @@ type ValidColonyA = IColonyV4; // Colonies that support the later (overloaded) methods type ValidColonyB = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; export interface AddDomainEstimateGasA { /** diff --git a/packages/colony-js/src/clients/Core/augments/MoveFundsBetweenPots.ts b/packages/colony-js/src/clients/Core/augments/MoveFundsBetweenPots.ts index 994b7aeef..43c803902 100644 --- a/packages/colony-js/src/clients/Core/augments/MoveFundsBetweenPots.ts +++ b/packages/colony-js/src/clients/Core/augments/MoveFundsBetweenPots.ts @@ -10,11 +10,11 @@ import { import { IColonyV6, - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../contracts.js'; import { AugmentedIColony, UnknownIColonyClient } from './commonAugments.js'; @@ -23,11 +23,11 @@ type ValidColonyA = IColonyV6; // Colonies that support the later (overloaded) methods type ValidColonyB = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; const getMoveFundsPermissionProofsA = async ( contract: AugmentedIColony, diff --git a/packages/colony-js/src/clients/Core/augments/augmentsV3.ts b/packages/colony-js/src/clients/Core/augments/augmentsV3.ts index af8967260..6a3979728 100644 --- a/packages/colony-js/src/clients/Core/augments/augmentsV3.ts +++ b/packages/colony-js/src/clients/Core/augments/augmentsV3.ts @@ -7,11 +7,11 @@ import { import { ColonyNetworkClient } from '../../ColonyNetworkClient.js'; import { - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../contracts.js'; import { addAugments as addCommonAugments, @@ -19,11 +19,11 @@ import { } from './commonAugments.js'; type ValidColony = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; export interface AugmentedEstimateV3 { /** diff --git a/packages/colony-js/src/clients/Core/augments/augmentsV4.ts b/packages/colony-js/src/clients/Core/augments/augmentsV4.ts index 3ce307804..fbab347a0 100644 --- a/packages/colony-js/src/clients/Core/augments/augmentsV4.ts +++ b/packages/colony-js/src/clients/Core/augments/augmentsV4.ts @@ -7,11 +7,11 @@ import { import { ColonyNetworkClient } from '../../ColonyNetworkClient.js'; import { - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../contracts.js'; import { AugmentedIColony } from './commonAugments.js'; import { @@ -21,11 +21,11 @@ import { } from './augmentsV3.js'; type ValidColony = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; export interface AugmentedEstimateV4 extends AugmentedEstimateV3 { /** diff --git a/packages/colony-js/src/clients/Core/augments/augmentsV5.ts b/packages/colony-js/src/clients/Core/augments/augmentsV5.ts index d7edb5d1b..9a17c8669 100644 --- a/packages/colony-js/src/clients/Core/augments/augmentsV5.ts +++ b/packages/colony-js/src/clients/Core/augments/augmentsV5.ts @@ -19,11 +19,11 @@ import { import { ColonyNetworkClient } from '../../ColonyNetworkClient.js'; import { - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../contracts.js'; import { AugmentedIColony } from './commonAugments.js'; import { ColonyAugmentsV3 } from './augmentsV3.js'; @@ -34,11 +34,11 @@ import { } from './augmentsV4.js'; type ValidColony = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; /* * Estimates diff --git a/packages/colony-js/src/clients/Core/augments/augmentsV6.ts b/packages/colony-js/src/clients/Core/augments/augmentsV6.ts index 5ca73b49d..46e34bfb4 100644 --- a/packages/colony-js/src/clients/Core/augments/augmentsV6.ts +++ b/packages/colony-js/src/clients/Core/augments/augmentsV6.ts @@ -7,11 +7,11 @@ import { import { ColonyNetworkClient } from '../../ColonyNetworkClient.js'; import { - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../contracts.js'; import { AugmentedIColony } from './commonAugments.js'; import { ColonyAugmentsV3 } from './augmentsV3.js'; @@ -23,11 +23,11 @@ import { } from './augmentsV5.js'; type ValidColony = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; /* * Estimates diff --git a/packages/colony-js/src/clients/Core/augments/augmentsV7.ts b/packages/colony-js/src/clients/Core/augments/augmentsV7.ts index 7506cabcc..6b29c5b03 100644 --- a/packages/colony-js/src/clients/Core/augments/augmentsV7.ts +++ b/packages/colony-js/src/clients/Core/augments/augmentsV7.ts @@ -7,11 +7,11 @@ import { import { ColonyNetworkClient } from '../../ColonyNetworkClient.js'; import { - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../contracts.js'; import { AugmentedIColony } from './commonAugments.js'; import { ColonyAugmentsV3 } from './augmentsV3.js'; @@ -24,11 +24,11 @@ import { } from './augmentsV6.js'; type ValidColony = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; /* * Estimates diff --git a/packages/colony-js/src/clients/Core/contracts.ts b/packages/colony-js/src/clients/Core/contracts.ts index cc114790d..37d98c3c8 100644 --- a/packages/colony-js/src/clients/Core/contracts.ts +++ b/packages/colony-js/src/clients/Core/contracts.ts @@ -14,9 +14,10 @@ import type { IColony as IColony12 } from '../../contracts/IColony/12/index.js'; import type { IColony as IColony13 } from '../../contracts/IColony/13/index.js'; import type { IColony as IColony14 } from '../../contracts/IColony/14/index.js'; import type { IColony as IColony15 } from '../../contracts/IColony/15/index.js'; +import type { IColony as IColony16 } from '../../contracts/IColony/16/index.js'; // Always adjust to the latest Colony version -export { IColony__factory as IColonyFactory } from '../../contracts/IColony/15/factories/IColony__factory.js'; +export { IColony__factory as IColonyFactory } from '../../contracts/IColony/16/factories/IColony__factory.js'; export type IColonyV1 = IColony1; export type IColonyV2 = IColony2; @@ -33,11 +34,11 @@ export type IColonyV12 = IColony12; export type IColonyV13 = IColony13; export type IColonyV14 = IColony14; export type IColonyV15 = IColony15; +export type IColonyV16 = IColony16; export type AnyIColony = - | IColony10 - | IColony11 | IColony12 | IColony13 | IColony14 - | IColony15; + | IColony15 + | IColony16; diff --git a/packages/colony-js/src/clients/Core/exports.ts b/packages/colony-js/src/clients/Core/exports.ts index 634dad129..be409ba5e 100644 --- a/packages/colony-js/src/clients/Core/exports.ts +++ b/packages/colony-js/src/clients/Core/exports.ts @@ -13,27 +13,26 @@ import getColonyClientV6 from './ColonyClientV6.js'; import getColonyClientV7 from './ColonyClientV7.js'; import getColonyClientV8 from './ColonyClientV8.js'; import getColonyClientV9 from './ColonyClientV9.js'; -import getColonyClientV10, { ColonyClientV10 } from './ColonyClientV10.js'; -import getColonyClientV11, { ColonyClientV11 } from './ColonyClientV11.js'; +import getColonyClientV10 from './ColonyClientV10.js'; +import getColonyClientV11 from './ColonyClientV11.js'; import getColonyClientV12, { ColonyClientV12 } from './ColonyClientV12.js'; import getColonyClientV13, { ColonyClientV13 } from './ColonyClientV13.js'; import getColonyClientV14, { ColonyClientV14 } from './ColonyClientV14.js'; import getColonyClientV15, { ColonyClientV15 } from './ColonyClientV15.js'; +import getColonyClientV16, { ColonyClientV16 } from './ColonyClientV16.js'; -export { ColonyClientV10 } from './ColonyClientV10.js'; -export { ColonyClientV11 } from './ColonyClientV11.js'; export { ColonyClientV12 } from './ColonyClientV12.js'; export { ColonyClientV13 } from './ColonyClientV13.js'; export { ColonyClientV14 } from './ColonyClientV14.js'; export { ColonyClientV15 } from './ColonyClientV15.js'; +export { ColonyClientV16 } from './ColonyClientV16.js'; export type AnyColonyClient = - | ColonyClientV10 - | ColonyClientV11 | ColonyClientV12 | ColonyClientV13 | ColonyClientV14 - | ColonyClientV15; + | ColonyClientV15 + | ColonyClientV16; /** Versioned core contract names */ export enum Core { @@ -75,7 +74,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 2: { @@ -83,7 +82,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 3: { @@ -91,7 +90,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 4: { @@ -99,7 +98,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 5: { @@ -107,7 +106,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 6: { @@ -115,7 +114,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 7: { @@ -123,7 +122,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 8: { @@ -131,7 +130,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 9: { @@ -139,7 +138,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ) as ColonyClientV10; + ) as ColonyClientV12; break; } case 10: { @@ -147,7 +146,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ); + ) as ColonyClientV12; break; } case 11: { @@ -155,7 +154,7 @@ export async function getColonyClient( this, colonyAddress, signerOrProvider, - ); + ) as ColonyClientV12; break; } case 12: { @@ -190,6 +189,14 @@ export async function getColonyClient( ); break; } + case 16: { + colonyClient = getColonyClientV16.call( + this, + colonyAddress, + signerOrProvider, + ); + break; + } default: { throw new Error('Colony version not supported'); } diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV1.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV1.ts index 72fe64cee..b7b826495 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV1.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV1.ts @@ -5,10 +5,11 @@ import { ClientType } from '../../../constants.js'; import { type UnkonwnFundingQueueClient, addAugments, + ValidColony, } from './augments/commonAugments.js'; export default function getFundingQueueClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ) { const fundingQueueClient = FundingQueueFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV2.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV2.ts index 641218e37..365a843eb 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV2.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV2.ts @@ -1,26 +1,21 @@ -import type { FundingQueue } from '../../../contracts/FundingQueue/2/FundingQueue.js'; import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; import { FundingQueue__factory as FundingQueueFactory } from '../../../contracts/FundingQueue/2/factories/FundingQueue__factory.js'; import { ClientType } from '../../../constants.js'; import { addAugments, - AugmentedFundingQueue, + UnkonwnFundingQueueClient, + ValidColony, } from './augments/commonAugments.js'; -export interface FundingQueueClientV2 - extends AugmentedFundingQueue { - clientVersion: 2; -} - export default function getFundingQueueClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, -): FundingQueueClientV2 { +) { const fundingQueueClient = FundingQueueFactory.connect( address, colonyClient.signer || colonyClient.provider, - ) as FundingQueueClientV2; + ) as UnkonwnFundingQueueClient; fundingQueueClient.clientType = ClientType.FundingQueueClient; fundingQueueClient.clientVersion = 2; diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV3.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV3.ts index d215d37ec..848f67fe3 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV3.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV3.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedFundingQueue, + ValidColony, } from './augments/commonAugments.js'; export interface FundingQueueClientV3 @@ -14,7 +15,7 @@ export interface FundingQueueClientV3 } export default function getFundingQueueClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): FundingQueueClientV3 { const fundingQueueClient = FundingQueueFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV4.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV4.ts index 58e048b6b..a2d863d53 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV4.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV4.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedFundingQueue, + ValidColony, } from './augments/commonAugments.js'; export interface FundingQueueClientV4 @@ -14,7 +15,7 @@ export interface FundingQueueClientV4 } export default function getFundingQueueClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): FundingQueueClientV4 { const fundingQueueClient = FundingQueueFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV5.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV5.ts index 916834874..3248ce14a 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV5.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV5.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedFundingQueue, + ValidColony, } from './augments/commonAugments.js'; export interface FundingQueueClientV5 @@ -14,7 +15,7 @@ export interface FundingQueueClientV5 } export default function getFundingQueueClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): FundingQueueClientV5 { const fundingQueueClient = FundingQueueFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV6.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV6.ts index ea12d2375..53cbcae60 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV6.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV6.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedFundingQueue, + ValidColony, } from './augments/commonAugments.js'; export interface FundingQueueClientV6 @@ -14,7 +15,7 @@ export interface FundingQueueClientV6 } export default function getFundingQueueClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): FundingQueueClientV6 { const fundingQueueClient = FundingQueueFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV7.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV7.ts index 5088c3a00..8f20c2df5 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV7.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV7.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedFundingQueue, + ValidColony, } from './augments/commonAugments.js'; export interface FundingQueueClientV7 @@ -14,7 +15,7 @@ export interface FundingQueueClientV7 } export default function getFundingQueueClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): FundingQueueClientV7 { const fundingQueueClient = FundingQueueFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV8.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV8.ts new file mode 100644 index 000000000..ddddd565d --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/FundingQueueClientV8.ts @@ -0,0 +1,31 @@ +import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import type { FundingQueue } from '../../../contracts/FundingQueue/8/FundingQueue.js'; + +import { FundingQueue__factory as FundingQueueFactory } from '../../../contracts/FundingQueue/8/factories/FundingQueue__factory.js'; +import { ClientType } from '../../../constants.js'; +import { + addAugments, + AugmentedFundingQueue, + ValidColony, +} from './augments/commonAugments.js'; + +export interface FundingQueueClientV8 + extends AugmentedFundingQueue { + clientVersion: 8; +} + +export default function getFundingQueueClient( + colonyClient: AugmentedIColony, + address: string, +): FundingQueueClientV8 { + const fundingQueueClient = FundingQueueFactory.connect( + address, + colonyClient.signer || colonyClient.provider, + ) as FundingQueueClientV8; + + fundingQueueClient.clientType = ClientType.FundingQueueClient; + fundingQueueClient.clientVersion = 8; + addAugments(fundingQueueClient, colonyClient); + + return fundingQueueClient; +} diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/augments/commonAugments.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/augments/commonAugments.ts index 2127034d8..fb53d499b 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/augments/commonAugments.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/augments/commonAugments.ts @@ -9,6 +9,9 @@ import { ClientType } from '../../../../constants.js'; import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; import { AnyFundingQueue } from '../contracts.js'; +import { AnyIColony } from '../../../Core/contracts.js'; + +export type ValidColony = AnyIColony; export type AugmentedFundingQueue = T & { diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/contracts.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/contracts.ts index 81344b2be..2051e584b 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/contracts.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/contracts.ts @@ -6,9 +6,10 @@ import type { FundingQueue as FundingQueue4 } from '../../../contracts/FundingQu import type { FundingQueue as FundingQueue5 } from '../../../contracts/FundingQueue/5/index.js'; import type { FundingQueue as FundingQueue6 } from '../../../contracts/FundingQueue/6/index.js'; import type { FundingQueue as FundingQueue7 } from '../../../contracts/FundingQueue/7/index.js'; +import type { FundingQueue as FundingQueue8 } from '../../../contracts/FundingQueue/8/index.js'; // Always adjust to the latest factory -export { FundingQueue__factory as FundingQueueFactory } from '../../../contracts/FundingQueue/7/factories/FundingQueue__factory.js'; +export { FundingQueue__factory as FundingQueueFactory } from '../../../contracts/FundingQueue/8/factories/FundingQueue__factory.js'; export type FundingQueueV1 = FundingQueue1; export type FundingQueueV2 = FundingQueue2; @@ -17,11 +18,12 @@ export type FundingQueueV4 = FundingQueue4; export type FundingQueueV5 = FundingQueue5; export type FundingQueueV6 = FundingQueue6; export type FundingQueueV7 = FundingQueue7; +export type FundingQueueV8 = FundingQueue8; export type AnyFundingQueue = - | FundingQueue2 | FundingQueue3 | FundingQueue4 | FundingQueue5 | FundingQueue6 - | FundingQueue7; + | FundingQueue7 + | FundingQueue8; diff --git a/packages/colony-js/src/clients/Extensions/FundingQueue/exports.ts b/packages/colony-js/src/clients/Extensions/FundingQueue/exports.ts index 06db9c729..bc1fe4406 100644 --- a/packages/colony-js/src/clients/Extensions/FundingQueue/exports.ts +++ b/packages/colony-js/src/clients/Extensions/FundingQueue/exports.ts @@ -5,9 +5,7 @@ import { assertExhaustiveSwitch } from '@colony/core/utils'; import { AugmentedIColony } from '../../Core/augments/commonAugments.js'; import getFundingQueueClientV1 from './FundingQueueClientV1.js'; -import getFundingQueueClientV2, { - FundingQueueClientV2, -} from './FundingQueueClientV2.js'; +import getFundingQueueClientV2 from './FundingQueueClientV2.js'; import getFundingQueueClientV3, { FundingQueueClientV3, } from './FundingQueueClientV3.js'; @@ -23,21 +21,24 @@ import getFundingQueueClientV6, { import getFundingQueueClientV7, { FundingQueueClientV7, } from './FundingQueueClientV7.js'; +import getFundingQueueClientV8, { + FundingQueueClientV8, +} from './FundingQueueClientV8.js'; -export { FundingQueueClientV2 } from './FundingQueueClientV2.js'; export { FundingQueueClientV3 } from './FundingQueueClientV3.js'; export { FundingQueueClientV4 } from './FundingQueueClientV4.js'; export { FundingQueueClientV5 } from './FundingQueueClientV5.js'; export { FundingQueueClientV6 } from './FundingQueueClientV6.js'; export { FundingQueueClientV7 } from './FundingQueueClientV7.js'; +export { FundingQueueClientV8 } from './FundingQueueClientV8.js'; export type AnyFundingQueueClient = - | FundingQueueClientV2 | FundingQueueClientV3 | FundingQueueClientV4 | FundingQueueClientV5 | FundingQueueClientV6 - | FundingQueueClientV7; + | FundingQueueClientV7 + | FundingQueueClientV8; /** @internal */ export const getFundingQueueClient = ( @@ -50,9 +51,12 @@ export const getFundingQueueClient = ( return getFundingQueueClientV1( colonyClient, address, - ) as FundingQueueClientV2; + ) as FundingQueueClientV3; case 2: - return getFundingQueueClientV2(colonyClient, address); + return getFundingQueueClientV2( + colonyClient, + address, + ) as FundingQueueClientV3; case 3: return getFundingQueueClientV3(colonyClient, address); case 4: @@ -63,6 +67,8 @@ export const getFundingQueueClient = ( return getFundingQueueClientV6(colonyClient, address); case 7: return getFundingQueueClientV7(colonyClient, address); + case 8: + return getFundingQueueClientV8(colonyClient, address); default: return assertExhaustiveSwitch( version, diff --git a/packages/colony-js/src/clients/Extensions/MultisigPermissions/MultisigPermissionsClientV1.ts b/packages/colony-js/src/clients/Extensions/MultisigPermissions/MultisigPermissionsClientV1.ts new file mode 100644 index 000000000..3f9f50873 --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/MultisigPermissions/MultisigPermissionsClientV1.ts @@ -0,0 +1,31 @@ +import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import type { MultisigPermissions } from '../../../contracts/MultisigPermissions/1/MultisigPermissions.js'; + +import { MultisigPermissions__factory as MultisigPermissionsFactory } from '../../../contracts/MultisigPermissions/1/factories/MultisigPermissions__factory.js'; +import { ClientType } from '../../../constants.js'; +import { + addAugments, + AugmentedMultisigPermissions, + ValidColony, +} from './augments/commonAugments.js'; + +export interface MultisigPermissionsClientV1 + extends AugmentedMultisigPermissions { + clientVersion: 1; +} + +export default function getMultisigPermissionsClient( + colonyClient: AugmentedIColony, + address: string, +): MultisigPermissionsClientV1 { + const stagedExpenditureClient = MultisigPermissionsFactory.connect( + address, + colonyClient.signer || colonyClient.provider, + ) as MultisigPermissionsClientV1; + + stagedExpenditureClient.clientType = ClientType.MultisigPermissionsClient; + stagedExpenditureClient.clientVersion = 1; + addAugments(stagedExpenditureClient, colonyClient); + + return stagedExpenditureClient; +} diff --git a/packages/colony-js/src/clients/Extensions/MultisigPermissions/augments/commonAugments.ts b/packages/colony-js/src/clients/Extensions/MultisigPermissions/augments/commonAugments.ts new file mode 100644 index 000000000..2ca9b4740 --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/MultisigPermissions/augments/commonAugments.ts @@ -0,0 +1,55 @@ +import { type MultisigPermissionsVersion } from '@colony/core'; +import { + type MultisigPermissionsEvents, + MultisigPermissionsEvents__factory as MultisigPermissionsEventsFactory, +} from '@colony/events'; + +import { ClientType } from '../../../../constants.js'; +import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; +import { IColonyV14, IColonyV15, IColonyV16 } from '../../../Core/contracts.js'; +import { AnyMultisigPermissions } from '../contracts.js'; + +export type ValidColony = IColonyV14 | IColonyV15 | IColonyV16; + +export type AugmentedEstimate< + T extends AnyMultisigPermissions = AnyMultisigPermissions, +> = T['estimateGas']; + +export type AugmentedMultisigPermissions< + T extends AnyMultisigPermissions = AnyMultisigPermissions, +> = T & { + clientType: ClientType.MultisigPermissionsClient; + clientVersion: MultisigPermissionsVersion; + /** An instance of the corresponding ColonyClient */ + colonyClient: AugmentedIColony; + + /** + * The multisigPermissionsEvents contract supports all events across all versions. + * Isn't that amazing? + * It's an ethers contract with only events to filter + */ + // eslint-disable-next-line max-len + multisigPermissionsEvents: MultisigPermissionsEvents.MultisigPermissionsEvents; + + estimateGas: T['estimateGas'] & AugmentedEstimate; +}; + +export const addAugments = ( + instance: T, + colonyClient: AugmentedIColony, +): T => { + /* eslint-disable no-param-reassign */ + instance.clientType = ClientType.MultisigPermissionsClient; + instance.colonyClient = colonyClient; + + instance.multisigPermissionsEvents = MultisigPermissionsEventsFactory.connect( + instance.address, + instance.signer || instance.provider, + ); + + return instance; + /* eslint-enable no-param-reassign */ +}; + +export type UnkonwnMultisigPermissionsClient = + AugmentedMultisigPermissions; diff --git a/packages/colony-js/src/clients/Extensions/MultisigPermissions/contracts.ts b/packages/colony-js/src/clients/Extensions/MultisigPermissions/contracts.ts new file mode 100644 index 000000000..096b9642a --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/MultisigPermissions/contracts.ts @@ -0,0 +1,9 @@ +// Always add the next MultisigPermissions version here +import type { MultisigPermissions as MultisigPermissions1 } from '../../../contracts/MultisigPermissions/1/index.js'; + +// Always adjust to the latest factory +export { MultisigPermissions__factory as MultisigPermissionsFactory } from '../../../contracts/MultisigPermissions/1/factories/MultisigPermissions__factory.js'; + +export type MultisigPermissionsV1 = MultisigPermissions1; + +export type AnyMultisigPermissions = MultisigPermissions1; diff --git a/packages/colony-js/src/clients/Extensions/MultisigPermissions/exports.ts b/packages/colony-js/src/clients/Extensions/MultisigPermissions/exports.ts new file mode 100644 index 000000000..edddb029a --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/MultisigPermissions/exports.ts @@ -0,0 +1,34 @@ +import type { MultisigPermissionsVersion } from '@colony/core'; + +import { assertExhaustiveSwitch } from '@colony/core/utils'; + +import { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import { ValidColony } from './augments/commonAugments.js'; + +import getMultisigPermissionsClientV1, { + MultisigPermissionsClientV1, +} from './MultisigPermissionsClientV1.js'; + +export { MultisigPermissionsClientV1 } from './MultisigPermissionsClientV1.js'; + +export type AnyMultisigPermissionsClient = MultisigPermissionsClientV1; + +/** @internal */ +export const getMultisigPermissionsClient = ( + colonyClient: AugmentedIColony, + address: string, + version: MultisigPermissionsVersion, +): AnyMultisigPermissionsClient => { + switch (version) { + case 1: + return getMultisigPermissionsClientV1( + colonyClient as AugmentedIColony, + address, + ); + default: + return assertExhaustiveSwitch( + version, + 'Could not find MultisigPermissions version', + ); + } +}; diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV1.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV1.ts index 507ead847..debf4d4e1 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV1.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV1.ts @@ -5,10 +5,11 @@ import { ClientType } from '../../../constants.js'; import { type UnkonwnOneTxPaymentClient, addAugments, + ValidColony, } from './augments/commonAugments.js'; export default function getOneTxPaymentClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ) { const oneTxPaymentClient = OneTxPaymentFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV2.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV2.ts index e46d72b5d..4a7884711 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV2.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV2.ts @@ -1,30 +1,21 @@ import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; -import type { OneTxPayment } from '../../../contracts/OneTxPayment/2/OneTxPayment.js'; import { OneTxPayment__factory as OneTxPaymentFactory } from '../../../contracts/OneTxPayment/2/factories/OneTxPayment__factory.js'; import { ClientType } from '../../../constants.js'; import { addAugments, - AugmentedEstimate, - AugmentedOneTxPayment, + UnkonwnOneTxPaymentClient, + ValidColony, } from './augments/commonAugments.js'; -type OneTxPaymentEstimate = AugmentedEstimate; - -export interface OneTxPaymentClientV2 - extends AugmentedOneTxPayment { - clientVersion: 2; - estimateGas: OneTxPaymentEstimate; -} - export default function getOneTxPaymentClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, -): OneTxPaymentClientV2 { +) { const oneTxPaymentClient = OneTxPaymentFactory.connect( address, colonyClient.signer || colonyClient.provider, - ) as OneTxPaymentClientV2; + ) as UnkonwnOneTxPaymentClient; oneTxPaymentClient.clientType = ClientType.OneTxPaymentClient; oneTxPaymentClient.clientVersion = 2; diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV3.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV3.ts index 8f3e9325e..cd87ce531 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV3.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV3.ts @@ -7,6 +7,7 @@ import { addAugments, AugmentedEstimate, AugmentedOneTxPayment, + ValidColony, } from './augments/commonAugments.js'; type OneTxPaymentEstimate = AugmentedEstimate; @@ -18,7 +19,7 @@ export interface OneTxPaymentClientV3 } export default function getOneTxPaymentClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): OneTxPaymentClientV3 { const oneTxPaymentClient = OneTxPaymentFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV4.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV4.ts index 9544c892c..defacf2eb 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV4.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV4.ts @@ -7,6 +7,7 @@ import { addAugments, AugmentedEstimate, AugmentedOneTxPayment, + ValidColony, } from './augments/commonAugments.js'; type OneTxPaymentEstimate = AugmentedEstimate; @@ -18,7 +19,7 @@ export interface OneTxPaymentClientV4 } export default function getOneTxPaymentClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): OneTxPaymentClientV4 { const oneTxPaymentClient = OneTxPaymentFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV5.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV5.ts index 46315ef9f..a3ae3bb80 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV5.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV5.ts @@ -7,6 +7,7 @@ import { addAugments, AugmentedEstimate, AugmentedOneTxPayment, + ValidColony, } from './augments/commonAugments.js'; type OneTxPaymentEstimate = AugmentedEstimate; @@ -18,7 +19,7 @@ export interface OneTxPaymentClientV5 } export default function getOneTxPaymentClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): OneTxPaymentClientV5 { const oneTxPaymentClient = OneTxPaymentFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV6.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV6.ts index 2790e0841..294eecba5 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV6.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV6.ts @@ -7,6 +7,7 @@ import { addAugments, AugmentedEstimate, AugmentedOneTxPayment, + ValidColony, } from './augments/commonAugments.js'; type OneTxPaymentEstimate = AugmentedEstimate; @@ -18,7 +19,7 @@ export interface OneTxPaymentClientV6 } export default function getOneTxPaymentClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): OneTxPaymentClientV6 { const oneTxPaymentClient = OneTxPaymentFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV7.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV7.ts index 63a5250c0..ffe8dd5db 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV7.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV7.ts @@ -7,6 +7,7 @@ import { addAugments, AugmentedEstimate, AugmentedOneTxPayment, + ValidColony, } from './augments/commonAugments.js'; type OneTxPaymentEstimate = AugmentedEstimate; @@ -18,7 +19,7 @@ export interface OneTxPaymentClientV7 } export default function getOneTxPaymentClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): OneTxPaymentClientV7 { const oneTxPaymentClient = OneTxPaymentFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV8.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV8.ts new file mode 100644 index 000000000..1f7b41b0a --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/OneTxPaymentClientV8.ts @@ -0,0 +1,35 @@ +import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import type { OneTxPayment } from '../../../contracts/OneTxPayment/8/OneTxPayment.js'; + +import { OneTxPayment__factory as OneTxPaymentFactory } from '../../../contracts/OneTxPayment/8/factories/OneTxPayment__factory.js'; +import { ClientType } from '../../../constants.js'; +import { + addAugments, + AugmentedEstimate, + AugmentedOneTxPayment, + ValidColony, +} from './augments/commonAugments.js'; + +type OneTxPaymentEstimate = AugmentedEstimate; + +export interface OneTxPaymentClientV8 + extends AugmentedOneTxPayment { + clientVersion: 8; + estimateGas: OneTxPaymentEstimate; +} + +export default function getOneTxPaymentClient( + colonyClient: AugmentedIColony, + address: string, +): OneTxPaymentClientV8 { + const oneTxPaymentClient = OneTxPaymentFactory.connect( + address, + colonyClient.signer || colonyClient.provider, + ) as OneTxPaymentClientV8; + + oneTxPaymentClient.clientType = ClientType.OneTxPaymentClient; + oneTxPaymentClient.clientVersion = 8; + addAugments(oneTxPaymentClient, colonyClient); + + return oneTxPaymentClient; +} diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/augments/commonAugments.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/augments/commonAugments.ts index 4e5f45a4e..7b59d045a 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/augments/commonAugments.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/augments/commonAugments.ts @@ -14,6 +14,9 @@ import { import { ClientType } from '../../../../constants.js'; import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; import { AnyOneTxPayment } from '../contracts.js'; +import { AnyIColony } from '../../../Core/contracts.js'; + +export type ValidColony = AnyIColony; export type AugmentedEstimate = T['estimateGas'] & { diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/contracts.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/contracts.ts index 48b4a7aaa..d1dbdba73 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/contracts.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/contracts.ts @@ -6,9 +6,10 @@ import type { OneTxPayment as OneTxPayment4 } from '../../../contracts/OneTxPaym import type { OneTxPayment as OneTxPayment5 } from '../../../contracts/OneTxPayment/5/index.js'; import type { OneTxPayment as OneTxPayment6 } from '../../../contracts/OneTxPayment/6/index.js'; import type { OneTxPayment as OneTxPayment7 } from '../../../contracts/OneTxPayment/7/index.js'; +import type { OneTxPayment as OneTxPayment8 } from '../../../contracts/OneTxPayment/8/index.js'; // Always adjust to the latest factory -export { OneTxPayment__factory as OneTxPaymentFactory } from '../../../contracts/OneTxPayment/7/factories/OneTxPayment__factory.js'; +export { OneTxPayment__factory as OneTxPaymentFactory } from '../../../contracts/OneTxPayment/8/factories/OneTxPayment__factory.js'; export type OneTxPaymentV1 = OneTxPayment1; export type OneTxPaymentV2 = OneTxPayment2; @@ -17,6 +18,7 @@ export type OneTxPaymentV4 = OneTxPayment4; export type OneTxPaymentV5 = OneTxPayment5; export type OneTxPaymentV6 = OneTxPayment6; export type OneTxPaymentV7 = OneTxPayment7; +export type OneTxPaymentV8 = OneTxPayment8; export type AnyOneTxPayment = | OneTxPayment2 @@ -24,4 +26,5 @@ export type AnyOneTxPayment = | OneTxPayment4 | OneTxPayment5 | OneTxPayment6 - | OneTxPayment7; + | OneTxPayment7 + | OneTxPayment8; diff --git a/packages/colony-js/src/clients/Extensions/OneTxPayment/exports.ts b/packages/colony-js/src/clients/Extensions/OneTxPayment/exports.ts index e639ee812..2069627eb 100644 --- a/packages/colony-js/src/clients/Extensions/OneTxPayment/exports.ts +++ b/packages/colony-js/src/clients/Extensions/OneTxPayment/exports.ts @@ -5,9 +5,7 @@ import { assertExhaustiveSwitch } from '@colony/core/utils'; import { AugmentedIColony } from '../../Core/augments/commonAugments.js'; import getOneTxPaymentClientV1 from './OneTxPaymentClientV1.js'; -import getOneTxPaymentClientV2, { - OneTxPaymentClientV2, -} from './OneTxPaymentClientV2.js'; +import getOneTxPaymentClientV2 from './OneTxPaymentClientV2.js'; import getOneTxPaymentClientV3, { OneTxPaymentClientV3, } from './OneTxPaymentClientV3.js'; @@ -23,21 +21,24 @@ import getOneTxPaymentClientV6, { import getOneTxPaymentClientV7, { OneTxPaymentClientV7, } from './OneTxPaymentClientV7.js'; +import getOneTxPaymentClientV8, { + OneTxPaymentClientV8, +} from './OneTxPaymentClientV8.js'; -export { OneTxPaymentClientV2 } from './OneTxPaymentClientV2.js'; export { OneTxPaymentClientV3 } from './OneTxPaymentClientV3.js'; export { OneTxPaymentClientV4 } from './OneTxPaymentClientV4.js'; export { OneTxPaymentClientV5 } from './OneTxPaymentClientV5.js'; export { OneTxPaymentClientV6 } from './OneTxPaymentClientV6.js'; export { OneTxPaymentClientV7 } from './OneTxPaymentClientV7.js'; +export { OneTxPaymentClientV8 } from './OneTxPaymentClientV8.js'; export type AnyOneTxPaymentClient = - | OneTxPaymentClientV2 | OneTxPaymentClientV3 | OneTxPaymentClientV4 | OneTxPaymentClientV5 | OneTxPaymentClientV6 - | OneTxPaymentClientV7; + | OneTxPaymentClientV7 + | OneTxPaymentClientV8; /** @internal */ export const getOneTxPaymentClient = ( @@ -47,9 +48,15 @@ export const getOneTxPaymentClient = ( ): AnyOneTxPaymentClient => { switch (version) { case 1: - return getOneTxPaymentClientV1(colonyClient, address); + return getOneTxPaymentClientV1( + colonyClient, + address, + ) as OneTxPaymentClientV3; case 2: - return getOneTxPaymentClientV2(colonyClient, address); + return getOneTxPaymentClientV2( + colonyClient, + address, + ) as OneTxPaymentClientV3; case 3: return getOneTxPaymentClientV3(colonyClient, address); case 4: @@ -60,6 +67,8 @@ export const getOneTxPaymentClient = ( return getOneTxPaymentClientV6(colonyClient, address); case 7: return getOneTxPaymentClientV7(colonyClient, address); + case 8: + return getOneTxPaymentClientV8(colonyClient, address); default: return assertExhaustiveSwitch( version, diff --git a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV1.ts b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV1.ts index f70375fd7..9af758618 100644 --- a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV1.ts +++ b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV1.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedReputationBootstrapper, + ValidColony, } from './augments/commonAugments.js'; export interface ReputationBootstrapperClientV1 @@ -14,7 +15,7 @@ export interface ReputationBootstrapperClientV1 } export default function getReputationBootstrapperClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): ReputationBootstrapperClientV1 { const reputationBootstrapperClient = ReputationBootstrapperFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV2.ts b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV2.ts index d712f7c6c..80ffda5ef 100644 --- a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV2.ts +++ b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV2.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedReputationBootstrapper, + ValidColony, } from './augments/commonAugments.js'; export interface ReputationBootstrapperClientV2 @@ -14,7 +15,7 @@ export interface ReputationBootstrapperClientV2 } export default function getReputationBootstrapperClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): ReputationBootstrapperClientV2 { const reputationBootstrapperClient = ReputationBootstrapperFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV3.ts b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV3.ts index 19f2754bd..32a2ba6a0 100644 --- a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV3.ts +++ b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV3.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedReputationBootstrapper, + ValidColony, } from './augments/commonAugments.js'; export interface ReputationBootstrapperClientV3 @@ -14,7 +15,7 @@ export interface ReputationBootstrapperClientV3 } export default function getReputationBootstrapperClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): ReputationBootstrapperClientV3 { const reputationBootstrapperClient = ReputationBootstrapperFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV4.ts b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV4.ts index 0afca5d44..0eb7af3e5 100644 --- a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV4.ts +++ b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV4.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedReputationBootstrapper, + ValidColony, } from './augments/commonAugments.js'; export interface ReputationBootstrapperClientV4 @@ -14,7 +15,7 @@ export interface ReputationBootstrapperClientV4 } export default function getReputationBootstrapperClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): ReputationBootstrapperClientV4 { const reputationBootstrapperClient = ReputationBootstrapperFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV5.ts b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV5.ts new file mode 100644 index 000000000..a979678c9 --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/ReputationBootstrapperClientV5.ts @@ -0,0 +1,32 @@ +import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import type { ReputationBootstrapper } from '../../../contracts/ReputationBootstrapper/5/ReputationBootstrapper.js'; + +import { ReputationBootstrapper__factory as ReputationBootstrapperFactory } from '../../../contracts/ReputationBootstrapper/5/factories/ReputationBootstrapper__factory.js'; +import { ClientType } from '../../../constants.js'; +import { + addAugments, + AugmentedReputationBootstrapper, + ValidColony, +} from './augments/commonAugments.js'; + +export interface ReputationBootstrapperClientV5 + extends AugmentedReputationBootstrapper { + clientVersion: 5; +} + +export default function getReputationBootstrapperClient( + colonyClient: AugmentedIColony, + address: string, +): ReputationBootstrapperClientV5 { + const reputationBootstrapperClient = ReputationBootstrapperFactory.connect( + address, + colonyClient.signer || colonyClient.provider, + ) as ReputationBootstrapperClientV5; + + reputationBootstrapperClient.clientType = + ClientType.ReputationBootstrapperClient; + reputationBootstrapperClient.clientVersion = 5; + addAugments(reputationBootstrapperClient, colonyClient); + + return reputationBootstrapperClient; +} diff --git a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/augments/commonAugments.ts b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/augments/commonAugments.ts index 76656439d..f55e4c9c1 100644 --- a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/augments/commonAugments.ts +++ b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/augments/commonAugments.ts @@ -8,6 +8,9 @@ import { import { ClientType } from '../../../../constants.js'; import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; import { AnyReputationBootstrapper } from '../contracts.js'; +import { AnyIColony } from '../../../Core/contracts.js'; + +export type ValidColony = AnyIColony; export type AugmentedReputationBootstrapper< T extends AnyReputationBootstrapper = AnyReputationBootstrapper, diff --git a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/contracts.ts b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/contracts.ts index 9a8e493de..00a8e1daa 100644 --- a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/contracts.ts +++ b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/contracts.ts @@ -3,17 +3,20 @@ import type { ReputationBootstrapper as ReputationBootstrapper1 } from '../../.. import type { ReputationBootstrapper as ReputationBootstrapper2 } from '../../../contracts/ReputationBootstrapper/2/index.js'; import type { ReputationBootstrapper as ReputationBootstrapper3 } from '../../../contracts/ReputationBootstrapper/3/index.js'; import type { ReputationBootstrapper as ReputationBootstrapper4 } from '../../../contracts/ReputationBootstrapper/4/index.js'; +import type { ReputationBootstrapper as ReputationBootstrapper5 } from '../../../contracts/ReputationBootstrapper/5/index.js'; // Always adjust to the latest factory -export { ReputationBootstrapper__factory as ReputationBootstrapperFactory } from '../../../contracts/ReputationBootstrapper/4/factories/ReputationBootstrapper__factory.js'; +export { ReputationBootstrapper__factory as ReputationBootstrapperFactory } from '../../../contracts/ReputationBootstrapper/5/factories/ReputationBootstrapper__factory.js'; export type ReputationBootstrapperV1 = ReputationBootstrapper1; export type ReputationBootstrapperV2 = ReputationBootstrapper2; export type ReputationBootstrapperV3 = ReputationBootstrapper3; export type ReputationBootstrapperV4 = ReputationBootstrapper4; +export type ReputationBootstrapperV5 = ReputationBootstrapper5; export type AnyReputationBootstrapper = | ReputationBootstrapper1 | ReputationBootstrapper2 | ReputationBootstrapper3 - | ReputationBootstrapper4; + | ReputationBootstrapper4 + | ReputationBootstrapper5; diff --git a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/exports.ts b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/exports.ts index e43694b1b..2368e3f77 100644 --- a/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/exports.ts +++ b/packages/colony-js/src/clients/Extensions/ReputationBootstrapper/exports.ts @@ -16,17 +16,22 @@ import getReputationBootstrapperClientV3, { import getReputationBootstrapperClientV4, { ReputationBootstrapperClientV4, } from './ReputationBootstrapperClientV4.js'; +import getReputationBootstrapperClientV5, { + ReputationBootstrapperClientV5, +} from './ReputationBootstrapperClientV5.js'; export { ReputationBootstrapperClientV1 } from './ReputationBootstrapperClientV1.js'; export { ReputationBootstrapperClientV2 } from './ReputationBootstrapperClientV2.js'; export { ReputationBootstrapperClientV3 } from './ReputationBootstrapperClientV3.js'; export { ReputationBootstrapperClientV4 } from './ReputationBootstrapperClientV4.js'; +export { ReputationBootstrapperClientV5 } from './ReputationBootstrapperClientV5.js'; export type AnyReputationBootstrapperClient = | ReputationBootstrapperClientV1 | ReputationBootstrapperClientV2 | ReputationBootstrapperClientV3 - | ReputationBootstrapperClientV4; + | ReputationBootstrapperClientV4 + | ReputationBootstrapperClientV5; /** @internal */ export const getReputationBootstrapperClient = ( @@ -43,6 +48,8 @@ export const getReputationBootstrapperClient = ( return getReputationBootstrapperClientV3(colonyClient, address); case 4: return getReputationBootstrapperClientV4(colonyClient, address); + case 5: + return getReputationBootstrapperClientV5(colonyClient, address); default: return assertExhaustiveSwitch( version, diff --git a/packages/colony-js/src/clients/Extensions/StagedExpenditure/StagedExpenditureClientV3.ts b/packages/colony-js/src/clients/Extensions/StagedExpenditure/StagedExpenditureClientV3.ts new file mode 100644 index 000000000..99ebaaa78 --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/StagedExpenditure/StagedExpenditureClientV3.ts @@ -0,0 +1,31 @@ +import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import type { StagedExpenditure } from '../../../contracts/StagedExpenditure/3/StagedExpenditure.js'; + +import { StagedExpenditure__factory as StagedExpenditureFactory } from '../../../contracts/StagedExpenditure/3/factories/StagedExpenditure__factory.js'; +import { ClientType } from '../../../constants.js'; +import { + addAugments, + AugmentedStagedExpenditure, + ValidColony, +} from './augments/commonAugments.js'; + +export interface StagedExpenditureClientV3 + extends AugmentedStagedExpenditure { + clientVersion: 3; +} + +export default function getStagedExpenditureClient( + colonyClient: AugmentedIColony, + address: string, +): StagedExpenditureClientV3 { + const stagedExpenditureClient = StagedExpenditureFactory.connect( + address, + colonyClient.signer || colonyClient.provider, + ) as StagedExpenditureClientV3; + + stagedExpenditureClient.clientType = ClientType.StagedExpenditureClient; + stagedExpenditureClient.clientVersion = 3; + addAugments(stagedExpenditureClient, colonyClient); + + return stagedExpenditureClient; +} diff --git a/packages/colony-js/src/clients/Extensions/StagedExpenditure/augments/commonAugments.ts b/packages/colony-js/src/clients/Extensions/StagedExpenditure/augments/commonAugments.ts index 498ab549e..b4253e2cd 100644 --- a/packages/colony-js/src/clients/Extensions/StagedExpenditure/augments/commonAugments.ts +++ b/packages/colony-js/src/clients/Extensions/StagedExpenditure/augments/commonAugments.ts @@ -6,10 +6,10 @@ import { import { ClientType } from '../../../../constants.js'; import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; -import { IColonyV14 } from '../../../Core/contracts.js'; +import { IColonyV14, IColonyV15, IColonyV16 } from '../../../Core/contracts.js'; import { AnyStagedExpenditure } from '../contracts.js'; -export type ValidColony = IColonyV14; +export type ValidColony = IColonyV14 | IColonyV15 | IColonyV16; export type AugmentedEstimate< T extends AnyStagedExpenditure = AnyStagedExpenditure, diff --git a/packages/colony-js/src/clients/Extensions/StagedExpenditure/contracts.ts b/packages/colony-js/src/clients/Extensions/StagedExpenditure/contracts.ts index 8644523f0..c127b2949 100644 --- a/packages/colony-js/src/clients/Extensions/StagedExpenditure/contracts.ts +++ b/packages/colony-js/src/clients/Extensions/StagedExpenditure/contracts.ts @@ -1,11 +1,16 @@ // Always add the next StagedExpenditure version here import type { StagedExpenditure as StagedExpenditure1 } from '../../../contracts/StagedExpenditure/1/index.js'; import type { StagedExpenditure as StagedExpenditure2 } from '../../../contracts/StagedExpenditure/2/index.js'; +import type { StagedExpenditure as StagedExpenditure3 } from '../../../contracts/StagedExpenditure/3/index.js'; // Always adjust to the latest factory -export { StagedExpenditure__factory as StagedExpenditureFactory } from '../../../contracts/StagedExpenditure/2/factories/StagedExpenditure__factory.js'; +export { StagedExpenditure__factory as StagedExpenditureFactory } from '../../../contracts/StagedExpenditure/3/factories/StagedExpenditure__factory.js'; export type StagedExpenditureV1 = StagedExpenditure1; export type StagedExpenditureV2 = StagedExpenditure2; +export type StagedExpenditureV3 = StagedExpenditure3; -export type AnyStagedExpenditure = StagedExpenditure1 | StagedExpenditure2; +export type AnyStagedExpenditure = + | StagedExpenditure1 + | StagedExpenditure2 + | StagedExpenditure3; diff --git a/packages/colony-js/src/clients/Extensions/StagedExpenditure/exports.ts b/packages/colony-js/src/clients/Extensions/StagedExpenditure/exports.ts index fca510150..187efca82 100644 --- a/packages/colony-js/src/clients/Extensions/StagedExpenditure/exports.ts +++ b/packages/colony-js/src/clients/Extensions/StagedExpenditure/exports.ts @@ -11,13 +11,18 @@ import getStagedExpenditureClientV1, { import getStagedExpenditureClientV2, { StagedExpenditureClientV2, } from './StagedExpenditureClientV2.js'; +import getStagedExpenditureClientV3, { + StagedExpenditureClientV3, +} from './StagedExpenditureClientV3.js'; export { StagedExpenditureClientV1 } from './StagedExpenditureClientV1.js'; export { StagedExpenditureClientV2 } from './StagedExpenditureClientV2.js'; +export { StagedExpenditureClientV3 } from './StagedExpenditureClientV3.js'; export type AnyStagedExpenditureClient = | StagedExpenditureClientV1 - | StagedExpenditureClientV2; + | StagedExpenditureClientV2 + | StagedExpenditureClientV3; /** @internal */ export const getStagedExpenditureClient = ( @@ -36,6 +41,11 @@ export const getStagedExpenditureClient = ( colonyClient as AugmentedIColony, address, ); + case 3: + return getStagedExpenditureClientV3( + colonyClient as AugmentedIColony, + address, + ); default: return assertExhaustiveSwitch( version, diff --git a/packages/colony-js/src/clients/Extensions/StakedExpenditure/StakedExpenditureClientV6.ts b/packages/colony-js/src/clients/Extensions/StakedExpenditure/StakedExpenditureClientV6.ts new file mode 100644 index 000000000..1523bd9c3 --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/StakedExpenditure/StakedExpenditureClientV6.ts @@ -0,0 +1,31 @@ +import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import type { StakedExpenditure } from '../../../contracts/StakedExpenditure/6/index.js'; + +import { StakedExpenditure__factory as StakedExpenditureFactory } from '../../../contracts/StakedExpenditure/6/factories/StakedExpenditure__factory.js'; +import { + addAugments, + AugmentedStakedExpenditure, + ValidColony, +} from './augments/commonAugments.js'; +import { ClientType } from '../../../constants.js'; + +export interface StakedExpenditureClientV6 + extends AugmentedStakedExpenditure { + clientVersion: 6; +} + +export default function getStakedExpenditureClient( + colonyClient: AugmentedIColony, + address: string, +): StakedExpenditureClientV6 { + const stakedExpenditureClient = StakedExpenditureFactory.connect( + address, + colonyClient.signer || colonyClient.provider, + ) as StakedExpenditureClientV6; + + stakedExpenditureClient.clientType = ClientType.StakedExpenditureClient; + stakedExpenditureClient.clientVersion = 6; + addAugments(stakedExpenditureClient, colonyClient); + + return stakedExpenditureClient; +} diff --git a/packages/colony-js/src/clients/Extensions/StakedExpenditure/augments/commonAugments.ts b/packages/colony-js/src/clients/Extensions/StakedExpenditure/augments/commonAugments.ts index 8fe36c75f..b07e46894 100644 --- a/packages/colony-js/src/clients/Extensions/StakedExpenditure/augments/commonAugments.ts +++ b/packages/colony-js/src/clients/Extensions/StakedExpenditure/augments/commonAugments.ts @@ -18,20 +18,20 @@ import { import { ClientType } from '../../../../constants.js'; import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; import { - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../../../Core/contracts.js'; import { AnyStakedExpenditure } from '../contracts.js'; export type ValidColony = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; export type AugmentedEstimate< T extends AnyStakedExpenditure = AnyStakedExpenditure, diff --git a/packages/colony-js/src/clients/Extensions/StakedExpenditure/contracts.ts b/packages/colony-js/src/clients/Extensions/StakedExpenditure/contracts.ts index a0f831e0c..fdb6cf860 100644 --- a/packages/colony-js/src/clients/Extensions/StakedExpenditure/contracts.ts +++ b/packages/colony-js/src/clients/Extensions/StakedExpenditure/contracts.ts @@ -4,19 +4,22 @@ import type { StakedExpenditure as StakedExpenditure2 } from '../../../contracts import type { StakedExpenditure as StakedExpenditure3 } from '../../../contracts/StakedExpenditure/3/index.js'; import type { StakedExpenditure as StakedExpenditure4 } from '../../../contracts/StakedExpenditure/4/index.js'; import type { StakedExpenditure as StakedExpenditure5 } from '../../../contracts/StakedExpenditure/5/index.js'; +import type { StakedExpenditure as StakedExpenditure6 } from '../../../contracts/StakedExpenditure/6/index.js'; // Always adjust to the latest factory -export { StakedExpenditure__factory as StakedExpenditureFactory } from '../../../contracts/StakedExpenditure/5/factories/StakedExpenditure__factory.js'; +export { StakedExpenditure__factory as StakedExpenditureFactory } from '../../../contracts/StakedExpenditure/6/factories/StakedExpenditure__factory.js'; export type StakedExpenditureV1 = StakedExpenditure1; export type StakedExpenditureV2 = StakedExpenditure2; export type StakedExpenditureV3 = StakedExpenditure3; export type StakedExpenditureV4 = StakedExpenditure4; export type StakedExpenditureV5 = StakedExpenditure5; +export type StakedExpenditureV6 = StakedExpenditure6; export type AnyStakedExpenditure = | StakedExpenditure1 | StakedExpenditure2 | StakedExpenditure3 | StakedExpenditure4 - | StakedExpenditure5; + | StakedExpenditure5 + | StakedExpenditure6; diff --git a/packages/colony-js/src/clients/Extensions/StakedExpenditure/exports.ts b/packages/colony-js/src/clients/Extensions/StakedExpenditure/exports.ts index 7f35b9869..8fc02e70e 100644 --- a/packages/colony-js/src/clients/Extensions/StakedExpenditure/exports.ts +++ b/packages/colony-js/src/clients/Extensions/StakedExpenditure/exports.ts @@ -20,19 +20,24 @@ import getStakedExpenditureClientV4, { import getStakedExpenditureClientV5, { StakedExpenditureClientV5, } from './StakedExpenditureClientV5.js'; +import getStakedExpenditureClientV6, { + StakedExpenditureClientV6, +} from './StakedExpenditureClientV6.js'; export { StakedExpenditureClientV1 } from './StakedExpenditureClientV1.js'; export { StakedExpenditureClientV2 } from './StakedExpenditureClientV2.js'; export { StakedExpenditureClientV3 } from './StakedExpenditureClientV3.js'; export { StakedExpenditureClientV4 } from './StakedExpenditureClientV4.js'; export { StakedExpenditureClientV5 } from './StakedExpenditureClientV5.js'; +export { StakedExpenditureClientV6 } from './StakedExpenditureClientV6.js'; export type AnyStakedExpenditureClient = | StakedExpenditureClientV1 | StakedExpenditureClientV2 | StakedExpenditureClientV3 | StakedExpenditureClientV4 - | StakedExpenditureClientV5; + | StakedExpenditureClientV5 + | StakedExpenditureClientV6; /** @internal */ export const getStakedExpenditureClient = ( @@ -66,6 +71,11 @@ export const getStakedExpenditureClient = ( colonyClient as AugmentedIColony, address, ); + case 6: + return getStakedExpenditureClientV6( + colonyClient as AugmentedIColony, + address, + ); default: return assertExhaustiveSwitch( version, diff --git a/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV2.ts b/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV2.ts deleted file mode 100644 index d9ce04951..000000000 --- a/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV2.ts +++ /dev/null @@ -1,31 +0,0 @@ -import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; -import type { StreamingPayments } from '../../../contracts/StreamingPayments/2/StreamingPayments.js'; - -import { StreamingPayments__factory as StreamingPaymentsFactory } from '../../../contracts/StreamingPayments/2/factories/StreamingPayments__factory.js'; -import { ClientType } from '../../../constants.js'; -import { - addAugments, - AugmentedStreamingPayments, - ValidColony, -} from './augments/commonAugments.js'; - -export interface StreamingPaymentsClientV2 - extends AugmentedStreamingPayments { - clientVersion: 2; -} - -export default function getStreamingPaymentsClient( - colonyClient: AugmentedIColony, - address: string, -): StreamingPaymentsClientV2 { - const streamingPaymentsClient = StreamingPaymentsFactory.connect( - address, - colonyClient.signer || colonyClient.provider, - ) as StreamingPaymentsClientV2; - - streamingPaymentsClient.clientType = ClientType.StreamingPaymentsClient; - streamingPaymentsClient.clientVersion = 2; - addAugments(streamingPaymentsClient, colonyClient); - - return streamingPaymentsClient; -} diff --git a/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV3.ts b/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV3.ts deleted file mode 100644 index a44af1e32..000000000 --- a/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV3.ts +++ /dev/null @@ -1,31 +0,0 @@ -import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; -import type { StreamingPayments } from '../../../contracts/StreamingPayments/3/StreamingPayments.js'; - -import { StreamingPayments__factory as StreamingPaymentsFactory } from '../../../contracts/StreamingPayments/3/factories/StreamingPayments__factory.js'; -import { ClientType } from '../../../constants.js'; -import { - addAugments, - AugmentedStreamingPayments, - ValidColony, -} from './augments/commonAugments.js'; - -export interface StreamingPaymentsClientV3 - extends AugmentedStreamingPayments { - clientVersion: 3; -} - -export default function getStreamingPaymentsClient( - colonyClient: AugmentedIColony, - address: string, -): StreamingPaymentsClientV3 { - const streamingPaymentsClient = StreamingPaymentsFactory.connect( - address, - colonyClient.signer || colonyClient.provider, - ) as StreamingPaymentsClientV3; - - streamingPaymentsClient.clientType = ClientType.StreamingPaymentsClient; - streamingPaymentsClient.clientVersion = 3; - addAugments(streamingPaymentsClient, colonyClient); - - return streamingPaymentsClient; -} diff --git a/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV4.ts b/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV4.ts deleted file mode 100644 index 3ca21b503..000000000 --- a/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV4.ts +++ /dev/null @@ -1,31 +0,0 @@ -import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; -import type { StreamingPayments } from '../../../contracts/StreamingPayments/4/StreamingPayments.js'; - -import { StreamingPayments__factory as StreamingPaymentsFactory } from '../../../contracts/StreamingPayments/4/factories/StreamingPayments__factory.js'; -import { ClientType } from '../../../constants.js'; -import { - addAugments, - AugmentedStreamingPayments, - ValidColony, -} from './augments/commonAugments.js'; - -export interface StreamingPaymentsClientV4 - extends AugmentedStreamingPayments { - clientVersion: 4; -} - -export default function getStreamingPaymentsClient( - colonyClient: AugmentedIColony, - address: string, -): StreamingPaymentsClientV4 { - const streamingPaymentsClient = StreamingPaymentsFactory.connect( - address, - colonyClient.signer || colonyClient.provider, - ) as StreamingPaymentsClientV4; - - streamingPaymentsClient.clientType = ClientType.StreamingPaymentsClient; - streamingPaymentsClient.clientVersion = 4; - addAugments(streamingPaymentsClient, colonyClient); - - return streamingPaymentsClient; -} diff --git a/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV1.ts b/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV5.ts similarity index 76% rename from packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV1.ts rename to packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV5.ts index 8d3ec8738..cbf1db8bd 100644 --- a/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV1.ts +++ b/packages/colony-js/src/clients/Extensions/StreamingPayments/StreamingPaymentsClientV5.ts @@ -1,30 +1,30 @@ import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; -import type { StreamingPayments } from '../../../contracts/StreamingPayments/1/StreamingPayments.js'; +import type { StreamingPayments } from '../../../contracts/StreamingPayments/5/StreamingPayments.js'; -import { StreamingPayments__factory as StreamingPaymentsFactory } from '../../../contracts/StreamingPayments/1/factories/StreamingPayments__factory.js'; +import { StreamingPayments__factory as StreamingPaymentsFactory } from '../../../contracts/StreamingPayments/5/factories/StreamingPayments__factory.js'; +import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedStreamingPayments, ValidColony, } from './augments/commonAugments.js'; -import { ClientType } from '../../../constants.js'; -export interface StreamingPaymentsClientV1 +export interface StreamingPaymentsClientV5 extends AugmentedStreamingPayments { - clientVersion: 1; + clientVersion: 5; } export default function getStreamingPaymentsClient( colonyClient: AugmentedIColony, address: string, -): StreamingPaymentsClientV1 { +): StreamingPaymentsClientV5 { const streamingPaymentsClient = StreamingPaymentsFactory.connect( address, colonyClient.signer || colonyClient.provider, - ) as StreamingPaymentsClientV1; + ) as StreamingPaymentsClientV5; streamingPaymentsClient.clientType = ClientType.StreamingPaymentsClient; - streamingPaymentsClient.clientVersion = 1; + streamingPaymentsClient.clientVersion = 5; addAugments(streamingPaymentsClient, colonyClient); return streamingPaymentsClient; diff --git a/packages/colony-js/src/clients/Extensions/StreamingPayments/augments/commonAugments.ts b/packages/colony-js/src/clients/Extensions/StreamingPayments/augments/commonAugments.ts index 798affe5f..e63703d07 100644 --- a/packages/colony-js/src/clients/Extensions/StreamingPayments/augments/commonAugments.ts +++ b/packages/colony-js/src/clients/Extensions/StreamingPayments/augments/commonAugments.ts @@ -18,22 +18,22 @@ import { import { ClientType } from '../../../../constants.js'; import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; import { - IColonyV10, - IColonyV11, IColonyV12, IColonyV13, IColonyV14, + IColonyV15, + IColonyV16, } from '../../../Core/contracts.js'; import { AnyStreamingPayments } from '../contracts.js'; const { MaxUint256 } = constants; export type ValidColony = - | IColonyV10 - | IColonyV11 | IColonyV12 | IColonyV13 - | IColonyV14; + | IColonyV14 + | IColonyV15 + | IColonyV16; export type AugmentedEstimate< T extends AnyStreamingPayments = AnyStreamingPayments, @@ -55,8 +55,8 @@ export type AugmentedEstimate< _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, - _tokens: string[], - _amounts: BigNumberish[], + _token: string, + _amount: BigNumberish, overrides?: TxOverrides, ): Promise; @@ -68,21 +68,6 @@ export type AugmentedEstimate< */ claimWithProofs( _id: BigNumberish, - _tokens: string[], - overrides?: TxOverrides, - ): Promise; - - /** - * Same as {@link addToken}, but let colonyJS figure out the permission proofs for you. - * Always prefer this method, except when you have good reason not to. - * @param _id - The id of the streaming payment - * @param _token - The address of the token - * @param _amount - The amount to pay out - */ - addTokenWithProofs( - _id: BigNumberish, - _token: string, - _amount: BigNumberish, overrides?: TxOverrides, ): Promise; @@ -95,8 +80,8 @@ export type AugmentedEstimate< */ setTokenAmountWithProofs( _id: BigNumberish, - _token: string, _amount: BigNumberish, + _interval: BigNumberish, overrides?: TxOverrides, ): Promise; @@ -169,8 +154,8 @@ export type AugmentedStreamingPayments< _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, - _tokens: string[], - _amounts: BigNumberish[], + _token: string, + _amount: BigNumberish, overrides?: TxOverrides, ): Promise; @@ -182,21 +167,6 @@ export type AugmentedStreamingPayments< */ claimWithProofs( _id: BigNumberish, - _tokens: string[], - overrides?: TxOverrides, - ): Promise; - - /** - * Same as {@link addToken}, but let colonyJS figure out the permission proofs for you. - * Always prefer this method, except when you have good reason not to. - * @param _id - The id of the streaming payment - * @param _token - The address of the token - * @param _amount - The amount to pay out - */ - addTokenWithProofs( - _id: BigNumberish, - _token: string, - _amount: BigNumberish, overrides?: TxOverrides, ): Promise; @@ -209,8 +179,8 @@ export type AugmentedStreamingPayments< */ setTokenAmountWithProofs( _id: BigNumberish, - _token: string, _amount: BigNumberish, + _interval: BigNumberish, overrides?: TxOverrides, ): Promise; @@ -256,8 +226,8 @@ async function createWithProofs( _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, - _tokens: string[], - _amounts: BigNumberish[], + _token: string, + _amount: BigNumberish, overrides: TxOverrides = {}, ): Promise { const [fundingPermissionDomainId, fundingChildSkillIndex] = @@ -285,8 +255,8 @@ async function createWithProofs( _endTime, _interval, _recipient, - _tokens, - _amounts, + _token, + _amount, overrides, ); } @@ -298,8 +268,8 @@ async function estimateCreateWithProofs( _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, - _tokens: string[], - _amounts: BigNumberish[], + _token: string, + _amount: BigNumberish, overrides: TxOverrides = {}, ): Promise { const [fundingPermissionDomainId, fundingChildSkillIndex] = @@ -327,8 +297,8 @@ async function estimateCreateWithProofs( _endTime, _interval, _recipient, - _tokens, - _amounts, + _token, + _amount, overrides, ); } @@ -336,7 +306,6 @@ async function estimateCreateWithProofs( async function claimWithProofs( this: AugmentedStreamingPayments, _id: BigNumberish, - _tokens: string[], overrides?: TxOverrides, ): Promise { const { domainId } = await this.getStreamingPayment(_id); @@ -356,7 +325,6 @@ async function claimWithProofs( MaxUint256, MaxUint256, _id, - _tokens, overrides, ); } @@ -364,7 +332,6 @@ async function claimWithProofs( async function estimateClaimWithProofs( this: AugmentedStreamingPayments, _id: BigNumberish, - _tokens: string[], overrides?: TxOverrides, ): Promise { const { domainId } = await this.getStreamingPayment(_id); @@ -384,59 +351,6 @@ async function estimateClaimWithProofs( MaxUint256, MaxUint256, _id, - _tokens, - overrides, - ); -} - -async function addTokenWithProofs( - this: AugmentedStreamingPayments, - _id: BigNumberish, - _token: string, - _amount: BigNumberish, - overrides?: TxOverrides, -): Promise { - const { domainId } = await this.getStreamingPayment(_id); - - const [permissionDomainId, childSkillIndex] = await getPermissionProofs( - this.colonyClient.networkClient, - this.colonyClient, - domainId, - ColonyRole.Funding, - ); - - return this.addToken( - permissionDomainId, - childSkillIndex, - _id, - _token, - _amount, - overrides, - ); -} - -async function estimateAddTokenWithProofs( - this: AugmentedStreamingPayments, - _id: BigNumberish, - _token: string, - _amount: BigNumberish, - overrides?: TxOverrides, -): Promise { - const { domainId } = await this.getStreamingPayment(_id); - - const [permissionDomainId, childSkillIndex] = await getPermissionProofs( - this.colonyClient.networkClient, - this.colonyClient, - domainId, - ColonyRole.Funding, - ); - - return this.estimateGas.addToken( - permissionDomainId, - childSkillIndex, - _id, - _token, - _amount, overrides, ); } @@ -444,8 +358,8 @@ async function estimateAddTokenWithProofs( async function setTokenAmountWithProofs( this: AugmentedStreamingPayments, _id: BigNumberish, - _token: string, _amount: BigNumberish, + _interval: BigNumberish, overrides?: TxOverrides, ): Promise { const { domainId } = await this.getStreamingPayment(_id); @@ -475,8 +389,8 @@ async function setTokenAmountWithProofs( MaxUint256, MaxUint256, _id, - _token, _amount, + _interval, overrides, ); } @@ -484,8 +398,8 @@ async function setTokenAmountWithProofs( async function estimateSetTokenAmountWithProofs( this: AugmentedStreamingPayments, _id: BigNumberish, - _token: string, _amount: BigNumberish, + _interval: BigNumberish, overrides?: TxOverrides, ): Promise { const { domainId } = await this.getStreamingPayment(_id); @@ -515,8 +429,8 @@ async function estimateSetTokenAmountWithProofs( MaxUint256, MaxUint256, _id, - _token, _amount, + _interval, overrides, ); } @@ -674,9 +588,6 @@ export const addAugments = ( estimateCreateWithProofs.bind(instance); instance.claimWithProofs = claimWithProofs.bind(instance); instance.estimateGas.claimWithProofs = estimateClaimWithProofs.bind(instance); - instance.addTokenWithProofs = addTokenWithProofs.bind(instance); - instance.estimateGas.addTokenWithProofs = - estimateAddTokenWithProofs.bind(instance); instance.setTokenAmountWithProofs = setTokenAmountWithProofs.bind(instance); instance.estimateGas.setTokenAmountWithProofs = estimateSetTokenAmountWithProofs.bind(instance); diff --git a/packages/colony-js/src/clients/Extensions/StreamingPayments/contracts.ts b/packages/colony-js/src/clients/Extensions/StreamingPayments/contracts.ts index c48cd53de..5aad24201 100644 --- a/packages/colony-js/src/clients/Extensions/StreamingPayments/contracts.ts +++ b/packages/colony-js/src/clients/Extensions/StreamingPayments/contracts.ts @@ -3,6 +3,7 @@ import type { StreamingPayments as StreamingPayments1 } from '../../../contracts import type { StreamingPayments as StreamingPayments2 } from '../../../contracts/StreamingPayments/2/index.js'; import type { StreamingPayments as StreamingPayments3 } from '../../../contracts/StreamingPayments/3/index.js'; import type { StreamingPayments as StreamingPayments4 } from '../../../contracts/StreamingPayments/4/index.js'; +import type { StreamingPayments as StreamingPayments5 } from '../../../contracts/StreamingPayments/5/index.js'; // Always adjust to the latest factory export { StreamingPayments__factory as StreamingPaymentsFactory } from '../../../contracts/StreamingPayments/4/factories/StreamingPayments__factory.js'; @@ -11,9 +12,7 @@ export type StreamingPaymentsV1 = StreamingPayments1; export type StreamingPaymentsV2 = StreamingPayments2; export type StreamingPaymentsV3 = StreamingPayments3; export type StreamingPaymentsV4 = StreamingPayments4; +export type StreamingPaymentsV5 = StreamingPayments5; -export type AnyStreamingPayments = - | StreamingPayments1 - | StreamingPayments2 - | StreamingPayments3 - | StreamingPayments4; +// No one is using StreamingPaymentsV1 through V4, so we can safely ignore them for now +export type AnyStreamingPayments = StreamingPaymentsV5; diff --git a/packages/colony-js/src/clients/Extensions/StreamingPayments/exports.ts b/packages/colony-js/src/clients/Extensions/StreamingPayments/exports.ts index c4007552b..71cfc8cad 100644 --- a/packages/colony-js/src/clients/Extensions/StreamingPayments/exports.ts +++ b/packages/colony-js/src/clients/Extensions/StreamingPayments/exports.ts @@ -5,29 +5,13 @@ import { assertExhaustiveSwitch } from '@colony/core/utils'; import { AugmentedIColony } from '../../Core/augments/commonAugments.js'; import { ValidColony } from './augments/commonAugments.js'; -import getStreamingPaymentsClientV1, { - StreamingPaymentsClientV1, -} from './StreamingPaymentsClientV1.js'; -import getStreamingPaymentsClientV2, { - StreamingPaymentsClientV2, -} from './StreamingPaymentsClientV2.js'; -import getStreamingPaymentsClientV3, { - StreamingPaymentsClientV3, -} from './StreamingPaymentsClientV3.js'; -import getStreamingPaymentsClientV4, { - StreamingPaymentsClientV4, -} from './StreamingPaymentsClientV4.js'; +import getStreamingPaymentsClientV5, { + StreamingPaymentsClientV5, +} from './StreamingPaymentsClientV5.js'; -export { StreamingPaymentsClientV1 } from './StreamingPaymentsClientV1.js'; -export { StreamingPaymentsClientV2 } from './StreamingPaymentsClientV2.js'; -export { StreamingPaymentsClientV3 } from './StreamingPaymentsClientV3.js'; -export { StreamingPaymentsClientV4 } from './StreamingPaymentsClientV4.js'; +export { StreamingPaymentsClientV5 } from './StreamingPaymentsClientV5.js'; -export type AnyStreamingPaymentsClient = - | StreamingPaymentsClientV1 - | StreamingPaymentsClientV2 - | StreamingPaymentsClientV3 - | StreamingPaymentsClientV4; +export type AnyStreamingPaymentsClient = StreamingPaymentsClientV5; /** @internal */ export const getStreamingPaymentsClient = ( @@ -37,22 +21,15 @@ export const getStreamingPaymentsClient = ( ): AnyStreamingPaymentsClient => { switch (version) { case 1: - return getStreamingPaymentsClientV1( - colonyClient as AugmentedIColony, - address, - ); + throw new Error('StreamingPayments version 1 is not supported'); case 2: - return getStreamingPaymentsClientV2( - colonyClient as AugmentedIColony, - address, - ); + throw new Error('StreamingPayments version 2 is not supported'); case 3: - return getStreamingPaymentsClientV3( - colonyClient as AugmentedIColony, - address, - ); + throw new Error('StreamingPayments version 3 is not supported'); case 4: - return getStreamingPaymentsClientV4( + throw new Error('StreamingPayments version 4 is not supported'); + case 5: + return getStreamingPaymentsClientV5( colonyClient as AugmentedIColony, address, ); diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV2.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV2.ts index 6c6bff0ac..5fe2ac41b 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV2.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV2.ts @@ -1,26 +1,20 @@ import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; -import type { TokenSupplier } from '../../../contracts/TokenSupplier/2/TokenSupplier.js'; import { TokenSupplier__factory as TokenSupplierFactory } from '../../../contracts/TokenSupplier/2/factories/TokenSupplier__factory.js'; import { ClientType } from '../../../constants.js'; import { + UnkonwnTokenSupplierClient, addAugments, - AugmentedTokenSupplier, } from './augments/commonAugments.js'; -export interface TokenSupplierClientV2 - extends AugmentedTokenSupplier { - clientVersion: 2; -} - export default function getTokenSupplierClient( colonyClient: AugmentedIColony, address: string, -): TokenSupplierClientV2 { +) { const tokenSupplierClient = TokenSupplierFactory.connect( address, colonyClient.signer || colonyClient.provider, - ) as TokenSupplierClientV2; + ) as UnkonwnTokenSupplierClient; tokenSupplierClient.clientType = ClientType.TokenSupplierClient; tokenSupplierClient.clientVersion = 2; diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV3.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV3.ts index 0d436831d..ddacac9a2 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV3.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV3.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedTokenSupplier, + ValidColony, } from './augments/commonAugments.js'; export interface TokenSupplierClientV3 @@ -14,7 +15,7 @@ export interface TokenSupplierClientV3 } export default function getTokenSupplierClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): TokenSupplierClientV3 { const tokenSupplierClient = TokenSupplierFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV4.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV4.ts index 868a1913b..1a89878f7 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV4.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV4.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedTokenSupplier, + ValidColony, } from './augments/commonAugments.js'; export interface TokenSupplierClientV4 @@ -14,7 +15,7 @@ export interface TokenSupplierClientV4 } export default function getTokenSupplierClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): TokenSupplierClientV4 { const tokenSupplierClient = TokenSupplierFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV5.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV5.ts index 4ac393835..3d5dd18ca 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV5.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV5.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedTokenSupplier, + ValidColony, } from './augments/commonAugments.js'; export interface TokenSupplierClientV5 @@ -14,7 +15,7 @@ export interface TokenSupplierClientV5 } export default function getTokenSupplierClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): TokenSupplierClientV5 { const tokenSupplierClient = TokenSupplierFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV6.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV6.ts index b12c47d7c..855e6124e 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV6.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV6.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedTokenSupplier, + ValidColony, } from './augments/commonAugments.js'; export interface TokenSupplierClientV6 @@ -14,7 +15,7 @@ export interface TokenSupplierClientV6 } export default function getTokenSupplierClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): TokenSupplierClientV6 { const tokenSupplierClient = TokenSupplierFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV7.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV7.ts index fb8890843..16ae11932 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV7.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV7.ts @@ -6,6 +6,7 @@ import { ClientType } from '../../../constants.js'; import { addAugments, AugmentedTokenSupplier, + ValidColony, } from './augments/commonAugments.js'; export interface TokenSupplierClientV7 @@ -14,7 +15,7 @@ export interface TokenSupplierClientV7 } export default function getTokenSupplierClient( - colonyClient: AugmentedIColony, + colonyClient: AugmentedIColony, address: string, ): TokenSupplierClientV7 { const tokenSupplierClient = TokenSupplierFactory.connect( diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV8.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV8.ts new file mode 100644 index 000000000..543772ecf --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/TokenSupplierClientV8.ts @@ -0,0 +1,31 @@ +import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import type { TokenSupplier } from '../../../contracts/TokenSupplier/8/TokenSupplier.js'; + +import { TokenSupplier__factory as TokenSupplierFactory } from '../../../contracts/TokenSupplier/8/factories/TokenSupplier__factory.js'; +import { ClientType } from '../../../constants.js'; +import { + addAugments, + AugmentedTokenSupplier, + ValidColony, +} from './augments/commonAugments.js'; + +export interface TokenSupplierClientV8 + extends AugmentedTokenSupplier { + clientVersion: 8; +} + +export default function getTokenSupplierClient( + colonyClient: AugmentedIColony, + address: string, +): TokenSupplierClientV8 { + const tokenSupplierClient = TokenSupplierFactory.connect( + address, + colonyClient.signer || colonyClient.provider, + ) as TokenSupplierClientV8; + + tokenSupplierClient.clientType = ClientType.TokenSupplierClient; + tokenSupplierClient.clientVersion = 8; + addAugments(tokenSupplierClient, colonyClient); + + return tokenSupplierClient; +} diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/augments/commonAugments.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/augments/commonAugments.ts index 9a34357da..9e84291c6 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/augments/commonAugments.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/augments/commonAugments.ts @@ -8,6 +8,9 @@ import { import { ClientType } from '../../../../constants.js'; import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; import { AnyTokenSupplier } from '../contracts.js'; +import { AnyIColony } from '../../../Core/contracts.js'; + +export type ValidColony = AnyIColony; export type AugmentedTokenSupplier< T extends AnyTokenSupplier = AnyTokenSupplier, diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/contracts.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/contracts.ts index 4c878f397..4a2d8680a 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/contracts.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/contracts.ts @@ -6,9 +6,10 @@ import type { TokenSupplier as TokenSupplier4 } from '../../../contracts/TokenSu import type { TokenSupplier as TokenSupplier5 } from '../../../contracts/TokenSupplier/5/index.js'; import type { TokenSupplier as TokenSupplier6 } from '../../../contracts/TokenSupplier/6/index.js'; import type { TokenSupplier as TokenSupplier7 } from '../../../contracts/TokenSupplier/7/index.js'; +import type { TokenSupplier as TokenSupplier8 } from '../../../contracts/TokenSupplier/8/index.js'; // Always adjust to the latest factory -export { TokenSupplier__factory as TokenSupplierFactory } from '../../../contracts/TokenSupplier/7/factories/TokenSupplier__factory.js'; +export { TokenSupplier__factory as TokenSupplierFactory } from '../../../contracts/TokenSupplier/8/factories/TokenSupplier__factory.js'; export type TokenSupplierV1 = TokenSupplier1; export type TokenSupplierV2 = TokenSupplier2; @@ -17,11 +18,12 @@ export type TokenSupplierV4 = TokenSupplier4; export type TokenSupplierV5 = TokenSupplier5; export type TokenSupplierV6 = TokenSupplier6; export type TokenSupplierV7 = TokenSupplier7; +export type TokenSupplierV8 = TokenSupplier8; export type AnyTokenSupplier = - | TokenSupplier2 | TokenSupplier3 | TokenSupplier4 | TokenSupplier5 | TokenSupplier6 - | TokenSupplier7; + | TokenSupplier7 + | TokenSupplier8; diff --git a/packages/colony-js/src/clients/Extensions/TokenSupplier/exports.ts b/packages/colony-js/src/clients/Extensions/TokenSupplier/exports.ts index 03ba1a0cf..c377dcb86 100644 --- a/packages/colony-js/src/clients/Extensions/TokenSupplier/exports.ts +++ b/packages/colony-js/src/clients/Extensions/TokenSupplier/exports.ts @@ -5,9 +5,7 @@ import { assertExhaustiveSwitch } from '@colony/core/utils'; import { AugmentedIColony } from '../../Core/augments/commonAugments.js'; import getTokenSupplierClientV1 from './TokenSupplierClientV1.js'; -import getTokenSupplierClientV2, { - TokenSupplierClientV2, -} from './TokenSupplierClientV2.js'; +import getTokenSupplierClientV2 from './TokenSupplierClientV2.js'; import getTokenSupplierClientV3, { TokenSupplierClientV3, } from './TokenSupplierClientV3.js'; @@ -23,21 +21,24 @@ import getTokenSupplierClientV6, { import getTokenSupplierClientV7, { TokenSupplierClientV7, } from './TokenSupplierClientV7.js'; +import getTokenSupplierClientV8, { + TokenSupplierClientV8, +} from './TokenSupplierClientV8.js'; -export { TokenSupplierClientV2 } from './TokenSupplierClientV2.js'; export { TokenSupplierClientV3 } from './TokenSupplierClientV3.js'; export { TokenSupplierClientV4 } from './TokenSupplierClientV4.js'; export { TokenSupplierClientV5 } from './TokenSupplierClientV5.js'; export { TokenSupplierClientV6 } from './TokenSupplierClientV6.js'; export { TokenSupplierClientV7 } from './TokenSupplierClientV7.js'; +export { TokenSupplierClientV8 } from './TokenSupplierClientV8.js'; export type AnyTokenSupplierClient = - | TokenSupplierClientV2 | TokenSupplierClientV3 | TokenSupplierClientV4 | TokenSupplierClientV5 | TokenSupplierClientV6 - | TokenSupplierClientV7; + | TokenSupplierClientV7 + | TokenSupplierClientV8; /** @internal */ export const getTokenSupplierClient = ( @@ -50,9 +51,12 @@ export const getTokenSupplierClient = ( return getTokenSupplierClientV1( colonyClient, address, - ) as TokenSupplierClientV2; + ) as TokenSupplierClientV3; case 2: - return getTokenSupplierClientV2(colonyClient, address); + return getTokenSupplierClientV2( + colonyClient, + address, + ) as TokenSupplierClientV3; case 3: return getTokenSupplierClientV3(colonyClient, address); case 4: @@ -63,6 +67,8 @@ export const getTokenSupplierClient = ( return getTokenSupplierClientV6(colonyClient, address); case 7: return getTokenSupplierClientV7(colonyClient, address); + case 8: + return getTokenSupplierClientV8(colonyClient, address); default: return assertExhaustiveSwitch( version, diff --git a/packages/colony-js/src/clients/Extensions/VotingReputation/VotingReputationClientV12.ts b/packages/colony-js/src/clients/Extensions/VotingReputation/VotingReputationClientV12.ts new file mode 100644 index 000000000..823ba6461 --- /dev/null +++ b/packages/colony-js/src/clients/Extensions/VotingReputation/VotingReputationClientV12.ts @@ -0,0 +1,45 @@ +import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; +import type { IVotingReputation } from '../../../contracts/IVotingReputation/12/IVotingReputation.js'; + +import { IVotingReputation__factory as VotingReputationFactory } from '../../../contracts/IVotingReputation/12/factories/IVotingReputation__factory.js'; +import { ClientType } from '../../../constants.js'; +import { + AugmentedEstimate, + AugmentedVotingReputation, +} from './augments/commonAugments.js'; +import { AugmentedEstimateV2, AugmentsV2 } from './augments/augmentsV2.js'; +import { + addAugments as addAugmentsV3, + AugmentedEstimateV3, + AugmentsV3, +} from './augments/augmentsV3.js'; + +interface VotingReputationEstimate + extends AugmentedEstimate, + AugmentedEstimateV2, + AugmentedEstimateV3 {} + +export interface VotingReputationClientV12 + extends AugmentedVotingReputation, + AugmentsV2, + AugmentsV3 { + clientVersion: 12; + estimateGas: VotingReputationEstimate; +} + +export default function getVotingReputationClient( + colonyClient: AugmentedIColony, + address: string, +): VotingReputationClientV12 { + const votingReputationClient = VotingReputationFactory.connect( + address, + colonyClient.signer || colonyClient.provider, + ) as VotingReputationClientV12; + + votingReputationClient.clientType = ClientType.VotingReputationClient; + votingReputationClient.clientVersion = 12; + + addAugmentsV3(votingReputationClient, colonyClient); + + return votingReputationClient; +} diff --git a/packages/colony-js/src/clients/Extensions/VotingReputation/VotingReputationClientV6.ts b/packages/colony-js/src/clients/Extensions/VotingReputation/VotingReputationClientV6.ts index cd8611840..b4c1dfd83 100644 --- a/packages/colony-js/src/clients/Extensions/VotingReputation/VotingReputationClientV6.ts +++ b/packages/colony-js/src/clients/Extensions/VotingReputation/VotingReputationClientV6.ts @@ -1,44 +1,19 @@ import type { AugmentedIColony } from '../../Core/augments/commonAugments.js'; -import type { IVotingReputation } from '../../../contracts/IVotingReputation/6/IVotingReputation.js'; import { IVotingReputation__factory as VotingReputationFactory } from '../../../contracts/IVotingReputation/6/factories/IVotingReputation__factory.js'; import { ClientType } from '../../../constants.js'; -import { - AugmentedEstimate, - AugmentedVotingReputation, -} from './augments/commonAugments.js'; -import { - addAugments, - AugmentedEstimateV2, - AugmentsV2, -} from './augments/augmentsV2.js'; -import { - addAugments as addCreateDomainMotionAugments, - CreateDomainMotionAugments, - CreateDomainMotionEstimateGas, -} from './augments/CreateDomainMotion.js'; - -interface VotingReputationEstimate - extends AugmentedEstimate, - AugmentedEstimateV2, - CreateDomainMotionEstimateGas {} - -export interface VotingReputationClientV6 - extends AugmentedVotingReputation, - AugmentsV2, - CreateDomainMotionAugments { - clientVersion: 6; - estimateGas: VotingReputationEstimate; -} +import { UnkonwnVotingReputationClient } from './augments/commonAugments.js'; +import { addAugments } from './augments/augmentsV2.js'; +import { addAugments as addCreateDomainMotionAugments } from './augments/CreateDomainMotion.js'; export default function getVotingReputationClient( colonyClient: AugmentedIColony, address: string, -): VotingReputationClientV6 { +) { const votingReputationClient = VotingReputationFactory.connect( address, colonyClient.signer || colonyClient.provider, - ) as VotingReputationClientV6; + ) as UnkonwnVotingReputationClient; votingReputationClient.clientType = ClientType.VotingReputationClient; votingReputationClient.clientVersion = 6; diff --git a/packages/colony-js/src/clients/Extensions/VotingReputation/augments/CreateDomainMotion.ts b/packages/colony-js/src/clients/Extensions/VotingReputation/augments/CreateDomainMotion.ts index 6eb499db4..5c72b18d4 100644 --- a/packages/colony-js/src/clients/Extensions/VotingReputation/augments/CreateDomainMotion.ts +++ b/packages/colony-js/src/clients/Extensions/VotingReputation/augments/CreateDomainMotion.ts @@ -11,11 +11,11 @@ import { parsePermissionedAction, } from '@colony/core'; -import { VotingReputationV6, VotingReputationV7 } from '../contracts.js'; +import { VotingReputationV7 } from '../contracts.js'; import { AugmentedVotingReputation } from './commonAugments.js'; // VotingReputation versions that support this method -type ValidVotingReputation = VotingReputationV6 | VotingReputationV7; +type ValidVotingReputation = VotingReputationV7; const { MaxUint256 } = constants; diff --git a/packages/colony-js/src/clients/Extensions/VotingReputation/augments/augmentsV2.ts b/packages/colony-js/src/clients/Extensions/VotingReputation/augments/augmentsV2.ts index 6bdf3da84..8aa7f23c0 100644 --- a/packages/colony-js/src/clients/Extensions/VotingReputation/augments/augmentsV2.ts +++ b/packages/colony-js/src/clients/Extensions/VotingReputation/augments/augmentsV2.ts @@ -8,12 +8,12 @@ import { type TxOverrides, getCreateMotionProofs } from '@colony/core'; import { AugmentedIColony } from '../../../Core/augments/commonAugments.js'; import { - VotingReputationV6, VotingReputationV7, VotingReputationV8, VotingReputationV9, VotingReputationV10, VotingReputationV11, + VotingReputationV12, } from '../contracts.js'; import { AnyVotingReputationClient } from '../exports.js'; import { @@ -22,12 +22,12 @@ import { } from './commonAugments.js'; type ValidVotingReputation = - | VotingReputationV6 | VotingReputationV7 | VotingReputationV8 | VotingReputationV9 | VotingReputationV10 - | VotingReputationV11; + | VotingReputationV11 + | VotingReputationV12; export interface AugmentedEstimateV2 { /** diff --git a/packages/colony-js/src/clients/Extensions/VotingReputation/augments/augmentsV3.ts b/packages/colony-js/src/clients/Extensions/VotingReputation/augments/augmentsV3.ts index daace32ba..ce68e8a6b 100644 --- a/packages/colony-js/src/clients/Extensions/VotingReputation/augments/augmentsV3.ts +++ b/packages/colony-js/src/clients/Extensions/VotingReputation/augments/augmentsV3.ts @@ -12,6 +12,7 @@ import { VotingReputationV9, VotingReputationV10, VotingReputationV11, + VotingReputationV12, } from '../contracts.js'; import { AugmentedVotingReputation } from './commonAugments.js'; import { addAugments as addAugmentsV2, AugmentsV2 } from './augmentsV2.js'; @@ -21,7 +22,8 @@ type ValidVotingReputation = | VotingReputationV8 | VotingReputationV9 | VotingReputationV10 - | VotingReputationV11; + | VotingReputationV11 + | VotingReputationV12; export interface AugmentedEstimateV3 { /** diff --git a/packages/colony-js/src/clients/Extensions/VotingReputation/contracts.ts b/packages/colony-js/src/clients/Extensions/VotingReputation/contracts.ts index 9ce1f99ed..84e259df7 100644 --- a/packages/colony-js/src/clients/Extensions/VotingReputation/contracts.ts +++ b/packages/colony-js/src/clients/Extensions/VotingReputation/contracts.ts @@ -10,8 +10,9 @@ import type { IVotingReputation as VotingReputation8 } from '../../../contracts/ import type { IVotingReputation as VotingReputation9 } from '../../../contracts/IVotingReputation/9/index.js'; import type { IVotingReputation as VotingReputation10 } from '../../../contracts/IVotingReputation/10/index.js'; import type { IVotingReputation as VotingReputation11 } from '../../../contracts/IVotingReputation/11/index.js'; +import type { IVotingReputation as VotingReputation12 } from '../../../contracts/IVotingReputation/12/index.js'; -export { IVotingReputation__factory as VotingReputationFactory } from '../../../contracts/IVotingReputation/11/factories/IVotingReputation__factory.js'; +export { IVotingReputation__factory as VotingReputationFactory } from '../../../contracts/IVotingReputation/12/factories/IVotingReputation__factory.js'; export type VotingReputationV1 = VotingReputation1; export type VotingReputationV2 = VotingReputation2; @@ -24,11 +25,12 @@ export type VotingReputationV8 = VotingReputation8; export type VotingReputationV9 = VotingReputation9; export type VotingReputationV10 = VotingReputation10; export type VotingReputationV11 = VotingReputation11; +export type VotingReputationV12 = VotingReputation12; export type AnyVotingReputation = - | VotingReputation6 | VotingReputation7 | VotingReputation8 | VotingReputation9 | VotingReputation10 - | VotingReputation11; + | VotingReputation11 + | VotingReputation12; diff --git a/packages/colony-js/src/clients/Extensions/VotingReputation/exports.ts b/packages/colony-js/src/clients/Extensions/VotingReputation/exports.ts index 1012b3031..7191ad227 100644 --- a/packages/colony-js/src/clients/Extensions/VotingReputation/exports.ts +++ b/packages/colony-js/src/clients/Extensions/VotingReputation/exports.ts @@ -9,9 +9,7 @@ import getVotingReputationClientV2 from './VotingReputationClientV2.js'; import getVotingReputationClientV3 from './VotingReputationClientV3.js'; import getVotingReputationClientV4 from './VotingReputationClientV4.js'; import getVotingReputationClientV5 from './VotingReputationClientV5.js'; -import getVotingReputationClientV6, { - VotingReputationClientV6, -} from './VotingReputationClientV6.js'; +import getVotingReputationClientV6 from './VotingReputationClientV6.js'; import getVotingReputationClientV7, { VotingReputationClientV7, } from './VotingReputationClientV7.js'; @@ -27,21 +25,24 @@ import getVotingReputationClientV10, { import getVotingReputationClientV11, { VotingReputationClientV11, } from './VotingReputationClientV11.js'; +import getVotingReputationClientV12, { + VotingReputationClientV12, +} from './VotingReputationClientV12.js'; -export { VotingReputationClientV6 } from './VotingReputationClientV6.js'; export { VotingReputationClientV7 } from './VotingReputationClientV7.js'; export { VotingReputationClientV8 } from './VotingReputationClientV8.js'; export { VotingReputationClientV9 } from './VotingReputationClientV9.js'; export { VotingReputationClientV10 } from './VotingReputationClientV10.js'; export { VotingReputationClientV11 } from './VotingReputationClientV11.js'; +export { VotingReputationClientV12 } from './VotingReputationClientV12.js'; export type AnyVotingReputationClient = - | VotingReputationClientV6 | VotingReputationClientV7 | VotingReputationClientV8 | VotingReputationClientV9 | VotingReputationClientV10 - | VotingReputationClientV11; + | VotingReputationClientV11 + | VotingReputationClientV12; /** @internal */ export function getVotingReputationClient( @@ -54,29 +55,32 @@ export function getVotingReputationClient( return getVotingReputationClientV1( colonyClient, address, - ) as VotingReputationClientV6; + ) as VotingReputationClientV7; case 2: return getVotingReputationClientV2( colonyClient, address, - ) as VotingReputationClientV6; + ) as VotingReputationClientV7; case 3: return getVotingReputationClientV3( colonyClient, address, - ) as VotingReputationClientV6; + ) as VotingReputationClientV7; case 4: return getVotingReputationClientV4( colonyClient, address, - ) as VotingReputationClientV6; + ) as VotingReputationClientV7; case 5: return getVotingReputationClientV5( colonyClient, address, - ) as VotingReputationClientV6; + ) as VotingReputationClientV7; case 6: - return getVotingReputationClientV6(colonyClient, address); + return getVotingReputationClientV6( + colonyClient, + address, + ) as VotingReputationClientV7; case 7: return getVotingReputationClientV7(colonyClient, address); case 8: @@ -87,6 +91,8 @@ export function getVotingReputationClient( return getVotingReputationClientV10(colonyClient, address); case 11: return getVotingReputationClientV11(colonyClient, address); + case 12: + return getVotingReputationClientV12(colonyClient, address); default: return assertExhaustiveSwitch( version, diff --git a/packages/colony-js/src/clients/Extensions/exports.ts b/packages/colony-js/src/clients/Extensions/exports.ts index 7ce4d400c..481a5d112 100644 --- a/packages/colony-js/src/clients/Extensions/exports.ts +++ b/packages/colony-js/src/clients/Extensions/exports.ts @@ -2,6 +2,7 @@ import { constants } from 'ethers'; import { type ExtensionVersion, type FundingQueueVersion, + type MultisigPermissionsVersion, type OneTxPaymentVersion, type ReputationBootstrapperVersion, type StagedExpenditureVersion, @@ -17,6 +18,10 @@ import { assertExhaustiveSwitch } from '@colony/core/utils'; import { AugmentedIColony } from '../Core/augments/commonAugments.js'; +import { + getMultisigPermissionsClient, + AnyMultisigPermissionsClient, +} from './MultisigPermissions/exports.js'; import { getOneTxPaymentClient, AnyOneTxPaymentClient, @@ -54,6 +59,7 @@ import { const { AddressZero } = constants; +export * from './MultisigPermissions/exports.js'; export * from './OneTxPayment/exports.js'; export * from './StagedExpenditure/exports.js'; export * from './StakedExpenditure/exports.js'; @@ -63,6 +69,7 @@ export * from './VotingReputation/exports.js'; export type ExtensionClient = | AnyFundingQueueClient + | AnyMultisigPermissionsClient | AnyOneTxPaymentClient | AnyReputationBootstrapperClient | AnyStagedExpenditureClient @@ -75,6 +82,7 @@ export type ExtensionClient = export type GetExtensionClientReturns = { [Extension.FundingQueue]: AnyFundingQueueClient; [Extension.IVotingReputation]: AnyVotingReputationClient; + [Extension.MultisigPermissions]: AnyMultisigPermissionsClient; [Extension.OneTxPayment]: AnyOneTxPaymentClient; [Extension.ReputationBootstrapper]: AnyReputationBootstrapperClient; [Extension.StagedExpenditure]: AnyStagedExpenditureClient; @@ -130,6 +138,13 @@ export async function getExtensionClient( version as FundingQueueVersion, ); } + case Extension.MultisigPermissions: { + return getMultisigPermissionsClient( + this, + address, + version as MultisigPermissionsVersion, + ); + } case Extension.IVotingReputation: { return getVotingReputationClient( this, diff --git a/packages/colony-js/src/constants.ts b/packages/colony-js/src/constants.ts index b91f10877..8f55a11bd 100644 --- a/packages/colony-js/src/constants.ts +++ b/packages/colony-js/src/constants.ts @@ -9,6 +9,7 @@ export enum ClientType { ColonyClient = 'ColonyClient', FundingQueueClient = 'FundingQueueClient', MotionTargetClient = 'MotionTargetClient', + MultisigPermissionsClient = 'MultisigPermissionsClient', NetworkClient = 'NetworkClient', OneTxPaymentClient = 'OneTxPaymentClient', ReputationBootstrapperClient = 'ReputationBootstrapperClient', diff --git a/packages/colony-js/src/types.ts b/packages/colony-js/src/types.ts index 7791ec9bd..6653baf16 100644 --- a/packages/colony-js/src/types.ts +++ b/packages/colony-js/src/types.ts @@ -3,6 +3,7 @@ import type { ColonyEvents, ColonyNetworkEvents, MetaTxTokenEvents, + MultisigPermissionsEvents, OneTxPaymentEvents, StakedExpenditureEvents, StreamingPaymentsEvents, @@ -25,6 +26,7 @@ export type EventsClient = | ColonyNetworkEvents.IColonyNetworkEvents | VotingReputationEvents.IVotingReputationEvents | MetaTxTokenEvents.MetaTxTokenEvents + | MultisigPermissionsEvents.MultisigPermissionsEvents | OneTxPaymentEvents.OneTxPaymentEvents | StakedExpenditureEvents.StakedExpenditureEvents | StreamingPaymentsEvents.StreamingPaymentsEvents diff --git a/packages/contractor/package.json b/packages/contractor/package.json index 59c503e71..4a2eeb967 100644 --- a/packages/contractor/package.json +++ b/packages/contractor/package.json @@ -30,7 +30,7 @@ }, "homepage": "https://docs.colony.io/develop", "dependencies": { - "@colony/abis": "1.3.0", + "@colony/abis": "1.5.0", "@typechain/ethers-v5": "^11.1.0", "@typechain/ethers-v6": "^0.4.2", "@types/mkdirp": "^1.0.2", diff --git a/packages/core/src/constants.ts b/packages/core/src/constants.ts index f391068ff..89f789f86 100644 --- a/packages/core/src/constants.ts +++ b/packages/core/src/constants.ts @@ -251,6 +251,7 @@ export enum Extension { FundingQueue = 'FundingQueue', // The VotingReputation contract was refactored in flwss3 to also be an interface (akin to IColony) IVotingReputation = 'IVotingReputation', + MultisigPermissions = 'MultisigPermissions', OneTxPayment = 'OneTxPayment', ReputationBootstrapper = 'ReputationBootstrapper', StagedExpenditure = 'StagedExpenditure', diff --git a/packages/core/src/versions/FundingQueue.ts b/packages/core/src/versions/FundingQueue.ts index 6d6d8726a..169fff3e7 100644 --- a/packages/core/src/versions/FundingQueue.ts +++ b/packages/core/src/versions/FundingQueue.ts @@ -2,7 +2,7 @@ import type { ColonyVersion } from './IColony.js'; import { createContractVersionArray } from './utils.js'; -const FUNDING_QUEUE_VERSION_NEXT = 8; +const FUNDING_QUEUE_VERSION_NEXT = 9; /** @internal */ export const FUNDING_QUEUE_VERSIONS = createContractVersionArray( @@ -23,6 +23,7 @@ export const fundingQueueIncompatibilityMap: Record< 5: [], 6: [], 7: [], + 8: [], }; /** @internal */ diff --git a/packages/core/src/versions/IColony.ts b/packages/core/src/versions/IColony.ts index ef9a7286c..862de7843 100644 --- a/packages/core/src/versions/IColony.ts +++ b/packages/core/src/versions/IColony.ts @@ -1,7 +1,7 @@ import { createContractVersionArray } from './utils.js'; // This is the latest IColony version + 1. It's for generating types and compatibility maps -const COLONY_VERSION_NEXT = 16; +const COLONY_VERSION_NEXT = 17; /** @internal */ export const COLONY_VERSIONS = createContractVersionArray(COLONY_VERSION_NEXT); diff --git a/packages/core/src/versions/MultisigPermissions.ts b/packages/core/src/versions/MultisigPermissions.ts new file mode 100644 index 000000000..e9279ba51 --- /dev/null +++ b/packages/core/src/versions/MultisigPermissions.ts @@ -0,0 +1,25 @@ +import type { ColonyVersion } from './IColony.js'; + +import { createContractVersionArray } from './utils.js'; + +const MULTISIG_PERMISSIONS_VERSION_NEXT = 2; + +/** @internal */ +export const MULTISIG_PERMISSIONS_VERSIONS = createContractVersionArray( + MULTISIG_PERMISSIONS_VERSION_NEXT, +); + +export type MultisigPermissionsVersion = + (typeof MULTISIG_PERMISSIONS_VERSIONS)[number]; + +/** @internal */ +export const multisigPermissionsIncompatibilityMap: Record< + MultisigPermissionsVersion, + Array +> = { + 1: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], +}; + +/** @internal */ +export const MULTISIG_PERMISSIONS_VERSION_LATEST = + (MULTISIG_PERMISSIONS_VERSION_NEXT - 1) as MultisigPermissionsVersion; diff --git a/packages/core/src/versions/OneTxPayment.ts b/packages/core/src/versions/OneTxPayment.ts index 875341960..1e41550da 100644 --- a/packages/core/src/versions/OneTxPayment.ts +++ b/packages/core/src/versions/OneTxPayment.ts @@ -2,7 +2,7 @@ import type { ColonyVersion } from './IColony.js'; import { createContractVersionArray } from './utils.js'; -const ONE_TX_PAYMENT_VERSION_NEXT = 8; +const ONE_TX_PAYMENT_VERSION_NEXT = 9; /** @internal */ export const ONE_TX_PAYMENT_VERSIONS = createContractVersionArray( @@ -23,6 +23,7 @@ export const oneTxPaymentIncompatibilityMap: Record< 5: [], 6: [], 7: [], + 8: [], }; /** @internal */ diff --git a/packages/core/src/versions/ReputationBootstrapper.ts b/packages/core/src/versions/ReputationBootstrapper.ts index 44889c50a..00f327258 100644 --- a/packages/core/src/versions/ReputationBootstrapper.ts +++ b/packages/core/src/versions/ReputationBootstrapper.ts @@ -2,7 +2,7 @@ import type { ColonyVersion } from './IColony.js'; import { createContractVersionArray } from './utils.js'; -const REPUTATION_BOOTSTRAPPER_VERSION_NEXT = 5; +const REPUTATION_BOOTSTRAPPER_VERSION_NEXT = 6; /** @internal */ export const REPUTATION_BOOTSTRAPPER_VERSIONS = createContractVersionArray( @@ -21,6 +21,7 @@ export const reputationBootstrapperIncompatibilityMap: Record< 2: [], 3: [], 4: [], + 5: [], }; /** @internal */ diff --git a/packages/core/src/versions/StagedExpenditure.ts b/packages/core/src/versions/StagedExpenditure.ts index 1f9517ce4..a60a694fd 100644 --- a/packages/core/src/versions/StagedExpenditure.ts +++ b/packages/core/src/versions/StagedExpenditure.ts @@ -2,7 +2,7 @@ import type { ColonyVersion } from './IColony.js'; import { createContractVersionArray } from './utils.js'; -const STAGED_EXPENDITURE_VERSION_NEXT = 3; +const STAGED_EXPENDITURE_VERSION_NEXT = 4; /** @internal */ export const STAGED_EXPENDITURE_VERSIONS = createContractVersionArray( @@ -18,7 +18,8 @@ export const stagedExpenditureIncompatibilityMap: Record< Array > = { 1: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], - 2: [], + 2: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], + 3: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], }; /** @internal */ diff --git a/packages/core/src/versions/StakedExpenditure.ts b/packages/core/src/versions/StakedExpenditure.ts index 03e342618..e668268ea 100644 --- a/packages/core/src/versions/StakedExpenditure.ts +++ b/packages/core/src/versions/StakedExpenditure.ts @@ -2,7 +2,7 @@ import type { ColonyVersion } from './IColony.js'; import { createContractVersionArray } from './utils.js'; -const STAKED_EXPENDITURE_VERSION_NEXT = 6; +const STAKED_EXPENDITURE_VERSION_NEXT = 7; /** @internal */ export const STAKED_EXPENDITURE_VERSIONS = createContractVersionArray( @@ -22,6 +22,7 @@ export const stakedExpenditureIncompatibilityMap: Record< 3: [1, 2, 3], 4: [1, 2, 3], 5: [1, 2, 3], + 6: [1, 2, 3], }; /** @internal */ diff --git a/packages/core/src/versions/StreamingPayments.ts b/packages/core/src/versions/StreamingPayments.ts index 31960b572..80ece3017 100644 --- a/packages/core/src/versions/StreamingPayments.ts +++ b/packages/core/src/versions/StreamingPayments.ts @@ -2,7 +2,7 @@ import type { ColonyVersion } from './IColony.js'; import { createContractVersionArray } from './utils.js'; -const STREAMING_PAYMENTS_VERSION_NEXT = 5; +const STREAMING_PAYMENTS_VERSION_NEXT = 6; /** @internal */ export const STREAMING_PAYMENTS_VERSIONS = createContractVersionArray( @@ -21,6 +21,7 @@ export const streamingPaymentsIncompatibilityMap: Record< 2: [1, 2, 3], 3: [1, 2, 3], 4: [1, 2, 3], + 5: [1, 2, 3], }; /** @internal */ diff --git a/packages/core/src/versions/TokenSupplier.ts b/packages/core/src/versions/TokenSupplier.ts index cdc93dbf4..bbc9e5a36 100644 --- a/packages/core/src/versions/TokenSupplier.ts +++ b/packages/core/src/versions/TokenSupplier.ts @@ -2,7 +2,7 @@ import type { ColonyVersion } from './IColony.js'; import { createContractVersionArray } from './utils.js'; -const TOKEN_SUPPLIER_VERSION_NEXT = 8; +const TOKEN_SUPPLIER_VERSION_NEXT = 9; /** @internal */ export const TOKEN_SUPPLIER_VERSIONS = createContractVersionArray( @@ -23,6 +23,7 @@ export const tokenSupplierIncompatibilityMap: Record< 5: [], 6: [], 7: [], + 8: [], }; /** @internal */ diff --git a/packages/core/src/versions/VotingReputation.ts b/packages/core/src/versions/VotingReputation.ts index d27fc4a85..25be91dc6 100644 --- a/packages/core/src/versions/VotingReputation.ts +++ b/packages/core/src/versions/VotingReputation.ts @@ -2,7 +2,7 @@ import type { ColonyVersion } from './IColony.js'; import { createContractVersionArray } from './utils.js'; -const VOTING_REPUTATION_VERSION_NEXT = 12; +const VOTING_REPUTATION_VERSION_NEXT = 13; /** @internal */ export const VOTING_REPUTATION_VERSIONS = createContractVersionArray( @@ -28,6 +28,7 @@ export const votingReputationIncompatibilityMap: Record< 9: [1, 2, 3, 4, 5, 6], 10: [1, 2, 3, 4, 5, 6], 11: [1, 2, 3, 4, 5, 6], + 12: [1, 2, 3, 4, 5, 6], }; /** @internal */ diff --git a/packages/core/src/versions/helpers.ts b/packages/core/src/versions/helpers.ts index 8d054be90..bd02b07cd 100644 --- a/packages/core/src/versions/helpers.ts +++ b/packages/core/src/versions/helpers.ts @@ -5,6 +5,10 @@ import { fundingQueueIncompatibilityMap, FundingQueueVersion, } from './FundingQueue.js'; +import { + multisigPermissionsIncompatibilityMap, + MultisigPermissionsVersion, +} from './MultisigPermissions.js'; import { oneTxPaymentIncompatibilityMap, OneTxPaymentVersion, @@ -50,6 +54,11 @@ const getExtensionIncompatibilityMap = ( extensionVersion as VotingReputationVersion ]; } + case Extension.MultisigPermissions: { + return multisigPermissionsIncompatibilityMap[ + extensionVersion as MultisigPermissionsVersion + ]; + } case Extension.OneTxPayment: { return oneTxPaymentIncompatibilityMap[ extensionVersion as OneTxPaymentVersion diff --git a/packages/core/src/versions/index.ts b/packages/core/src/versions/index.ts index 6aa0aa067..4a308eced 100644 --- a/packages/core/src/versions/index.ts +++ b/packages/core/src/versions/index.ts @@ -4,6 +4,10 @@ import { FUNDING_QUEUE_VERSION_LATEST, FundingQueueVersion, } from './FundingQueue.js'; +import { + MULTISIG_PERMISSIONS_VERSION_LATEST, + MultisigPermissionsVersion, +} from './MultisigPermissions.js'; import { ONE_TX_PAYMENT_VERSION_LATEST, OneTxPaymentVersion, @@ -41,6 +45,7 @@ export * from './helpers.js'; export const ExtensionVersions = { [Extension.FundingQueue]: FUNDING_QUEUE_VERSION_LATEST, [Extension.IVotingReputation]: VOTING_REPUTATION_VERSION_LATEST, + [Extension.MultisigPermissions]: MULTISIG_PERMISSIONS_VERSION_LATEST, [Extension.OneTxPayment]: ONE_TX_PAYMENT_VERSION_LATEST, [Extension.ReputationBootstrapper]: REPUTATION_BOOTSTRAPPER_VERSION_LATEST, [Extension.StagedExpenditure]: STAGED_EXPENDITURE_VERSION_LATEST, @@ -55,6 +60,7 @@ export const ExtensionVersions = { */ export type ExtensionVersion = | FundingQueueVersion + | MultisigPermissionsVersion | OneTxPaymentVersion | ReputationBootstrapperVersion | StagedExpenditureVersion @@ -76,6 +82,10 @@ export { ColonyVersion } from './IColony.js'; * All possible FundingQueue versions */ export { FundingQueueVersion } from './FundingQueue.js'; +/** + * All possible MultisigPermissions versions + */ +export { MultisigPermissionsVersion } from './MultisigPermissions.js'; /** * All possible OneTxPayment versions */ diff --git a/packages/core/src/versions/utils.ts b/packages/core/src/versions/utils.ts index b24ceac64..b27180877 100644 --- a/packages/core/src/versions/utils.ts +++ b/packages/core/src/versions/utils.ts @@ -12,6 +12,6 @@ type Range = Exclude< export const createContractVersionArray = (last: T) => { return Array.from(Array(last - 1)).map( - (i) => (i + 1) as Range<1, typeof last>, + (_, i) => (i + 1) as Range<1, typeof last>, ); }; diff --git a/packages/events/src/contracts.ts b/packages/events/src/contracts.ts index 7c41a3211..c16a5419f 100644 --- a/packages/events/src/contracts.ts +++ b/packages/events/src/contracts.ts @@ -5,6 +5,7 @@ export * as ColonyNetworkEvents from './contracts/IColonyNetworkEvents.js'; export * as EvaluatedExpenditureEvents from './contracts/EvaluatedExpenditureEvents.js'; export * as FundingQueueEvents from './contracts/FundingQueueEvents.js'; export * as MetaTxTokenEvents from './contracts/MetaTxTokenEvents.js'; +export * as MultisigPermissionsEvents from './contracts/MultisigPermissionsEvents.js'; export * as OneTxPaymentEvents from './contracts/OneTxPaymentEvents.js'; export * as ReputationBootstrapperEvents from './contracts/ReputationBootstrapperEvents.js'; export * as StagedExpenditureEvents from './contracts/StagedExpenditureEvents.js'; diff --git a/packages/sdk/docs/api/README.md b/packages/sdk/docs/api/README.md index 52a2c0a14..140949175 100644 --- a/packages/sdk/docs/api/README.md +++ b/packages/sdk/docs/api/README.md @@ -9,6 +9,7 @@ - [EvaluatedExpenditureEvents](modules/EvaluatedExpenditureEvents.md) - [FundingQueueEvents](modules/FundingQueueEvents.md) - [MetaTxTokenEvents](modules/MetaTxTokenEvents.md) +- [MultisigPermissionsEvents](modules/MultisigPermissionsEvents.md) - [OneTxPaymentEvents](modules/OneTxPaymentEvents.md) - [ReputationBootstrapperEvents](modules/ReputationBootstrapperEvents.md) - [StagedExpenditureEvents](modules/StagedExpenditureEvents.md) @@ -54,6 +55,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) @@ -202,15 +204,16 @@ Latest versions of all extension contracts | Name | Type | | :------ | :------ | -| `FundingQueue` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` | -| `IVotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` | -| `OneTxPayment` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` | -| `ReputationBootstrapper` | ``1`` \| ``2`` \| ``3`` \| ``4`` | -| `StagedExpenditure` | ``1`` \| ``2`` | -| `StakedExpenditure` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` | -| `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` | -| `TokenSupplier` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` | -| `VotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` | +| `FundingQueue` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` | +| `IVotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` | +| `MultisigPermissions` | ``1`` | +| `OneTxPayment` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` | +| `ReputationBootstrapper` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` | +| `StagedExpenditure` | ``1`` \| ``2`` \| ``3`` | +| `StakedExpenditure` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` | +| `StreamingPayments` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` | +| `TokenSupplier` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` | +| `VotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` | ___ @@ -364,7 +367,7 @@ Returns `true` if an extension version is compatible with the given colony versi | :------ | :------ | :------ | | `extension` | [`Extension`](enums/Extension.md) | A valid `Extension` contract name | | `extensionVersion` | `ExtensionVersion` | The version of the extension to check against the colony | -| `colonyVersion` | ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` | The version of the colony to check for | +| `colonyVersion` | ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` \| ``16`` | The version of the colony to check for | #### Returns diff --git a/packages/sdk/docs/api/classes/Colony.md b/packages/sdk/docs/api/classes/Colony.md index b974b9938..bd79f2efe 100644 --- a/packages/sdk/docs/api/classes/Colony.md +++ b/packages/sdk/docs/api/classes/Colony.md @@ -62,7 +62,7 @@ ___ ### version -• **version**: ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` +• **version**: ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` \| ``16`` Contract version @@ -1178,8 +1178,8 @@ ___ ### getLatestSupportedVersion -▸ `Static` **getLatestSupportedVersion**(): ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` +▸ `Static` **getLatestSupportedVersion**(): ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` \| ``16`` #### Returns -``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` +``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` \| ``16`` 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..2ee8f0033 --- /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`](../interfaces/MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `signerOrProvider` | `Signer` \| `Provider` | + +#### Returns + +[`MultisigPermissionsEvents`](../interfaces/MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +___ + +### createInterface + +▸ `Static` **createInterface**(): [`MultisigPermissionsEventsInterface`](../interfaces/MultisigPermissionsEvents.MultisigPermissionsEventsInterface.md) + +#### Returns + +[`MultisigPermissionsEventsInterface`](../interfaces/MultisigPermissionsEvents.MultisigPermissionsEventsInterface.md) diff --git a/packages/sdk/docs/api/classes/OneTxPayment.md b/packages/sdk/docs/api/classes/OneTxPayment.md index 7ad9b0de9..70af6257c 100644 --- a/packages/sdk/docs/api/classes/OneTxPayment.md +++ b/packages/sdk/docs/api/classes/OneTxPayment.md @@ -24,7 +24,7 @@ ___ ### version -• **version**: ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` +• **version**: ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` The extension contract's version @@ -160,8 +160,8 @@ ___ ### getLatestSupportedVersion -▸ `Static` **getLatestSupportedVersion**(): ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` +▸ `Static` **getLatestSupportedVersion**(): ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` #### Returns -``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` +``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` diff --git a/packages/sdk/docs/api/classes/StagedExpenditureEvents__factory.md b/packages/sdk/docs/api/classes/StagedExpenditureEvents__factory.md index f37436b0c..458165796 100644 --- a/packages/sdk/docs/api/classes/StagedExpenditureEvents__factory.md +++ b/packages/sdk/docs/api/classes/StagedExpenditureEvents__factory.md @@ -10,7 +10,7 @@ ### 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`: ``"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`: ``"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`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"staged"`` ; `type`: ``"bool"`` }] ; `name`: ``"ExpenditureMadeStaged"`` ; `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`: ``"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`: ``"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`: ``"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`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StagedPaymentReleased"`` ; `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"`` }] +▪ `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`: ``"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`: ``"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`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"staged"`` ; `type`: ``"bool"`` }] ; `name`: ``"ExpenditureMadeStaged"`` ; `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`: ``"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`: ``"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`: ``"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`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StagedPaymentReleased"`` ; `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"`` }, { `anonymous`: ``false`` ; `inputs`: readonly [{ `indexed`: ``false`` ; `internalType`: ``"address"`` ; `name`: ``"agent"`` ; `type`: ``"address"`` }, { `indexed`: ``true`` ; `internalType`: ``"uint256"`` ; `name`: ``"expenditureId"`` ; `type`: ``"uint256"`` }, { `indexed`: ``false`` ; `internalType`: ``"bool"`` ; `name`: ``"staged"`` ; `type`: ``"bool"`` }] ; `name`: ``"ExpenditureMadeStaged"`` ; `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`: ``"uint256"`` ; `name`: ``"slot"`` ; `type`: ``"uint256"`` }] ; `name`: ``"StagedPaymentReleased"`` ; `type`: ``"event"`` }] ## Methods diff --git a/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md b/packages/sdk/docs/api/classes/StreamingPaymentsEvents__factory.md index 30a5b8316..3cfdb3ed3 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"`` }, { `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"`` }, { `indexed`: ``false`` ; `internalType`: ``"uint256"`` ; `name`: ``"interval"`` ; `type`: ``"uint256"`` }] ; `name`: ``"PaymentTokenUpdated"`` ; `type`: ``"event"`` }] ## Methods diff --git a/packages/sdk/docs/api/classes/VotingReputation.md b/packages/sdk/docs/api/classes/VotingReputation.md index 56db6c67f..15e14fbba 100644 --- a/packages/sdk/docs/api/classes/VotingReputation.md +++ b/packages/sdk/docs/api/classes/VotingReputation.md @@ -100,7 +100,7 @@ You can - at any point in the lifecycle inspect the current state of a Motion. U | :------ | :------ | | `colony` | [`Colony`](Colony.md) | | `votingReputationContract` | `SupportedVotingReputationContract` | -| `deployedVersion` | ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` | +| `deployedVersion` | ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` | ## Properties @@ -112,7 +112,7 @@ ___ ### version -• **version**: ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` +• **version**: ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` ___ @@ -741,8 +741,8 @@ ___ ### getLatestSupportedVersion -▸ `Static` **getLatestSupportedVersion**(): ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` +▸ `Static` **getLatestSupportedVersion**(): ``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` #### Returns -``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` +``2`` \| ``1`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` diff --git a/packages/sdk/docs/api/enums/Extension.md b/packages/sdk/docs/api/enums/Extension.md index adc87b392..743a94842 100644 --- a/packages/sdk/docs/api/enums/Extension.md +++ b/packages/sdk/docs/api/enums/Extension.md @@ -16,6 +16,12 @@ ___ ___ +### MultisigPermissions + +• **MultisigPermissions** = ``"MultisigPermissions"`` + +___ + ### OneTxPayment • **OneTxPayment** = ``"OneTxPayment"`` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.AnnotationEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.AnnotationEventObject.md new file mode 100644 index 000000000..b74888f52 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.AnnotationEventObject.md @@ -0,0 +1,21 @@ +# Interface: AnnotationEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).AnnotationEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### metadata + +• **metadata**: `string` + +___ + +### txHash + +• **txHash**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ApprovalChangedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ApprovalChangedEventObject.md new file mode 100644 index 000000000..2137d363c --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ApprovalChangedEventObject.md @@ -0,0 +1,27 @@ +# Interface: ApprovalChangedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ApprovalChangedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### approval + +• **approval**: `boolean` + +___ + +### motionId + +• **motionId**: `BigNumber` + +___ + +### role + +• **role**: `number` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ArbitraryReputationUpdateEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ArbitraryReputationUpdateEventObject.md new file mode 100644 index 000000000..6c0150f53 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ArbitraryReputationUpdateEventObject.md @@ -0,0 +1,27 @@ +# Interface: ArbitraryReputationUpdateEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ArbitraryReputationUpdateEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### skillId + +• **skillId**: `BigNumber` + +___ + +### user + +• **user**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ArbitraryTransactionEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ArbitraryTransactionEventObject.md new file mode 100644 index 000000000..475ef7b0f --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ArbitraryTransactionEventObject.md @@ -0,0 +1,21 @@ +# Interface: ArbitraryTransactionEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ArbitraryTransactionEventObject + +## Properties + +### data + +• **data**: `string` + +___ + +### success + +• **success**: `boolean` + +___ + +### target + +• **target**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyBootstrappedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyBootstrappedEventObject.md new file mode 100644 index 000000000..b52a506fd --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyBootstrappedEventObject.md @@ -0,0 +1,21 @@ +# Interface: ColonyBootstrappedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyBootstrappedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amounts + +• **amounts**: `BigNumber`[] + +___ + +### users + +• **users**: `string`[] diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyFundsClaimedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyFundsClaimedEventObject.md new file mode 100644 index 000000000..74586bde2 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyFundsClaimedEventObject.md @@ -0,0 +1,27 @@ +# Interface: ColonyFundsClaimedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyFundsClaimedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### fee + +• **fee**: `BigNumber` + +___ + +### payoutRemainder + +• **payoutRemainder**: `BigNumber` + +___ + +### token + +• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyFundsMovedBetweenFundingPotsEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyFundsMovedBetweenFundingPotsEventObject.md new file mode 100644 index 000000000..027f9ffcf --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyFundsMovedBetweenFundingPotsEventObject.md @@ -0,0 +1,33 @@ +# Interface: ColonyFundsMovedBetweenFundingPotsEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyFundsMovedBetweenFundingPotsEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### fromPot + +• **fromPot**: `BigNumber` + +___ + +### toPot + +• **toPot**: `BigNumber` + +___ + +### token + +• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyInitialisedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyInitialisedEventObject.md new file mode 100644 index 000000000..2d8053599 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyInitialisedEventObject.md @@ -0,0 +1,21 @@ +# Interface: ColonyInitialisedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyInitialisedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### colonyNetwork + +• **colonyNetwork**: `string` + +___ + +### token + +• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyMetadataDeltaEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyMetadataDeltaEventObject.md new file mode 100644 index 000000000..0004f1cc0 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyMetadataDeltaEventObject.md @@ -0,0 +1,15 @@ +# Interface: ColonyMetadataDeltaEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyMetadataDeltaEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### metadata + +• **metadata**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyMetadataEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyMetadataEventObject.md new file mode 100644 index 000000000..c69cd5fc3 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyMetadataEventObject.md @@ -0,0 +1,15 @@ +# Interface: ColonyMetadataEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyMetadataEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### metadata + +• **metadata**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyRewardInverseSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyRewardInverseSetEventObject.md new file mode 100644 index 000000000..2d7ffbc53 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyRewardInverseSetEventObject.md @@ -0,0 +1,15 @@ +# Interface: ColonyRewardInverseSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyRewardInverseSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### rewardInverse + +• **rewardInverse**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyRoleSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyRoleSetEventObject.md new file mode 100644 index 000000000..5a5e8a629 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyRoleSetEventObject.md @@ -0,0 +1,33 @@ +# Interface: ColonyRoleSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyRoleSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### domainId + +• **domainId**: `BigNumber` + +___ + +### role + +• **role**: `number` + +___ + +### setTo + +• **setTo**: `boolean` + +___ + +### user + +• **user**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyUpgradedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyUpgradedEventObject.md new file mode 100644 index 000000000..8985186eb --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ColonyUpgradedEventObject.md @@ -0,0 +1,21 @@ +# Interface: ColonyUpgradedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ColonyUpgradedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### newVersion + +• **newVersion**: `BigNumber` + +___ + +### oldVersion + +• **oldVersion**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainAddedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainAddedEventObject.md new file mode 100644 index 000000000..841464f03 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainAddedEventObject.md @@ -0,0 +1,15 @@ +# Interface: DomainAddedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).DomainAddedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### domainId + +• **domainId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainDeprecatedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainDeprecatedEventObject.md new file mode 100644 index 000000000..48969e114 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainDeprecatedEventObject.md @@ -0,0 +1,21 @@ +# Interface: DomainDeprecatedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).DomainDeprecatedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### deprecated + +• **deprecated**: `boolean` + +___ + +### domainId + +• **domainId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainMetadataEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainMetadataEventObject.md new file mode 100644 index 000000000..c430f67aa --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainMetadataEventObject.md @@ -0,0 +1,21 @@ +# Interface: DomainMetadataEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).DomainMetadataEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### domainId + +• **domainId**: `BigNumber` + +___ + +### metadata + +• **metadata**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainSkillThresholdSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainSkillThresholdSetEventObject.md new file mode 100644 index 000000000..ade851d2b --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.DomainSkillThresholdSetEventObject.md @@ -0,0 +1,15 @@ +# Interface: DomainSkillThresholdSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).DomainSkillThresholdSetEventObject + +## Properties + +### domainSkillId + +• **domainSkillId**: `BigNumber` + +___ + +### threshold + +• **threshold**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureAddedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureAddedEventObject.md new file mode 100644 index 000000000..e9c66d527 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureAddedEventObject.md @@ -0,0 +1,15 @@ +# Interface: ExpenditureAddedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureAddedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureCancelledEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureCancelledEventObject.md new file mode 100644 index 000000000..58923a843 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureCancelledEventObject.md @@ -0,0 +1,15 @@ +# Interface: ExpenditureCancelledEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureCancelledEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureClaimDelaySetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureClaimDelaySetEventObject.md new file mode 100644 index 000000000..582d35407 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureClaimDelaySetEventObject.md @@ -0,0 +1,27 @@ +# Interface: ExpenditureClaimDelaySetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureClaimDelaySetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### claimDelay + +• **claimDelay**: `BigNumber` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### slot + +• **slot**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureFinalizedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureFinalizedEventObject.md new file mode 100644 index 000000000..655dd1269 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureFinalizedEventObject.md @@ -0,0 +1,15 @@ +# Interface: ExpenditureFinalizedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureFinalizedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureGlobalClaimDelaySetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureGlobalClaimDelaySetEventObject.md new file mode 100644 index 000000000..f9ea74c88 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureGlobalClaimDelaySetEventObject.md @@ -0,0 +1,15 @@ +# Interface: ExpenditureGlobalClaimDelaySetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureGlobalClaimDelaySetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### globalClaimDelay + +• **globalClaimDelay**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureLockedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureLockedEventObject.md new file mode 100644 index 000000000..ae1641da6 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureLockedEventObject.md @@ -0,0 +1,15 @@ +# Interface: ExpenditureLockedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureLockedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureMetadataSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureMetadataSetEventObject.md new file mode 100644 index 000000000..ae21ca1a0 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureMetadataSetEventObject.md @@ -0,0 +1,21 @@ +# Interface: ExpenditureMetadataSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureMetadataSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### metadata + +• **metadata**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditurePayoutModifierSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditurePayoutModifierSetEventObject.md new file mode 100644 index 000000000..3df8cb236 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditurePayoutModifierSetEventObject.md @@ -0,0 +1,27 @@ +# Interface: ExpenditurePayoutModifierSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditurePayoutModifierSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### payoutModifier + +• **payoutModifier**: `BigNumber` + +___ + +### slot + +• **slot**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditurePayoutSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditurePayoutSetEventObject.md new file mode 100644 index 000000000..419abff99 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditurePayoutSetEventObject.md @@ -0,0 +1,33 @@ +# Interface: ExpenditurePayoutSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditurePayoutSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### slot + +• **slot**: `BigNumber` + +___ + +### token + +• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureRecipientSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureRecipientSetEventObject.md new file mode 100644 index 000000000..384ec1667 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureRecipientSetEventObject.md @@ -0,0 +1,27 @@ +# Interface: ExpenditureRecipientSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureRecipientSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### recipient + +• **recipient**: `string` + +___ + +### slot + +• **slot**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureSkillSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureSkillSetEventObject.md new file mode 100644 index 000000000..84b8c6639 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureSkillSetEventObject.md @@ -0,0 +1,27 @@ +# Interface: ExpenditureSkillSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureSkillSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### skillId + +• **skillId**: `BigNumber` + +___ + +### slot + +• **slot**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureStateChangedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureStateChangedEventObject.md new file mode 100644 index 000000000..ada1cef53 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureStateChangedEventObject.md @@ -0,0 +1,39 @@ +# Interface: ExpenditureStateChangedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureStateChangedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### keys + +• **keys**: `string`[] + +___ + +### mask + +• **mask**: `boolean`[] + +___ + +### storageSlot + +• **storageSlot**: `BigNumber` + +___ + +### value + +• **value**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureTransferredEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureTransferredEventObject.md new file mode 100644 index 000000000..431912fe9 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExpenditureTransferredEventObject.md @@ -0,0 +1,21 @@ +# Interface: ExpenditureTransferredEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExpenditureTransferredEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### owner + +• **owner**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExtensionInitialisedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExtensionInitialisedEventObject.md new file mode 100644 index 000000000..dd6777c87 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.ExtensionInitialisedEventObject.md @@ -0,0 +1,3 @@ +# Interface: ExtensionInitialisedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).ExtensionInitialisedEventObject diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.FundingPotAddedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.FundingPotAddedEventObject.md new file mode 100644 index 000000000..9b5b1a85b --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.FundingPotAddedEventObject.md @@ -0,0 +1,9 @@ +# Interface: FundingPotAddedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).FundingPotAddedEventObject + +## Properties + +### fundingPotId + +• **fundingPotId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.GlobalThresholdSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.GlobalThresholdSetEventObject.md new file mode 100644 index 000000000..bfafe61df --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.GlobalThresholdSetEventObject.md @@ -0,0 +1,9 @@ +# Interface: GlobalThresholdSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).GlobalThresholdSetEventObject + +## Properties + +### globalThreshold + +• **globalThreshold**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LocalSkillAddedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LocalSkillAddedEventObject.md new file mode 100644 index 000000000..697a56dd5 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LocalSkillAddedEventObject.md @@ -0,0 +1,15 @@ +# Interface: LocalSkillAddedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).LocalSkillAddedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### localSkillId + +• **localSkillId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LocalSkillDeprecatedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LocalSkillDeprecatedEventObject.md new file mode 100644 index 000000000..ba6e7cf6d --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LocalSkillDeprecatedEventObject.md @@ -0,0 +1,21 @@ +# Interface: LocalSkillDeprecatedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).LocalSkillDeprecatedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### deprecated + +• **deprecated**: `boolean` + +___ + +### localSkillId + +• **localSkillId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LogSetAuthorityEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LogSetAuthorityEventObject.md new file mode 100644 index 000000000..fea06ae68 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LogSetAuthorityEventObject.md @@ -0,0 +1,9 @@ +# Interface: LogSetAuthorityEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).LogSetAuthorityEventObject + +## Properties + +### authority + +• **authority**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LogSetOwnerEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LogSetOwnerEventObject.md new file mode 100644 index 000000000..c3db206f1 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.LogSetOwnerEventObject.md @@ -0,0 +1,9 @@ +# Interface: LogSetOwnerEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).LogSetOwnerEventObject + +## Properties + +### owner + +• **owner**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MetaTransactionExecutedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MetaTransactionExecutedEventObject.md new file mode 100644 index 000000000..dc2e1000d --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MetaTransactionExecutedEventObject.md @@ -0,0 +1,21 @@ +# Interface: MetaTransactionExecutedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).MetaTransactionExecutedEventObject + +## Properties + +### functionSignature + +• **functionSignature**: `string` + +___ + +### relayerAddress + +• **relayerAddress**: `string` + +___ + +### user + +• **user**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionCancelledEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionCancelledEventObject.md new file mode 100644 index 000000000..f472031d7 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionCancelledEventObject.md @@ -0,0 +1,15 @@ +# Interface: MotionCancelledEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).MotionCancelledEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### motionId + +• **motionId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionCreatedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionCreatedEventObject.md new file mode 100644 index 000000000..9ffab7c0d --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionCreatedEventObject.md @@ -0,0 +1,15 @@ +# Interface: MotionCreatedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).MotionCreatedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### motionId + +• **motionId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionExecutedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionExecutedEventObject.md new file mode 100644 index 000000000..8703e197d --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MotionExecutedEventObject.md @@ -0,0 +1,21 @@ +# Interface: MotionExecutedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).MotionExecutedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### motionId + +• **motionId**: `BigNumber` + +___ + +### success + +• **success**: `boolean` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigPermissionsEvents.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigPermissionsEvents.md new file mode 100644 index 000000000..4ceb798f1 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigPermissionsEvents.md @@ -0,0 +1,625 @@ +# Interface: MultisigPermissionsEvents + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).MultisigPermissionsEvents + +## Hierarchy + +- `BaseContract` + + ↳ **`MultisigPermissionsEvents`** + +## Properties + +### \_deployedPromise + +• **\_deployedPromise**: `Promise`<`Contract`\> + +#### Inherited from + +BaseContract.\_deployedPromise + +___ + +### \_runningEvents + +• **\_runningEvents**: `Object` + +#### Index signature + +▪ [eventTag: `string`]: `RunningEvent` + +#### Inherited from + +BaseContract.\_runningEvents + +___ + +### \_wrappedEmits + +• **\_wrappedEmits**: `Object` + +#### Index signature + +▪ [eventTag: `string`]: (...`args`: `any`[]) => `void` + +#### Inherited from + +BaseContract.\_wrappedEmits + +___ + +### address + +• `Readonly` **address**: `string` + +#### Inherited from + +BaseContract.address + +___ + +### callStatic + +• **callStatic**: `Object` + +#### Overrides + +BaseContract.callStatic + +___ + +### deployTransaction + +• `Readonly` **deployTransaction**: [`TransactionResponse`](TransactionResponse.md) + +#### Inherited from + +BaseContract.deployTransaction + +___ + +### estimateGas + +• **estimateGas**: `Object` + +#### Overrides + +BaseContract.estimateGas + +___ + +### filters + +• **filters**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `Annotation` | (`agent?`: ``null`` \| `string`, `txHash?`: ``null`` \| `BytesLike`, `metadata?`: ``null``) => [`AnnotationEventFilter`](../modules/MultisigPermissionsEvents.md#annotationeventfilter) | +| `Annotation(address,bytes32,string)` | (`agent?`: ``null`` \| `string`, `txHash?`: ``null`` \| `BytesLike`, `metadata?`: ``null``) => [`AnnotationEventFilter`](../modules/MultisigPermissionsEvents.md#annotationeventfilter) | +| `ApprovalChanged` | (`agent?`: ``null``, `motionId?`: ``null``, `role?`: ``null``, `approval?`: ``null``) => [`ApprovalChangedEventFilter`](../modules/MultisigPermissionsEvents.md#approvalchangedeventfilter) | +| `ApprovalChanged(address,uint256,uint8,bool)` | (`agent?`: ``null``, `motionId?`: ``null``, `role?`: ``null``, `approval?`: ``null``) => [`ApprovalChangedEventFilter`](../modules/MultisigPermissionsEvents.md#approvalchangedeventfilter) | +| `ArbitraryReputationUpdate` | (`agent?`: ``null``, `user?`: ``null``, `skillId?`: ``null``, `amount?`: ``null``) => [`ArbitraryReputationUpdateEventFilter`](../modules/MultisigPermissionsEvents.md#arbitraryreputationupdateeventfilter) | +| `ArbitraryReputationUpdate(address,address,uint256,int256)` | (`agent?`: ``null``, `user?`: ``null``, `skillId?`: ``null``, `amount?`: ``null``) => [`ArbitraryReputationUpdateEventFilter`](../modules/MultisigPermissionsEvents.md#arbitraryreputationupdateeventfilter) | +| `ArbitraryTransaction` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => [`ArbitraryTransactionEventFilter`](../modules/MultisigPermissionsEvents.md#arbitrarytransactioneventfilter) | +| `ArbitraryTransaction(address,bytes,bool)` | (`target?`: ``null``, `data?`: ``null``, `success?`: ``null``) => [`ArbitraryTransactionEventFilter`](../modules/MultisigPermissionsEvents.md#arbitrarytransactioneventfilter) | +| `ColonyBootstrapped` | (`agent?`: ``null``, `users?`: ``null``, `amounts?`: ``null``) => [`ColonyBootstrappedEventFilter`](../modules/MultisigPermissionsEvents.md#colonybootstrappedeventfilter) | +| `ColonyBootstrapped(address,address[],int256[])` | (`agent?`: ``null``, `users?`: ``null``, `amounts?`: ``null``) => [`ColonyBootstrappedEventFilter`](../modules/MultisigPermissionsEvents.md#colonybootstrappedeventfilter) | +| `ColonyFundsClaimed` | (`agent?`: ``null``, `token?`: ``null``, `fee?`: ``null``, `payoutRemainder?`: ``null``) => [`ColonyFundsClaimedEventFilter`](../modules/MultisigPermissionsEvents.md#colonyfundsclaimedeventfilter) | +| `ColonyFundsClaimed(address,address,uint256,uint256)` | (`agent?`: ``null``, `token?`: ``null``, `fee?`: ``null``, `payoutRemainder?`: ``null``) => [`ColonyFundsClaimedEventFilter`](../modules/MultisigPermissionsEvents.md#colonyfundsclaimedeventfilter) | +| `ColonyFundsMovedBetweenFundingPots` | (`agent?`: ``null``, `fromPot?`: ``null`` \| `BigNumberish`, `toPot?`: ``null`` \| `BigNumberish`, `amount?`: ``null``, `token?`: ``null``) => [`ColonyFundsMovedBetweenFundingPotsEventFilter`](../modules/MultisigPermissionsEvents.md#colonyfundsmovedbetweenfundingpotseventfilter) | +| `ColonyFundsMovedBetweenFundingPots(address,uint256,uint256,uint256,address)` | (`agent?`: ``null``, `fromPot?`: ``null`` \| `BigNumberish`, `toPot?`: ``null`` \| `BigNumberish`, `amount?`: ``null``, `token?`: ``null``) => [`ColonyFundsMovedBetweenFundingPotsEventFilter`](../modules/MultisigPermissionsEvents.md#colonyfundsmovedbetweenfundingpotseventfilter) | +| `ColonyInitialised` | (`agent?`: ``null``, `colonyNetwork?`: ``null``, `token?`: ``null``) => [`ColonyInitialisedEventFilter`](../modules/MultisigPermissionsEvents.md#colonyinitialisedeventfilter) | +| `ColonyInitialised(address,address,address)` | (`agent?`: ``null``, `colonyNetwork?`: ``null``, `token?`: ``null``) => [`ColonyInitialisedEventFilter`](../modules/MultisigPermissionsEvents.md#colonyinitialisedeventfilter) | +| `ColonyMetadata` | (`agent?`: ``null``, `metadata?`: ``null``) => [`ColonyMetadataEventFilter`](../modules/MultisigPermissionsEvents.md#colonymetadataeventfilter) | +| `ColonyMetadata(address,string)` | (`agent?`: ``null``, `metadata?`: ``null``) => [`ColonyMetadataEventFilter`](../modules/MultisigPermissionsEvents.md#colonymetadataeventfilter) | +| `ColonyMetadataDelta` | (`agent?`: ``null``, `metadata?`: ``null``) => [`ColonyMetadataDeltaEventFilter`](../modules/MultisigPermissionsEvents.md#colonymetadatadeltaeventfilter) | +| `ColonyMetadataDelta(address,string)` | (`agent?`: ``null``, `metadata?`: ``null``) => [`ColonyMetadataDeltaEventFilter`](../modules/MultisigPermissionsEvents.md#colonymetadatadeltaeventfilter) | +| `ColonyRewardInverseSet` | (`agent?`: ``null``, `rewardInverse?`: ``null``) => [`ColonyRewardInverseSetEventFilter`](../modules/MultisigPermissionsEvents.md#colonyrewardinverseseteventfilter) | +| `ColonyRewardInverseSet(address,uint256)` | (`agent?`: ``null``, `rewardInverse?`: ``null``) => [`ColonyRewardInverseSetEventFilter`](../modules/MultisigPermissionsEvents.md#colonyrewardinverseseteventfilter) | +| `ColonyRoleSet` | (`agent?`: ``null``, `user?`: ``null`` \| `string`, `domainId?`: ``null`` \| `BigNumberish`, `role?`: ``null`` \| `BigNumberish`, `setTo?`: ``null``) => [`ColonyRoleSetEventFilter`](../modules/MultisigPermissionsEvents.md#colonyroleseteventfilter) | +| `ColonyRoleSet(address,address,uint256,uint8,bool)` | (`agent?`: ``null``, `user?`: ``null`` \| `string`, `domainId?`: ``null`` \| `BigNumberish`, `role?`: ``null`` \| `BigNumberish`, `setTo?`: ``null``) => [`ColonyRoleSetEventFilter`](../modules/MultisigPermissionsEvents.md#colonyroleseteventfilter) | +| `ColonyUpgraded` | (`agent?`: ``null``, `oldVersion?`: ``null``, `newVersion?`: ``null``) => [`ColonyUpgradedEventFilter`](../modules/MultisigPermissionsEvents.md#colonyupgradedeventfilter) | +| `ColonyUpgraded(address,uint256,uint256)` | (`agent?`: ``null``, `oldVersion?`: ``null``, `newVersion?`: ``null``) => [`ColonyUpgradedEventFilter`](../modules/MultisigPermissionsEvents.md#colonyupgradedeventfilter) | +| `DomainAdded` | (`agent?`: ``null``, `domainId?`: ``null``) => [`DomainAddedEventFilter`](../modules/MultisigPermissionsEvents.md#domainaddedeventfilter) | +| `DomainAdded(address,uint256)` | (`agent?`: ``null``, `domainId?`: ``null``) => [`DomainAddedEventFilter`](../modules/MultisigPermissionsEvents.md#domainaddedeventfilter) | +| `DomainDeprecated` | (`agent?`: ``null``, `domainId?`: ``null`` \| `BigNumberish`, `deprecated?`: ``null``) => [`DomainDeprecatedEventFilter`](../modules/MultisigPermissionsEvents.md#domaindeprecatedeventfilter) | +| `DomainDeprecated(address,uint256,bool)` | (`agent?`: ``null``, `domainId?`: ``null`` \| `BigNumberish`, `deprecated?`: ``null``) => [`DomainDeprecatedEventFilter`](../modules/MultisigPermissionsEvents.md#domaindeprecatedeventfilter) | +| `DomainMetadata` | (`agent?`: ``null``, `domainId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => [`DomainMetadataEventFilter`](../modules/MultisigPermissionsEvents.md#domainmetadataeventfilter) | +| `DomainMetadata(address,uint256,string)` | (`agent?`: ``null``, `domainId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => [`DomainMetadataEventFilter`](../modules/MultisigPermissionsEvents.md#domainmetadataeventfilter) | +| `DomainSkillThresholdSet` | (`domainSkillId?`: ``null``, `threshold?`: ``null``) => [`DomainSkillThresholdSetEventFilter`](../modules/MultisigPermissionsEvents.md#domainskillthresholdseteventfilter) | +| `DomainSkillThresholdSet(uint256,uint256)` | (`domainSkillId?`: ``null``, `threshold?`: ``null``) => [`DomainSkillThresholdSetEventFilter`](../modules/MultisigPermissionsEvents.md#domainskillthresholdseteventfilter) | +| `ExpenditureAdded` | (`agent?`: ``null``, `expenditureId?`: ``null``) => [`ExpenditureAddedEventFilter`](../modules/MultisigPermissionsEvents.md#expenditureaddedeventfilter) | +| `ExpenditureAdded(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null``) => [`ExpenditureAddedEventFilter`](../modules/MultisigPermissionsEvents.md#expenditureaddedeventfilter) | +| `ExpenditureCancelled` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => [`ExpenditureCancelledEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurecancelledeventfilter) | +| `ExpenditureCancelled(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => [`ExpenditureCancelledEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurecancelledeventfilter) | +| `ExpenditureClaimDelaySet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `claimDelay?`: ``null``) => [`ExpenditureClaimDelaySetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditureclaimdelayseteventfilter) | +| `ExpenditureClaimDelaySet(address,uint256,uint256,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `claimDelay?`: ``null``) => [`ExpenditureClaimDelaySetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditureclaimdelayseteventfilter) | +| `ExpenditureFinalized` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => [`ExpenditureFinalizedEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurefinalizedeventfilter) | +| `ExpenditureFinalized(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => [`ExpenditureFinalizedEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurefinalizedeventfilter) | +| `ExpenditureGlobalClaimDelaySet` | (`agent?`: ``null``, `globalClaimDelay?`: ``null``) => [`ExpenditureGlobalClaimDelaySetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditureglobalclaimdelayseteventfilter) | +| `ExpenditureGlobalClaimDelaySet(address,uint256)` | (`agent?`: ``null``, `globalClaimDelay?`: ``null``) => [`ExpenditureGlobalClaimDelaySetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditureglobalclaimdelayseteventfilter) | +| `ExpenditureLocked` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => [`ExpenditureLockedEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurelockedeventfilter) | +| `ExpenditureLocked(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => [`ExpenditureLockedEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurelockedeventfilter) | +| `ExpenditureMetadataSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => [`ExpenditureMetadataSetEventFilter`](../modules/MultisigPermissionsEvents.md#expendituremetadataseteventfilter) | +| `ExpenditureMetadataSet(address,uint256,string)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => [`ExpenditureMetadataSetEventFilter`](../modules/MultisigPermissionsEvents.md#expendituremetadataseteventfilter) | +| `ExpenditurePayoutModifierSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `payoutModifier?`: ``null``) => [`ExpenditurePayoutModifierSetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurepayoutmodifierseteventfilter) | +| `ExpenditurePayoutModifierSet(address,uint256,uint256,int256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `payoutModifier?`: ``null``) => [`ExpenditurePayoutModifierSetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurepayoutmodifierseteventfilter) | +| `ExpenditurePayoutSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `token?`: ``null`` \| `string`, `amount?`: ``null``) => [`ExpenditurePayoutSetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurepayoutseteventfilter) | +| `ExpenditurePayoutSet(address,uint256,uint256,address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `token?`: ``null`` \| `string`, `amount?`: ``null``) => [`ExpenditurePayoutSetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurepayoutseteventfilter) | +| `ExpenditureRecipientSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `recipient?`: ``null`` \| `string`) => [`ExpenditureRecipientSetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurerecipientseteventfilter) | +| `ExpenditureRecipientSet(address,uint256,uint256,address)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `recipient?`: ``null`` \| `string`) => [`ExpenditureRecipientSetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurerecipientseteventfilter) | +| `ExpenditureSkillSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `skillId?`: ``null`` \| `BigNumberish`) => [`ExpenditureSkillSetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditureskillseteventfilter) | +| `ExpenditureSkillSet(address,uint256,uint256,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `skillId?`: ``null`` \| `BigNumberish`) => [`ExpenditureSkillSetEventFilter`](../modules/MultisigPermissionsEvents.md#expenditureskillseteventfilter) | +| `ExpenditureStateChanged` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `storageSlot?`: ``null`` \| `BigNumberish`, `mask?`: ``null``, `keys?`: ``null``, `value?`: ``null``) => [`ExpenditureStateChangedEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurestatechangedeventfilter) | +| `ExpenditureStateChanged(address,uint256,uint256,bool[],bytes32[],bytes32)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `storageSlot?`: ``null`` \| `BigNumberish`, `mask?`: ``null``, `keys?`: ``null``, `value?`: ``null``) => [`ExpenditureStateChangedEventFilter`](../modules/MultisigPermissionsEvents.md#expenditurestatechangedeventfilter) | +| `ExpenditureTransferred` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `owner?`: ``null`` \| `string`) => [`ExpenditureTransferredEventFilter`](../modules/MultisigPermissionsEvents.md#expendituretransferredeventfilter) | +| `ExpenditureTransferred(address,uint256,address)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `owner?`: ``null`` \| `string`) => [`ExpenditureTransferredEventFilter`](../modules/MultisigPermissionsEvents.md#expendituretransferredeventfilter) | +| `ExtensionInitialised` | () => [`ExtensionInitialisedEventFilter`](../modules/MultisigPermissionsEvents.md#extensioninitialisedeventfilter) | +| `ExtensionInitialised()` | () => [`ExtensionInitialisedEventFilter`](../modules/MultisigPermissionsEvents.md#extensioninitialisedeventfilter) | +| `FundingPotAdded` | (`fundingPotId?`: ``null``) => [`FundingPotAddedEventFilter`](../modules/MultisigPermissionsEvents.md#fundingpotaddedeventfilter) | +| `FundingPotAdded(uint256)` | (`fundingPotId?`: ``null``) => [`FundingPotAddedEventFilter`](../modules/MultisigPermissionsEvents.md#fundingpotaddedeventfilter) | +| `GlobalThresholdSet` | (`globalThreshold?`: ``null``) => [`GlobalThresholdSetEventFilter`](../modules/MultisigPermissionsEvents.md#globalthresholdseteventfilter) | +| `GlobalThresholdSet(uint256)` | (`globalThreshold?`: ``null``) => [`GlobalThresholdSetEventFilter`](../modules/MultisigPermissionsEvents.md#globalthresholdseteventfilter) | +| `LocalSkillAdded` | (`agent?`: ``null``, `localSkillId?`: ``null``) => [`LocalSkillAddedEventFilter`](../modules/MultisigPermissionsEvents.md#localskilladdedeventfilter) | +| `LocalSkillAdded(address,uint256)` | (`agent?`: ``null``, `localSkillId?`: ``null``) => [`LocalSkillAddedEventFilter`](../modules/MultisigPermissionsEvents.md#localskilladdedeventfilter) | +| `LocalSkillDeprecated` | (`agent?`: ``null``, `localSkillId?`: ``null``, `deprecated?`: ``null``) => [`LocalSkillDeprecatedEventFilter`](../modules/MultisigPermissionsEvents.md#localskilldeprecatedeventfilter) | +| `LocalSkillDeprecated(address,uint256,bool)` | (`agent?`: ``null``, `localSkillId?`: ``null``, `deprecated?`: ``null``) => [`LocalSkillDeprecatedEventFilter`](../modules/MultisigPermissionsEvents.md#localskilldeprecatedeventfilter) | +| `LogSetAuthority` | (`authority?`: ``null`` \| `string`) => [`LogSetAuthorityEventFilter`](../modules/MultisigPermissionsEvents.md#logsetauthorityeventfilter) | +| `LogSetAuthority(address)` | (`authority?`: ``null`` \| `string`) => [`LogSetAuthorityEventFilter`](../modules/MultisigPermissionsEvents.md#logsetauthorityeventfilter) | +| `LogSetOwner` | (`owner?`: ``null`` \| `string`) => [`LogSetOwnerEventFilter`](../modules/MultisigPermissionsEvents.md#logsetownereventfilter) | +| `LogSetOwner(address)` | (`owner?`: ``null`` \| `string`) => [`LogSetOwnerEventFilter`](../modules/MultisigPermissionsEvents.md#logsetownereventfilter) | +| `MetaTransactionExecuted` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => [`MetaTransactionExecutedEventFilter`](../modules/MultisigPermissionsEvents.md#metatransactionexecutedeventfilter) | +| `MetaTransactionExecuted(address,address,bytes)` | (`user?`: ``null``, `relayerAddress?`: ``null``, `functionSignature?`: ``null``) => [`MetaTransactionExecutedEventFilter`](../modules/MultisigPermissionsEvents.md#metatransactionexecutedeventfilter) | +| `MotionCancelled` | (`agent?`: ``null``, `motionId?`: ``null``) => [`MotionCancelledEventFilter`](../modules/MultisigPermissionsEvents.md#motioncancelledeventfilter) | +| `MotionCancelled(address,uint256)` | (`agent?`: ``null``, `motionId?`: ``null``) => [`MotionCancelledEventFilter`](../modules/MultisigPermissionsEvents.md#motioncancelledeventfilter) | +| `MotionCreated` | (`agent?`: ``null``, `motionId?`: ``null``) => [`MotionCreatedEventFilter`](../modules/MultisigPermissionsEvents.md#motioncreatedeventfilter) | +| `MotionCreated(address,uint256)` | (`agent?`: ``null``, `motionId?`: ``null``) => [`MotionCreatedEventFilter`](../modules/MultisigPermissionsEvents.md#motioncreatedeventfilter) | +| `MotionExecuted` | (`agent?`: ``null``, `motionId?`: ``null``, `success?`: ``null``) => [`MotionExecutedEventFilter`](../modules/MultisigPermissionsEvents.md#motionexecutedeventfilter) | +| `MotionExecuted(address,uint256,bool)` | (`agent?`: ``null``, `motionId?`: ``null``, `success?`: ``null``) => [`MotionExecutedEventFilter`](../modules/MultisigPermissionsEvents.md#motionexecutedeventfilter) | +| `MultisigRoleSet` | (`agent?`: ``null``, `user?`: ``null``, `domainId?`: ``null``, `roleId?`: ``null``, `setTo?`: ``null``) => [`MultisigRoleSetEventFilter`](../modules/MultisigPermissionsEvents.md#multisigroleseteventfilter) | +| `MultisigRoleSet(address,address,uint256,uint256,bool)` | (`agent?`: ``null``, `user?`: ``null``, `domainId?`: ``null``, `roleId?`: ``null``, `setTo?`: ``null``) => [`MultisigRoleSetEventFilter`](../modules/MultisigPermissionsEvents.md#multisigroleseteventfilter) | +| `PaymentAdded` | (`agent?`: ``null``, `paymentId?`: ``null``) => [`PaymentAddedEventFilter`](../modules/MultisigPermissionsEvents.md#paymentaddedeventfilter) | +| `PaymentAdded(address,uint256)` | (`agent?`: ``null``, `paymentId?`: ``null``) => [`PaymentAddedEventFilter`](../modules/MultisigPermissionsEvents.md#paymentaddedeventfilter) | +| `PaymentFinalized` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`) => [`PaymentFinalizedEventFilter`](../modules/MultisigPermissionsEvents.md#paymentfinalizedeventfilter) | +| `PaymentFinalized(address,uint256)` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`) => [`PaymentFinalizedEventFilter`](../modules/MultisigPermissionsEvents.md#paymentfinalizedeventfilter) | +| `PaymentPayoutSet` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`PaymentPayoutSetEventFilter`](../modules/MultisigPermissionsEvents.md#paymentpayoutseteventfilter) | +| `PaymentPayoutSet(address,uint256,address,uint256)` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`PaymentPayoutSetEventFilter`](../modules/MultisigPermissionsEvents.md#paymentpayoutseteventfilter) | +| `PaymentRecipientSet` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `recipient?`: ``null``) => [`PaymentRecipientSetEventFilter`](../modules/MultisigPermissionsEvents.md#paymentrecipientseteventfilter) | +| `PaymentRecipientSet(address,uint256,address)` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `recipient?`: ``null``) => [`PaymentRecipientSetEventFilter`](../modules/MultisigPermissionsEvents.md#paymentrecipientseteventfilter) | +| `PaymentSkillSet` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `skillId?`: ``null``) => [`PaymentSkillSetEventFilter`](../modules/MultisigPermissionsEvents.md#paymentskillseteventfilter) | +| `PaymentSkillSet(address,uint256,uint256)` | (`agent?`: ``null``, `paymentId?`: ``null`` \| `BigNumberish`, `skillId?`: ``null``) => [`PaymentSkillSetEventFilter`](../modules/MultisigPermissionsEvents.md#paymentskillseteventfilter) | +| `PayoutClaimed(address,uint256,address,uint256)` | (`agent?`: ``null``, `fundingPotId?`: ``null`` \| `BigNumberish`, `token?`: ``null``, `amount?`: ``null``) => [`PayoutClaimed_address_uint256_address_uint256_EventFilter`](../modules/MultisigPermissionsEvents.md#payoutclaimed_address_uint256_address_uint256_eventfilter) | +| `PayoutClaimed(address,uint256,uint256,address,uint256)` | (`agent?`: ``null``, `id?`: ``null``, `slot?`: ``null``, `token?`: ``null``, `tokenPayout?`: ``null``) => [`PayoutClaimed_address_uint256_uint256_address_uint256_EventFilter`](../modules/MultisigPermissionsEvents.md#payoutclaimed_address_uint256_uint256_address_uint256_eventfilter) | +| `RejectionChanged` | (`agent?`: ``null``, `motionId?`: ``null``, `role?`: ``null``, `approval?`: ``null``) => [`RejectionChangedEventFilter`](../modules/MultisigPermissionsEvents.md#rejectionchangedeventfilter) | +| `RejectionChanged(address,uint256,uint8,bool)` | (`agent?`: ``null``, `motionId?`: ``null``, `role?`: ``null``, `approval?`: ``null``) => [`RejectionChangedEventFilter`](../modules/MultisigPermissionsEvents.md#rejectionchangedeventfilter) | +| `RewardPayoutClaimed` | (`rewardPayoutId?`: ``null``, `user?`: ``null``, `fee?`: ``null``, `rewardRemainder?`: ``null``) => [`RewardPayoutClaimedEventFilter`](../modules/MultisigPermissionsEvents.md#rewardpayoutclaimedeventfilter) | +| `RewardPayoutClaimed(uint256,address,uint256,uint256)` | (`rewardPayoutId?`: ``null``, `user?`: ``null``, `fee?`: ``null``, `rewardRemainder?`: ``null``) => [`RewardPayoutClaimedEventFilter`](../modules/MultisigPermissionsEvents.md#rewardpayoutclaimedeventfilter) | +| `RewardPayoutCycleEnded` | (`agent?`: ``null``, `rewardPayoutId?`: ``null``) => [`RewardPayoutCycleEndedEventFilter`](../modules/MultisigPermissionsEvents.md#rewardpayoutcycleendedeventfilter) | +| `RewardPayoutCycleEnded(address,uint256)` | (`agent?`: ``null``, `rewardPayoutId?`: ``null``) => [`RewardPayoutCycleEndedEventFilter`](../modules/MultisigPermissionsEvents.md#rewardpayoutcycleendedeventfilter) | +| `RewardPayoutCycleStarted` | (`agent?`: ``null``, `rewardPayoutId?`: ``null``) => [`RewardPayoutCycleStartedEventFilter`](../modules/MultisigPermissionsEvents.md#rewardpayoutcyclestartedeventfilter) | +| `RewardPayoutCycleStarted(address,uint256)` | (`agent?`: ``null``, `rewardPayoutId?`: ``null``) => [`RewardPayoutCycleStartedEventFilter`](../modules/MultisigPermissionsEvents.md#rewardpayoutcyclestartedeventfilter) | +| `TaskAdded` | (`agent?`: ``null``, `taskId?`: ``null``) => [`TaskAddedEventFilter`](../modules/MultisigPermissionsEvents.md#taskaddedeventfilter) | +| `TaskAdded(address,uint256)` | (`agent?`: ``null``, `taskId?`: ``null``) => [`TaskAddedEventFilter`](../modules/MultisigPermissionsEvents.md#taskaddedeventfilter) | +| `TaskBriefSet` | (`taskId?`: ``null`` \| `BigNumberish`, `specificationHash?`: ``null``) => [`TaskBriefSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskbriefseteventfilter) | +| `TaskBriefSet(uint256,bytes32)` | (`taskId?`: ``null`` \| `BigNumberish`, `specificationHash?`: ``null``) => [`TaskBriefSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskbriefseteventfilter) | +| `TaskCanceled` | (`taskId?`: ``null`` \| `BigNumberish`) => [`TaskCanceledEventFilter`](../modules/MultisigPermissionsEvents.md#taskcanceledeventfilter) | +| `TaskCanceled(uint256)` | (`taskId?`: ``null`` \| `BigNumberish`) => [`TaskCanceledEventFilter`](../modules/MultisigPermissionsEvents.md#taskcanceledeventfilter) | +| `TaskChangedViaSignatures` | (`reviewerAddresses?`: ``null``) => [`TaskChangedViaSignaturesEventFilter`](../modules/MultisigPermissionsEvents.md#taskchangedviasignatureseventfilter) | +| `TaskChangedViaSignatures(address[])` | (`reviewerAddresses?`: ``null``) => [`TaskChangedViaSignaturesEventFilter`](../modules/MultisigPermissionsEvents.md#taskchangedviasignatureseventfilter) | +| `TaskCompleted` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`) => [`TaskCompletedEventFilter`](../modules/MultisigPermissionsEvents.md#taskcompletedeventfilter) | +| `TaskCompleted(address,uint256)` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`) => [`TaskCompletedEventFilter`](../modules/MultisigPermissionsEvents.md#taskcompletedeventfilter) | +| `TaskDeliverableSubmitted` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`, `deliverableHash?`: ``null``) => [`TaskDeliverableSubmittedEventFilter`](../modules/MultisigPermissionsEvents.md#taskdeliverablesubmittedeventfilter) | +| `TaskDeliverableSubmitted(address,uint256,bytes32)` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`, `deliverableHash?`: ``null``) => [`TaskDeliverableSubmittedEventFilter`](../modules/MultisigPermissionsEvents.md#taskdeliverablesubmittedeventfilter) | +| `TaskDueDateSet` | (`taskId?`: ``null`` \| `BigNumberish`, `dueDate?`: ``null``) => [`TaskDueDateSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskduedateseteventfilter) | +| `TaskDueDateSet(uint256,uint256)` | (`taskId?`: ``null`` \| `BigNumberish`, `dueDate?`: ``null``) => [`TaskDueDateSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskduedateseteventfilter) | +| `TaskFinalized` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`) => [`TaskFinalizedEventFilter`](../modules/MultisigPermissionsEvents.md#taskfinalizedeventfilter) | +| `TaskFinalized(address,uint256)` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`) => [`TaskFinalizedEventFilter`](../modules/MultisigPermissionsEvents.md#taskfinalizedeventfilter) | +| `TaskPayoutSet` | (`taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `token?`: ``null``, `amount?`: ``null``) => [`TaskPayoutSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskpayoutseteventfilter) | +| `TaskPayoutSet(uint256,uint8,address,uint256)` | (`taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `token?`: ``null``, `amount?`: ``null``) => [`TaskPayoutSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskpayoutseteventfilter) | +| `TaskRoleUserSet` | (`taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `user?`: ``null`` \| `string`) => [`TaskRoleUserSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskroleuserseteventfilter) | +| `TaskRoleUserSet(uint256,uint8,address)` | (`taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `user?`: ``null`` \| `string`) => [`TaskRoleUserSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskroleuserseteventfilter) | +| `TaskSkillSet` | (`taskId?`: ``null`` \| `BigNumberish`, `skillId?`: ``null`` \| `BigNumberish`) => [`TaskSkillSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskskillseteventfilter) | +| `TaskSkillSet(uint256,uint256)` | (`taskId?`: ``null`` \| `BigNumberish`, `skillId?`: ``null`` \| `BigNumberish`) => [`TaskSkillSetEventFilter`](../modules/MultisigPermissionsEvents.md#taskskillseteventfilter) | +| `TaskWorkRatingRevealed` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `rating?`: ``null``) => [`TaskWorkRatingRevealedEventFilter`](../modules/MultisigPermissionsEvents.md#taskworkratingrevealedeventfilter) | +| `TaskWorkRatingRevealed(address,uint256,uint8,uint8)` | (`agent?`: ``null``, `taskId?`: ``null`` \| `BigNumberish`, `role?`: ``null``, `rating?`: ``null``) => [`TaskWorkRatingRevealedEventFilter`](../modules/MultisigPermissionsEvents.md#taskworkratingrevealedeventfilter) | +| `TokenUnlocked` | (`agent?`: ``null``) => [`TokenUnlockedEventFilter`](../modules/MultisigPermissionsEvents.md#tokenunlockedeventfilter) | +| `TokenUnlocked(address)` | (`agent?`: ``null``) => [`TokenUnlockedEventFilter`](../modules/MultisigPermissionsEvents.md#tokenunlockedeventfilter) | +| `TokensBurned` | (`agent?`: ``null``, `token?`: ``null``, `amount?`: ``null``) => [`TokensBurnedEventFilter`](../modules/MultisigPermissionsEvents.md#tokensburnedeventfilter) | +| `TokensBurned(address,address,uint256)` | (`agent?`: ``null``, `token?`: ``null``, `amount?`: ``null``) => [`TokensBurnedEventFilter`](../modules/MultisigPermissionsEvents.md#tokensburnedeventfilter) | +| `TokensMinted` | (`agent?`: ``null``, `who?`: ``null``, `amount?`: ``null``) => [`TokensMintedEventFilter`](../modules/MultisigPermissionsEvents.md#tokensmintedeventfilter) | +| `TokensMinted(address,address,uint256)` | (`agent?`: ``null``, `who?`: ``null``, `amount?`: ``null``) => [`TokensMintedEventFilter`](../modules/MultisigPermissionsEvents.md#tokensmintedeventfilter) | + +#### Overrides + +BaseContract.filters + +___ + +### functions + +• **functions**: `Object` + +#### Overrides + +BaseContract.functions + +___ + +### interface + +• **interface**: [`MultisigPermissionsEventsInterface`](MultisigPermissionsEvents.MultisigPermissionsEventsInterface.md) + +#### Overrides + +BaseContract.interface + +___ + +### off + +• **off**: `OnEvent`<[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md)\> + +#### Overrides + +BaseContract.off + +___ + +### on + +• **on**: `OnEvent`<[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md)\> + +#### Overrides + +BaseContract.on + +___ + +### once + +• **once**: `OnEvent`<[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md)\> + +#### Overrides + +BaseContract.once + +___ + +### populateTransaction + +• **populateTransaction**: `Object` + +#### Overrides + +BaseContract.populateTransaction + +___ + +### provider + +• `Readonly` **provider**: `Provider` + +#### Inherited from + +BaseContract.provider + +___ + +### removeListener + +• **removeListener**: `OnEvent`<[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md)\> + +#### Overrides + +BaseContract.removeListener + +___ + +### resolvedAddress + +• `Readonly` **resolvedAddress**: `Promise`<`string`\> + +#### Inherited from + +BaseContract.resolvedAddress + +___ + +### signer + +• `Readonly` **signer**: `Signer` + +#### Inherited from + +BaseContract.signer + +## Methods + +### \_checkRunningEvents + +▸ **_checkRunningEvents**(`runningEvent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `runningEvent` | `RunningEvent` | + +#### Returns + +`void` + +#### Inherited from + +BaseContract.\_checkRunningEvents + +___ + +### \_deployed + +▸ **_deployed**(`blockTag?`): `Promise`<`Contract`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blockTag?` | `BlockTag` | + +#### Returns + +`Promise`<`Contract`\> + +#### Inherited from + +BaseContract.\_deployed + +___ + +### \_wrapEvent + +▸ **_wrapEvent**(`runningEvent`, `log`, `listener`): `Event` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `runningEvent` | `RunningEvent` | +| `log` | `Log` | +| `listener` | `Listener` | + +#### Returns + +`Event` + +#### Inherited from + +BaseContract.\_wrapEvent + +___ + +### attach + +▸ **attach**(`addressOrName`): [`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `addressOrName` | `string` | + +#### Returns + +[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Overrides + +BaseContract.attach + +___ + +### connect + +▸ **connect**(`signerOrProvider`): [`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `signerOrProvider` | `string` \| `Signer` \| `Provider` | + +#### Returns + +[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Overrides + +BaseContract.connect + +___ + +### deployed + +▸ **deployed**(): `Promise`<[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md)\> + +#### Returns + +`Promise`<[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md)\> + +#### Overrides + +BaseContract.deployed + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `EventFilter` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +BaseContract.emit + +___ + +### fallback + +▸ **fallback**(`overrides?`): `Promise`<[`TransactionResponse`](TransactionResponse.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `overrides?` | `TransactionRequest` | + +#### Returns + +`Promise`<[`TransactionResponse`](TransactionResponse.md)\> + +#### Inherited from + +BaseContract.fallback + +___ + +### listenerCount + +▸ **listenerCount**(`eventName?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` \| `EventFilter` | + +#### Returns + +`number` + +#### Inherited from + +BaseContract.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`\>[] + +#### Overrides + +BaseContract.listeners + +▸ **listeners**(`eventName?`): `Listener`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +`Listener`[] + +#### Overrides + +BaseContract.listeners + +___ + +### 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`[]\> + +#### Overrides + +BaseContract.queryFilter + +___ + +### removeAllListeners + +▸ **removeAllListeners**<`TEvent`\>(`eventFilter`): [`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TEvent` | extends `TypedEvent`<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFilter` | `TypedEventFilter`<`TEvent`\> | + +#### Returns + +[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Overrides + +BaseContract.removeAllListeners + +▸ **removeAllListeners**(`eventName?`): [`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName?` | `string` | + +#### Returns + +[`MultisigPermissionsEvents`](MultisigPermissionsEvents.MultisigPermissionsEvents.md) + +#### Overrides + +BaseContract.removeAllListeners diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigPermissionsEventsInterface.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigPermissionsEventsInterface.md new file mode 100644 index 000000000..13ca08df7 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigPermissionsEventsInterface.md @@ -0,0 +1,2739 @@ +# Interface: MultisigPermissionsEventsInterface + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).MultisigPermissionsEventsInterface + +## Hierarchy + +- `Interface` + + ↳ **`MultisigPermissionsEventsInterface`** + +## Properties + +### \_abiCoder + +• `Readonly` **\_abiCoder**: `AbiCoder` + +#### Inherited from + +utils.Interface.\_abiCoder + +___ + +### \_isInterface + +• `Readonly` **\_isInterface**: `boolean` + +#### Inherited from + +utils.Interface.\_isInterface + +___ + +### deploy + +• `Readonly` **deploy**: `ConstructorFragment` + +#### Inherited from + +utils.Interface.deploy + +___ + +### errors + +• `Readonly` **errors**: `Object` + +#### Index signature + +▪ [name: `string`]: `ErrorFragment` + +#### Inherited from + +utils.Interface.errors + +___ + +### events + +• **events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `Annotation(address,bytes32,string)` | `EventFragment` | +| `ApprovalChanged(address,uint256,uint8,bool)` | `EventFragment` | +| `ArbitraryReputationUpdate(address,address,uint256,int256)` | `EventFragment` | +| `ArbitraryTransaction(address,bytes,bool)` | `EventFragment` | +| `ColonyBootstrapped(address,address[],int256[])` | `EventFragment` | +| `ColonyFundsClaimed(address,address,uint256,uint256)` | `EventFragment` | +| `ColonyFundsMovedBetweenFundingPots(address,uint256,uint256,uint256,address)` | `EventFragment` | +| `ColonyInitialised(address,address,address)` | `EventFragment` | +| `ColonyMetadata(address,string)` | `EventFragment` | +| `ColonyMetadataDelta(address,string)` | `EventFragment` | +| `ColonyRewardInverseSet(address,uint256)` | `EventFragment` | +| `ColonyRoleSet(address,address,uint256,uint8,bool)` | `EventFragment` | +| `ColonyUpgraded(address,uint256,uint256)` | `EventFragment` | +| `DomainAdded(address,uint256)` | `EventFragment` | +| `DomainDeprecated(address,uint256,bool)` | `EventFragment` | +| `DomainMetadata(address,uint256,string)` | `EventFragment` | +| `DomainSkillThresholdSet(uint256,uint256)` | `EventFragment` | +| `ExpenditureAdded(address,uint256)` | `EventFragment` | +| `ExpenditureCancelled(address,uint256)` | `EventFragment` | +| `ExpenditureClaimDelaySet(address,uint256,uint256,uint256)` | `EventFragment` | +| `ExpenditureFinalized(address,uint256)` | `EventFragment` | +| `ExpenditureGlobalClaimDelaySet(address,uint256)` | `EventFragment` | +| `ExpenditureLocked(address,uint256)` | `EventFragment` | +| `ExpenditureMetadataSet(address,uint256,string)` | `EventFragment` | +| `ExpenditurePayoutModifierSet(address,uint256,uint256,int256)` | `EventFragment` | +| `ExpenditurePayoutSet(address,uint256,uint256,address,uint256)` | `EventFragment` | +| `ExpenditureRecipientSet(address,uint256,uint256,address)` | `EventFragment` | +| `ExpenditureSkillSet(address,uint256,uint256,uint256)` | `EventFragment` | +| `ExpenditureStateChanged(address,uint256,uint256,bool[],bytes32[],bytes32)` | `EventFragment` | +| `ExpenditureTransferred(address,uint256,address)` | `EventFragment` | +| `ExtensionInitialised()` | `EventFragment` | +| `FundingPotAdded(uint256)` | `EventFragment` | +| `GlobalThresholdSet(uint256)` | `EventFragment` | +| `LocalSkillAdded(address,uint256)` | `EventFragment` | +| `LocalSkillDeprecated(address,uint256,bool)` | `EventFragment` | +| `LogSetAuthority(address)` | `EventFragment` | +| `LogSetOwner(address)` | `EventFragment` | +| `MetaTransactionExecuted(address,address,bytes)` | `EventFragment` | +| `MotionCancelled(address,uint256)` | `EventFragment` | +| `MotionCreated(address,uint256)` | `EventFragment` | +| `MotionExecuted(address,uint256,bool)` | `EventFragment` | +| `MultisigRoleSet(address,address,uint256,uint256,bool)` | `EventFragment` | +| `PaymentAdded(address,uint256)` | `EventFragment` | +| `PaymentFinalized(address,uint256)` | `EventFragment` | +| `PaymentPayoutSet(address,uint256,address,uint256)` | `EventFragment` | +| `PaymentRecipientSet(address,uint256,address)` | `EventFragment` | +| `PaymentSkillSet(address,uint256,uint256)` | `EventFragment` | +| `PayoutClaimed(address,uint256,address,uint256)` | `EventFragment` | +| `PayoutClaimed(address,uint256,uint256,address,uint256)` | `EventFragment` | +| `RejectionChanged(address,uint256,uint8,bool)` | `EventFragment` | +| `RewardPayoutClaimed(uint256,address,uint256,uint256)` | `EventFragment` | +| `RewardPayoutCycleEnded(address,uint256)` | `EventFragment` | +| `RewardPayoutCycleStarted(address,uint256)` | `EventFragment` | +| `TaskAdded(address,uint256)` | `EventFragment` | +| `TaskBriefSet(uint256,bytes32)` | `EventFragment` | +| `TaskCanceled(uint256)` | `EventFragment` | +| `TaskChangedViaSignatures(address[])` | `EventFragment` | +| `TaskCompleted(address,uint256)` | `EventFragment` | +| `TaskDeliverableSubmitted(address,uint256,bytes32)` | `EventFragment` | +| `TaskDueDateSet(uint256,uint256)` | `EventFragment` | +| `TaskFinalized(address,uint256)` | `EventFragment` | +| `TaskPayoutSet(uint256,uint8,address,uint256)` | `EventFragment` | +| `TaskRoleUserSet(uint256,uint8,address)` | `EventFragment` | +| `TaskSkillSet(uint256,uint256)` | `EventFragment` | +| `TaskWorkRatingRevealed(address,uint256,uint8,uint8)` | `EventFragment` | +| `TokenUnlocked(address)` | `EventFragment` | +| `TokensBurned(address,address,uint256)` | `EventFragment` | +| `TokensMinted(address,address,uint256)` | `EventFragment` | + +#### Overrides + +utils.Interface.events + +___ + +### fragments + +• `Readonly` **fragments**: readonly `Fragment`[] + +#### Inherited from + +utils.Interface.fragments + +___ + +### functions + +• **functions**: `Object` + +#### Overrides + +utils.Interface.functions + +___ + +### structs + +• `Readonly` **structs**: `Object` + +#### Index signature + +▪ [name: `string`]: `any` + +#### Inherited from + +utils.Interface.structs + +## Methods + +### \_decodeParams + +▸ **_decodeParams**(`params`, `data`): `Result` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | readonly `ParamType`[] | +| `data` | `BytesLike` | + +#### Returns + +`Result` + +#### Inherited from + +utils.Interface.\_decodeParams + +___ + +### \_encodeParams + +▸ **_encodeParams**(`params`, `values`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | readonly `ParamType`[] | +| `values` | readonly `any`[] | + +#### Returns + +`string` + +#### Inherited from + +utils.Interface.\_encodeParams + +___ + +### decodeErrorResult + +▸ **decodeErrorResult**(`fragment`, `data`): `Result` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fragment` | `string` \| `ErrorFragment` | +| `data` | `BytesLike` | + +#### Returns + +`Result` + +#### Inherited from + +utils.Interface.decodeErrorResult + +___ + +### decodeEventLog + +▸ **decodeEventLog**(`eventFragment`, `data`, `topics?`): `Result` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFragment` | `string` \| `EventFragment` | +| `data` | `BytesLike` | +| `topics?` | readonly `string`[] | + +#### Returns + +`Result` + +#### Inherited from + +utils.Interface.decodeEventLog + +___ + +### decodeFunctionData + +▸ **decodeFunctionData**(`functionFragment`, `data`): `Result` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `functionFragment` | `string` \| `FunctionFragment` | +| `data` | `BytesLike` | + +#### Returns + +`Result` + +#### Inherited from + +utils.Interface.decodeFunctionData + +___ + +### decodeFunctionResult + +▸ **decodeFunctionResult**(`functionFragment`, `data`): `Result` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `functionFragment` | `string` \| `FunctionFragment` | +| `data` | `BytesLike` | + +#### Returns + +`Result` + +#### Inherited from + +utils.Interface.decodeFunctionResult + +___ + +### encodeDeploy + +▸ **encodeDeploy**(`values?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `values?` | readonly `any`[] | + +#### Returns + +`string` + +#### Inherited from + +utils.Interface.encodeDeploy + +___ + +### encodeErrorResult + +▸ **encodeErrorResult**(`fragment`, `values?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fragment` | `string` \| `ErrorFragment` | +| `values?` | readonly `any`[] | + +#### Returns + +`string` + +#### Inherited from + +utils.Interface.encodeErrorResult + +___ + +### encodeEventLog + +▸ **encodeEventLog**(`eventFragment`, `values`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFragment` | `string` \| `EventFragment` | +| `values` | readonly `any`[] | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `data` | `string` | +| `topics` | `string`[] | + +#### Inherited from + +utils.Interface.encodeEventLog + +___ + +### encodeFilterTopics + +▸ **encodeFilterTopics**(`eventFragment`, `values`): (`string` \| `string`[])[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFragment` | `string` \| `EventFragment` | +| `values` | readonly `any`[] | + +#### Returns + +(`string` \| `string`[])[] + +#### Inherited from + +utils.Interface.encodeFilterTopics + +___ + +### encodeFunctionData + +▸ **encodeFunctionData**(`functionFragment`, `values?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `functionFragment` | `string` \| `FunctionFragment` | +| `values?` | readonly `any`[] | + +#### Returns + +`string` + +#### Inherited from + +utils.Interface.encodeFunctionData + +___ + +### encodeFunctionResult + +▸ **encodeFunctionResult**(`functionFragment`, `values?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `functionFragment` | `string` \| `FunctionFragment` | +| `values?` | readonly `any`[] | + +#### Returns + +`string` + +#### Inherited from + +utils.Interface.encodeFunctionResult + +___ + +### format + +▸ **format**(`format?`): `string` \| `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `format?` | `string` | + +#### Returns + +`string` \| `string`[] + +#### Inherited from + +utils.Interface.format + +___ + +### getError + +▸ **getError**(`nameOrSignatureOrSighash`): `ErrorFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrSighash` | `string` | + +#### Returns + +`ErrorFragment` + +#### Inherited from + +utils.Interface.getError + +___ + +### getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"Annotation"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"Annotation(address,bytes32,string)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ApprovalChanged"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ApprovalChanged(address,uint256,uint8,bool)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ArbitraryReputationUpdate"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ArbitraryReputationUpdate(address,address,uint256,int256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ArbitraryTransaction"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ArbitraryTransaction(address,bytes,bool)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyBootstrapped"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyBootstrapped(address,address[],int256[])"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyFundsClaimed"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyFundsClaimed(address,address,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyFundsMovedBetweenFundingPots"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyFundsMovedBetweenFundingPots(address,uint256,uint256,uint256,address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyInitialised"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyInitialised(address,address,address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyMetadata"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyMetadata(address,string)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyMetadataDelta"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyMetadataDelta(address,string)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyRewardInverseSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyRewardInverseSet(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyRoleSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyRoleSet(address,address,uint256,uint8,bool)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyUpgraded"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ColonyUpgraded(address,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"DomainAdded"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"DomainAdded(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"DomainDeprecated"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"DomainDeprecated(address,uint256,bool)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"DomainMetadata"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"DomainMetadata(address,uint256,string)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"DomainSkillThresholdSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"DomainSkillThresholdSet(uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureAdded"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureAdded(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureCancelled"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureCancelled(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureClaimDelaySet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureClaimDelaySet(address,uint256,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureFinalized"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureFinalized(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureGlobalClaimDelaySet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureGlobalClaimDelaySet(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureLocked"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureLocked(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureMetadataSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureMetadataSet(address,uint256,string)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditurePayoutModifierSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditurePayoutModifierSet(address,uint256,uint256,int256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditurePayoutSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditurePayoutSet(address,uint256,uint256,address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureRecipientSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureRecipientSet(address,uint256,uint256,address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureSkillSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureSkillSet(address,uint256,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureStateChanged"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureStateChanged(address,uint256,uint256,bool[],bytes32[],bytes32)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureTransferred"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExpenditureTransferred(address,uint256,address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExtensionInitialised"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"ExtensionInitialised()"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"FundingPotAdded"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"FundingPotAdded(uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"GlobalThresholdSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"GlobalThresholdSet(uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"LocalSkillAdded"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"LocalSkillAdded(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"LocalSkillDeprecated"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"LocalSkillDeprecated(address,uint256,bool)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"LogSetAuthority"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"LogSetAuthority(address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"LogSetOwner"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"LogSetOwner(address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MetaTransactionExecuted"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MetaTransactionExecuted(address,address,bytes)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MotionCancelled"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MotionCancelled(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MotionCreated"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MotionCreated(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MotionExecuted"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MotionExecuted(address,uint256,bool)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MultisigRoleSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"MultisigRoleSet(address,address,uint256,uint256,bool)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentAdded"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentAdded(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentFinalized"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentFinalized(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentPayoutSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentPayoutSet(address,uint256,address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentRecipientSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentRecipientSet(address,uint256,address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentSkillSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentSkillSet(address,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PayoutClaimed(address,uint256,address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PayoutClaimed(address,uint256,uint256,address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"RejectionChanged"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"RejectionChanged(address,uint256,uint8,bool)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"RewardPayoutClaimed"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"RewardPayoutClaimed(uint256,address,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"RewardPayoutCycleEnded"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"RewardPayoutCycleEnded(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"RewardPayoutCycleStarted"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"RewardPayoutCycleStarted(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskAdded"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskAdded(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskBriefSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskBriefSet(uint256,bytes32)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskCanceled"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskCanceled(uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskChangedViaSignatures"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskChangedViaSignatures(address[])"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskCompleted"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskCompleted(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskDeliverableSubmitted"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskDeliverableSubmitted(address,uint256,bytes32)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskDueDateSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskDueDateSet(uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskFinalized"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskFinalized(address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskPayoutSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskPayoutSet(uint256,uint8,address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskRoleUserSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskRoleUserSet(uint256,uint8,address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskSkillSet"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskSkillSet(uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskWorkRatingRevealed"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TaskWorkRatingRevealed(address,uint256,uint8,uint8)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TokenUnlocked"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TokenUnlocked(address)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TokensBurned"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TokensBurned(address,address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TokensMinted"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"TokensMinted(address,address,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +___ + +### getEventTopic + +▸ **getEventTopic**(`eventFragment`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventFragment` | `string` \| `EventFragment` | + +#### Returns + +`string` + +#### Inherited from + +utils.Interface.getEventTopic + +___ + +### getFunction + +▸ **getFunction**(`nameOrSignatureOrSighash`): `FunctionFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrSighash` | `string` | + +#### Returns + +`FunctionFragment` + +#### Inherited from + +utils.Interface.getFunction + +___ + +### getSighash + +▸ **getSighash**(`fragment`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fragment` | `string` \| `FunctionFragment` \| `ErrorFragment` | + +#### Returns + +`string` + +#### Inherited from + +utils.Interface.getSighash + +___ + +### parseError + +▸ **parseError**(`data`): `ErrorDescription` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `BytesLike` | + +#### Returns + +`ErrorDescription` + +#### Inherited from + +utils.Interface.parseError + +___ + +### parseLog + +▸ **parseLog**(`log`): `LogDescription` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `log` | `Object` | +| `log.data` | `string` | +| `log.topics` | `string`[] | + +#### Returns + +`LogDescription` + +#### Inherited from + +utils.Interface.parseLog + +___ + +### parseTransaction + +▸ **parseTransaction**(`tx`): `TransactionDescription` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | `Object` | +| `tx.data` | `string` | +| `tx.value?` | `BigNumberish` | + +#### Returns + +`TransactionDescription` + +#### Inherited from + +utils.Interface.parseTransaction diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigRoleSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigRoleSetEventObject.md new file mode 100644 index 000000000..52b87262a --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.MultisigRoleSetEventObject.md @@ -0,0 +1,33 @@ +# Interface: MultisigRoleSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).MultisigRoleSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### domainId + +• **domainId**: `BigNumber` + +___ + +### roleId + +• **roleId**: `BigNumber` + +___ + +### setTo + +• **setTo**: `boolean` + +___ + +### user + +• **user**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentAddedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentAddedEventObject.md new file mode 100644 index 000000000..6268d4c07 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentAddedEventObject.md @@ -0,0 +1,15 @@ +# Interface: PaymentAddedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).PaymentAddedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### paymentId + +• **paymentId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentFinalizedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentFinalizedEventObject.md new file mode 100644 index 000000000..1b7808fe4 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentFinalizedEventObject.md @@ -0,0 +1,15 @@ +# Interface: PaymentFinalizedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).PaymentFinalizedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### paymentId + +• **paymentId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentPayoutSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentPayoutSetEventObject.md new file mode 100644 index 000000000..848804f72 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentPayoutSetEventObject.md @@ -0,0 +1,27 @@ +# Interface: PaymentPayoutSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).PaymentPayoutSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### paymentId + +• **paymentId**: `BigNumber` + +___ + +### token + +• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentRecipientSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentRecipientSetEventObject.md new file mode 100644 index 000000000..08757cf1f --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentRecipientSetEventObject.md @@ -0,0 +1,21 @@ +# Interface: PaymentRecipientSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).PaymentRecipientSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### paymentId + +• **paymentId**: `BigNumber` + +___ + +### recipient + +• **recipient**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentSkillSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentSkillSetEventObject.md new file mode 100644 index 000000000..4fd325a1e --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PaymentSkillSetEventObject.md @@ -0,0 +1,21 @@ +# Interface: PaymentSkillSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).PaymentSkillSetEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### paymentId + +• **paymentId**: `BigNumber` + +___ + +### skillId + +• **skillId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_address_uint256_EventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_address_uint256_EventObject.md new file mode 100644 index 000000000..4194cbb4a --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_address_uint256_EventObject.md @@ -0,0 +1,27 @@ +# Interface: PayoutClaimed\_address\_uint256\_address\_uint256\_EventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).PayoutClaimed_address_uint256_address_uint256_EventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### fundingPotId + +• **fundingPotId**: `BigNumber` + +___ + +### token + +• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_uint256_address_uint256_EventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_uint256_address_uint256_EventObject.md new file mode 100644 index 000000000..5047d5f27 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_uint256_address_uint256_EventObject.md @@ -0,0 +1,33 @@ +# Interface: PayoutClaimed\_address\_uint256\_uint256\_address\_uint256\_EventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).PayoutClaimed_address_uint256_uint256_address_uint256_EventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### id + +• **id**: `BigNumber` + +___ + +### slot + +• **slot**: `BigNumber` + +___ + +### token + +• **token**: `string` + +___ + +### tokenPayout + +• **tokenPayout**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RejectionChangedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RejectionChangedEventObject.md new file mode 100644 index 000000000..cfe14486b --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RejectionChangedEventObject.md @@ -0,0 +1,27 @@ +# Interface: RejectionChangedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).RejectionChangedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### approval + +• **approval**: `boolean` + +___ + +### motionId + +• **motionId**: `BigNumber` + +___ + +### role + +• **role**: `number` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutClaimedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutClaimedEventObject.md new file mode 100644 index 000000000..b08af3d37 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutClaimedEventObject.md @@ -0,0 +1,27 @@ +# Interface: RewardPayoutClaimedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).RewardPayoutClaimedEventObject + +## Properties + +### fee + +• **fee**: `BigNumber` + +___ + +### rewardPayoutId + +• **rewardPayoutId**: `BigNumber` + +___ + +### rewardRemainder + +• **rewardRemainder**: `BigNumber` + +___ + +### user + +• **user**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutCycleEndedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutCycleEndedEventObject.md new file mode 100644 index 000000000..0eb60607d --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutCycleEndedEventObject.md @@ -0,0 +1,15 @@ +# Interface: RewardPayoutCycleEndedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).RewardPayoutCycleEndedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### rewardPayoutId + +• **rewardPayoutId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutCycleStartedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutCycleStartedEventObject.md new file mode 100644 index 000000000..4ba3d42b2 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.RewardPayoutCycleStartedEventObject.md @@ -0,0 +1,15 @@ +# Interface: RewardPayoutCycleStartedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).RewardPayoutCycleStartedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### rewardPayoutId + +• **rewardPayoutId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskAddedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskAddedEventObject.md new file mode 100644 index 000000000..36b9ee873 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskAddedEventObject.md @@ -0,0 +1,15 @@ +# Interface: TaskAddedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskAddedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskBriefSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskBriefSetEventObject.md new file mode 100644 index 000000000..9eba1f8ed --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskBriefSetEventObject.md @@ -0,0 +1,15 @@ +# Interface: TaskBriefSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskBriefSetEventObject + +## Properties + +### specificationHash + +• **specificationHash**: `string` + +___ + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskCanceledEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskCanceledEventObject.md new file mode 100644 index 000000000..dd2e3ea22 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskCanceledEventObject.md @@ -0,0 +1,9 @@ +# Interface: TaskCanceledEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskCanceledEventObject + +## Properties + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskChangedViaSignaturesEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskChangedViaSignaturesEventObject.md new file mode 100644 index 000000000..ff9fe91c9 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskChangedViaSignaturesEventObject.md @@ -0,0 +1,9 @@ +# Interface: TaskChangedViaSignaturesEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskChangedViaSignaturesEventObject + +## Properties + +### reviewerAddresses + +• **reviewerAddresses**: `string`[] diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskCompletedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskCompletedEventObject.md new file mode 100644 index 000000000..0f3774213 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskCompletedEventObject.md @@ -0,0 +1,15 @@ +# Interface: TaskCompletedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskCompletedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskDeliverableSubmittedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskDeliverableSubmittedEventObject.md new file mode 100644 index 000000000..5ddfc35db --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskDeliverableSubmittedEventObject.md @@ -0,0 +1,21 @@ +# Interface: TaskDeliverableSubmittedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskDeliverableSubmittedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### deliverableHash + +• **deliverableHash**: `string` + +___ + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskDueDateSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskDueDateSetEventObject.md new file mode 100644 index 000000000..479cb9fcc --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskDueDateSetEventObject.md @@ -0,0 +1,15 @@ +# Interface: TaskDueDateSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskDueDateSetEventObject + +## Properties + +### dueDate + +• **dueDate**: `BigNumber` + +___ + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskFinalizedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskFinalizedEventObject.md new file mode 100644 index 000000000..cb5566427 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskFinalizedEventObject.md @@ -0,0 +1,15 @@ +# Interface: TaskFinalizedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskFinalizedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskPayoutSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskPayoutSetEventObject.md new file mode 100644 index 000000000..a2aa2b6bd --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskPayoutSetEventObject.md @@ -0,0 +1,27 @@ +# Interface: TaskPayoutSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskPayoutSetEventObject + +## Properties + +### amount + +• **amount**: `BigNumber` + +___ + +### role + +• **role**: `number` + +___ + +### taskId + +• **taskId**: `BigNumber` + +___ + +### token + +• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskRoleUserSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskRoleUserSetEventObject.md new file mode 100644 index 000000000..d5a10f3e5 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskRoleUserSetEventObject.md @@ -0,0 +1,21 @@ +# Interface: TaskRoleUserSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskRoleUserSetEventObject + +## Properties + +### role + +• **role**: `number` + +___ + +### taskId + +• **taskId**: `BigNumber` + +___ + +### user + +• **user**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskSkillSetEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskSkillSetEventObject.md new file mode 100644 index 000000000..bd8f5666d --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskSkillSetEventObject.md @@ -0,0 +1,15 @@ +# Interface: TaskSkillSetEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskSkillSetEventObject + +## Properties + +### skillId + +• **skillId**: `BigNumber` + +___ + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskWorkRatingRevealedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskWorkRatingRevealedEventObject.md new file mode 100644 index 000000000..cd3de385e --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TaskWorkRatingRevealedEventObject.md @@ -0,0 +1,27 @@ +# Interface: TaskWorkRatingRevealedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TaskWorkRatingRevealedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### rating + +• **rating**: `number` + +___ + +### role + +• **role**: `number` + +___ + +### taskId + +• **taskId**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokenUnlockedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokenUnlockedEventObject.md new file mode 100644 index 000000000..f45b30bef --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokenUnlockedEventObject.md @@ -0,0 +1,9 @@ +# Interface: TokenUnlockedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TokenUnlockedEventObject + +## Properties + +### agent + +• **agent**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokensBurnedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokensBurnedEventObject.md new file mode 100644 index 000000000..e593aabd0 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokensBurnedEventObject.md @@ -0,0 +1,21 @@ +# Interface: TokensBurnedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TokensBurnedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### token + +• **token**: `string` diff --git a/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokensMintedEventObject.md b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokensMintedEventObject.md new file mode 100644 index 000000000..72ea42927 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/MultisigPermissionsEvents.TokensMintedEventObject.md @@ -0,0 +1,21 @@ +# Interface: TokensMintedEventObject + +[MultisigPermissionsEvents](../modules/MultisigPermissionsEvents.md).TokensMintedEventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### who + +• **who**: `string` diff --git a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_address_uint256_bool_EventObject.md b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_address_uint256_bool_EventObject.md new file mode 100644 index 000000000..75ce712d5 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_address_uint256_bool_EventObject.md @@ -0,0 +1,21 @@ +# Interface: ExpenditureMadeStaged\_address\_uint256\_bool\_EventObject + +[StagedExpenditureEvents](../modules/StagedExpenditureEvents.md).ExpenditureMadeStaged_address_uint256_bool_EventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### staged + +• **staged**: `boolean` diff --git a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStagedEventObject.md b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_uint256_bool_EventObject.md similarity index 61% rename from packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStagedEventObject.md rename to packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_uint256_bool_EventObject.md index a903d3080..2837ddacd 100644 --- a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStagedEventObject.md +++ b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_uint256_bool_EventObject.md @@ -1,6 +1,6 @@ -# Interface: ExpenditureMadeStagedEventObject +# Interface: ExpenditureMadeStaged\_uint256\_bool\_EventObject -[StagedExpenditureEvents](../modules/StagedExpenditureEvents.md).ExpenditureMadeStagedEventObject +[StagedExpenditureEvents](../modules/StagedExpenditureEvents.md).ExpenditureMadeStaged_uint256_bool_EventObject ## Properties diff --git a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedExpenditureEvents.md b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedExpenditureEvents.md index 28b4bbb96..79da2f3dc 100644 --- a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedExpenditureEvents.md +++ b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedExpenditureEvents.md @@ -138,8 +138,8 @@ ___ | `ExpenditureGlobalClaimDelaySet(address,uint256)` | (`agent?`: ``null``, `globalClaimDelay?`: ``null``) => [`ExpenditureGlobalClaimDelaySetEventFilter`](../modules/StagedExpenditureEvents.md#expenditureglobalclaimdelayseteventfilter) | | `ExpenditureLocked` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => [`ExpenditureLockedEventFilter`](../modules/StagedExpenditureEvents.md#expenditurelockedeventfilter) | | `ExpenditureLocked(address,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`) => [`ExpenditureLockedEventFilter`](../modules/StagedExpenditureEvents.md#expenditurelockedeventfilter) | -| `ExpenditureMadeStaged` | (`expenditureId?`: ``null`` \| `BigNumberish`, `staged?`: ``null``) => [`ExpenditureMadeStagedEventFilter`](../modules/StagedExpenditureEvents.md#expendituremadestagedeventfilter) | -| `ExpenditureMadeStaged(uint256,bool)` | (`expenditureId?`: ``null`` \| `BigNumberish`, `staged?`: ``null``) => [`ExpenditureMadeStagedEventFilter`](../modules/StagedExpenditureEvents.md#expendituremadestagedeventfilter) | +| `ExpenditureMadeStaged(address,uint256,bool)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `staged?`: ``null``) => [`ExpenditureMadeStaged_address_uint256_bool_EventFilter`](../modules/StagedExpenditureEvents.md#expendituremadestaged_address_uint256_bool_eventfilter) | +| `ExpenditureMadeStaged(uint256,bool)` | (`expenditureId?`: ``null`` \| `BigNumberish`, `staged?`: ``null``) => [`ExpenditureMadeStaged_uint256_bool_EventFilter`](../modules/StagedExpenditureEvents.md#expendituremadestaged_uint256_bool_eventfilter) | | `ExpenditureMetadataSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => [`ExpenditureMetadataSetEventFilter`](../modules/StagedExpenditureEvents.md#expendituremetadataseteventfilter) | | `ExpenditureMetadataSet(address,uint256,string)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `metadata?`: ``null``) => [`ExpenditureMetadataSetEventFilter`](../modules/StagedExpenditureEvents.md#expendituremetadataseteventfilter) | | `ExpenditurePayoutModifierSet` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null`` \| `BigNumberish`, `payoutModifier?`: ``null``) => [`ExpenditurePayoutModifierSetEventFilter`](../modules/StagedExpenditureEvents.md#expenditurepayoutmodifierseteventfilter) | @@ -186,8 +186,8 @@ ___ | `RewardPayoutCycleEnded(address,uint256)` | (`agent?`: ``null``, `rewardPayoutId?`: ``null``) => [`RewardPayoutCycleEndedEventFilter`](../modules/StagedExpenditureEvents.md#rewardpayoutcycleendedeventfilter) | | `RewardPayoutCycleStarted` | (`agent?`: ``null``, `rewardPayoutId?`: ``null``) => [`RewardPayoutCycleStartedEventFilter`](../modules/StagedExpenditureEvents.md#rewardpayoutcyclestartedeventfilter) | | `RewardPayoutCycleStarted(address,uint256)` | (`agent?`: ``null``, `rewardPayoutId?`: ``null``) => [`RewardPayoutCycleStartedEventFilter`](../modules/StagedExpenditureEvents.md#rewardpayoutcyclestartedeventfilter) | -| `StagedPaymentReleased` | (`expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null``) => [`StagedPaymentReleasedEventFilter`](../modules/StagedExpenditureEvents.md#stagedpaymentreleasedeventfilter) | -| `StagedPaymentReleased(uint256,uint256)` | (`expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null``) => [`StagedPaymentReleasedEventFilter`](../modules/StagedExpenditureEvents.md#stagedpaymentreleasedeventfilter) | +| `StagedPaymentReleased(address,uint256,uint256)` | (`agent?`: ``null``, `expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null``) => [`StagedPaymentReleased_address_uint256_uint256_EventFilter`](../modules/StagedExpenditureEvents.md#stagedpaymentreleased_address_uint256_uint256_eventfilter) | +| `StagedPaymentReleased(uint256,uint256)` | (`expenditureId?`: ``null`` \| `BigNumberish`, `slot?`: ``null``) => [`StagedPaymentReleased_uint256_uint256_EventFilter`](../modules/StagedExpenditureEvents.md#stagedpaymentreleased_uint256_uint256_eventfilter) | | `TaskAdded` | (`agent?`: ``null``, `taskId?`: ``null``) => [`TaskAddedEventFilter`](../modules/StagedExpenditureEvents.md#taskaddedeventfilter) | | `TaskAdded(address,uint256)` | (`agent?`: ``null``, `taskId?`: ``null``) => [`TaskAddedEventFilter`](../modules/StagedExpenditureEvents.md#taskaddedeventfilter) | | `TaskBriefSet` | (`taskId?`: ``null`` \| `BigNumberish`, `specificationHash?`: ``null``) => [`TaskBriefSetEventFilter`](../modules/StagedExpenditureEvents.md#taskbriefseteventfilter) | diff --git a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedExpenditureEventsInterface.md b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedExpenditureEventsInterface.md index ce3a7004c..d1d6cf7ca 100644 --- a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedExpenditureEventsInterface.md +++ b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedExpenditureEventsInterface.md @@ -83,6 +83,7 @@ ___ | `ExpenditureFinalized(address,uint256)` | `EventFragment` | | `ExpenditureGlobalClaimDelaySet(address,uint256)` | `EventFragment` | | `ExpenditureLocked(address,uint256)` | `EventFragment` | +| `ExpenditureMadeStaged(address,uint256,bool)` | `EventFragment` | | `ExpenditureMadeStaged(uint256,bool)` | `EventFragment` | | `ExpenditureMetadataSet(address,uint256,string)` | `EventFragment` | | `ExpenditurePayoutModifierSet(address,uint256,uint256,int256)` | `EventFragment` | @@ -108,6 +109,7 @@ ___ | `RewardPayoutClaimed(uint256,address,uint256,uint256)` | `EventFragment` | | `RewardPayoutCycleEnded(address,uint256)` | `EventFragment` | | `RewardPayoutCycleStarted(address,uint256)` | `EventFragment` | +| `StagedPaymentReleased(address,uint256,uint256)` | `EventFragment` | | `StagedPaymentReleased(uint256,uint256)` | `EventFragment` | | `TaskAdded(address,uint256)` | `EventFragment` | | `TaskBriefSet(uint256,bytes32)` | `EventFragment` | @@ -1142,7 +1144,7 @@ utils.Interface.getEvent | Name | Type | | :------ | :------ | -| `nameOrSignatureOrTopic` | ``"ExpenditureMadeStaged"`` | +| `nameOrSignatureOrTopic` | ``"ExpenditureMadeStaged(uint256,bool)"`` | #### Returns @@ -1158,7 +1160,7 @@ utils.Interface.getEvent | Name | Type | | :------ | :------ | -| `nameOrSignatureOrTopic` | ``"ExpenditureMadeStaged(uint256,bool)"`` | +| `nameOrSignatureOrTopic` | ``"ExpenditureMadeStaged(address,uint256,bool)"`` | #### Returns @@ -1910,7 +1912,7 @@ utils.Interface.getEvent | Name | Type | | :------ | :------ | -| `nameOrSignatureOrTopic` | ``"StagedPaymentReleased"`` | +| `nameOrSignatureOrTopic` | ``"StagedPaymentReleased(uint256,uint256)"`` | #### Returns @@ -1926,7 +1928,7 @@ utils.Interface.getEvent | Name | Type | | :------ | :------ | -| `nameOrSignatureOrTopic` | ``"StagedPaymentReleased(uint256,uint256)"`` | +| `nameOrSignatureOrTopic` | ``"StagedPaymentReleased(address,uint256,uint256)"`` | #### Returns diff --git a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleased_address_uint256_uint256_EventObject.md b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleased_address_uint256_uint256_EventObject.md new file mode 100644 index 000000000..ab95d17ea --- /dev/null +++ b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleased_address_uint256_uint256_EventObject.md @@ -0,0 +1,21 @@ +# Interface: StagedPaymentReleased\_address\_uint256\_uint256\_EventObject + +[StagedExpenditureEvents](../modules/StagedExpenditureEvents.md).StagedPaymentReleased_address_uint256_uint256_EventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### expenditureId + +• **expenditureId**: `BigNumber` + +___ + +### slot + +• **slot**: `BigNumber` diff --git a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleasedEventObject.md b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleased_uint256_uint256_EventObject.md similarity index 60% rename from packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleasedEventObject.md rename to packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleased_uint256_uint256_EventObject.md index 7f433ad9c..aaa3bf412 100644 --- a/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleasedEventObject.md +++ b/packages/sdk/docs/api/interfaces/StagedExpenditureEvents.StagedPaymentReleased_uint256_uint256_EventObject.md @@ -1,6 +1,6 @@ -# Interface: StagedPaymentReleasedEventObject +# Interface: StagedPaymentReleased\_uint256\_uint256\_EventObject -[StagedExpenditureEvents](../modules/StagedExpenditureEvents.md).StagedPaymentReleasedEventObject +[StagedExpenditureEvents](../modules/StagedExpenditureEvents.md).StagedPaymentReleased_uint256_uint256_EventObject ## Properties 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.PaymentTokenUpdated_address_uint256_uint256_uint256_EventObject.md b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_uint256_uint256_EventObject.md new file mode 100644 index 000000000..e68d73ea3 --- /dev/null +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_uint256_uint256_EventObject.md @@ -0,0 +1,27 @@ +# Interface: PaymentTokenUpdated\_address\_uint256\_uint256\_uint256\_EventObject + +[StreamingPaymentsEvents](../modules/StreamingPaymentsEvents.md).PaymentTokenUpdated_address_uint256_uint256_uint256_EventObject + +## Properties + +### agent + +• **agent**: `string` + +___ + +### amount + +• **amount**: `BigNumber` + +___ + +### interval + +• **interval**: `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..f64a2dd97 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,11 @@ ___ | `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) | +| `PaymentTokenUpdated(address,uint256,uint256,uint256)` | (`agent?`: ``null``, `streamingPaymentId?`: ``null`` \| `BigNumberish`, `amount?`: ``null``, `interval?`: ``null``) => [`PaymentTokenUpdated_address_uint256_uint256_uint256_EventFilter`](../modules/StreamingPaymentsEvents.md#paymenttokenupdated_address_uint256_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..cd976f132 100644 --- a/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md +++ b/packages/sdk/docs/api/interfaces/StreamingPaymentsEvents.StreamingPaymentsEventsInterface.md @@ -62,11 +62,16 @@ ___ | 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` | +| `PaymentTokenUpdated(address,uint256,uint256,uint256)` | `EventFragment` | +| `StartTimeSet(address,uint256,uint256)` | `EventFragment` | | `StreamingPaymentClaimed(address,uint256,address,uint256)` | `EventFragment` | | `StreamingPaymentCreated(address,uint256)` | `EventFragment` | @@ -543,7 +548,7 @@ utils.Interface.getEvent | Name | Type | | :------ | :------ | -| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated"`` | +| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated(address,uint256,address,uint256)"`` | #### Returns @@ -559,7 +564,23 @@ utils.Interface.getEvent | Name | Type | | :------ | :------ | -| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated(address,uint256,address,uint256)"`` | +| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated(address,uint256,uint256)"`` | + +#### Returns + +`EventFragment` + +#### Overrides + +utils.Interface.getEvent + +▸ **getEvent**(`nameOrSignatureOrTopic`): `EventFragment` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrTopic` | ``"PaymentTokenUpdated(address,uint256,uint256,uint256)"`` | #### Returns @@ -633,6 +654,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/MultisigPermissionsEvents.md b/packages/sdk/docs/api/modules/MultisigPermissionsEvents.md new file mode 100644 index 000000000..03ad6c956 --- /dev/null +++ b/packages/sdk/docs/api/modules/MultisigPermissionsEvents.md @@ -0,0 +1,890 @@ +# Namespace: MultisigPermissionsEvents + +## Interfaces + +- [AnnotationEventObject](../interfaces/MultisigPermissionsEvents.AnnotationEventObject.md) +- [ApprovalChangedEventObject](../interfaces/MultisigPermissionsEvents.ApprovalChangedEventObject.md) +- [ArbitraryReputationUpdateEventObject](../interfaces/MultisigPermissionsEvents.ArbitraryReputationUpdateEventObject.md) +- [ArbitraryTransactionEventObject](../interfaces/MultisigPermissionsEvents.ArbitraryTransactionEventObject.md) +- [ColonyBootstrappedEventObject](../interfaces/MultisigPermissionsEvents.ColonyBootstrappedEventObject.md) +- [ColonyFundsClaimedEventObject](../interfaces/MultisigPermissionsEvents.ColonyFundsClaimedEventObject.md) +- [ColonyFundsMovedBetweenFundingPotsEventObject](../interfaces/MultisigPermissionsEvents.ColonyFundsMovedBetweenFundingPotsEventObject.md) +- [ColonyInitialisedEventObject](../interfaces/MultisigPermissionsEvents.ColonyInitialisedEventObject.md) +- [ColonyMetadataDeltaEventObject](../interfaces/MultisigPermissionsEvents.ColonyMetadataDeltaEventObject.md) +- [ColonyMetadataEventObject](../interfaces/MultisigPermissionsEvents.ColonyMetadataEventObject.md) +- [ColonyRewardInverseSetEventObject](../interfaces/MultisigPermissionsEvents.ColonyRewardInverseSetEventObject.md) +- [ColonyRoleSetEventObject](../interfaces/MultisigPermissionsEvents.ColonyRoleSetEventObject.md) +- [ColonyUpgradedEventObject](../interfaces/MultisigPermissionsEvents.ColonyUpgradedEventObject.md) +- [DomainAddedEventObject](../interfaces/MultisigPermissionsEvents.DomainAddedEventObject.md) +- [DomainDeprecatedEventObject](../interfaces/MultisigPermissionsEvents.DomainDeprecatedEventObject.md) +- [DomainMetadataEventObject](../interfaces/MultisigPermissionsEvents.DomainMetadataEventObject.md) +- [DomainSkillThresholdSetEventObject](../interfaces/MultisigPermissionsEvents.DomainSkillThresholdSetEventObject.md) +- [ExpenditureAddedEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureAddedEventObject.md) +- [ExpenditureCancelledEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureCancelledEventObject.md) +- [ExpenditureClaimDelaySetEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureClaimDelaySetEventObject.md) +- [ExpenditureFinalizedEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureFinalizedEventObject.md) +- [ExpenditureGlobalClaimDelaySetEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureGlobalClaimDelaySetEventObject.md) +- [ExpenditureLockedEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureLockedEventObject.md) +- [ExpenditureMetadataSetEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureMetadataSetEventObject.md) +- [ExpenditurePayoutModifierSetEventObject](../interfaces/MultisigPermissionsEvents.ExpenditurePayoutModifierSetEventObject.md) +- [ExpenditurePayoutSetEventObject](../interfaces/MultisigPermissionsEvents.ExpenditurePayoutSetEventObject.md) +- [ExpenditureRecipientSetEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureRecipientSetEventObject.md) +- [ExpenditureSkillSetEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureSkillSetEventObject.md) +- [ExpenditureStateChangedEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureStateChangedEventObject.md) +- [ExpenditureTransferredEventObject](../interfaces/MultisigPermissionsEvents.ExpenditureTransferredEventObject.md) +- [ExtensionInitialisedEventObject](../interfaces/MultisigPermissionsEvents.ExtensionInitialisedEventObject.md) +- [FundingPotAddedEventObject](../interfaces/MultisigPermissionsEvents.FundingPotAddedEventObject.md) +- [GlobalThresholdSetEventObject](../interfaces/MultisigPermissionsEvents.GlobalThresholdSetEventObject.md) +- [LocalSkillAddedEventObject](../interfaces/MultisigPermissionsEvents.LocalSkillAddedEventObject.md) +- [LocalSkillDeprecatedEventObject](../interfaces/MultisigPermissionsEvents.LocalSkillDeprecatedEventObject.md) +- [LogSetAuthorityEventObject](../interfaces/MultisigPermissionsEvents.LogSetAuthorityEventObject.md) +- [LogSetOwnerEventObject](../interfaces/MultisigPermissionsEvents.LogSetOwnerEventObject.md) +- [MetaTransactionExecutedEventObject](../interfaces/MultisigPermissionsEvents.MetaTransactionExecutedEventObject.md) +- [MotionCancelledEventObject](../interfaces/MultisigPermissionsEvents.MotionCancelledEventObject.md) +- [MotionCreatedEventObject](../interfaces/MultisigPermissionsEvents.MotionCreatedEventObject.md) +- [MotionExecutedEventObject](../interfaces/MultisigPermissionsEvents.MotionExecutedEventObject.md) +- [MultisigPermissionsEvents](../interfaces/MultisigPermissionsEvents.MultisigPermissionsEvents.md) +- [MultisigPermissionsEventsInterface](../interfaces/MultisigPermissionsEvents.MultisigPermissionsEventsInterface.md) +- [MultisigRoleSetEventObject](../interfaces/MultisigPermissionsEvents.MultisigRoleSetEventObject.md) +- [PaymentAddedEventObject](../interfaces/MultisigPermissionsEvents.PaymentAddedEventObject.md) +- [PaymentFinalizedEventObject](../interfaces/MultisigPermissionsEvents.PaymentFinalizedEventObject.md) +- [PaymentPayoutSetEventObject](../interfaces/MultisigPermissionsEvents.PaymentPayoutSetEventObject.md) +- [PaymentRecipientSetEventObject](../interfaces/MultisigPermissionsEvents.PaymentRecipientSetEventObject.md) +- [PaymentSkillSetEventObject](../interfaces/MultisigPermissionsEvents.PaymentSkillSetEventObject.md) +- [PayoutClaimed\_address\_uint256\_address\_uint256\_EventObject](../interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_address_uint256_EventObject.md) +- [PayoutClaimed\_address\_uint256\_uint256\_address\_uint256\_EventObject](../interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_uint256_address_uint256_EventObject.md) +- [RejectionChangedEventObject](../interfaces/MultisigPermissionsEvents.RejectionChangedEventObject.md) +- [RewardPayoutClaimedEventObject](../interfaces/MultisigPermissionsEvents.RewardPayoutClaimedEventObject.md) +- [RewardPayoutCycleEndedEventObject](../interfaces/MultisigPermissionsEvents.RewardPayoutCycleEndedEventObject.md) +- [RewardPayoutCycleStartedEventObject](../interfaces/MultisigPermissionsEvents.RewardPayoutCycleStartedEventObject.md) +- [TaskAddedEventObject](../interfaces/MultisigPermissionsEvents.TaskAddedEventObject.md) +- [TaskBriefSetEventObject](../interfaces/MultisigPermissionsEvents.TaskBriefSetEventObject.md) +- [TaskCanceledEventObject](../interfaces/MultisigPermissionsEvents.TaskCanceledEventObject.md) +- [TaskChangedViaSignaturesEventObject](../interfaces/MultisigPermissionsEvents.TaskChangedViaSignaturesEventObject.md) +- [TaskCompletedEventObject](../interfaces/MultisigPermissionsEvents.TaskCompletedEventObject.md) +- [TaskDeliverableSubmittedEventObject](../interfaces/MultisigPermissionsEvents.TaskDeliverableSubmittedEventObject.md) +- [TaskDueDateSetEventObject](../interfaces/MultisigPermissionsEvents.TaskDueDateSetEventObject.md) +- [TaskFinalizedEventObject](../interfaces/MultisigPermissionsEvents.TaskFinalizedEventObject.md) +- [TaskPayoutSetEventObject](../interfaces/MultisigPermissionsEvents.TaskPayoutSetEventObject.md) +- [TaskRoleUserSetEventObject](../interfaces/MultisigPermissionsEvents.TaskRoleUserSetEventObject.md) +- [TaskSkillSetEventObject](../interfaces/MultisigPermissionsEvents.TaskSkillSetEventObject.md) +- [TaskWorkRatingRevealedEventObject](../interfaces/MultisigPermissionsEvents.TaskWorkRatingRevealedEventObject.md) +- [TokenUnlockedEventObject](../interfaces/MultisigPermissionsEvents.TokenUnlockedEventObject.md) +- [TokensBurnedEventObject](../interfaces/MultisigPermissionsEvents.TokensBurnedEventObject.md) +- [TokensMintedEventObject](../interfaces/MultisigPermissionsEvents.TokensMintedEventObject.md) + +## Type Aliases + +### AnnotationEvent + +Ƭ **AnnotationEvent**: `TypedEvent`<[`string`, `string`, `string`], [`AnnotationEventObject`](../interfaces/MultisigPermissionsEvents.AnnotationEventObject.md)\> + +___ + +### AnnotationEventFilter + +Ƭ **AnnotationEventFilter**: `TypedEventFilter`<[`AnnotationEvent`](MultisigPermissionsEvents.md#annotationevent)\> + +___ + +### ApprovalChangedEvent + +Ƭ **ApprovalChangedEvent**: `TypedEvent`<[`string`, `BigNumber`, `number`, `boolean`], [`ApprovalChangedEventObject`](../interfaces/MultisigPermissionsEvents.ApprovalChangedEventObject.md)\> + +___ + +### ApprovalChangedEventFilter + +Ƭ **ApprovalChangedEventFilter**: `TypedEventFilter`<[`ApprovalChangedEvent`](MultisigPermissionsEvents.md#approvalchangedevent)\> + +___ + +### ArbitraryReputationUpdateEvent + +Ƭ **ArbitraryReputationUpdateEvent**: `TypedEvent`<[`string`, `string`, `BigNumber`, `BigNumber`], [`ArbitraryReputationUpdateEventObject`](../interfaces/MultisigPermissionsEvents.ArbitraryReputationUpdateEventObject.md)\> + +___ + +### ArbitraryReputationUpdateEventFilter + +Ƭ **ArbitraryReputationUpdateEventFilter**: `TypedEventFilter`<[`ArbitraryReputationUpdateEvent`](MultisigPermissionsEvents.md#arbitraryreputationupdateevent)\> + +___ + +### ArbitraryTransactionEvent + +Ƭ **ArbitraryTransactionEvent**: `TypedEvent`<[`string`, `string`, `boolean`], [`ArbitraryTransactionEventObject`](../interfaces/MultisigPermissionsEvents.ArbitraryTransactionEventObject.md)\> + +___ + +### ArbitraryTransactionEventFilter + +Ƭ **ArbitraryTransactionEventFilter**: `TypedEventFilter`<[`ArbitraryTransactionEvent`](MultisigPermissionsEvents.md#arbitrarytransactionevent)\> + +___ + +### ColonyBootstrappedEvent + +Ƭ **ColonyBootstrappedEvent**: `TypedEvent`<[`string`, `string`[], `BigNumber`[]], [`ColonyBootstrappedEventObject`](../interfaces/MultisigPermissionsEvents.ColonyBootstrappedEventObject.md)\> + +___ + +### ColonyBootstrappedEventFilter + +Ƭ **ColonyBootstrappedEventFilter**: `TypedEventFilter`<[`ColonyBootstrappedEvent`](MultisigPermissionsEvents.md#colonybootstrappedevent)\> + +___ + +### ColonyFundsClaimedEvent + +Ƭ **ColonyFundsClaimedEvent**: `TypedEvent`<[`string`, `string`, `BigNumber`, `BigNumber`], [`ColonyFundsClaimedEventObject`](../interfaces/MultisigPermissionsEvents.ColonyFundsClaimedEventObject.md)\> + +___ + +### ColonyFundsClaimedEventFilter + +Ƭ **ColonyFundsClaimedEventFilter**: `TypedEventFilter`<[`ColonyFundsClaimedEvent`](MultisigPermissionsEvents.md#colonyfundsclaimedevent)\> + +___ + +### ColonyFundsMovedBetweenFundingPotsEvent + +Ƭ **ColonyFundsMovedBetweenFundingPotsEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `BigNumber`, `string`], [`ColonyFundsMovedBetweenFundingPotsEventObject`](../interfaces/MultisigPermissionsEvents.ColonyFundsMovedBetweenFundingPotsEventObject.md)\> + +___ + +### ColonyFundsMovedBetweenFundingPotsEventFilter + +Ƭ **ColonyFundsMovedBetweenFundingPotsEventFilter**: `TypedEventFilter`<[`ColonyFundsMovedBetweenFundingPotsEvent`](MultisigPermissionsEvents.md#colonyfundsmovedbetweenfundingpotsevent)\> + +___ + +### ColonyInitialisedEvent + +Ƭ **ColonyInitialisedEvent**: `TypedEvent`<[`string`, `string`, `string`], [`ColonyInitialisedEventObject`](../interfaces/MultisigPermissionsEvents.ColonyInitialisedEventObject.md)\> + +___ + +### ColonyInitialisedEventFilter + +Ƭ **ColonyInitialisedEventFilter**: `TypedEventFilter`<[`ColonyInitialisedEvent`](MultisigPermissionsEvents.md#colonyinitialisedevent)\> + +___ + +### ColonyMetadataDeltaEvent + +Ƭ **ColonyMetadataDeltaEvent**: `TypedEvent`<[`string`, `string`], [`ColonyMetadataDeltaEventObject`](../interfaces/MultisigPermissionsEvents.ColonyMetadataDeltaEventObject.md)\> + +___ + +### ColonyMetadataDeltaEventFilter + +Ƭ **ColonyMetadataDeltaEventFilter**: `TypedEventFilter`<[`ColonyMetadataDeltaEvent`](MultisigPermissionsEvents.md#colonymetadatadeltaevent)\> + +___ + +### ColonyMetadataEvent + +Ƭ **ColonyMetadataEvent**: `TypedEvent`<[`string`, `string`], [`ColonyMetadataEventObject`](../interfaces/MultisigPermissionsEvents.ColonyMetadataEventObject.md)\> + +___ + +### ColonyMetadataEventFilter + +Ƭ **ColonyMetadataEventFilter**: `TypedEventFilter`<[`ColonyMetadataEvent`](MultisigPermissionsEvents.md#colonymetadataevent)\> + +___ + +### ColonyRewardInverseSetEvent + +Ƭ **ColonyRewardInverseSetEvent**: `TypedEvent`<[`string`, `BigNumber`], [`ColonyRewardInverseSetEventObject`](../interfaces/MultisigPermissionsEvents.ColonyRewardInverseSetEventObject.md)\> + +___ + +### ColonyRewardInverseSetEventFilter + +Ƭ **ColonyRewardInverseSetEventFilter**: `TypedEventFilter`<[`ColonyRewardInverseSetEvent`](MultisigPermissionsEvents.md#colonyrewardinversesetevent)\> + +___ + +### ColonyRoleSetEvent + +Ƭ **ColonyRoleSetEvent**: `TypedEvent`<[`string`, `string`, `BigNumber`, `number`, `boolean`], [`ColonyRoleSetEventObject`](../interfaces/MultisigPermissionsEvents.ColonyRoleSetEventObject.md)\> + +___ + +### ColonyRoleSetEventFilter + +Ƭ **ColonyRoleSetEventFilter**: `TypedEventFilter`<[`ColonyRoleSetEvent`](MultisigPermissionsEvents.md#colonyrolesetevent)\> + +___ + +### ColonyUpgradedEvent + +Ƭ **ColonyUpgradedEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`], [`ColonyUpgradedEventObject`](../interfaces/MultisigPermissionsEvents.ColonyUpgradedEventObject.md)\> + +___ + +### ColonyUpgradedEventFilter + +Ƭ **ColonyUpgradedEventFilter**: `TypedEventFilter`<[`ColonyUpgradedEvent`](MultisigPermissionsEvents.md#colonyupgradedevent)\> + +___ + +### DomainAddedEvent + +Ƭ **DomainAddedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`DomainAddedEventObject`](../interfaces/MultisigPermissionsEvents.DomainAddedEventObject.md)\> + +___ + +### DomainAddedEventFilter + +Ƭ **DomainAddedEventFilter**: `TypedEventFilter`<[`DomainAddedEvent`](MultisigPermissionsEvents.md#domainaddedevent)\> + +___ + +### DomainDeprecatedEvent + +Ƭ **DomainDeprecatedEvent**: `TypedEvent`<[`string`, `BigNumber`, `boolean`], [`DomainDeprecatedEventObject`](../interfaces/MultisigPermissionsEvents.DomainDeprecatedEventObject.md)\> + +___ + +### DomainDeprecatedEventFilter + +Ƭ **DomainDeprecatedEventFilter**: `TypedEventFilter`<[`DomainDeprecatedEvent`](MultisigPermissionsEvents.md#domaindeprecatedevent)\> + +___ + +### DomainMetadataEvent + +Ƭ **DomainMetadataEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`], [`DomainMetadataEventObject`](../interfaces/MultisigPermissionsEvents.DomainMetadataEventObject.md)\> + +___ + +### DomainMetadataEventFilter + +Ƭ **DomainMetadataEventFilter**: `TypedEventFilter`<[`DomainMetadataEvent`](MultisigPermissionsEvents.md#domainmetadataevent)\> + +___ + +### DomainSkillThresholdSetEvent + +Ƭ **DomainSkillThresholdSetEvent**: `TypedEvent`<[`BigNumber`, `BigNumber`], [`DomainSkillThresholdSetEventObject`](../interfaces/MultisigPermissionsEvents.DomainSkillThresholdSetEventObject.md)\> + +___ + +### DomainSkillThresholdSetEventFilter + +Ƭ **DomainSkillThresholdSetEventFilter**: `TypedEventFilter`<[`DomainSkillThresholdSetEvent`](MultisigPermissionsEvents.md#domainskillthresholdsetevent)\> + +___ + +### ExpenditureAddedEvent + +Ƭ **ExpenditureAddedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`ExpenditureAddedEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureAddedEventObject.md)\> + +___ + +### ExpenditureAddedEventFilter + +Ƭ **ExpenditureAddedEventFilter**: `TypedEventFilter`<[`ExpenditureAddedEvent`](MultisigPermissionsEvents.md#expenditureaddedevent)\> + +___ + +### ExpenditureCancelledEvent + +Ƭ **ExpenditureCancelledEvent**: `TypedEvent`<[`string`, `BigNumber`], [`ExpenditureCancelledEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureCancelledEventObject.md)\> + +___ + +### ExpenditureCancelledEventFilter + +Ƭ **ExpenditureCancelledEventFilter**: `TypedEventFilter`<[`ExpenditureCancelledEvent`](MultisigPermissionsEvents.md#expenditurecancelledevent)\> + +___ + +### ExpenditureClaimDelaySetEvent + +Ƭ **ExpenditureClaimDelaySetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `BigNumber`], [`ExpenditureClaimDelaySetEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureClaimDelaySetEventObject.md)\> + +___ + +### ExpenditureClaimDelaySetEventFilter + +Ƭ **ExpenditureClaimDelaySetEventFilter**: `TypedEventFilter`<[`ExpenditureClaimDelaySetEvent`](MultisigPermissionsEvents.md#expenditureclaimdelaysetevent)\> + +___ + +### ExpenditureFinalizedEvent + +Ƭ **ExpenditureFinalizedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`ExpenditureFinalizedEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureFinalizedEventObject.md)\> + +___ + +### ExpenditureFinalizedEventFilter + +Ƭ **ExpenditureFinalizedEventFilter**: `TypedEventFilter`<[`ExpenditureFinalizedEvent`](MultisigPermissionsEvents.md#expenditurefinalizedevent)\> + +___ + +### ExpenditureGlobalClaimDelaySetEvent + +Ƭ **ExpenditureGlobalClaimDelaySetEvent**: `TypedEvent`<[`string`, `BigNumber`], [`ExpenditureGlobalClaimDelaySetEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureGlobalClaimDelaySetEventObject.md)\> + +___ + +### ExpenditureGlobalClaimDelaySetEventFilter + +Ƭ **ExpenditureGlobalClaimDelaySetEventFilter**: `TypedEventFilter`<[`ExpenditureGlobalClaimDelaySetEvent`](MultisigPermissionsEvents.md#expenditureglobalclaimdelaysetevent)\> + +___ + +### ExpenditureLockedEvent + +Ƭ **ExpenditureLockedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`ExpenditureLockedEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureLockedEventObject.md)\> + +___ + +### ExpenditureLockedEventFilter + +Ƭ **ExpenditureLockedEventFilter**: `TypedEventFilter`<[`ExpenditureLockedEvent`](MultisigPermissionsEvents.md#expenditurelockedevent)\> + +___ + +### ExpenditureMetadataSetEvent + +Ƭ **ExpenditureMetadataSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`], [`ExpenditureMetadataSetEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureMetadataSetEventObject.md)\> + +___ + +### ExpenditureMetadataSetEventFilter + +Ƭ **ExpenditureMetadataSetEventFilter**: `TypedEventFilter`<[`ExpenditureMetadataSetEvent`](MultisigPermissionsEvents.md#expendituremetadatasetevent)\> + +___ + +### ExpenditurePayoutModifierSetEvent + +Ƭ **ExpenditurePayoutModifierSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `BigNumber`], [`ExpenditurePayoutModifierSetEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditurePayoutModifierSetEventObject.md)\> + +___ + +### ExpenditurePayoutModifierSetEventFilter + +Ƭ **ExpenditurePayoutModifierSetEventFilter**: `TypedEventFilter`<[`ExpenditurePayoutModifierSetEvent`](MultisigPermissionsEvents.md#expenditurepayoutmodifiersetevent)\> + +___ + +### ExpenditurePayoutSetEvent + +Ƭ **ExpenditurePayoutSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `string`, `BigNumber`], [`ExpenditurePayoutSetEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditurePayoutSetEventObject.md)\> + +___ + +### ExpenditurePayoutSetEventFilter + +Ƭ **ExpenditurePayoutSetEventFilter**: `TypedEventFilter`<[`ExpenditurePayoutSetEvent`](MultisigPermissionsEvents.md#expenditurepayoutsetevent)\> + +___ + +### ExpenditureRecipientSetEvent + +Ƭ **ExpenditureRecipientSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `string`], [`ExpenditureRecipientSetEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureRecipientSetEventObject.md)\> + +___ + +### ExpenditureRecipientSetEventFilter + +Ƭ **ExpenditureRecipientSetEventFilter**: `TypedEventFilter`<[`ExpenditureRecipientSetEvent`](MultisigPermissionsEvents.md#expenditurerecipientsetevent)\> + +___ + +### ExpenditureSkillSetEvent + +Ƭ **ExpenditureSkillSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `BigNumber`], [`ExpenditureSkillSetEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureSkillSetEventObject.md)\> + +___ + +### ExpenditureSkillSetEventFilter + +Ƭ **ExpenditureSkillSetEventFilter**: `TypedEventFilter`<[`ExpenditureSkillSetEvent`](MultisigPermissionsEvents.md#expenditureskillsetevent)\> + +___ + +### ExpenditureStateChangedEvent + +Ƭ **ExpenditureStateChangedEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `boolean`[], `string`[], `string`], [`ExpenditureStateChangedEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureStateChangedEventObject.md)\> + +___ + +### ExpenditureStateChangedEventFilter + +Ƭ **ExpenditureStateChangedEventFilter**: `TypedEventFilter`<[`ExpenditureStateChangedEvent`](MultisigPermissionsEvents.md#expenditurestatechangedevent)\> + +___ + +### ExpenditureTransferredEvent + +Ƭ **ExpenditureTransferredEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`], [`ExpenditureTransferredEventObject`](../interfaces/MultisigPermissionsEvents.ExpenditureTransferredEventObject.md)\> + +___ + +### ExpenditureTransferredEventFilter + +Ƭ **ExpenditureTransferredEventFilter**: `TypedEventFilter`<[`ExpenditureTransferredEvent`](MultisigPermissionsEvents.md#expendituretransferredevent)\> + +___ + +### ExtensionInitialisedEvent + +Ƭ **ExtensionInitialisedEvent**: `TypedEvent`<[], [`ExtensionInitialisedEventObject`](../interfaces/MultisigPermissionsEvents.ExtensionInitialisedEventObject.md)\> + +___ + +### ExtensionInitialisedEventFilter + +Ƭ **ExtensionInitialisedEventFilter**: `TypedEventFilter`<[`ExtensionInitialisedEvent`](MultisigPermissionsEvents.md#extensioninitialisedevent)\> + +___ + +### FundingPotAddedEvent + +Ƭ **FundingPotAddedEvent**: `TypedEvent`<[`BigNumber`], [`FundingPotAddedEventObject`](../interfaces/MultisigPermissionsEvents.FundingPotAddedEventObject.md)\> + +___ + +### FundingPotAddedEventFilter + +Ƭ **FundingPotAddedEventFilter**: `TypedEventFilter`<[`FundingPotAddedEvent`](MultisigPermissionsEvents.md#fundingpotaddedevent)\> + +___ + +### GlobalThresholdSetEvent + +Ƭ **GlobalThresholdSetEvent**: `TypedEvent`<[`BigNumber`], [`GlobalThresholdSetEventObject`](../interfaces/MultisigPermissionsEvents.GlobalThresholdSetEventObject.md)\> + +___ + +### GlobalThresholdSetEventFilter + +Ƭ **GlobalThresholdSetEventFilter**: `TypedEventFilter`<[`GlobalThresholdSetEvent`](MultisigPermissionsEvents.md#globalthresholdsetevent)\> + +___ + +### LocalSkillAddedEvent + +Ƭ **LocalSkillAddedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`LocalSkillAddedEventObject`](../interfaces/MultisigPermissionsEvents.LocalSkillAddedEventObject.md)\> + +___ + +### LocalSkillAddedEventFilter + +Ƭ **LocalSkillAddedEventFilter**: `TypedEventFilter`<[`LocalSkillAddedEvent`](MultisigPermissionsEvents.md#localskilladdedevent)\> + +___ + +### LocalSkillDeprecatedEvent + +Ƭ **LocalSkillDeprecatedEvent**: `TypedEvent`<[`string`, `BigNumber`, `boolean`], [`LocalSkillDeprecatedEventObject`](../interfaces/MultisigPermissionsEvents.LocalSkillDeprecatedEventObject.md)\> + +___ + +### LocalSkillDeprecatedEventFilter + +Ƭ **LocalSkillDeprecatedEventFilter**: `TypedEventFilter`<[`LocalSkillDeprecatedEvent`](MultisigPermissionsEvents.md#localskilldeprecatedevent)\> + +___ + +### LogSetAuthorityEvent + +Ƭ **LogSetAuthorityEvent**: `TypedEvent`<[`string`], [`LogSetAuthorityEventObject`](../interfaces/MultisigPermissionsEvents.LogSetAuthorityEventObject.md)\> + +___ + +### LogSetAuthorityEventFilter + +Ƭ **LogSetAuthorityEventFilter**: `TypedEventFilter`<[`LogSetAuthorityEvent`](MultisigPermissionsEvents.md#logsetauthorityevent)\> + +___ + +### LogSetOwnerEvent + +Ƭ **LogSetOwnerEvent**: `TypedEvent`<[`string`], [`LogSetOwnerEventObject`](../interfaces/MultisigPermissionsEvents.LogSetOwnerEventObject.md)\> + +___ + +### LogSetOwnerEventFilter + +Ƭ **LogSetOwnerEventFilter**: `TypedEventFilter`<[`LogSetOwnerEvent`](MultisigPermissionsEvents.md#logsetownerevent)\> + +___ + +### MetaTransactionExecutedEvent + +Ƭ **MetaTransactionExecutedEvent**: `TypedEvent`<[`string`, `string`, `string`], [`MetaTransactionExecutedEventObject`](../interfaces/MultisigPermissionsEvents.MetaTransactionExecutedEventObject.md)\> + +___ + +### MetaTransactionExecutedEventFilter + +Ƭ **MetaTransactionExecutedEventFilter**: `TypedEventFilter`<[`MetaTransactionExecutedEvent`](MultisigPermissionsEvents.md#metatransactionexecutedevent)\> + +___ + +### MotionCancelledEvent + +Ƭ **MotionCancelledEvent**: `TypedEvent`<[`string`, `BigNumber`], [`MotionCancelledEventObject`](../interfaces/MultisigPermissionsEvents.MotionCancelledEventObject.md)\> + +___ + +### MotionCancelledEventFilter + +Ƭ **MotionCancelledEventFilter**: `TypedEventFilter`<[`MotionCancelledEvent`](MultisigPermissionsEvents.md#motioncancelledevent)\> + +___ + +### MotionCreatedEvent + +Ƭ **MotionCreatedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`MotionCreatedEventObject`](../interfaces/MultisigPermissionsEvents.MotionCreatedEventObject.md)\> + +___ + +### MotionCreatedEventFilter + +Ƭ **MotionCreatedEventFilter**: `TypedEventFilter`<[`MotionCreatedEvent`](MultisigPermissionsEvents.md#motioncreatedevent)\> + +___ + +### MotionExecutedEvent + +Ƭ **MotionExecutedEvent**: `TypedEvent`<[`string`, `BigNumber`, `boolean`], [`MotionExecutedEventObject`](../interfaces/MultisigPermissionsEvents.MotionExecutedEventObject.md)\> + +___ + +### MotionExecutedEventFilter + +Ƭ **MotionExecutedEventFilter**: `TypedEventFilter`<[`MotionExecutedEvent`](MultisigPermissionsEvents.md#motionexecutedevent)\> + +___ + +### MultisigRoleSetEvent + +Ƭ **MultisigRoleSetEvent**: `TypedEvent`<[`string`, `string`, `BigNumber`, `BigNumber`, `boolean`], [`MultisigRoleSetEventObject`](../interfaces/MultisigPermissionsEvents.MultisigRoleSetEventObject.md)\> + +___ + +### MultisigRoleSetEventFilter + +Ƭ **MultisigRoleSetEventFilter**: `TypedEventFilter`<[`MultisigRoleSetEvent`](MultisigPermissionsEvents.md#multisigrolesetevent)\> + +___ + +### PaymentAddedEvent + +Ƭ **PaymentAddedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`PaymentAddedEventObject`](../interfaces/MultisigPermissionsEvents.PaymentAddedEventObject.md)\> + +___ + +### PaymentAddedEventFilter + +Ƭ **PaymentAddedEventFilter**: `TypedEventFilter`<[`PaymentAddedEvent`](MultisigPermissionsEvents.md#paymentaddedevent)\> + +___ + +### PaymentFinalizedEvent + +Ƭ **PaymentFinalizedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`PaymentFinalizedEventObject`](../interfaces/MultisigPermissionsEvents.PaymentFinalizedEventObject.md)\> + +___ + +### PaymentFinalizedEventFilter + +Ƭ **PaymentFinalizedEventFilter**: `TypedEventFilter`<[`PaymentFinalizedEvent`](MultisigPermissionsEvents.md#paymentfinalizedevent)\> + +___ + +### PaymentPayoutSetEvent + +Ƭ **PaymentPayoutSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`, `BigNumber`], [`PaymentPayoutSetEventObject`](../interfaces/MultisigPermissionsEvents.PaymentPayoutSetEventObject.md)\> + +___ + +### PaymentPayoutSetEventFilter + +Ƭ **PaymentPayoutSetEventFilter**: `TypedEventFilter`<[`PaymentPayoutSetEvent`](MultisigPermissionsEvents.md#paymentpayoutsetevent)\> + +___ + +### PaymentRecipientSetEvent + +Ƭ **PaymentRecipientSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`], [`PaymentRecipientSetEventObject`](../interfaces/MultisigPermissionsEvents.PaymentRecipientSetEventObject.md)\> + +___ + +### PaymentRecipientSetEventFilter + +Ƭ **PaymentRecipientSetEventFilter**: `TypedEventFilter`<[`PaymentRecipientSetEvent`](MultisigPermissionsEvents.md#paymentrecipientsetevent)\> + +___ + +### PaymentSkillSetEvent + +Ƭ **PaymentSkillSetEvent**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`], [`PaymentSkillSetEventObject`](../interfaces/MultisigPermissionsEvents.PaymentSkillSetEventObject.md)\> + +___ + +### PaymentSkillSetEventFilter + +Ƭ **PaymentSkillSetEventFilter**: `TypedEventFilter`<[`PaymentSkillSetEvent`](MultisigPermissionsEvents.md#paymentskillsetevent)\> + +___ + +### PayoutClaimed\_address\_uint256\_address\_uint256\_Event + +Ƭ **PayoutClaimed\_address\_uint256\_address\_uint256\_Event**: `TypedEvent`<[`string`, `BigNumber`, `string`, `BigNumber`], [`PayoutClaimed_address_uint256_address_uint256_EventObject`](../interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_address_uint256_EventObject.md)\> + +___ + +### PayoutClaimed\_address\_uint256\_address\_uint256\_EventFilter + +Ƭ **PayoutClaimed\_address\_uint256\_address\_uint256\_EventFilter**: `TypedEventFilter`<[`PayoutClaimed_address_uint256_address_uint256_Event`](MultisigPermissionsEvents.md#payoutclaimed_address_uint256_address_uint256_event)\> + +___ + +### PayoutClaimed\_address\_uint256\_uint256\_address\_uint256\_Event + +Ƭ **PayoutClaimed\_address\_uint256\_uint256\_address\_uint256\_Event**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `string`, `BigNumber`], [`PayoutClaimed_address_uint256_uint256_address_uint256_EventObject`](../interfaces/MultisigPermissionsEvents.PayoutClaimed_address_uint256_uint256_address_uint256_EventObject.md)\> + +___ + +### PayoutClaimed\_address\_uint256\_uint256\_address\_uint256\_EventFilter + +Ƭ **PayoutClaimed\_address\_uint256\_uint256\_address\_uint256\_EventFilter**: `TypedEventFilter`<[`PayoutClaimed_address_uint256_uint256_address_uint256_Event`](MultisigPermissionsEvents.md#payoutclaimed_address_uint256_uint256_address_uint256_event)\> + +___ + +### RejectionChangedEvent + +Ƭ **RejectionChangedEvent**: `TypedEvent`<[`string`, `BigNumber`, `number`, `boolean`], [`RejectionChangedEventObject`](../interfaces/MultisigPermissionsEvents.RejectionChangedEventObject.md)\> + +___ + +### RejectionChangedEventFilter + +Ƭ **RejectionChangedEventFilter**: `TypedEventFilter`<[`RejectionChangedEvent`](MultisigPermissionsEvents.md#rejectionchangedevent)\> + +___ + +### RewardPayoutClaimedEvent + +Ƭ **RewardPayoutClaimedEvent**: `TypedEvent`<[`BigNumber`, `string`, `BigNumber`, `BigNumber`], [`RewardPayoutClaimedEventObject`](../interfaces/MultisigPermissionsEvents.RewardPayoutClaimedEventObject.md)\> + +___ + +### RewardPayoutClaimedEventFilter + +Ƭ **RewardPayoutClaimedEventFilter**: `TypedEventFilter`<[`RewardPayoutClaimedEvent`](MultisigPermissionsEvents.md#rewardpayoutclaimedevent)\> + +___ + +### RewardPayoutCycleEndedEvent + +Ƭ **RewardPayoutCycleEndedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`RewardPayoutCycleEndedEventObject`](../interfaces/MultisigPermissionsEvents.RewardPayoutCycleEndedEventObject.md)\> + +___ + +### RewardPayoutCycleEndedEventFilter + +Ƭ **RewardPayoutCycleEndedEventFilter**: `TypedEventFilter`<[`RewardPayoutCycleEndedEvent`](MultisigPermissionsEvents.md#rewardpayoutcycleendedevent)\> + +___ + +### RewardPayoutCycleStartedEvent + +Ƭ **RewardPayoutCycleStartedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`RewardPayoutCycleStartedEventObject`](../interfaces/MultisigPermissionsEvents.RewardPayoutCycleStartedEventObject.md)\> + +___ + +### RewardPayoutCycleStartedEventFilter + +Ƭ **RewardPayoutCycleStartedEventFilter**: `TypedEventFilter`<[`RewardPayoutCycleStartedEvent`](MultisigPermissionsEvents.md#rewardpayoutcyclestartedevent)\> + +___ + +### TaskAddedEvent + +Ƭ **TaskAddedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`TaskAddedEventObject`](../interfaces/MultisigPermissionsEvents.TaskAddedEventObject.md)\> + +___ + +### TaskAddedEventFilter + +Ƭ **TaskAddedEventFilter**: `TypedEventFilter`<[`TaskAddedEvent`](MultisigPermissionsEvents.md#taskaddedevent)\> + +___ + +### TaskBriefSetEvent + +Ƭ **TaskBriefSetEvent**: `TypedEvent`<[`BigNumber`, `string`], [`TaskBriefSetEventObject`](../interfaces/MultisigPermissionsEvents.TaskBriefSetEventObject.md)\> + +___ + +### TaskBriefSetEventFilter + +Ƭ **TaskBriefSetEventFilter**: `TypedEventFilter`<[`TaskBriefSetEvent`](MultisigPermissionsEvents.md#taskbriefsetevent)\> + +___ + +### TaskCanceledEvent + +Ƭ **TaskCanceledEvent**: `TypedEvent`<[`BigNumber`], [`TaskCanceledEventObject`](../interfaces/MultisigPermissionsEvents.TaskCanceledEventObject.md)\> + +___ + +### TaskCanceledEventFilter + +Ƭ **TaskCanceledEventFilter**: `TypedEventFilter`<[`TaskCanceledEvent`](MultisigPermissionsEvents.md#taskcanceledevent)\> + +___ + +### TaskChangedViaSignaturesEvent + +Ƭ **TaskChangedViaSignaturesEvent**: `TypedEvent`<[`string`[]], [`TaskChangedViaSignaturesEventObject`](../interfaces/MultisigPermissionsEvents.TaskChangedViaSignaturesEventObject.md)\> + +___ + +### TaskChangedViaSignaturesEventFilter + +Ƭ **TaskChangedViaSignaturesEventFilter**: `TypedEventFilter`<[`TaskChangedViaSignaturesEvent`](MultisigPermissionsEvents.md#taskchangedviasignaturesevent)\> + +___ + +### TaskCompletedEvent + +Ƭ **TaskCompletedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`TaskCompletedEventObject`](../interfaces/MultisigPermissionsEvents.TaskCompletedEventObject.md)\> + +___ + +### TaskCompletedEventFilter + +Ƭ **TaskCompletedEventFilter**: `TypedEventFilter`<[`TaskCompletedEvent`](MultisigPermissionsEvents.md#taskcompletedevent)\> + +___ + +### TaskDeliverableSubmittedEvent + +Ƭ **TaskDeliverableSubmittedEvent**: `TypedEvent`<[`string`, `BigNumber`, `string`], [`TaskDeliverableSubmittedEventObject`](../interfaces/MultisigPermissionsEvents.TaskDeliverableSubmittedEventObject.md)\> + +___ + +### TaskDeliverableSubmittedEventFilter + +Ƭ **TaskDeliverableSubmittedEventFilter**: `TypedEventFilter`<[`TaskDeliverableSubmittedEvent`](MultisigPermissionsEvents.md#taskdeliverablesubmittedevent)\> + +___ + +### TaskDueDateSetEvent + +Ƭ **TaskDueDateSetEvent**: `TypedEvent`<[`BigNumber`, `BigNumber`], [`TaskDueDateSetEventObject`](../interfaces/MultisigPermissionsEvents.TaskDueDateSetEventObject.md)\> + +___ + +### TaskDueDateSetEventFilter + +Ƭ **TaskDueDateSetEventFilter**: `TypedEventFilter`<[`TaskDueDateSetEvent`](MultisigPermissionsEvents.md#taskduedatesetevent)\> + +___ + +### TaskFinalizedEvent + +Ƭ **TaskFinalizedEvent**: `TypedEvent`<[`string`, `BigNumber`], [`TaskFinalizedEventObject`](../interfaces/MultisigPermissionsEvents.TaskFinalizedEventObject.md)\> + +___ + +### TaskFinalizedEventFilter + +Ƭ **TaskFinalizedEventFilter**: `TypedEventFilter`<[`TaskFinalizedEvent`](MultisigPermissionsEvents.md#taskfinalizedevent)\> + +___ + +### TaskPayoutSetEvent + +Ƭ **TaskPayoutSetEvent**: `TypedEvent`<[`BigNumber`, `number`, `string`, `BigNumber`], [`TaskPayoutSetEventObject`](../interfaces/MultisigPermissionsEvents.TaskPayoutSetEventObject.md)\> + +___ + +### TaskPayoutSetEventFilter + +Ƭ **TaskPayoutSetEventFilter**: `TypedEventFilter`<[`TaskPayoutSetEvent`](MultisigPermissionsEvents.md#taskpayoutsetevent)\> + +___ + +### TaskRoleUserSetEvent + +Ƭ **TaskRoleUserSetEvent**: `TypedEvent`<[`BigNumber`, `number`, `string`], [`TaskRoleUserSetEventObject`](../interfaces/MultisigPermissionsEvents.TaskRoleUserSetEventObject.md)\> + +___ + +### TaskRoleUserSetEventFilter + +Ƭ **TaskRoleUserSetEventFilter**: `TypedEventFilter`<[`TaskRoleUserSetEvent`](MultisigPermissionsEvents.md#taskroleusersetevent)\> + +___ + +### TaskSkillSetEvent + +Ƭ **TaskSkillSetEvent**: `TypedEvent`<[`BigNumber`, `BigNumber`], [`TaskSkillSetEventObject`](../interfaces/MultisigPermissionsEvents.TaskSkillSetEventObject.md)\> + +___ + +### TaskSkillSetEventFilter + +Ƭ **TaskSkillSetEventFilter**: `TypedEventFilter`<[`TaskSkillSetEvent`](MultisigPermissionsEvents.md#taskskillsetevent)\> + +___ + +### TaskWorkRatingRevealedEvent + +Ƭ **TaskWorkRatingRevealedEvent**: `TypedEvent`<[`string`, `BigNumber`, `number`, `number`], [`TaskWorkRatingRevealedEventObject`](../interfaces/MultisigPermissionsEvents.TaskWorkRatingRevealedEventObject.md)\> + +___ + +### TaskWorkRatingRevealedEventFilter + +Ƭ **TaskWorkRatingRevealedEventFilter**: `TypedEventFilter`<[`TaskWorkRatingRevealedEvent`](MultisigPermissionsEvents.md#taskworkratingrevealedevent)\> + +___ + +### TokenUnlockedEvent + +Ƭ **TokenUnlockedEvent**: `TypedEvent`<[`string`], [`TokenUnlockedEventObject`](../interfaces/MultisigPermissionsEvents.TokenUnlockedEventObject.md)\> + +___ + +### TokenUnlockedEventFilter + +Ƭ **TokenUnlockedEventFilter**: `TypedEventFilter`<[`TokenUnlockedEvent`](MultisigPermissionsEvents.md#tokenunlockedevent)\> + +___ + +### TokensBurnedEvent + +Ƭ **TokensBurnedEvent**: `TypedEvent`<[`string`, `string`, `BigNumber`], [`TokensBurnedEventObject`](../interfaces/MultisigPermissionsEvents.TokensBurnedEventObject.md)\> + +___ + +### TokensBurnedEventFilter + +Ƭ **TokensBurnedEventFilter**: `TypedEventFilter`<[`TokensBurnedEvent`](MultisigPermissionsEvents.md#tokensburnedevent)\> + +___ + +### TokensMintedEvent + +Ƭ **TokensMintedEvent**: `TypedEvent`<[`string`, `string`, `BigNumber`], [`TokensMintedEventObject`](../interfaces/MultisigPermissionsEvents.TokensMintedEventObject.md)\> + +___ + +### TokensMintedEventFilter + +Ƭ **TokensMintedEventFilter**: `TypedEventFilter`<[`TokensMintedEvent`](MultisigPermissionsEvents.md#tokensmintedevent)\> diff --git a/packages/sdk/docs/api/modules/StagedExpenditureEvents.md b/packages/sdk/docs/api/modules/StagedExpenditureEvents.md index 67a996587..d3144f354 100644 --- a/packages/sdk/docs/api/modules/StagedExpenditureEvents.md +++ b/packages/sdk/docs/api/modules/StagedExpenditureEvents.md @@ -23,7 +23,8 @@ - [ExpenditureFinalizedEventObject](../interfaces/StagedExpenditureEvents.ExpenditureFinalizedEventObject.md) - [ExpenditureGlobalClaimDelaySetEventObject](../interfaces/StagedExpenditureEvents.ExpenditureGlobalClaimDelaySetEventObject.md) - [ExpenditureLockedEventObject](../interfaces/StagedExpenditureEvents.ExpenditureLockedEventObject.md) -- [ExpenditureMadeStagedEventObject](../interfaces/StagedExpenditureEvents.ExpenditureMadeStagedEventObject.md) +- [ExpenditureMadeStaged\_address\_uint256\_bool\_EventObject](../interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_address_uint256_bool_EventObject.md) +- [ExpenditureMadeStaged\_uint256\_bool\_EventObject](../interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_uint256_bool_EventObject.md) - [ExpenditureMetadataSetEventObject](../interfaces/StagedExpenditureEvents.ExpenditureMetadataSetEventObject.md) - [ExpenditurePayoutModifierSetEventObject](../interfaces/StagedExpenditureEvents.ExpenditurePayoutModifierSetEventObject.md) - [ExpenditurePayoutSetEventObject](../interfaces/StagedExpenditureEvents.ExpenditurePayoutSetEventObject.md) @@ -50,7 +51,8 @@ - [RewardPayoutCycleStartedEventObject](../interfaces/StagedExpenditureEvents.RewardPayoutCycleStartedEventObject.md) - [StagedExpenditureEvents](../interfaces/StagedExpenditureEvents.StagedExpenditureEvents.md) - [StagedExpenditureEventsInterface](../interfaces/StagedExpenditureEvents.StagedExpenditureEventsInterface.md) -- [StagedPaymentReleasedEventObject](../interfaces/StagedExpenditureEvents.StagedPaymentReleasedEventObject.md) +- [StagedPaymentReleased\_address\_uint256\_uint256\_EventObject](../interfaces/StagedExpenditureEvents.StagedPaymentReleased_address_uint256_uint256_EventObject.md) +- [StagedPaymentReleased\_uint256\_uint256\_EventObject](../interfaces/StagedExpenditureEvents.StagedPaymentReleased_uint256_uint256_EventObject.md) - [TaskAddedEventObject](../interfaces/StagedExpenditureEvents.TaskAddedEventObject.md) - [TaskBriefSetEventObject](../interfaces/StagedExpenditureEvents.TaskBriefSetEventObject.md) - [TaskCanceledEventObject](../interfaces/StagedExpenditureEvents.TaskCanceledEventObject.md) @@ -321,15 +323,27 @@ ___ ___ -### ExpenditureMadeStagedEvent +### ExpenditureMadeStaged\_address\_uint256\_bool\_Event -Ƭ **ExpenditureMadeStagedEvent**: `TypedEvent`<[`BigNumber`, `boolean`], [`ExpenditureMadeStagedEventObject`](../interfaces/StagedExpenditureEvents.ExpenditureMadeStagedEventObject.md)\> +Ƭ **ExpenditureMadeStaged\_address\_uint256\_bool\_Event**: `TypedEvent`<[`string`, `BigNumber`, `boolean`], [`ExpenditureMadeStaged_address_uint256_bool_EventObject`](../interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_address_uint256_bool_EventObject.md)\> ___ -### ExpenditureMadeStagedEventFilter +### ExpenditureMadeStaged\_address\_uint256\_bool\_EventFilter -Ƭ **ExpenditureMadeStagedEventFilter**: `TypedEventFilter`<[`ExpenditureMadeStagedEvent`](StagedExpenditureEvents.md#expendituremadestagedevent)\> +Ƭ **ExpenditureMadeStaged\_address\_uint256\_bool\_EventFilter**: `TypedEventFilter`<[`ExpenditureMadeStaged_address_uint256_bool_Event`](StagedExpenditureEvents.md#expendituremadestaged_address_uint256_bool_event)\> + +___ + +### ExpenditureMadeStaged\_uint256\_bool\_Event + +Ƭ **ExpenditureMadeStaged\_uint256\_bool\_Event**: `TypedEvent`<[`BigNumber`, `boolean`], [`ExpenditureMadeStaged_uint256_bool_EventObject`](../interfaces/StagedExpenditureEvents.ExpenditureMadeStaged_uint256_bool_EventObject.md)\> + +___ + +### ExpenditureMadeStaged\_uint256\_bool\_EventFilter + +Ƭ **ExpenditureMadeStaged\_uint256\_bool\_EventFilter**: `TypedEventFilter`<[`ExpenditureMadeStaged_uint256_bool_Event`](StagedExpenditureEvents.md#expendituremadestaged_uint256_bool_event)\> ___ @@ -621,15 +635,27 @@ ___ ___ -### StagedPaymentReleasedEvent +### StagedPaymentReleased\_address\_uint256\_uint256\_Event + +Ƭ **StagedPaymentReleased\_address\_uint256\_uint256\_Event**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`], [`StagedPaymentReleased_address_uint256_uint256_EventObject`](../interfaces/StagedExpenditureEvents.StagedPaymentReleased_address_uint256_uint256_EventObject.md)\> + +___ + +### StagedPaymentReleased\_address\_uint256\_uint256\_EventFilter + +Ƭ **StagedPaymentReleased\_address\_uint256\_uint256\_EventFilter**: `TypedEventFilter`<[`StagedPaymentReleased_address_uint256_uint256_Event`](StagedExpenditureEvents.md#stagedpaymentreleased_address_uint256_uint256_event)\> + +___ + +### StagedPaymentReleased\_uint256\_uint256\_Event -Ƭ **StagedPaymentReleasedEvent**: `TypedEvent`<[`BigNumber`, `BigNumber`], [`StagedPaymentReleasedEventObject`](../interfaces/StagedExpenditureEvents.StagedPaymentReleasedEventObject.md)\> +Ƭ **StagedPaymentReleased\_uint256\_uint256\_Event**: `TypedEvent`<[`BigNumber`, `BigNumber`], [`StagedPaymentReleased_uint256_uint256_EventObject`](../interfaces/StagedExpenditureEvents.StagedPaymentReleased_uint256_uint256_EventObject.md)\> ___ -### StagedPaymentReleasedEventFilter +### StagedPaymentReleased\_uint256\_uint256\_EventFilter -Ƭ **StagedPaymentReleasedEventFilter**: `TypedEventFilter`<[`StagedPaymentReleasedEvent`](StagedExpenditureEvents.md#stagedpaymentreleasedevent)\> +Ƭ **StagedPaymentReleased\_uint256\_uint256\_EventFilter**: `TypedEventFilter`<[`StagedPaymentReleased_uint256_uint256_Event`](StagedExpenditureEvents.md#stagedpaymentreleased_uint256_uint256_event)\> ___ diff --git a/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md b/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md index ef05ff79a..7c260a6ca 100644 --- a/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md +++ b/packages/sdk/docs/api/modules/StreamingPaymentsEvents.md @@ -2,11 +2,16 @@ ## 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) +- [PaymentTokenUpdated\_address\_uint256\_uint256\_uint256\_EventObject](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_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 +19,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 +91,51 @@ ___ ___ -### 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)\> + +___ + +### PaymentTokenUpdated\_address\_uint256\_uint256\_uint256\_Event + +Ƭ **PaymentTokenUpdated\_address\_uint256\_uint256\_uint256\_Event**: `TypedEvent`<[`string`, `BigNumber`, `BigNumber`, `BigNumber`], [`PaymentTokenUpdated_address_uint256_uint256_uint256_EventObject`](../interfaces/StreamingPaymentsEvents.PaymentTokenUpdated_address_uint256_uint256_uint256_EventObject.md)\> + +___ + +### PaymentTokenUpdated\_address\_uint256\_uint256\_uint256\_EventFilter + +Ƭ **PaymentTokenUpdated\_address\_uint256\_uint256\_uint256\_EventFilter**: `TypedEventFilter`<[`PaymentTokenUpdated_address_uint256_uint256_uint256_Event`](StreamingPaymentsEvents.md#paymenttokenupdated_address_uint256_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)\> ___ diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 390116ec5..813edafbe 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -115,8 +115,8 @@ importers: packages/contractor: dependencies: '@colony/abis': - specifier: 1.3.0 - version: 1.3.0 + specifier: 1.5.0 + version: 1.5.0 '@typechain/ethers-v5': specifier: ^11.1.0 version: 11.1.0(@ethersproject/abi@5.7.0)(@ethersproject/providers@5.7.2)(typechain@8.3.0)(typescript@5.1.6) @@ -828,8 +828,8 @@ packages: prettier: 2.8.8 dev: false - /@colony/abis@1.3.0: - resolution: {integrity: sha512-+HgHHnIkCb37rbNhJxDsnmPNsFYRxYdniTyaofJTielZqlA9ogEJCGgCqon8C0jcgg6EGaOFCxRMW/s9TR0vJQ==} + /@colony/abis@1.5.0: + resolution: {integrity: sha512-j1gePuI/rog7IEsY2rNxqp1JI/ChDkTECh2id30kh0ubUApf3sfidDp08aFNQRSHILW1jPNvngtp7rSTV8zE5g==} engines: {node: ^16 || ^18 || ^20, npm: ^8 || ^9 || ^10} dev: false