[SDK-CORE] Added FlowOperator Query and its Entity (#1396)

* Added, account token settings and query required for Permission and Allowance feature (Dashboard).

* fixed review comments

* fixed lint issue

* added flowOperator as filter option

* change entity name

* fix getRelevantAddressesFromResultCore

* undo sdk-redux version

---------

Co-authored-by: Kaspar Kallas <kaspar@superfluid.finance>

packages/sdk-core/CHANGELOG.md

@@ -5,6 +5,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## Unreleased
 
+### Added
+- Subgraph query support for `FlowOperator`
+
 ## [0.6.5] - 2023-05-12
 
 ### Fixed

packages/sdk-core/src/index.ts

@@ -48,6 +48,7 @@ export * from "./subgraph/entities/streamPeriod/streamPeriod";
 export * from "./subgraph/entities/token/token";
 export * from "./subgraph/entities/tokenStatistic/tokenStatistic";
 export * from "./subgraph/entities/tokenStatisticLog/tokenStatisticLog";
+export * from "./subgraph/entities/flowOperator/flowOperators";
 
 export * from "./subgraph/events/events";
 export * from "./subgraph/events/flowUpdatedEvent";

packages/sdk-core/src/subgraph/entities/flowOperator/flowOperators.graphql

@@ -0,0 +1,33 @@
+query flowOperators(
+    $first: Int = 10
+    $orderBy: FlowOperator_orderBy = id
+    $orderDirection: OrderDirection = asc
+    $skip: Int = 0
+    $where: FlowOperator_filter = {}
+    $block: Block_height
+) {
+    flowOperators(
+        first: $first
+        orderBy: $orderBy
+        orderDirection: $orderDirection
+        skip: $skip
+        where: $where
+        block: $block
+    ) {
+        id
+        createdAtTimestamp
+        createdAtBlockNumber
+        updatedAtBlockNumber
+        updatedAtTimestamp
+        flowOperator
+        sender {
+            id
+        }
+        token {
+            id
+        }
+        flowRateAllowanceRemaining
+        permissions
+        allowance
+    }
+}

packages/sdk-core/src/subgraph/entities/flowOperator/flowOperators.ts

@@ -0,0 +1,74 @@
+import {
+    Address,
+    BigNumber,
+    BlockNumber,
+    Timestamp,
+} from "../../mappedSubgraphTypes";
+import {
+    FlowOperator_Filter,
+    FlowOperator_OrderBy,
+} from "../../schema.generated";
+import {
+    RelevantAddressesIntermediate,
+    SubgraphListQuery,
+    SubgraphQueryHandler,
+} from "../../subgraphQueryHandler";
+
+import {
+    FlowOperatorsDocument,
+    FlowOperatorsQuery,
+    FlowOperatorsQueryVariables,
+} from "./flowOperators.generated";
+
+export interface FlowOperator {
+    id: string;
+    createdAtBlockNumber: BlockNumber;
+    createdAtTimestamp: Timestamp;
+    updatedAtBlockNumber: BlockNumber;
+    updatedAtTimestamp: Timestamp;
+    flowOperator: Address;
+    sender: Address;
+    token: Address;
+    flowRateAllowanceRemaining: BigNumber;
+    allowance: BigNumber;
+    permissions: number;
+}
+
+export type FlowOperatorListQuery = SubgraphListQuery<
+    FlowOperator_Filter,
+    FlowOperator_OrderBy
+>;
+
+export class FlowOperatorQueryHandler extends SubgraphQueryHandler<
+    FlowOperator,
+    FlowOperatorListQuery,
+    FlowOperatorsQuery,
+    FlowOperatorsQueryVariables
+> {
+    getAddressFieldKeysFromFilter = (): {
+        accountKeys: (keyof FlowOperator_Filter)[];
+        tokenKeys: (keyof FlowOperator_Filter)[];
+    } => ({
+        accountKeys: ["sender", "flowOperator"],
+        tokenKeys: ["token"],
+    });
+
+    getRelevantAddressesFromResultCore = (
+        result: FlowOperator
+    ): RelevantAddressesIntermediate => ({
+        accounts: [result.sender, result.flowOperator],
+        tokens: [result.token],
+    });
+
+    mapFromSubgraphResponse = (response: FlowOperatorsQuery): FlowOperator[] =>
+        response.flowOperators.map((x) => ({
+            ...x,
+            sender: x.sender.id,
+            token: x.token.id,
+            createdAtTimestamp: Number(x.createdAtTimestamp),
+            createdAtBlockNumber: Number(x.createdAtBlockNumber),
+            updatedAtTimestamp: Number(x.updatedAtTimestamp),
+            updatedAtBlockNumber: Number(x.updatedAtBlockNumber),
+        }));
+    requestDocument = FlowOperatorsDocument;
+}