Feat/XRPL connector v2

.gitignore

@@ -3,6 +3,7 @@
 /dist
 /db
 /.idea
+/*.iml
 package-lock.json
 /certs
 /coverage
@@ -13,4 +14,4 @@ package-lock.json
 
 # VSCode
 .vscode/
-.history
+.history

docs/swagger/definitions.yml

@@ -35,7 +35,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
 
   NonceResponse:
     type: 'object'
@@ -70,7 +70,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
 
   AllowancesResponse:
     type: 'object'
@@ -189,7 +189,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
 
   ApproveResponse:
     type: 'object'
@@ -243,7 +243,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
 
   PollResponse:
     type: 'object'
@@ -328,7 +328,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
 
   PriceResponse:
     type: 'object'
@@ -418,7 +418,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       connector:
         type: 'string'
         example: 'uniswap'
@@ -496,7 +496,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
 
   CancelResponse:
     type: 'object'
@@ -518,32 +518,19 @@ definitions:
         type: 'string'
         example: '0xa321bbe8888c3bc88ecb1ad4f03f22a71e6f5715dfcb19e0a2dca9036c981b6d'  # noqa: documentation
 
-  AddWalletRequest:
+  GetWalletRequest:
     type: 'object'
     required:
-      - 'chainName'
-      - 'privateKey'
-    properties:
-      chainName:
-        type: 'string'
-        example: 'ethereum'
-      privateKey:
-        type: 'string'
-        example: '6078d949c953351685fd2026646028f2a862e6148d25d504967ba63898d720c0'  # noqa: documentation
-
-  RemoveWalletRequest:
-    type: 'object'
-    required:
-      - 'chainName'
-      - 'address'
+      - 'chain'
+      - 'network'
     properties:
-      chainName:
+      chain:
         type: 'string'
         example: 'ethereum'
-      address:
+      network:
         type: 'string'
-        example: '0xd0A1E359811322d97991E03f863a0C30C2cF029C'
-
+        example: 'testnet'
+        
   GetWalletResponse:
     type: 'object'
     required:
@@ -639,7 +626,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       connector:
         type: 'string'
         example: 'uniswap'
@@ -715,7 +702,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       connector:
         type: 'string'
         example: 'uniswapLP'
@@ -735,7 +722,7 @@ definitions:
     properties:
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       timestamp:
         type: 'integer'
         example: 1636368085740
@@ -781,7 +768,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       connector:
         type: 'string'
         example: 'uniswapLP'
@@ -800,7 +787,7 @@ definitions:
     properties:
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       timestamp:
         type: 'integer'
         example: 1636368085740
@@ -843,7 +830,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       connector:
         type: 'string'
         example: 'uniswapLP'
@@ -862,7 +849,7 @@ definitions:
     properties:
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       timestamp:
         type: 'integer'
         example: 1636368085740
@@ -897,7 +884,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       connector:
         type: 'string'
         example: 'uniswapLP'
@@ -920,7 +907,7 @@ definitions:
     properties:
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       timestamp:
         type: 'integer'
         example: 1636368085740
@@ -984,7 +971,7 @@ definitions:
         example: 'ethereum'
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       connector:
         type: 'string'
         example: 'uniswapLP'
@@ -1002,7 +989,7 @@ definitions:
     properties:
       network:
         type: 'string'
-        example: 'goerli'
+        example: 'kovan'
       timestamp:
         type: 'integer'
         example: 1636368085740

docs/swagger/wallet-routes.yml

@@ -7,6 +7,12 @@ paths:
       operationId: 'get'
       produces:
         - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          required: true
+          schema:
+            $ref: '#/definitions/GetWalletRequest'
       responses:
         '200':
           description: 'Wallet list'
@@ -27,7 +33,11 @@ paths:
           required: true
           schema:
             $ref: '#/definitions/AddWalletRequest'
-      responses: '200'
+      responses:
+        '200':
+          description: 'Added wallet address'
+          schema:
+            $ref: '#/definitions/AddWalletResponse'
 
   /wallet/remove:
     delete:

docs/swagger/xrpl-routes.yml

@@ -0,0 +1,65 @@
+paths:
+  /xrpl:
+    get:
+      tags:
+        - 'xrpl'
+      summary: 'View the XRPL network and RPC URL that gateway is configured to use'
+      description: 'The user can change this by editing src/chains/xrpl/xrpl.config.ts'
+      operationId: 'root'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          required: true
+          schema:
+            $ref: '#/definitions/XRPLConfigRequest'
+      responses:
+        '200':
+          description: 'XRPL config'
+          schema:
+            $ref: '#/definitions/XRPLConfigResponse'
+
+  /xrpl/balances:
+    get:
+      tags:
+        - 'xrpl'
+      summary: 'Get the balances of an XRPL secret key'
+      operationId: 'balances'
+      consumes:
+        - 'application/json'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          required: true
+          schema:
+            $ref: '#/definitions/XRPLBalancesRequest'
+      responses:
+        '200':
+          description: 'XRPL wallet balances'
+          schema:
+            $ref: '#/definitions/XRPLBalancesResponse'
+
+  /xrpl/poll:
+    get:
+      tags:
+        - 'xrpl'
+      summary: 'Get transaction details from transaction hash'
+      operationId: 'poll'
+      consumes:
+        - 'application/json'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          required: true
+          schema:
+            $ref: '#/definitions/XRPLPollRequest'
+      responses:
+        '200':
+          description: 'XRPL transaction details'
+          schema:
+            $ref: '#/definitions/XRPLPollResponse'

package.json

@@ -77,6 +77,7 @@
     "express": "^4.17.1",
     "express-winston": "^4.1.0",
     "fs-extra": "^10.0.0",
+    "http-status-codes": "^2.2.0",
     "js-yaml": "^4.1.0",
     "level": "^8.0.0",
     "lodash": "^4.17.21",
@@ -95,6 +96,7 @@
     "winston": "^3.3.3",
     "winston-daily-rotate-file": "^4.5.5",
     "xsswap-sdk": "^1.0.1",
+    "xrpl": "^2.7.0",
     "yarn": "^1.22.17"
   },
   "devDependencies": {

src/app.ts

@@ -119,7 +119,7 @@ export const startGateway = async () => {
       Math.random().toString(16).substr(2, 14)
     );
   }
-  logger.info(`Gateway Version: ${gateway_version}`) // display gateway version
+  logger.info(`Gateway Version: ${gateway_version}`); // display gateway version
   logger.info(`⚡️ Starting Gateway API on port ${port}...`);
   if (ConfigManagerV2.getInstance().get('server.unsafeDevModeWithHTTP')) {
     logger.info('Running in UNSAFE HTTP! This could expose private keys.');

src/chains/xrpl/xrpl-middlewares.ts

@@ -0,0 +1,24 @@
+import { HttpException } from '../../services/error-handler';
+import { XRPL } from './xrpl';
+import { NextFunction, Request, Response } from 'express';
+
+export const verifyXRPLIsAvailable = async (
+  req: Request,
+  _res: Response,
+  next: NextFunction
+) => {
+  if (!req || !req.body || !req.body.network) {
+    throw new HttpException(404, 'No XRPL network informed.');
+  }
+
+  const xrpl = await XRPL.getInstance(req.body.network);
+  if (!xrpl.ready) {
+    await xrpl.init();
+  }
+
+  if (!xrpl.isConnected()) {
+    await xrpl.client.connect();
+  }
+
+  return next();
+};