feat(price): add price endpoint for retrieving costs of interactions …

…on contract

package.json

@@ -16,6 +16,7 @@
     "start:prod": "yarn build && node dist/app.js",
     "build": "yarn clean && yarn && npx tsc --project ./tsconfig.json",
     "clean": "rimraf [ node_modules dist cache ]",
+    "test:docker": "docker compose up --exit-code-from test-runner --build",
     "test:integration": "mocha --spec=tests/integration/**.test.ts",
     "test:integration:local": "docker compose up arlocal -d ; yarn test:integration $* ; docker compose down -v",
     "docker:run": "docker compose up arns-service --build",

src/router.ts

@@ -86,6 +86,14 @@ router.get(
     return contractReadInteractionHandler(ctx, next);
   },
 );
+router.get(
+  `/v1/contract/:contractTxId${ARNS_CONTRACT_ID_REGEX}/price`,
+  (ctx: KoaContext, next: Next) => {
+    // set params for auction read interaction and then use our generic handler
+    ctx.params.functionName = 'priceForInteraction';
+    return contractReadInteractionHandler(ctx, next);
+  },
+);
 // generic handler that handles read APIs for any contract function
 router.get(
   `/v1/contract/:contractTxId${ARNS_CONTRACT_ID_REGEX}/read/:functionName`,

src/routes/contract.ts

@@ -284,12 +284,25 @@ export async function contractReadInteractionHandler(
     functionName,
   });
 
+  const parsedInput = Object.entries(input).reduce(
+    (parsedParams: { [x: string]: any }, [key, value]) => {
+      // parse known integer values
+      if (typeof value === 'string' && !isNaN(+value)) {
+        parsedParams[key] = +value;
+        return parsedParams;
+      }
+      parsedParams[key] = value;
+      return parsedParams;
+    },
+    {},
+  );
+
   const { result, evaluationOptions } = await getContractReadInteraction({
     contractTxId,
     warp,
     logger,
     functionName,
-    input,
+    input: parsedInput,
   });
 
   ctx.body = {

tests/integration/arlocal/index.js

@@ -70,6 +70,10 @@ export function handle(state, action) {
     return { state };
   }
 
+  if (input.function === 'priceForInteraction') {
+    return { result: { price: input.qty } };
+  }
+
   throw new ContractError(
     `No function supplied or function not recognized: "${input.function}"`,
   );

tests/integration/routes.test.ts

@@ -30,7 +30,7 @@ const axios = axiosPackage.create({
   baseURL: serviceURL,
   validateStatus: () => true, // don't throw errors
 });
-describe('PDNS Service Integration tests', () => {
+describe('Integration tests', () => {
   let ids: string[] = [];
   let id: string;
   let walletAddress: string;
@@ -140,6 +140,20 @@ describe('PDNS Service Integration tests', () => {
           expect(status).to.equal(404);
         });
       });
+      describe('/:contractTxId/price', () => {
+        it('should properly handle price interaction inputs', async () => {
+          const { status, data } = await axios.get(
+            `/v1/contract/${id}/price?qty=100`,
+          );
+          expect(status).to.equal(200);
+          expect(data).to.not.be.undefined;
+          const { contractTxId, result, evaluationOptions } = data;
+          expect(contractTxId).to.equal(id);
+          expect(evaluationOptions).not.to.be.undefined;
+          expect(result).to.include.keys(['price']);
+          expect(result.price).to.equal(100);
+        });
+      });
 
       describe('/:contractTxId/interactions', () => {
         it('should return the contract interactions', async () => {

tests/integration/setup.test.ts

@@ -109,12 +109,6 @@ export async function mochaGlobalSetup() {
         },
       }),
       src: contractSrcJs,
-      evaluationManifest: {
-        evaluationOptions: {
-          // used for testing query params
-          throwOnInternalWriteError: true,
-        },
-      },
     },
     true, // disable bundling
   );