Merge pull request #53 from ar-io/PE-5003-add-sort-key

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

@@ -144,9 +144,10 @@ async function readThroughToContractState(
       contractTxId,
       cacheKey: cacheKey.toString(),
     });
-    const { cachedValue } = await inFlightRequest;
+    const { cachedValue, sortKey } = await inFlightRequest;
     return {
       ...cachedValue,
+      sortKey,
       evaluationOptions,
     };
   }
@@ -182,14 +183,16 @@ async function readThroughToContractState(
     });
 
   // 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,
   };
 }

src/routes/contract.ts

@@ -15,14 +15,15 @@ export async function contractHandler(ctx: KoaContext, next: Next) {
   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,
   };
 

src/types.ts

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