Merge pull request #534 from JoinColony/release/5.2

Add flwss2 and flwss3 abis and clients
JoinColony · Sep 21, 2022 · 9538f86 · 9538f86
2 parents c4c33fb + a498da7
commit 9538f86
Show file tree

Hide file tree

Showing 247 changed files with 182,378 additions and 188 deletions.
diff --git a/docs/guides/upgrading-the-colonynetwork-version.md b/docs/guides/upgrading-the-colonynetwork-version.md
@@ -23,21 +23,21 @@ cd vendor/colonyNetwork
 git checkout flwss
 ```
 
-Update all git submodules and install all dependencies (see also [this guide](https://colony.gitbook.io/colony-network/quick-start) and make sure you have [`yarn`](https://yarnpkg.com/) version `1.x` installed globally):
+Update all git submodules and install all dependencies (see also [this guide](https://colony.gitbook.io/colony-network/quick-start)):
 
 ```bash
 git submodule update --recursive
-yarn
+npm ci
 ```
 
 Prepare the token submodule (and delete any existing build artifacts):
 
 ```bash
 cd lib/colonyToken
-yarn # again, make sure you're running the correct node version (with nvm)
+npm ci # again, make sure you're running the correct node version (with nvm)
 rm -rf build/contracts/*.json # to remove any prior builds
 git reset --hard # to recover the pinned (checked in) contracts
-yarn truffle compile
+npx truffle compile
 ```
 
 You will need Docker installed and running to compile the contracts. It is however possible to disable Docker for the builds, see [here](https://colony.gitbook.io/colony-network/quick-start) for more information.
@@ -46,7 +46,7 @@ Then back in the `vendor/colonyNetwork` submodule:
 
 ```bash
 rm -rf build/contracts/*.json # to remove any prior builds
-yarn truffle compile
+npx truffle compile
 ```
 
 Now we should have all the necessary contract ABIs ready. Next we extract those using a helper script within ColonyJS. Execute the following script. For the tag name use the tag checked out in the `colonyNetwork` directory (here `flwss`):

diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md
@@ -2,7 +2,6 @@
 
 ## Namespaces
 
-- [ColonyDataTypes](modules/ColonyDataTypes.md)
 - [Tokens](modules/Tokens.md)
 
 ## Enumerations
@@ -49,6 +48,8 @@
 - [VotingReputationClientV2](interfaces/VotingReputationClientV2.md)
 - [VotingReputationClientV3](interfaces/VotingReputationClientV3.md)
 - [VotingReputationClientV4](interfaces/VotingReputationClientV4.md)
+- [VotingReputationClientV5](interfaces/VotingReputationClientV5.md)
+- [VotingReputationClientV6](interfaces/VotingReputationClientV6.md)
 - [WhitelistClientV1](interfaces/WhitelistClientV1.md)
 - [WhitelistClientV2](interfaces/WhitelistClientV2.md)
 
@@ -74,7 +75,7 @@ ___
 
 ### AnyVotingReputationClient
 
-Ƭ **AnyVotingReputationClient**: [`VotingReputationClientV1`](interfaces/VotingReputationClientV1.md) \| [`VotingReputationClientV2`](interfaces/VotingReputationClientV2.md) \| [`VotingReputationClientV3`](interfaces/VotingReputationClientV3.md) \| [`VotingReputationClientV4`](interfaces/VotingReputationClientV4.md)
+Ƭ **AnyVotingReputationClient**: [`VotingReputationClientV1`](interfaces/VotingReputationClientV1.md) \| [`VotingReputationClientV2`](interfaces/VotingReputationClientV2.md) \| [`VotingReputationClientV3`](interfaces/VotingReputationClientV3.md) \| [`VotingReputationClientV4`](interfaces/VotingReputationClientV4.md) \| [`VotingReputationClientV5`](interfaces/VotingReputationClientV5.md) \| [`VotingReputationClientV6`](interfaces/VotingReputationClientV6.md)
 
 ___
 
@@ -125,12 +126,6 @@ ___
 
 ___
 
-### Motion
-
-Ƭ **Motion**: `VotingReputation.MotionStructOutput`
-
-___
-
 ### SignerOrProvider
 
 Ƭ **SignerOrProvider**: `Signer` \| `Provider`

diff --git a/docs/reference/api/interfaces/ColonyClientV9.md b/docs/reference/api/interfaces/ColonyClientV9.md
@@ -1774,7 +1774,7 @@ ___
 
 ### getDomain
 
-▸ **getDomain**(`_id`, `overrides?`): `Promise`<[`DomainStructOutput`](../modules/ColonyDataTypes.md#domainstructoutput)\>
+▸ **getDomain**(`_id`, `overrides?`): `Promise`<`DomainStructOutput`\>
 
 Get a domain by id.
 
@@ -1787,7 +1787,7 @@ Get a domain by id.
 
 #### Returns
 
-`Promise`<[`DomainStructOutput`](../modules/ColonyDataTypes.md#domainstructoutput)\>
+`Promise`<`DomainStructOutput`\>
 
 #### Inherited from
 
@@ -1842,7 +1842,7 @@ ___
 
 ### getExpenditure
 
-▸ **getExpenditure**(`_id`, `overrides?`): `Promise`<[`ExpenditureStructOutput`](../modules/ColonyDataTypes.md#expenditurestructoutput)\>
+▸ **getExpenditure**(`_id`, `overrides?`): `Promise`<`ExpenditureStructOutput`\>
 
 Returns an existing expenditure.
 
@@ -1855,7 +1855,7 @@ Returns an existing expenditure.
 
 #### Returns
 
-`Promise`<[`ExpenditureStructOutput`](../modules/ColonyDataTypes.md#expenditurestructoutput)\>
+`Promise`<`ExpenditureStructOutput`\>
 
 #### Inherited from
 
@@ -1887,7 +1887,7 @@ ___
 
 ### getExpenditureSlot
 
-▸ **getExpenditureSlot**(`_id`, `_slot`, `overrides?`): `Promise`<[`ExpenditureSlotStructOutput`](../modules/ColonyDataTypes.md#expenditureslotstructoutput)\>
+▸ **getExpenditureSlot**(`_id`, `_slot`, `overrides?`): `Promise`<`ExpenditureSlotStructOutput`\>
 
 Returns an existing expenditure slot.
 
@@ -1901,7 +1901,7 @@ Returns an existing expenditure slot.
 
 #### Returns
 
-`Promise`<[`ExpenditureSlotStructOutput`](../modules/ColonyDataTypes.md#expenditureslotstructoutput)\>
+`Promise`<`ExpenditureSlotStructOutput`\>
 
 #### Inherited from
 
@@ -2156,7 +2156,7 @@ ___
 
 ### getPayment
 
-▸ **getPayment**(`_id`, `overrides?`): `Promise`<[`PaymentStructOutput`](../modules/ColonyDataTypes.md#paymentstructoutput)\>
+▸ **getPayment**(`_id`, `overrides?`): `Promise`<`PaymentStructOutput`\>
 
 Returns an exiting payment.
 
@@ -2169,7 +2169,7 @@ Returns an exiting payment.
 
 #### Returns
 
-`Promise`<[`PaymentStructOutput`](../modules/ColonyDataTypes.md#paymentstructoutput)\>
+`Promise`<`PaymentStructOutput`\>
 
 #### Inherited from
 
@@ -2308,7 +2308,7 @@ ___
 
 ### getRewardPayoutInfo
 
-▸ **getRewardPayoutInfo**(`_payoutId`, `overrides?`): `Promise`<[`RewardPayoutCycleStructOutput`](../modules/ColonyDataTypes.md#rewardpayoutcyclestructoutput)\>
+▸ **getRewardPayoutInfo**(`_payoutId`, `overrides?`): `Promise`<`RewardPayoutCycleStructOutput`\>
 
 Get useful information about specific reward payout.
 
@@ -2321,7 +2321,7 @@ Get useful information about specific reward payout.
 
 #### Returns
 
-`Promise`<[`RewardPayoutCycleStructOutput`](../modules/ColonyDataTypes.md#rewardpayoutcyclestructoutput)\>
+`Promise`<`RewardPayoutCycleStructOutput`\>
 
 #### Inherited from
 
@@ -2446,7 +2446,7 @@ ___
 
 ### getTaskRole
 
-▸ **getTaskRole**(`_id`, `_role`, `overrides?`): `Promise`<[`RoleStructOutput`](../modules/ColonyDataTypes.md#rolestructoutput)\>
+▸ **getTaskRole**(`_id`, `_role`, `overrides?`): `Promise`<`RoleStructOutput`\>
 
 Get the `Role` properties back for role `_role` in task `_id`.
 
@@ -2460,7 +2460,7 @@ Get the `Role` properties back for role `_role` in task `_id`.
 
 #### Returns
 
-`Promise`<[`RoleStructOutput`](../modules/ColonyDataTypes.md#rolestructoutput)\>
+`Promise`<`RoleStructOutput`\>
 
 #### Inherited from