Merge pull request #240 from JoinColony/feat/2216-cancel-streams-via-motions

Feat: enable handler for the cancel streaming payment motion

Author: rumzledz

src/graphql/generated.ts

@@ -390,6 +390,8 @@ export enum ColonyActionType {
   CancelExpenditureMotion = 'CANCEL_EXPENDITURE_MOTION',
   /** An action related to cancelling a streaming payment */
   CancelStreamingPayment = 'CANCEL_STREAMING_PAYMENT',
+  /** An action related to cancelling a streaming payment via a motion */
+  CancelStreamingPaymentMotion = 'CANCEL_STREAMING_PAYMENT_MOTION',
   /** An action related to editing a Colony's details */
   ColonyEdit = 'COLONY_EDIT',
   /** An action related to editing a Colony's details via a motion */

src/handlers/motions/motionCreated/handlers/index.ts

@@ -13,3 +13,4 @@ export { handleMulticallMotion } from './multicall';
 export { handleMakeArbitraryTransactionsMotion } from './makeArbitraryTransactions';
 export { handleMetadataDeltaMotion } from './metadataDelta';
 export * from './expenditures';
+export * from './streamingPayments.ts';

src/handlers/motions/motionCreated/handlers/streamingPayments.ts/cancelStreamingPaymentsMotion.ts

@@ -0,0 +1,33 @@
+import { BigNumber } from 'ethers';
+import { TransactionDescription } from 'ethers/lib/utils';
+import { ContractEvent, motionNameMapping } from '~types';
+import { createMotionInDB } from '../../helpers';
+import {
+  getDomainDatabaseId,
+  getExpenditureDatabaseId,
+  toNumber,
+} from '~utils';
+
+export default async (
+  event: ContractEvent,
+  { name, args: actionArgs }: TransactionDescription,
+  gasEstimate: BigNumber,
+): Promise<void> => {
+  const { args, colonyAddress } = event;
+  const [, , streamingPaymentId] = actionArgs;
+  const [, , domainId] = args;
+
+  if (!colonyAddress) {
+    return;
+  }
+
+  await createMotionInDB(event, {
+    type: motionNameMapping[name],
+    fromDomainId: getDomainDatabaseId(colonyAddress, domainId),
+    gasEstimate: gasEstimate.toString(),
+    streamingPaymentId: getExpenditureDatabaseId(
+      colonyAddress,
+      toNumber(streamingPaymentId),
+    ),
+  });
+};

src/handlers/motions/motionCreated/handlers/streamingPayments.ts/index.ts

@@ -0,0 +1 @@
+export { default as handleCancelStreamingPaymentsMotion } from './cancelStreamingPaymentsMotion';

src/handlers/motions/motionCreated/helpers.ts

@@ -6,6 +6,7 @@ import {
   AnyStakedExpenditureClient,
   AnyStagedExpenditureClient,
   AnyVotingReputationClient,
+  AnyStreamingPaymentsClient,
 } from '@colony/colony-js';
 
 import { ColonyOperations, ContractEvent, MotionEvents } from '~types';
@@ -45,6 +46,7 @@ interface MotionActionClients {
   oneTxPaymentClient?: AnyOneTxPaymentClient | null;
   stakedExpenditureClient?: AnyStakedExpenditureClient | null;
   stagedExpenditureClient?: AnyStagedExpenditureClient | null;
+  streamingPaymentsClient?: AnyStreamingPaymentsClient | null;
 }
 
 export const parseAction = (

src/handlers/motions/motionCreated/motionCreated.ts

@@ -1,14 +1,19 @@
 import { BigNumber, constants } from 'ethers';
 import { StaticJsonRpcProvider } from '@ethersproject/providers';
 
-import { ColonyOperations, ContractEvent } from '~types';
+import {
+  ColonyOperations,
+  ContractEvent,
+  StreamingPaymentsOperations,
+} from '~types';
 import {
   getCachedColonyClient,
   getStakedExpenditureClient,
   getStagedExpenditureClient,
   getOneTxPaymentClient,
   getVotingClient,
   verbose,
+  getStreamingPaymentsClient,
 } from '~utils';
 import { SimpleTransactionDescription, parseAction } from './helpers';
 import {
@@ -30,6 +35,7 @@ import {
   handleCancelExpenditureViaArbitrationMotion,
   handleFinalizeExpenditureViaArbitrationMotion,
   handleReleaseStagedPaymentViaArbitration,
+  handleCancelStreamingPaymentsMotion,
 } from './handlers';
 
 export default async (event: ContractEvent): Promise<void> => {
@@ -60,6 +66,10 @@ export default async (event: ContractEvent): Promise<void> => {
     colonyAddress,
   );
 
+  const streamingPaymentsClient = await getStreamingPaymentsClient(
+    colonyAddress,
+  );
+
   const motion = await votingReputationClient.getMotion(motionId, {
     blockTag: blockNumber,
   });
@@ -68,6 +78,7 @@ export default async (event: ContractEvent): Promise<void> => {
     oneTxPaymentClient,
     stakedExpenditureClient,
     stagedExpenditureClient,
+    streamingPaymentsClient,
   });
 
   let gasEstimate: BigNumber;
@@ -251,6 +262,15 @@ export default async (event: ContractEvent): Promise<void> => {
         break;
       }
 
+      case StreamingPaymentsOperations.CancelStreamingPayment: {
+        await handleCancelStreamingPaymentsMotion(
+          event,
+          parsedAction,
+          gasEstimate,
+        );
+        break;
+      }
+
       default: {
         break;
       }

src/types/motions.ts

@@ -26,6 +26,10 @@ export enum ColonyOperations {
   ReleaseStagedPaymentViaArbitration = 'releaseStagedPaymentViaArbitration',
 }
 
+export enum StreamingPaymentsOperations {
+  CancelStreamingPayment = 'cancel',
+}
+
 export enum MotionEvents {
   MotionCreated = 'MotionCreated',
   MotionStaked = 'MotionStaked',
@@ -69,6 +73,8 @@ export const motionNameMapping: { [key: string]: ColonyActionType } = {
     ColonyActionType.SetExpenditureStateMotion,
   [ColonyOperations.ReleaseStagedPaymentViaArbitration]:
     ColonyActionType.ReleaseStagedPaymentMotion,
+  [StreamingPaymentsOperations.CancelStreamingPayment]:
+    ColonyActionType.CancelStreamingPaymentMotion,
 };
 
 export enum MotionSide {