feat(sortKey): add sortKey to contract response

commitlint.config.js

@@ -19,4 +19,8 @@
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   ignores: [(message) => message.includes('[skip ci]')],
+  rules: {
+    'header-max-length': [0, 'always'],
+    'body-max-line-length': [0, 'always'],
+  },
 };

src/api/warp.ts

@@ -21,7 +21,7 @@
 import { ParsedUrlQuery } from 'querystring';
 
 // cache duplicate requests on the same instance within a short period of time
 const requestMap: Map<string, Promise<any> | undefined> = new Map();
 
 // Convenience class for read through caching
 class ContractStateCacheKey {
@@ -74,7 +74,7 @@
   constructor(
     public readonly contractTxId: string,
     public readonly functionName: string,
     public readonly input: any,
     public readonly warp: Warp,
     public readonly evaluationOptions: Partial<EvaluationOptions>,
     public readonly logger?: winston.Logger,
@@ -96,7 +96,7 @@
 const contractReadInteractionCache: ReadThroughPromiseCache<
   ContractReadInteractionCacheKey,
   {
     result: any;
     evaluationOptions: Partial<EvaluationOptions>;
   }
 > = new ReadThroughPromiseCache({
@@ -144,9 +144,10 @@
       contractTxId,
       cacheKey: cacheKey.toString(),
     });
-    const { cachedValue } = await inFlightRequest;
+    const { cachedValue, sortKey } = await inFlightRequest;
     return {
       ...cachedValue,
+      sortKey,
       evaluationOptions,
     };
   }
@@ -182,14 +183,16 @@
     });
 
   // await the response
-  const { cachedValue } = await requestMap.get(cacheId);
+  const { cachedValue, sortKey } = await requestMap.get(cacheId);
   logger?.debug('Successfully evaluated contract state.', {
     contractTxId,
     cacheKey: cacheKey.toString(),
+    sortKey,
   });
 
   return {
     ...cachedValue,
+    sortKey,
     evaluationOptions,
   };
 }
@@ -221,8 +224,8 @@
     return new NotFoundError(error.message);
   } else if (
     (error instanceof Error &&
       (error as any).type &&
       ['TX_NOT_FOUND', 'TX_INVALID'].includes((error as any).type)) ||
     (typeof error === 'string' && (error as string).includes('TX_INVALID'))
   ) {
     return new NotFoundError(`Contract not found. ${error}`);
@@ -265,7 +268,7 @@
 export async function readThroughToContractReadInteraction(
   cacheKey: ContractReadInteractionCacheKey,
 ): Promise<{
   result: any;
   evaluationOptions: Partial<EvaluationOptions>;
 }> {
   const { contractTxId, evaluationOptions, warp, logger, functionName, input } =
@@ -350,7 +353,7 @@
   functionName: string;
   input: ParsedUrlQuery;
 }): Promise<{
   result: any;
   evaluationOptions: Partial<EvaluationOptions>;
 }> {
   try {

src/routes/contract.ts

@@ -15,14 +15,15 @@
   logger.debug('Fetching contract state', {
     contractTxId,
   });
-  const { state, evaluationOptions } = await getContractState({
+  const { state, evaluationOptions, sortKey } = await getContractState({
     contractTxId,
     warp,
     logger,
   });
   ctx.body = {
     contractTxId,
     state,
+    sortKey,
     evaluationOptions,
   };
 
@@ -201,8 +202,8 @@
 
   const associatedRecords = Object.entries(records).reduce(
     (
       filteredRecords: { [x: string]: any },
       [record, recordObj]: [string, any],
     ) => {
       if (
         !filteredContractTxIdsArray.length ||

src/types.ts

@@ -68,8 +68,9 @@
 
 // Warp types
 
 export type EvaluatedContractState = EvalStateResult<any> & {
-  evaluationOptions?: Partial<EvaluationOptions>;
+  evaluationOptions: Partial<EvaluationOptions>;
+  sortKey: string;
 };
 
 export type EvaluatedReadInteraction = {