Merge pull request #229 from apotdevin/refactor-forwards

refactor: forwards query

Author: apotdevin

pages/forwards.tsx

@@ -101,7 +101,7 @@ const ForwardsView = () => {
               <Separation />
               <ForwardChannelsReport days={days} order={infoType} />
             </Card>
-            <SubTitle>Grouped by Peer</SubTitle>
+            <SubTitle>Grouped by Channel</SubTitle>
             <Card>
               <ForwardTable days={days} order={infoType} />
             </Card>

server/helpers/rateLimiter.ts

@@ -14,6 +14,7 @@ export const RateConfig: RateConfigProps = {
   chainBalance: { max: 10, window: '5s' },
   pendingChainBalance: { max: 10, window: '5s' },
   channelBalance: { max: 10, window: '5s' },
+  getChannel: { max: 1000, window: '5s' },
 };
 
 const rateLimiter = getGraphQLRateLimiter({

server/schema/channel/resolvers.ts

@@ -1,6 +1,6 @@
 import { logger } from 'server/helpers/logger';
 import { toWithError } from 'server/helpers/async';
-import { getChannel } from 'ln-service';
+import { getChannel as getLnChannel } from 'ln-service';
 import { ChannelType, GetChannelType } from 'server/types/ln-service.types';
 import { openChannel } from './resolvers/mutation/openChannel';
 import { closeChannel } from './resolvers/mutation/closeChannel';
@@ -10,6 +10,7 @@ import { getChannelBalance } from './resolvers/query/getChannelBalance';
 import { getChannels } from './resolvers/query/getChannels';
 import { getClosedChannels } from './resolvers/query/getClosedChannels';
 import { getPendingChannels } from './resolvers/query/getPendingChannels';
+import { getChannel } from './resolvers/query/getChannel';
 
 type ParentType = {
   id: string;
@@ -21,6 +22,7 @@ type ParentType = {
 
 export const channelResolvers = {
   Query: {
+    getChannel,
     getChannelBalance,
     getChannels,
     getClosedChannels,
@@ -48,7 +50,7 @@ export const channelResolvers = {
       }
 
       const [channel, error] = await toWithError<GetChannelType>(
-        getChannel({ lnd, id })
+        getLnChannel({ lnd, id })
       );
 
       if (error) {

server/schema/channel/resolvers/query/getChannel.ts

@@ -0,0 +1,42 @@
+import { getChannel as getLnChannel } from 'ln-service';
+import { ContextType } from 'server/types/apiTypes';
+import { to } from 'server/helpers/async';
+import { requestLimiter } from 'server/helpers/rateLimiter';
+import { GetChannelType } from 'server/types/ln-service.types';
+
+export const getChannel = async (
+  _: undefined,
+  { id, pubkey }: { id: string; pubkey?: string },
+  { ip, lnd }: ContextType
+) => {
+  await requestLimiter(ip, 'getChannel');
+
+  const channel = await to<GetChannelType>(getLnChannel({ lnd, id }));
+
+  if (!pubkey) {
+    return channel;
+  }
+
+  let node_policies = null;
+  let partner_node_policies = null;
+
+  channel.policies.forEach(policy => {
+    if (pubkey && pubkey === policy.public_key) {
+      node_policies = {
+        ...policy,
+        node: { lnd, publicKey: policy.public_key },
+      };
+    } else {
+      partner_node_policies = {
+        ...policy,
+        node: { lnd, publicKey: policy.public_key },
+      };
+    }
+  });
+
+  return {
+    ...(channel as GetChannelType),
+    node_policies,
+    partner_node_policies,
+  };
+};

server/schema/forwards/resolvers.ts

@@ -0,0 +1,55 @@
+import { subDays } from 'date-fns';
+import { to } from 'server/helpers/async';
+import { requestLimiter } from 'server/helpers/rateLimiter';
+import { ContextType } from 'server/types/apiTypes';
+import { GetForwardsType } from 'server/types/ln-service.types';
+import { getForwards as getLnForwards } from 'ln-service';
+import { sortBy } from 'lodash';
+
+export const forwardsResolver = {
+  Query: {
+    getForwards: async (
+      _: undefined,
+      { days }: { days: number },
+      context: ContextType
+    ) => {
+      await requestLimiter(context.ip, 'getForwardsPastDays');
+
+      const { lnd } = context;
+
+      const today = new Date();
+      const startDate = subDays(today, days);
+
+      const forwardsList = await to<GetForwardsType>(
+        getLnForwards({
+          lnd,
+          after: startDate,
+          before: today,
+        })
+      );
+
+      let forwards = forwardsList.forwards;
+      let next = forwardsList.next;
+
+      let finishedFetching = false;
+
+      if (!next || !forwards || forwards.length <= 0) {
+        finishedFetching = true;
+      }
+
+      while (!finishedFetching) {
+        if (next) {
+          const moreForwards = await to<GetForwardsType>(
+            getLnForwards({ lnd, token: next })
+          );
+          forwards = [...forwards, ...moreForwards.forwards];
+          next = moreForwards.next;
+        } else {
+          finishedFetching = true;
+        }
+      }
+
+      return sortBy(forwards, 'created_at').reverse();
+    },
+  },
+};

server/schema/index.ts

@@ -44,6 +44,7 @@ import { lnMarketsResolvers } from './lnmarkets/resolvers';
 import { lnMarketsTypes } from './lnmarkets/types';
 import { boltzResolvers } from './boltz/resolvers';
 import { boltzTypes } from './boltz/types';
+import { forwardsResolver } from './forwards/resolvers';
 
 const typeDefs = [
   generalTypes,
@@ -94,7 +95,8 @@ const resolvers = merge(
   tbaseResolvers,
   lnUrlResolvers,
   lnMarketsResolvers,
-  boltzResolvers
+  boltzResolvers,
+  forwardsResolver
 );
 
 export const schema = makeExecutableSchema({ typeDefs, resolvers });

server/schema/transactions/resolvers.ts

@@ -1,11 +1,5 @@
-import {
-  getPayments,
-  getInvoices,
-  getForwards as getLnForwards,
-  getWalletInfo,
-  getClosedChannels,
-} from 'ln-service';
-import { compareDesc, subDays } from 'date-fns';
+import { getPayments, getInvoices } from 'ln-service';
+import { compareDesc } from 'date-fns';
 import { sortBy } from 'underscore';
 import { ContextType } from 'server/types/apiTypes';
 import { requestLimiter } from 'server/helpers/rateLimiter';
@@ -15,12 +9,7 @@ import {
   GetPaymentsType,
   InvoiceType,
   PaymentType,
-  GetForwardsType,
-  GetWalletInfoType,
-  GetClosedChannelsType,
 } from 'server/types/ln-service.types';
-import { logger } from 'server/helpers/logger';
-import { getNodeFromChannel } from './helpers';
 
 type TransactionType = InvoiceType | PaymentType;
 type TransactionWithType = { isTypeOf: string } & TransactionType;
@@ -105,89 +94,10 @@ export const transactionResolvers = {
         resume,
       };
     },
-
-    getForwardsPastDays: async (
-      _: undefined,
-      { days }: { days: number },
-      context: ContextType
-    ) => {
-      await requestLimiter(context.ip, 'getForwardsPastDays');
-
-      const { lnd } = context;
-
-      const today = new Date();
-      const startDate = subDays(today, days);
-
-      const walletInfo = await to<GetWalletInfoType>(getWalletInfo({ lnd }));
-
-      const closedChannels = await to<GetClosedChannelsType>(
-        getClosedChannels({ lnd })
-      );
-
-      const forwardsList = await to<GetForwardsType>(
-        getLnForwards({
-          lnd,
-          after: startDate,
-          before: today,
-        })
-      );
-
-      let forwards = forwardsList.forwards;
-      let next = forwardsList.next;
-
-      let finishedFetching = false;
-
-      if (!next || !forwards || forwards.length <= 0) {
-        finishedFetching = true;
-      }
-
-      while (!finishedFetching) {
-        if (next) {
-          const moreForwards = await to<GetForwardsType>(
-            getLnForwards({ lnd, token: next })
-          );
-          forwards = [...forwards, ...moreForwards.forwards];
-          next = moreForwards.next;
-        } else {
-          finishedFetching = true;
-        }
-      }
-
-      const final = forwards.map(f => ({
-        ...f,
-        lnd,
-        public_key: walletInfo.public_key,
-        closed_channels: closedChannels.channels || [],
-      }));
-
-      logger.debug(
-        `Got a total of ${final.length} forwards for the past ${days} days`
-      );
-
-      return sortBy(final, 'created_at').reverse();
-    },
   },
   Transaction: {
     __resolveType(parent: TransactionWithType) {
       return parent.isTypeOf;
     },
   },
-  Forward: {
-    incoming_node(parent: any) {
-      return getNodeFromChannel(
-        parent.lnd,
-        parent.incoming_channel,
-        parent.public_key,
-        parent.closed_channels
-      );
-    },
-    outgoing_node(parent: any) {
-      return getNodeFromChannel(
-        parent.lnd,
-        parent.outgoing_channel,
-        parent.public_key,
-        parent.closed_channels
-      );
-    },
-  },
 };

server/schema/transactions/types.ts

@@ -9,8 +9,6 @@ export const transactionTypes = gql`
     mtokens: String!
     outgoing_channel: String!
     tokens: Int!
-    incoming_node: ForwardNodeType
-    outgoing_node: ForwardNodeType
   }
 
   type ForwardNodeType {

server/schema/types.ts

@@ -51,6 +51,7 @@ export const queryTypes = gql`
     getTimeHealth: channelsTimeHealth
     getFeeHealth: channelsFeeHealth
     getChannelBalance: channelBalanceType
+    getChannel(id: String!, pubkey: String): singleChannelType!
     getChannels(active: Boolean): [channelType]!
     getClosedChannels(type: String): [closedChannelType]
     getPendingChannels: [pendingChannelType]
@@ -62,7 +63,7 @@ export const queryTypes = gql`
     decodeRequest(request: String!): decodeType
     getWalletInfo: walletInfoType
     getResume(token: String): getResumeType
-    getForwardsPastDays(days: Int!): [Forward]!
+    getForwards(days: Int!): [Forward]!
     getBitcoinPrice(logger: Boolean, currency: String): String
     getBitcoinFees(logger: Boolean): bitcoinFeeType
     getForwardChannelsReport(time: String, order: String, type: String): String