adjust query to support ordering

.github/workflows/run-tests.yaml

@@ -20,6 +20,7 @@ jobs:
           - 5432:5432
           - 8080:8080
           - 8181:8181
+          - 8282:8282
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

package.json

@@ -13,7 +13,7 @@
     "build": "npm run clean && npx tsc",
     "start": "node build/src/index.js",
     "dev": "cross-env NODE_NO_WARNINGS=1 npx nodemon src/index.ts",
-    "test": "npx tsc && for testfile in $(find build/tests -type f -name '*.test.js'); do node $testfile; done",
+    "test": "./run-tests.sh",
     "clean": "rimraf ./build",
     "gen-test-mocks": "cross-env NODE_NO_WARNINGS=1 node --loader ts-node/esm tests/mocked_sql/generate_mock_data.ts",
     "benchmark": "cross-env NODE_NO_WARNINGS=1 node --loader ts-node/esm benchmark/setup.ts && npx artillery run benchmark/graphql.yaml --output benchmark/report.json",

run-tests.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -e
+shopt -s globstar # to expand '**' into nested directories./
+
+npm run build
+
+# find all unit tests in build and run them
+for f in ./build/**/*test.js; do
+  echo "Running $f"
+  node --enable-source-maps --stack-trace-limit=1000 --test $f;
+done

schema.graphql

@@ -23,6 +23,7 @@
 }
 
 type EventData {
+  accountUpdateId: String!
   transactionInfo: TransactionInfo
   data: [String]!
 }
@@ -50,6 +51,10 @@
   hash: String!
   memo: String!
   authorizationKind: String!
+  sequenceNumber: Int! # TODO: Is it ok to make this required?
+  zkappAccountUpdateIds: [Int]!
+  zkappEventElementIds: [Int]!
+  zkappFieldArrayElementIds: [Int]!
 }
 
 type ActionStates {

src/blockchain/types.ts

@@ -13,6 +13,7 @@ export enum BlockStatusFilter {
 }
 
 export type Event = {
+  accountUpdateId: string;
   transactionInfo: TransactionInfo;
   data: string[];
 };
@@ -41,6 +42,10 @@ export type TransactionInfo = {
   hash: string;
   memo: string;
   authorizationKind: string;
+  sequenceNumber: number;
+  zkappAccountUpdateIds: number[];
+  zkappEventElementIds: number[];
+  zkappFieldArrayElementIds: number[];
 };
 
 export type Events = {

src/blockchain/utils.ts

@@ -24,14 +24,20 @@ export function createTransactionInfo(
     hash: row.hash,
     memo: row.memo,
     authorizationKind: row.authorization_kind,
+    sequenceNumber: row.sequence_number,
+    zkappAccountUpdateIds: row.zkapp_account_updates_ids,
+    zkappEventElementIds: row.zkapp_event_element_ids,
+    zkappFieldArrayElementIds: row.zkapp_field_array_element_ids,
   };
 }
 
 export function createEvent(
+  accountUpdateId: string,
   data: string[],
   transactionInfo: TransactionInfo
 ): Event {
   return {
+    accountUpdateId,
     data,
     transactionInfo,
   };

src/db/sql/events-actions/queries.ts

@@ -108,6 +108,7 @@ function emittedZkAppCommandsCTE(db_client: postgres.Sql) {
     SELECT
       blocks_accessed.*,
       zkcu.id AS zkapp_account_update_id,
+      bzkc.sequence_no AS sequence_number,
       zkapp_fee_payer_body_id,
       zkapp_account_updates_ids,
       authorization_kind,
@@ -136,6 +137,7 @@ function emittedEventsCTE(db_client: postgres.Sql) {
       *,
       zke.id AS zkapp_event_id,
       zke.element_ids AS zkapp_event_element_ids,
+      zkfa.element_ids AS zkapp_field_array_element_ids,
       zkfa.id AS zkapp_event_array_id
     FROM
       emitted_zkapp_commands
@@ -153,6 +155,7 @@ function emittedActionsCTE(db_client: postgres.Sql) {
       *,
       zke.id AS zkapp_event_id,
       zke.element_ids AS zkapp_event_element_ids,
+      zkfa.element_ids AS zkapp_field_array_element_ids,
       zkfa.id AS zkapp_event_array_id
     FROM
       emitted_zkapp_commands

src/db/sql/events-actions/types.ts

@@ -33,6 +33,9 @@ export type ArchiveNodeDatabaseRow = {
   // Current status of the block within the chain.
   chain_status: string;
 
+  // Sequence number of the transaction within a block
+  sequence_number: number;
+
   // Hash representing the ledger state.
   ledger_hash: string;
 
@@ -42,6 +45,10 @@ export type ArchiveNodeDatabaseRow = {
   // Unique identifier for the zkapp account update.
   zkapp_account_update_id: number;
 
+  // TODO: Would this be more accurately named `zkapp_event_field_array_id`?
+  // Unique identifier for the event within an account update.
+  zkapp_event_id: number;
+
   // List of identifiers inside a zkapp account update.
   zkapp_account_updates_ids: number[];
 
@@ -57,9 +64,13 @@ export type ArchiveNodeDatabaseRow = {
   // The unique identifier that maps events/actions to a specific zkApp.
   zkapp_event_array_id: number;
 
+  // TODO: Would this be more accuratley named `zkapp_event_field_array_ids`?
   // List of `element_ids` that are used to construct the zkApp event.
   zkapp_event_element_ids: number[];
 
+  // List of `element_ids` that are used to construct the field array.
+  zkapp_field_array_element_ids: number[];
+
   // `element_ids` represent a list of identifiers that map to specific field values.
   // These are used to identify which field values are used in a zkApp transaction and construct the data returned to the user.
   element_ids: number[];

src/resolvers-types.ts

@@ -87,6 +87,7 @@ export { BlockStatusFilter };
 
 export type EventData = {
   __typename?: 'EventData';
+  accountUpdateId: Scalars['String']['output'];
   data: Array<Maybe<Scalars['String']['output']>>;
   transactionInfo?: Maybe<TransactionInfo>;
 };
@@ -124,7 +125,11 @@ export type TransactionInfo = {
   authorizationKind: Scalars['String']['output'];
   hash: Scalars['String']['output'];
   memo: Scalars['String']['output'];
+  sequenceNumber: Scalars['Int']['output'];
   status: Scalars['String']['output'];
+  zkappAccountUpdateIds: Array<Maybe<Scalars['Int']['output']>>;
+  zkappEventElementIds: Array<Maybe<Scalars['Int']['output']>>;
+  zkappFieldArrayElementIds: Array<Maybe<Scalars['Int']['output']>>;
 };
 
 export type ResolverTypeWrapper<T> = Promise<T> | T;
@@ -386,6 +391,7 @@ export type EventDataResolvers<
   ParentType extends
     ResolversParentTypes['EventData'] = ResolversParentTypes['EventData'],
 > = {
+  accountUpdateId?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   data?: Resolver<
     Array<Maybe<ResolversTypes['String']>>,
     ParentType,
@@ -448,7 +454,23 @@ export type TransactionInfoResolvers<
   >;
   hash?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   memo?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  sequenceNumber?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
   status?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  zkappAccountUpdateIds?: Resolver<
+    Array<Maybe<ResolversTypes['Int']>>,
+    ParentType,
+    ContextType
+  >;
+  zkappEventElementIds?: Resolver<
+    Array<Maybe<ResolversTypes['Int']>>,
+    ParentType,
+    ContextType
+  >;
+  zkappFieldArrayElementIds?: Resolver<
+    Array<Maybe<ResolversTypes['Int']>>,
+    ParentType,
+    ContextType
+  >;
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 

src/services/actions-service/actions-service.ts

@@ -121,7 +121,7 @@ class ActionsService implements IActionsService {
     );
     for (let i = 0; i < blockTransactionEntries.length; i++) {
       const transactions = blockTransactionEntries[i][1];
-      const transaction = transactions.values().next().value[0];
+      const transaction = transactions.values().next().value![0];
       const blockInfo = createBlockInfo(transaction);
       const {
         action_state_value1,
@@ -143,7 +143,7 @@ class ActionsService implements IActionsService {
       }
       actions.push({
         blockInfo,
-        actionData: actionsData.flat(),
+        actionData: this.sortActions(actionsData.flat()),
         actionState: {
           /* eslint-disable */
           actionStateOne: action_state_value1!,
@@ -157,4 +157,29 @@ class ActionsService implements IActionsService {
     }
     return actions;
   }
+
+  sortActions(actions: Action[]): Action[] {
+    return actions.sort((a, b) => {
+      // Sort by sequence number
+      if (
+        a.transactionInfo.sequenceNumber !== b.transactionInfo.sequenceNumber
+      ) {
+        return (
+          a.transactionInfo.sequenceNumber - b.transactionInfo.sequenceNumber
+        );
+      }
+
+      // Sort by account update index within the transaction
+      const aAccountUpdateIndex =
+        a.transactionInfo.zkappAccountUpdateIds.indexOf(
+          Number(a.accountUpdateId)
+        );
+      const bAccountUpdateIndex =
+        b.transactionInfo.zkappAccountUpdateIds.indexOf(
+          Number(b.accountUpdateId)
+        );
+
+      return aAccountUpdateIndex - bAccountUpdateIndex;
+    });
+  }
 }

src/services/data-adapters/database-row-adapters.ts

@@ -199,15 +199,19 @@ function mapActionOrEvent(
 ) {
   const data: (Event | Action)[] = [];
   for (let i = 0; i < rows.length; i++) {
-    const { element_ids } = rows[i];
+    const { zkapp_account_update_id, element_ids } = rows[i];
     const transactionInfo = createTransactionInfo(rows[i]);
     const elementIdToFieldValues = getFieldValuesFromElementIds(
       element_ids,
       elementIdFieldValues
     );
 
     if (kind === 'event') {
-      const event = createEvent(elementIdToFieldValues, transactionInfo);
+      const event = createEvent(
+        zkapp_account_update_id.toString(),
+        elementIdToFieldValues,
+        transactionInfo
+      );
       data.push(event);
     } else {
       const { zkapp_account_update_id } = rows[i];

tests/makeActionsRequest.ts

@@ -0,0 +1,66 @@
+import { createYoga, createSchema } from 'graphql-yoga';
+import { loadSchemaSync } from '@graphql-tools/load';
+import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader';
+import { buildHTTPExecutor } from '@graphql-tools/executor-http';
+import { parse } from 'graphql';
+import { resolvers } from '../src/resolvers.js';
+import { buildContext, GraphQLContext } from '../src/context.js';
+
+const PG_CONN = 'postgresql://postgres:postgres@localhost:5432/archive ';
+const zkappAccount = 'B62qmBrPiukbHj4VnXdgMzjj2zpoQZeSBxZA6JDYMeeShApRAKaorto';
+
+const actionsQuery = `
+query getActions($input: ActionFilterOptionsInput!) {
+  actions(input: $input) {
+    blockInfo {
+      stateHash
+      timestamp
+      height
+      parentHash
+      chainStatus
+      distanceFromMaxBlockHeight
+      globalSlotSinceGenesis
+    }
+    actionState {
+      actionStateOne
+      actionStateTwo
+      actionStateThree
+      actionStateFour
+      actionStateFive
+    }
+    actionData {
+      data
+      accountUpdateId
+      transactionInfo {
+        status
+        hash
+        memo
+        sequenceNumber
+        zkappAccountUpdateIds
+        zkappEventElementIds
+      }
+    }
+  }
+}
+`;
+
+const schema = createSchema<GraphQLContext>({
+  typeDefs: loadSchemaSync('./schema.graphql', {
+    loaders: [new GraphQLFileLoader()],
+  }),
+  resolvers,
+});
+const context = await buildContext(PG_CONN);
+const yoga = createYoga<GraphQLContext>({ schema, context });
+const executor = buildHTTPExecutor({
+  fetch: yoga.fetch,
+});
+
+const results = await executor({
+  variables: {
+    input: { address: zkappAccount },
+  },
+  document: parse(`${actionsQuery}`),
+});
+
+console.log(JSON.stringify(results));