feat: add support for imwss2

JoinColony · Sep 24, 2024 · 1645c03 · 1645c03
1 parent 44e4da4
commit 1645c03
Show file tree

Hide file tree

Showing 221 changed files with 21,159 additions and 26,458 deletions.
diff --git a/.changeset/lovely-phones-compare.md 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
@@ -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
@@ -0,0 +1,8 @@
+---
+"@colony/contractor": minor
+"@colony/colony-js": minor
+"@colony/events": minor
+"@colony/core": minor
+---
+
+Add support for colonyNetwork's imwss2 and [email protected]
diff --git 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
diff --git a/packages/colony-js/docs/api/classes/ColonyFactory.md b/packages/colony-js/docs/api/classes/ColonyFactory.md
diff --git a/packages/colony-js/docs/api/classes/ColonyTokenFactory.md b/packages/colony-js/docs/api/classes/ColonyTokenFactory.md
diff --git a/packages/colony-js/docs/api/classes/factories.TokenLocking__factory.md b/packages/colony-js/docs/api/classes/factories.TokenLocking__factory.md
diff --git 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
@@ -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
diff --git a/packages/colony-js/docs/api/interfaces/ColonyClientV11.md b/packages/colony-js/docs/api/interfaces/ColonyClientV11.md
diff --git 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
diff --git a/packages/colony-js/docs/api/interfaces/MultisigPermissionsClientV1.md b/packages/colony-js/docs/api/interfaces/MultisigPermissionsClientV1.md
diff --git a/...cs/api/interfaces/OneTxPaymentClientV2.md → ...cs/api/interfaces/OneTxPaymentClientV8.md b/...cs/api/interfaces/OneTxPaymentClientV2.md → ...cs/api/interfaces/OneTxPaymentClientV8.md
diff --git a/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV1.md b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV1.md
diff --git a/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV2.md b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV2.md
diff --git a/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV3.md b/packages/colony-js/docs/api/interfaces/StagedExpenditureClientV3.md
diff --git a/packages/colony-js/docs/api/interfaces/StakedExpenditureClientV6.md b/packages/colony-js/docs/api/interfaces/StakedExpenditureClientV6.md
diff --git a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV1.md b/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV1.md
diff --git a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV2.md b/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV2.md
diff --git a/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV3.md b/packages/colony-js/docs/api/interfaces/StreamingPaymentsClientV3.md
diff --git a/...i/interfaces/StreamingPaymentsClientV4.md → ...i/interfaces/StreamingPaymentsClientV5.md b/...i/interfaces/StreamingPaymentsClientV4.md → ...i/interfaces/StreamingPaymentsClientV5.md
diff --git 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
@@ -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