Feat/776 circuit inputs parser

examples/bri-3/src/bri/zeroKnowledgeProof/services/circuit/circuitInputsParser/circuitInputParser.service.spec.ts

@@ -0,0 +1,259 @@
+import { DeepMockProxy, mockDeep } from 'jest-mock-extended';
+import { LoggingService } from '../../../../../shared/logging/logging.service';
+import { CircuitInputsParserService } from './circuitInputParser.service';
+
+let cips: CircuitInputsParserService;
+const loggingServiceMock: DeepMockProxy<LoggingService> =
+  mockDeep<LoggingService>();
+
+beforeAll(async () => {
+  cips = new CircuitInputsParserService(loggingServiceMock);
+});
+
+describe('CircuitInputsParserService', () => {
+  it('Should return null if empty CircuitInputsMapping passed in', () => {
+    // Arrange
+    const payload = 'test';
+    const schema = {} as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toBeNull();
+  });
+
+  it('Should generate a single circuit input param with charcode sum based on a single string param at root level', () => {
+    // Arrange
+    const payload = `{
+        "supplierInvoiceID": "INV123"
+       }`;
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoiceID',
+          dataType: 'string',
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toStrictEqual({ dascircuitinput: 387 });
+  });
+
+  it('Should generate a single circuit input param with charcode sum based on a default value for a missing string param at root level', () => {
+    // Arrange
+    const payload = `{
+        "somethingElse": ""
+       }`;
+
+    const defaultParamValue = '555333';
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoiceID',
+          dataType: 'string',
+          defaultValue: defaultParamValue,
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toStrictEqual({ dascircuitinput: 312 });
+  });
+
+  it('Should return null based on a missing default value for a missing string param at root level', () => {
+    // Arrange
+    const payload = `{
+        "somethingElse": ""
+       }`;
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoiceID',
+          dataType: 'string',
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toBeNull();
+  });
+
+  it('Should generate a single circuit input param with charcode sum based on a single string param at root + 1 level', () => {
+    // Arrange
+    const payload = `{
+        "supplierInvoice": {
+          "ID": "INV123"
+        } 
+       }`;
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoice.ID',
+          dataType: 'string',
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toStrictEqual({ dascircuitinput: 387 });
+  });
+
+  it('Should generate a single circuit input param based on a single integer param at root level', () => {
+    // Arrange
+    const payload = `{
+        "supplierInvoiceID": 123
+       }`;
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoiceID',
+          dataType: 'integer',
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toStrictEqual({ dascircuitinput: 123 });
+  });
+
+  it('Should generate a single circuit input param based on a default value for a missing integer param at root level', () => {
+    // Arrange
+    const payload = `{
+        "somethingElse": ""
+       }`;
+
+    const defaultValue = 555333;
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoiceID',
+          dataType: 'integer',
+          defaultValue: defaultValue,
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toStrictEqual({ dascircuitinput: defaultValue });
+  });
+
+  it('Should return null based on a missing default value for a missing integer param at root level', () => {
+    // Arrange
+    const payload = `{
+        "somethingElse": ""
+       }`;
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoiceID',
+          dataType: 'integer',
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toBeNull();
+  });
+
+  it('Should generate a single circuit input param based on a single integer array param at root level', () => {
+    // Arrange
+    const payload = `{
+        "supplierInvoiceIDs": [
+          123,
+          321,
+          454
+        ]
+       }`;
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoiceIDs',
+          dataType: 'array',
+          arrayType: 'integer',
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toStrictEqual({ dascircuitinput: [123, 321, 454] });
+  });
+
+  it('Should generate a single circuit input param with charcode sums based on a single string array param at root level', () => {
+    // Arrange
+    const payload = `{
+        "supplierInvoiceIDs": [
+          "INV123",
+          "INV124",
+          "INV125"
+        ]
+       }`;
+
+    const schema = {
+      mapping: [
+        {
+          circuitInput: 'dascircuitinput',
+          description: 'desc',
+          payloadJsonPath: 'supplierInvoiceIDs',
+          dataType: 'array',
+          arrayType: 'string',
+        } as CircuitInputMapping,
+      ],
+    } as CircuitInputsMapping;
+
+    // Act
+    const circuitInputs = cips.applyMappingToJSONPayload(payload, schema);
+
+    // Assert
+    expect(circuitInputs).toStrictEqual({ dascircuitinput: [387, 388, 389] });
+  });
+});

examples/bri-3/src/bri/zeroKnowledgeProof/services/circuit/circuitInputsParser/circuitInputParser.service.ts

@@ -0,0 +1,95 @@
+import { Injectable } from '@nestjs/common';
+import { LoggingService } from '../../../../../shared/logging/logging.service';
+
+@Injectable()
+export class CircuitInputsParserService {
+  constructor(private readonly logger: LoggingService) {}
+
+  public applyMappingToJSONPayload(payload: string, cim: CircuitInputsMapping) {
+    const result: any = {};
+
+    try {
+      const jsonPayload = JSON.parse(payload);
+
+      for (let mapping of cim.mapping) {
+        const value = this.getJsonValueByPath(
+          jsonPayload,
+          mapping.payloadJsonPath,
+        );
+
+        if (!value && !mapping.defaultValue) {
+          this.logger.logError(
+            `Missing value and default value for mapping ${cim.mapping} while mapping circuit inputs for payload ${payload}`,
+          );
+          return null;
+        }
+
+        switch (mapping.dataType) {
+          case 'string':
+            result[mapping.circuitInput] = value
+              ? this.calculateStringCharCodeSum(value)
+              : this.calculateStringCharCodeSum(mapping.defaultValue);
+            break;
+
+          case 'integer':
+            result[mapping.circuitInput] = value ?? mapping.defaultValue;
+            break;
+
+          case 'array':
+            if (mapping.arrayType === 'string') {
+              result[mapping.circuitInput] = value
+                ? value.map((val) => this.calculateStringCharCodeSum(val))
+                : mapping.defaultValue.map((val) =>
+                    this.calculateStringCharCodeSum(val),
+                  );
+            }
+
+            if (mapping.arrayType === 'integer') {
+              result[mapping.circuitInput] = value ?? mapping.defaultValue;
+            }
+
+            if (mapping.arrayType === 'object') {
+              // TODO
+            }
+            break;
+          default:
+            this.logger.logError(
+              `Unknown datatype '${mapping.dataType}' while mapping circuit inputs for payload ${payload}`,
+            );
+            return null;
+        }
+      }
+    } catch (error) {
+      this.logger.logError(
+        `Error '${error}' while mapping circuit inputs for payload ${payload}`,
+      );
+      return null;
+    }
+
+    return result;
+  }
+
+  private getJsonValueByPath(json: any, path: string) {
+    const parts = path.split('.');
+    let currentValue = json;
+
+    for (const part of parts) {
+      if (currentValue[part] === undefined) {
+        return undefined;
+      }
+      currentValue = currentValue[part];
+    }
+
+    return currentValue;
+  }
+
+  private calculateStringCharCodeSum(text: string): number {
+    let sum = 0;
+
+    for (let i = 0; i < text.length; i++) {
+      sum += text.charCodeAt(i);
+    }
+
+    return sum;
+  }
+}

examples/bri-3/src/bri/zeroKnowledgeProof/services/circuit/circuitInputsParser/circuitInputsMapping.ts

@@ -0,0 +1,12 @@
+type CircuitInputsMapping = {
+  mapping: CircuitInputMapping[];
+};
+
+type CircuitInputMapping = {
+  circuitInput: string;
+  description: string;
+  payloadJsonPath: string;
+  dataType: string;
+  defaultValue?: any;
+  arrayType?: string;
+};