Merge pull request #219 from JoinColony/feat/2206-claim-streaming-payments

Feat/2206 claim streaming payments

Author: davecreaser

src/eventListeners/extension/streamingPayments.ts

@@ -26,6 +26,7 @@ export const setupListenersForStreamingPayments = (
     ContractEventsSignatures.StartTimeSet,
     ContractEventsSignatures.EndTimeSet,
     ContractEventsSignatures.ClaimWaived,
+    ContractEventsSignatures.StreamingPaymentClaimed,
   ];
 
   events.forEach((eventSignature) =>

src/eventProcessor.ts

@@ -53,6 +53,7 @@ import {
   handleSetTokenAuthority,
   handleExpenditureStateChanged,
   handleStreamingPaymentEndTimeSet,
+  handleStreamingPaymentClaimed,
 } from './handlers';
 
 dotenv.config();
@@ -361,6 +362,11 @@ export default async (event: ContractEvent): Promise<void> => {
       return;
     }
 
+    case ContractEventsSignatures.StreamingPaymentClaimed: {
+      await handleStreamingPaymentClaimed(event);
+      return;
+    }
+
     default: {
       return;
     }

src/graphql/generated.ts

@@ -1476,6 +1476,7 @@ export type CreateSafeTransactionInput = {
 };
 
 export type CreateStreamingPaymentInput = {
+  claims?: InputMaybe<Array<StreamingPaymentClaimInput>>;
   createdAt?: InputMaybe<Scalars['AWSDateTime']>;
   endTime: Scalars['AWSTimestamp'];
   id?: InputMaybe<Scalars['ID']>;
@@ -6745,6 +6746,7 @@ export type StakerRewardsInput = {
 export type StreamingPayment = {
   __typename?: 'StreamingPayment';
   actions?: Maybe<ModelColonyActionConnection>;
+  claims?: Maybe<Array<StreamingPaymentClaim>>;
   createdAt: Scalars['AWSDateTime'];
   endTime: Scalars['AWSTimestamp'];
   id: Scalars['ID'];
@@ -6767,6 +6769,19 @@ export type StreamingPaymentActionsArgs = {
   sortDirection?: InputMaybe<ModelSortDirection>;
 };
 
+export type StreamingPaymentClaim = {
+  __typename?: 'StreamingPaymentClaim';
+  amount: Scalars['String'];
+  timestamp: Scalars['AWSTimestamp'];
+  tokenAddress: Scalars['ID'];
+};
+
+export type StreamingPaymentClaimInput = {
+  amount: Scalars['String'];
+  timestamp: Scalars['AWSTimestamp'];
+  tokenAddress: Scalars['ID'];
+};
+
 export enum StreamingPaymentEndCondition {
   FixedTime = 'FIXED_TIME',
   LimitReached = 'LIMIT_REACHED',
@@ -7944,6 +7959,7 @@ export type UpdateSafeTransactionInput = {
 };
 
 export type UpdateStreamingPaymentInput = {
+  claims?: InputMaybe<Array<StreamingPaymentClaimInput>>;
   createdAt?: InputMaybe<Scalars['AWSDateTime']>;
   endTime?: InputMaybe<Scalars['AWSTimestamp']>;
   id: Scalars['ID'];
@@ -9239,6 +9255,12 @@ export type GetStreamingPaymentQuery = {
       tokenAddress: string;
       isClaimed: boolean;
     }> | null;
+    claims?: Array<{
+      __typename?: 'StreamingPaymentClaim';
+      amount: string;
+      tokenAddress: string;
+      timestamp: number;
+    }> | null;
   } | null;
 };
 
@@ -10353,6 +10375,11 @@ export const GetStreamingPaymentDocument = gql`
         tokenAddress
         isClaimed
       }
+      claims {
+        amount
+        tokenAddress
+        timestamp
+      }
     }
   }
 `;

src/graphql/queries/expenditures.graphql

@@ -37,5 +37,10 @@ query GetStreamingPayment($id: ID!) {
       tokenAddress
       isClaimed
     }
+    claims {
+      amount
+      tokenAddress
+      timestamp
+    }
   }
 }

src/handlers/expenditures/index.ts

@@ -18,3 +18,4 @@ export { default as handleStreamingPaymentEndTimeSet } from './streamingPaymentE
 export { default as handleExpenditureMadeViaStake } from './expenditureMadeViaStake';
 export { default as handlePaymentTokenUpdated } from './paymentTokenUpdated';
 export { default as handleExpenditureStateChanged } from './expenditureStateChanged';
+export { default as handleStreamingPaymentClaimed } from './streamingPaymentClaimed';

src/handlers/expenditures/streamingPaymentClaimed.ts

@@ -0,0 +1,49 @@
+import { mutate } from '~amplifyClient';
+import {
+  StreamingPaymentClaim,
+  UpdateStreamingPaymentDocument,
+  UpdateStreamingPaymentMutation,
+  UpdateStreamingPaymentMutationVariables,
+} from '~graphql';
+import { ContractEvent } from '~types';
+import { getExpenditureDatabaseId, output, toNumber } from '~utils';
+import { getStreamingPaymentFromDB } from './helpers';
+
+export default async (event: ContractEvent): Promise<void> => {
+  const { colonyAddress, timestamp } = event;
+  const { amount, streamingPaymentId, token: tokenAddress } = event.args;
+  const convertedNativeId = toNumber(streamingPaymentId);
+
+  if (!colonyAddress) {
+    return;
+  }
+
+  const databaseId = getExpenditureDatabaseId(colonyAddress, convertedNativeId);
+
+  const streamingPayment = await getStreamingPaymentFromDB(databaseId);
+  if (!streamingPayment) {
+    output(
+      `Could not find streaming payment with ID: ${databaseId} in the db. This is a bug and needs investigating.`,
+    );
+    return;
+  }
+
+  const newClaim: StreamingPaymentClaim = {
+    amount: amount.toString(),
+    tokenAddress,
+    timestamp,
+  };
+  const claims: StreamingPaymentClaim[] = streamingPayment.claims
+    ? [...streamingPayment.claims, newClaim]
+    : [newClaim];
+
+  await mutate<
+    UpdateStreamingPaymentMutation,
+    UpdateStreamingPaymentMutationVariables
+  >(UpdateStreamingPaymentDocument, {
+    input: {
+      id: databaseId,
+      claims,
+    },
+  });
+};

src/types/events.ts

@@ -98,6 +98,7 @@ export enum ContractEventsSignatures {
   StartTimeSet = 'StartTimeSet(address,uint256,uint256)',
   EndTimeSet = 'EndTimeSet(address,uint256,uint256)',
   ClaimWaived = 'ClaimWaived(address,uint256,address)',
+  StreamingPaymentClaimed = 'StreamingPaymentClaimed(address,uint256,address,uint256)',
 
   // Annotations
   AnnotateTransaction = 'Annotation(address,bytes32,string)',