feat(csi-785): unified ILP interface (#217)

* feat(csi-785): unified ILP interface

* chore(snapshot): 19.2.0-snapshot.0

Author: geka-evk

.eslintrc.json

@@ -5,6 +5,9 @@
     "jest": true
   },
   "extends": "eslint:recommended",
+  "parserOptions": {
+    "ecmaVersion": 13
+  },
   "rules": {
     "indent": [
       "error",

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-standard-components",
-  "version": "19.1.3",
+  "version": "19.2.0-snapshot.0",
   "description": "A set of standard components for connecting to Mojaloop API enabled Switches",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package.json

@@ -1,23 +1,25 @@
 // todo: think, how to generate JSDocs based on these TS types
+type Prettify<T> = { //to make hover overlay more readable
+    [K in keyof T]: T[K];
+} & {};
+
+type Amount = {
+    amount: string;
+    currency: string;
+};
+
 export type IlpResponse = {
     fulfilment: string;
     condition: string;
     ilpPacket: string;
 }
 
-export type TransactionObject = {
-    quoteId: string;
-    transactionId: string;
-    transactionType: TransactionType;
-    payee: Party;
-    payer: Party;
-    expiration: string;
-    amount: {
-        amount: string;
-        currency: string;
-    };
-    note?: string;
-};
+export type TransactionObject = Prettify<
+    Pick<QuoteRequest, 'quoteId' | 'transactionId' | 'transactionType' | 'payee' | 'payer' | 'expiration'> & {
+        amount: Amount;
+        note?: string;
+    }
+>;
 
 export type IlpInputV1 = {
     amount: string;
@@ -64,14 +66,30 @@ export type TransactionType = {
     subScenario?: string;
 }
 
+export type QuoteRequest = {
+    quoteId: string;
+    transactionId: string;
+    transactionType: TransactionType;
+    payee: Party;
+    payer: Party;
+    expiration: string;
+    // add more fields, if needed
+}
+
+export type QuoteResponse = {
+    transferAmount: Amount;
+    note?: string;
+    // add more fields, if needed
+};
+
 export type FxQuoteRequest = {
     conversionRequestId: string;
-    // todo: define the rest fields
+    // add more fields, if needed
 }
 
 export type FxQuoteBeResponse = {
     conversionTerms: {
         expiration: string;
     };
-    // todo: define the rest fields
+    // add more fields, if needed
 };

src/ilp.d.ts

@@ -875,13 +875,14 @@ declare namespace SDKStandardComponents {
         new (options: IlpOptions): IlpProcessor;
         version: keyof typeof Ilp.ILP_VERSIONS;
         calculateConditionFromFulfil(fulfilment: string): string;
-        calculateFulfil(transactionObject: ilp.TransactionObject | string): string
+        calculateFulfil(ilpPacket: string): string
         decodeIlpPacket(ilpPacket: string): ilp.IlpInputV1 | ilp.IlpInputV4;
         getFxQuoteResponseIlp(fxQuoteRequest: ilp.FxQuoteRequest, fxQuoteBeResponse: ilp.FxQuoteBeResponse): ilp.IlpResponse;
+        getQuoteResponseIlp(quoteRequest: ilp.QuoteRequest, quoteResponse: ilp.QuoteResponse): ilp.IlpResponse;
         getResponseIlp(transactionObject: ilp.TransactionObject): ilp.IlpResponse;
         getTransactionObject(ilpPacket: string): ilp.TransactionObject;
-        validateFulfil(fulfilment: string, condition: string): boolean
-        // add other public methods and define needed types
+        validateFulfil(fulfilment: string, condition: string): boolean;
+        validateIlpAgainstTransferRequest(transactionObject: ilp.TransactionObject): boolean;
     }
 
     type IlpOptions = {

src/index.d.ts

@@ -43,7 +43,7 @@ class IlpV4 extends IlpBase {
      * @returns {IlpResponse} - object containing the fulfilment, condition and ilp packet (v4)
      */
     getResponseIlp(transactionObject) {
-        const fulfilment = this.calculateFulfil(transactionObject);
+        const fulfilment = this.#calculateFulfilFromTransactionObject(transactionObject);
         const condition = super.calculateConditionFromFulfil(fulfilment);
         const ilpPacket = this.calculateIlpPacket(transactionObject, condition);
 
@@ -57,6 +57,17 @@ class IlpV4 extends IlpBase {
         return result;
     }
 
+    /**
+     * Calculates a fulfilment given a base64 encoded ilp packet
+     *
+     * @returns {string} - string containing base64 encoded fulfilment
+     */
+    calculateFulfil(base64EncodedPacket) {
+        const transactionObject = this.getTransactionObject(base64EncodedPacket);
+        const { fulfilment } = this.getResponseIlp(transactionObject);
+        return fulfilment;
+    }
+
     /**
      * @typedef {Object} IlpInputV4
      * @prop {String} amount - Transfer amount.
@@ -110,18 +121,6 @@ class IlpV4 extends IlpBase {
         return ILP_ADDRESS;
     }
 
-    /**
-     * Calculates a fulfilment given a transaction object and a secret
-     *
-     * @returns {string} - string containing base64 encoded fulfilment
-     */
-    calculateFulfil(transactionObject) {
-        const base64EncodedTransaction = Buffer.from(safeStringify(transactionObject)).toString('base64');
-        const encodedSecret = Buffer.from(this.secret).toString('base64');
-
-        return super._createHmac(base64EncodedTransaction, encodedSecret);
-    }
-
     calculateIlpPacket(transactionObject, condition) {
         const packetInput = this.makeQuotePacketInput(transactionObject, condition);
         const packet = ilpPacket.serializeIlpPrepare(packetInput);
@@ -138,6 +137,18 @@ class IlpV4 extends IlpBase {
         const binaryPacket = Buffer.from(inputIlpPacket, 'base64');
         return ilpPacket.deserializeIlpPrepare(binaryPacket);
     }
+
+    /**
+     * Calculates a fulfilment given a transaction object and a secret
+     *
+     * @returns {string} - string containing base64 encoded fulfilment
+     */
+    #calculateFulfilFromTransactionObject(transactionObject) {
+        const base64EncodedTransaction = Buffer.from(safeStringify(transactionObject)).toString('base64');
+        const encodedSecret = Buffer.from(this.secret).toString('base64');
+
+        return super._createHmac(base64EncodedTransaction, encodedSecret);
+    }
 }
 
 module.exports = IlpV4;

src/lib/ilp/IlpV4.js

@@ -101,6 +101,14 @@ describe('IlpV1 Tests -->', () => {
         expect(condition).toBeTruthy();
     });
 
+    test('should calculate fulfilment based on ilpPacket sting', () => {
+        const transactionObj = dto.transactionObjectDto(quoteRequest, partialResponse);
+        const ilpCombo = ilp.getResponseIlp(transactionObj);
+
+        const fulfilment = ilp.calculateFulfil(ilpCombo.ilpPacket);
+        expect(fulfilment).toBe(ilpCombo.fulfilment);
+    });
+
     describe('Ilp Packet Serialize tests -->', () => {
         const createIlpJson = (amount) => ({
             data: Buffer.from('data'),

test/unit/lib/ilp/IlpV1.test.js

@@ -134,6 +134,14 @@ describe('IlpV4 Tests -->', () => {
         expect(json).toBeTruthy();
     });
 
+    test('should calculate fulfilment based on ilpPacket sting', () => {
+        const transactionObj = dto.transactionObjectDto(quoteRequest, partialResponse);
+        const ilpCombo = ilp.getResponseIlp(transactionObj);
+
+        const fulfilment = ilp.calculateFulfil(ilpCombo.ilpPacket);
+        expect(fulfilment).toBe(ilpCombo.fulfilment);
+    });
+
     describe('Ilp Packet Serialize tests -->', () => {
         const createIlpJson = (amount) => ({
             amount,
@@ -197,7 +205,7 @@ describe('IlpV4 Tests -->', () => {
             expect(transaction.amount).toEqual(partialResponse.transferAmount);
         });
 
-        test('Should validate the transfer request against the decoded Ilp packet', () => {
+        test('should validate the transfer request against the decoded Ilp packet', () => {
             const validation = ilp.validateIlpAgainstTransferRequest(transferRequest);
             expect(validation).toBe(true);
         });