fix(PE-5512): accept a validity query param that returns interactio …

src/middleware/query.ts

@@ -29,6 +29,7 @@ export const queryMiddleware = async (ctx: KoaContext, next: Next) => {
     sortKey,
     page = DEFAULT_PAGE,
     pageSize = DEFAULT_PAGE_SIZE,
+    validity,
   } = ctx.query;
 
   logger.debug('Query params provided', {
@@ -82,5 +83,10 @@ export const queryMiddleware = async (ctx: KoaContext, next: Next) => {
     ctx.state.pageSize = +pageSize;
   }
 
+  if (validity) {
+    logger.debug('Validity provided', { validity });
+    ctx.state.validity = validity === 'true' || validity === '1';
+  }
+
   return next();
 };

src/routes/contract.ts

@@ -33,6 +33,7 @@
     warp,
     sortKey: requestedSortKey,
     blockHeight: requestedBlockHeight,
+    validity: requestedValidity,
   } = ctx.state;
   const { contractTxId } = ctx.params;
   logger.debug('Fetching contract state', {
@@ -42,6 +43,7 @@
   });
   const {
     state,
+    validity,
     evaluationOptions,
     sortKey: evaluatedSortKey,
   } = await getContractState({
@@ -57,6 +59,7 @@
     state,
     sortKey: evaluatedSortKey,
     evaluationOptions,
+    ...(requestedValidity && { validity }),
   };
 }
 
@@ -408,8 +411,8 @@
 
   const associatedRecords = Object.entries(records).reduce(
     (
       filteredRecords: { [x: string]: any },
       [record, recordObj]: [string, any],
     ) => {
       if (
         !filteredContractTxIdsArray.length ||
@@ -486,7 +489,7 @@
   });
 
   const parsedInput = Object.entries(input).reduce(
     (parsedParams: { [x: string]: any }, [key, value]) => {
       // parse known integer values for parameters we care about
       if (
         queryParamsCastedToNumbers.includes(key) &&

tests/integration/routes.test.ts

@@ -47,7 +47,7 @@
     this.timeout(10_000);
 
     ids = [
       process.env.DEPLOYED_ANT_CONTRACT_TX_ID!,
       process.env.DEPLOYED_REGISTRY_CONTRACT_TX_ID!,
     ];
     id = process.env.DEPLOYED_REGISTRY_CONTRACT_TX_ID!;
@@ -139,7 +139,7 @@
           expect(data).to.equal('Contract is blocklisted.');
           expect(statusText).to.equal('Contract is blocklisted.');
         });
-        it('should return the contract state and id and default evaluation options', async () => {
+        it('should return the contract state and id and default evaluation options without validity', async () => {
           const { status, data } = await axios.get(`/v1/contract/${id}`);
           expect(status).to.equal(200);
           expect(data).to.not.be.undefined;
@@ -158,6 +158,29 @@
           ]);
         });
 
+        it('should return the contract state and id and default evaluation options when validity is provided', async () => {
+          const { status, data } = await axios.get(
+            `/v1/contract/${id}?validity=true`,
+          );
+          expect(status).to.equal(200);
+          expect(data).to.not.be.undefined;
+          const { contractTxId, state, evaluationOptions, sortKey, validity } =
+            data;
+          expect(contractTxId).to.equal(id);
+          expect(evaluationOptions).not.to.be.undefined;
+          expect(sortKey).not.be.undefined;
+          expect(validity).not.to.be.undefined;
+          expect(state).to.include.keys([
+            'balances',
+            'owner',
+            'name',
+            'records',
+            'ticker',
+            'owner',
+            'controller',
+          ]);
+        });
+
         it('should return a 404 for an invalid id', async () => {
           const { status } = await axios.get(`/v1/contract/non-matching-regex`);
           expect(status).to.equal(404);