Merge pull request #141 from JoinColony/refactor/txcreator

Use `TxCreator` in `VotingReputation`

docs/api/classes/Colony.md

@@ -420,6 +420,10 @@ Execute an arbitrary transaction in the name of the Colony
 
 This method can execute a transaction on any Ethereum Smart Contract with the Colony address as the sender. The action needs to be encoded function data (see https://docs.ethers.io/v5/api/utils/abi/interface/#Interface--encoding). We provide some common interfaces for you to make it even easier.
 
+**`Remarks`**
+
+This method can't be executed as a MetaTransaction
+
 **`Example`**
 
 Mint an NFT from a Colony

docs/api/classes/TxCreator.md

@@ -53,6 +53,7 @@ Learn more about these functions in their individual documentation
 | `__namedParameters.metadataType?` | `MD` |
 | `__namedParameters.method` | `M` |
 | `__namedParameters.permissionConfig?` | `PermissionConfig` |
+| `__namedParameters.txConfig?` | `TxConfig`<`MD`\> |
 
 ## Methods
 

docs/api/classes/VotingReputation.md

@@ -118,11 +118,15 @@ ___
 
 ### approveStake
 
-▸ **approveStake**(`amount`, `teamId?`): `Promise`<[{ `amount?`: `BigNumber` ; `approvedBy?`: `string` ; `token?`: `string` ; `user?`: `string`  }, `ContractReceipt`]\>
+▸ **approveStake**(`amount`, `teamId?`): [`TxCreator`](TxCreator.md)<`ColonyClientV10`, ``"approveStake"``, { `amount?`: `BigNumber` ; `approvedBy?`: `string` ; `token?`: `string` ; `user?`: `string`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
 Approve `amount` of the "activated" native tokens of a user for staking in a specific team
 After a token was "activated" (approved and deposited via the native token interface) it can be used for staking motions. To stake a motion, the token amount for staking has to be approved for the domain the motion was created in. See also the example in [VotingReputation.stakeMotion](VotingReputation.md#stakemotion)
 
+**`Remarks`**
+
+This method can't be executed as a motion
+
 #### Parameters
 
 | Name | Type | Default value | Description |
@@ -132,9 +136,9 @@ After a token was "activated" (approved and deposited via the native token inter
 
 #### Returns
 
-`Promise`<[{ `amount?`: `BigNumber` ; `approvedBy?`: `string` ; `token?`: `string` ; `user?`: `string`  }, `ContractReceipt`]\>
+[`TxCreator`](TxCreator.md)<`ColonyClientV10`, ``"approveStake"``, { `amount?`: `BigNumber` ; `approvedBy?`: `string` ; `token?`: `string` ; `user?`: `string`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
-A tupel of event data and contract receipt
+A [TxCreator](TxCreator.md)
 
 **Event data**
 
@@ -147,45 +151,20 @@ A tupel of event data and contract receipt
 
 ___
 
-### createMotion
-
-▸ **createMotion**(`motionDomain`, `encodedAction`, `altTarget?`): `Promise`<[{ `creator?`: `string` ; `domainId?`: `BigNumber` ; `motionId?`: `BigNumber`  }, `ContractReceipt`]\>
-
-Create a motion using an encoded action
-
-**`Remarks`**
-
-You will usually not use this function directly, but use the `send` or `motion` functions of the [TxCreator](TxCreator.md) within the relevant contract.
-
-#### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `motionDomain` | `BigNumberish` | `undefined` | The domain the motion will be created in |
-| `encodedAction` | `string` | `undefined` | The encoded action as a string |
-| `altTarget` | `string` | `'0x0'` | The contract to which we send the action - 0x0 for the colony (default) |
-
-#### Returns
-
-`Promise`<[{ `creator?`: `string` ; `domainId?`: `BigNumber` ; `motionId?`: `BigNumber`  }, `ContractReceipt`]\>
-
-A Motion object
-
-___
-
 ### finalizeMotion
 
-▸ **finalizeMotion**(`motionId`): `Promise`<[{ `action?`: `string` ; `executed?`: `boolean` ; `motionId?`: `BigNumber`  }, `ContractReceipt`]\>
+▸ **finalizeMotion**(`motionId`): [`TxCreator`](TxCreator.md)<`VotingReputationClientV7`, ``"finalizeMotion"``, { `action?`: `string` ; `executed?`: `boolean` ; `motionId?`: `BigNumber`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
 Finalize a motion, executing its action
 
 **`Remarks`**
 
-A motion cannot be finalized if:
-- The required Yay or Nay stake amount has not been reached
-- The staking period is not up yet
-- Voting is still in progress
-- The motion was already finalized
+* A motion cannot be finalized if:
+  - The required Yay or Nay stake amount has not been reached
+  - The staking period is not up yet
+  - Voting is still in progress
+  - The motion was already finalized
+* This method can't be executed as a motion
 
 #### Parameters
 
@@ -195,9 +174,9 @@ A motion cannot be finalized if:
 
 #### Returns
 
-`Promise`<[{ `action?`: `string` ; `executed?`: `boolean` ; `motionId?`: `BigNumber`  }, `ContractReceipt`]\>
+[`TxCreator`](TxCreator.md)<`VotingReputationClientV7`, ``"finalizeMotion"``, { `action?`: `string` ; `executed?`: `boolean` ; `motionId?`: `BigNumber`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
-A tupel of event data and contract receipt
+A [TxCreator](TxCreator.md)
 
 **Event data**
 
@@ -328,13 +307,14 @@ ___
 
 ### revealVote
 
-▸ **revealVote**(`motionId`, `vote?`): `Promise`<[{ `motionId?`: `BigNumber` ; `vote?`: `BigNumber` ; `voter?`: `string`  }, `ContractReceipt`]\>
+▸ **revealVote**(`motionId`, `vote?`): [`TxCreator`](TxCreator.md)<`VotingReputationClientV7`, ``"revealVote"``, { `motionId?`: `BigNumber` ; `vote?`: `BigNumber` ; `voter?`: `string`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
 Reveal a vote for a motion
 
 **`Remarks`**
 
-In order for a vote to count it has to be revealed within the reveal period. Only then rewards can be paid out to the voter.
+* In order for a vote to count it has to be revealed within the reveal period. Only then rewards can be paid out to the voter.
+* This method can't be executed as a motion
 
 #### Parameters
 
@@ -345,9 +325,9 @@ In order for a vote to count it has to be revealed within the reveal period. Onl
 
 #### Returns
 
-`Promise`<[{ `motionId?`: `BigNumber` ; `vote?`: `BigNumber` ; `voter?`: `string`  }, `ContractReceipt`]\>
+[`TxCreator`](TxCreator.md)<`VotingReputationClientV7`, ``"revealVote"``, { `motionId?`: `BigNumber` ; `vote?`: `BigNumber` ; `voter?`: `string`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
-A tupel of event data and contract receipt
+A [TxCreator](TxCreator.md)
 
 **Event data**
 
@@ -361,13 +341,14 @@ ___
 
 ### stakeMotion
 
-▸ **stakeMotion**(`motionId`, `vote`, `amount`): `Promise`<[{ `amount?`: `BigNumber` ; `eventIndex?`: `BigNumber` ; `motionId?`: `BigNumber` ; `staker?`: `string` ; `vote?`: `BigNumber`  }, `ContractReceipt`]\>
+▸ **stakeMotion**(`motionId`, `vote`, `amount`): [`TxCreator`](TxCreator.md)<`VotingReputationClientV7`, ``"stakeMotion"``, { `amount?`: `BigNumber` ; `eventIndex?`: `BigNumber` ; `motionId?`: `BigNumber` ; `staker?`: `string` ; `vote?`: `BigNumber`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
 Stake `amount` to support a motion with your vote
 
 **`Remarks`**
 
-In order to stake a motion the amount to stake (or any amount higher than that) needs to be "activated" and approved for staking in the motion's team first. See below for a full example. Usually you would have more tokens "activated" or even approved for a domain than you would stake, to make this process more seamless
+* In order to stake a motion the amount to stake (or any amount higher than that) needs to be "activated" and approved for staking in the motion's team first. See below for a full example. Usually you would have more tokens "activated" or even approved for a domain than you would stake, to make this process more seamless
+* This method can't be executed as a motion
 
 **`Example`**
 
@@ -381,8 +362,8 @@ import { Vote, w } from '@colony/sdk';
   await token.approve(w`200`);
   // Deposit all of approved the tokens
   await token.deposit(w`200`);
-  // Approve 150 tokens for staking in the root domain
-  await colony.ext.motions.approveStake(w`150`);
+  // Approve 150 tokens for staking in the root domain (can only be forced)
+  await colony.ext.motions.approveStake(w`150`).force();
   // Stake 100 tokens for motion with id 3
   await colony.ext.motions.stakeMotion(3, Vote.Yay, w`100`);
 })();
@@ -398,9 +379,9 @@ import { Vote, w } from '@colony/sdk';
 
 #### Returns
 
-`Promise`<[{ `amount?`: `BigNumber` ; `eventIndex?`: `BigNumber` ; `motionId?`: `BigNumber` ; `staker?`: `string` ; `vote?`: `BigNumber`  }, `ContractReceipt`]\>
+[`TxCreator`](TxCreator.md)<`VotingReputationClientV7`, ``"stakeMotion"``, { `amount?`: `BigNumber` ; `eventIndex?`: `BigNumber` ; `motionId?`: `BigNumber` ; `staker?`: `string` ; `vote?`: `BigNumber`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
-A tupel of event data and contract receipt
+A [TxCreator](TxCreator.md)
 
 **Event data**
 
@@ -416,10 +397,14 @@ ___
 
 ### submitVote
 
-▸ **submitVote**(`motionId`, `vote`): `Promise`<[{ `motionId?`: `BigNumber` ; `voter?`: `string`  }, `ContractReceipt`]\>
+▸ **submitVote**(`motionId`, `vote`): [`TxCreator`](TxCreator.md)<`VotingReputationClientV7`, ``"submitVote"``, { `motionId?`: `BigNumber` ; `voter?`: `string`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
 Submit a vote for a motion
 
+**`Remarks`**
+
+This method can't be executed as a motion
+
 #### Parameters
 
 | Name | Type | Description |
@@ -429,9 +414,9 @@ Submit a vote for a motion
 
 #### Returns
 
-`Promise`<[{ `motionId?`: `BigNumber` ; `voter?`: `string`  }, `ContractReceipt`]\>
+[`TxCreator`](TxCreator.md)<`VotingReputationClientV7`, ``"submitVote"``, { `motionId?`: `BigNumber` ; `voter?`: `string`  }, [`MetadataType`](../enums/MetadataType.md)\>
 
-A tupel of event data and contract receipt
+A [TxCreator](TxCreator.md)
 
 **Event data**
 

src/ColonyNetwork/Colony.ts

@@ -46,7 +46,7 @@ import {
   getVotingReputationClient,
   VotingReputation,
 } from './VotingReputation';
-import { PermissionConfig, TxCreator } from './TxCreator';
+import { PermissionConfig, TxConfig, TxCreator } from './TxCreator';
 
 export type SupportedColonyClient = ColonyClientV10;
 export type SupportedColonyMethods = SupportedColonyClient['functions'];
@@ -141,7 +141,7 @@ export class Colony {
    * @param method - The transaction method to execute on the contract
    * @param args - The arguments for the method
    * @param eventData - A function that extracts the relevant event data from the [[ContractReceipt]]
-   * @param metadataType - The [[MetadataType]] if the event contains metadata
+   * @param txConfig - More configuration options, like [[MetadataType]] if the event contains metadata or if methods are unsupported
    * @returns A [[TxCreator]]
    */
   createTxCreator<
@@ -156,7 +156,7 @@ export class Colony {
       | Parameters<C['functions'][F]>
       | (() => Promise<Parameters<C['functions'][F]>>),
     eventData?: (receipt: ContractReceipt) => Promise<D>,
-    metadataType?: M,
+    txConfig?: TxConfig<M>,
   ) {
     return new TxCreator({
       colony: this,
@@ -165,7 +165,7 @@ export class Colony {
       method,
       args,
       eventData,
-      metadataType,
+      txConfig,
     });
   }
 
@@ -180,7 +180,7 @@ export class Colony {
    * @param args - The arguments for the method
    * @param permissionConfig - Relevant configuration for the permissioned Colony function
    * @param eventData - A function that extracts the relevant event data from the [[ContractReceipt]]
-   * @param metadataType - The [[MetadataType]] if the event contains metadata
+   * @param txConfig - More configuration options, like [[MetadataType]] if the event contains metadata or if methods are unsupported
    * @returns A permissioned [[TxCreator]]
    */
   createPermissionedTxCreator<
@@ -196,7 +196,7 @@ export class Colony {
       | (() => Promise<ParametersFrom2<C['functions'][F]>>),
     permissionConfig: PermissionConfig,
     eventData?: (receipt: ContractReceipt) => Promise<D>,
-    metadataType?: M,
+    txConfig?: TxConfig<M>,
   ) {
     return new TxCreator({
       colony: this,
@@ -206,7 +206,7 @@ export class Colony {
       args,
       permissionConfig,
       eventData,
-      metadataType,
+      txConfig,
     });
   }
 
@@ -426,7 +426,7 @@ export class Colony {
         ...extractEvent<FundingPotAddedEventObject>('FundingPotAdded', receipt),
         ...extractEvent<DomainMetadataEventObject>('DomainMetadata', receipt),
       }),
-      MetadataType.Domain,
+      { metadataType: MetadataType.Domain },
     );
   }
 
@@ -662,6 +662,9 @@ export class Colony {
    *
    * This method can execute a transaction on any Ethereum Smart Contract with the Colony address as the sender. The action needs to be encoded function data (see https://docs.ethers.io/v5/api/utils/abi/interface/#Interface--encoding). We provide some common interfaces for you to make it even easier.
    *
+   * @remarks
+   * This method can't be executed as a MetaTransaction
+   *
    * @example Mint an NFT from a Colony
    * ```typescript
    * import { ERC721 } from '@colony/sdk';
@@ -694,6 +697,17 @@ export class Colony {
       this.colonyClient,
       'makeArbitraryTransactions',
       [[target], [action], false],
+      // TODO: This event will be allowed in Colony V11
+      // async (receipt) => ({
+      //   ...extractEvent<ArbitraryTransaction>('ArbitraryTransaction', receipt),
+      // }),
+      undefined,
+      {
+        unsupported: {
+          forceMeta: true,
+          motionMeta: true,
+        },
+      },
     );
   }
 
@@ -755,7 +769,7 @@ export class Colony {
       async (receipt) => ({
         ...extractEvent<AnnotationEventObject>('Annotation', receipt),
       }),
-      MetadataType.Annotation,
+      { metadataType: MetadataType.Annotation },
     );
   }
 

src/ColonyNetwork/ColonyNetwork.ts

@@ -21,7 +21,7 @@ import { IpfsMetadata, IpfsAdapter } from '../ipfs';
 import { Colony } from './Colony';
 import { ColonyLabelSuffix, MetaTxBroadCasterEndpoint } from '../constants';
 import { Expand, Parameters } from '../types';
-import { TxCreator } from './TxCreator';
+import { TxConfig, TxCreator } from './TxCreator';
 import { extractEvent } from '../utils';
 
 const { namehash } = utils;
@@ -106,7 +106,7 @@ export class ColonyNetwork {
    * @param method - The transaction method to execute on the contract
    * @param args - The arguments for the method
    * @param eventData - A function that extracts the relevant event data from the [[ContractReceipt]]
-   * @param metadataType - The [[MetadataType]] if the event contains metadata
+   * @param txConfig - More configuration options, like [[MetadataType]] if the event contains metadata or if methods are unsupported
    * @returns A [[TxCreator]]
    */
   createTxCreator<
@@ -121,15 +121,15 @@ export class ColonyNetwork {
       | Parameters<C['functions'][F]>
       | (() => Promise<Parameters<C['functions'][F]>>),
     eventData?: (receipt: ContractReceipt) => Promise<D>,
-    metadataType?: M,
+    txConfig?: TxConfig<M>,
   ) {
     return new TxCreator({
       colonyNetwork: this,
       contract,
       method,
       args,
       eventData,
-      metadataType,
+      txConfig,
     });
   }
 
@@ -286,7 +286,9 @@ export class ColonyNetwork {
       async (receipt) => ({
         ...extractEvent<ColonyAddedEventObject>('ColonyAdded', receipt),
       }),
-      MetadataType.Colony,
+      {
+        metadataType: MetadataType.Colony,
+      },
     );
   }