Process pegout rejection reasons

In order to show a more descriptive error in the app.

src/__tests__/unit/services/pegout-data.processor.unit.ts

@@ -796,7 +796,6 @@ describe('Service: PegoutDataProcessor', () => {
       valueRequestedInSatoshis: 0,
       valueInSatoshisToBeReceived: 0,
       feeInSatoshisToBePaid: 0,
-      reason: '',
       btcRawTxInputsHash: '',
       getId: function (): string {
         return '';

src/models/pegout-status.model.ts

@@ -1,5 +1,5 @@
 import {Model, model, property} from '@loopback/repository';
-import { PegoutStatuses } from './rsk/pegout-status-data-model';
+import { PegoutStatuses, RejectedPegoutReason } from './rsk/pegout-status-data-model';
 
 @model()
 export class PegoutStatus extends Model {
@@ -51,6 +51,11 @@ export class PegoutStatus extends Model {
   })
   btcTxId?: string;
 
+  @property({
+    type: 'string',
+  })
+  reason?: RejectedPegoutReason;
+
 
   constructor(data: Partial<PegoutStatus> = {}) {
     super();

src/models/rsk/pegout-status-data-model.ts

@@ -13,6 +13,14 @@ export enum PegoutStatuses {
   RELEASE_BTC = 'RELEASE_BTC'
 }
 
+export const RejectedPegoutReasons = {
+  '1': 'LOW_AMOUNT',
+  '2': 'CALLER_CONTRACT',
+  '3': 'FEE_ABOVE_VALUE',
+} as const;
+
+export type RejectedPegoutReason = (typeof RejectedPegoutReasons)[keyof typeof RejectedPegoutReasons];
+
 export interface PegoutStatusDataModel {
   originatingRskTxHash: string;
   rskTxHash: string;
@@ -23,6 +31,7 @@ export interface PegoutStatusDataModel {
   feeInSatoshisToBePaid: number;
   status: PegoutStatuses;
   btcRawTransaction: string;
+  reason?: RejectedPegoutReason;
 }
 
 export class PegoutStatusAppDataModel implements PegoutStatusDataModel{
@@ -61,13 +70,15 @@ export class PegoutStatusAppDataModel implements PegoutStatusDataModel{
       rskSenderAddress,
       valueRequestedInSatoshis,
       status,
+      reason,
     } = model;
     return new PegoutStatusAppDataModel({
       originatingRskTxHash,
       rskTxHash,
       rskSenderAddress,
       valueRequestedInSatoshis,
       status,
+      reason,
     });
   }
   rskTxHash: string;
@@ -80,6 +91,7 @@ export class PegoutStatusAppDataModel implements PegoutStatusDataModel{
   btcRawTransaction: string;
   originatingRskTxHash: string;
   createdOn: Date;
+  reason?: RejectedPegoutReason;
 }
 
 export class PegoutStatusDbDataModel implements SearchableModel, PegoutStatusDataModel {
@@ -99,7 +111,7 @@ export class PegoutStatusDbDataModel implements SearchableModel, PegoutStatusDat
   valueRequestedInSatoshis: number;
   valueInSatoshisToBeReceived: number;
   feeInSatoshisToBePaid: number;
-  reason: string;
+  reason?: RejectedPegoutReason;
   btcRawTxInputsHash: string;
   batchPegoutIndex: number;
   batchPegoutRskTxHash: string;

src/services/pegout-status-data-services/pegout-status-mongo.service.ts

@@ -31,6 +31,7 @@ const PegoutStatusSchema = new mongoose.Schema({
   batchPegoutRskTxHash: {type: String},
   changedByEvent: {type: String},
   updatedAt: {type: Date},
+  reason: {type: String},
 });
 
 const PegoutStatusConnector = mongoose.model<PegoutStatusMongoModel>("PegoutStatus", PegoutStatusSchema);

src/services/pegout-status/pegout-status-builder.ts

@@ -1,8 +1,9 @@
 import ExtendedBridgeTx from '../extended-bridge-tx';
-import { PegoutStatuses, PegoutStatusDbDataModel } from '../../models/rsk/pegout-status-data-model';
+import { PegoutStatuses, PegoutStatusDbDataModel, RejectedPegoutReasons } from '../../models/rsk/pegout-status-data-model';
 import { BRIDGE_EVENTS } from '../../utils/bridge-utils';
 import { BtcAddressUtils } from '../../utils/btc-utils';
 import {ExtendedBridgeEvent} from "../../models/types/bridge-transaction-parser";
+import { isAvailable } from '../../utils/ts-utils';
 
 export class PegoutStatusBuilder {
 
@@ -36,9 +37,7 @@ export class PegoutStatusBuilder {
         const events: ExtendedBridgeEvent[] = extendedBridgeTx.events as ExtendedBridgeEvent[];
         const releaseRequestRejectedEvent: ExtendedBridgeEvent = events.find(event => event.name === BRIDGE_EVENTS.RELEASE_REQUEST_REJECTED)!;
 
-        const rskSenderAddress = <string> releaseRequestRejectedEvent!.arguments.sender;
-        const amount = <number> releaseRequestRejectedEvent.arguments!.amount;
-        const reason = <string> releaseRequestRejectedEvent.arguments!.reason;
+        const {sender: rskSenderAddress, amount, reason} = releaseRequestRejectedEvent.arguments;
 
         const status: PegoutStatusDbDataModel = new PegoutStatusDbDataModel();
 
@@ -48,7 +47,9 @@ export class PegoutStatusBuilder {
         status.rskBlockHeight = extendedBridgeTx.blockNumber;
         status.rskSenderAddress = rskSenderAddress;
         status.valueRequestedInSatoshis = amount;
-        status.reason = reason;
+        if (isAvailable(RejectedPegoutReasons, reason)) {
+            status.reason = RejectedPegoutReasons[reason];
+        }
         status.originatingRskBlockHeight = extendedBridgeTx.blockNumber;
         status.status = PegoutStatuses.REJECTED;
         status.isNewestStatus = true;

src/services/pegout-status/pegout-status.service.ts

@@ -125,6 +125,7 @@ export class PegoutStatusService {
             feeInSatoshisToBePaid,
             status,
             btcRawTransaction,
+            reason,
           } = model;
           return new PegoutStatus({
             originatingRskTxHash,
@@ -136,6 +137,7 @@ export class PegoutStatusService {
             feeInSatoshisToBePaid,
             status,
             btcTxId: btcRawTransaction ? this.btcUtils.getBtcTxIdFromRawTransaction(btcRawTransaction) : undefined,
+            reason,
           });
     }
 

src/utils/ts-utils.ts

@@ -0,0 +1,6 @@
+export function isAvailable<Obj extends object>(
+  obj: Obj,
+  key: PropertyKey,
+): key is keyof Obj {
+  return key in obj;
+}