refactor(RelayServer): isCustom handler

rsksmart · Jun 6, 2024 · 1f9baa0 · 1f9baa0
1 parent cd74baa
commit 1f9baa0
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 5 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/RelayServer.ts b/src/RelayServer.ts
@@ -447,16 +447,26 @@ export class RelayServer extends EventEmitter {
       `EnvelopingRequest:${JSON.stringify(envelopingRequest, undefined, 4)}`
     );
 
+    this.validateInputTypes(envelopingRequest);
+
+    const {
+      relayRequest,
+      metadata: { isCustom },
+    } = envelopingRequest;
+
     const initialGasEstimation = await estimateRelayMaxPossibleGas(
       envelopingRequest,
-      this.workerAddress
+      this.workerAddress,
+      {
+        isCustom,
+      }
     );
     log.debug(
       `Gas estimation before fees:  ${initialGasEstimation.toString()}`
     );
 
     const fee = await calculateFee(
-      envelopingRequest.relayRequest,
+      relayRequest,
       initialGasEstimation,
       this.config.app
     );
@@ -472,7 +482,7 @@ export class RelayServer extends EventEmitter {
     );
 
     const conversionResult = await convertGasToTokenAndNative(
-      envelopingRequest.relayRequest,
+      relayRequest,
       maxPossibleGas
     );
     log.debug(

diff --git a/src/Utils.ts b/src/Utils.ts
@@ -148,6 +148,7 @@ export const deployTransactionRequestShape = {
     relayHubAddress: ow.string,
     relayMaxNonce: ow.number,
     signature: ow.string,
+    isCustom: ow.optional.boolean,
   },
 };
 
@@ -178,5 +179,6 @@ export const relayTransactionRequestShape = {
     relayHubAddress: ow.string,
     relayMaxNonce: ow.number,
     signature: ow.string,
+    isCustom: ow.optional.boolean,
   },
 };
diff --git a/src/definitions/httpEnvelopingRequest.type.ts b/src/definitions/httpEnvelopingRequest.type.ts
@@ -18,6 +18,7 @@ export declare type EnvelopingMetadata = {
   relayHubAddress: RelayRequestBody['relayHub'];
   relayMaxNonce: number;
   signature: string;
+  isCustom?: boolean;
 };
 
 export declare type EnvelopingRequestData = {

diff --git a/test/unit/RelayServer.test.ts b/test/unit/RelayServer.test.ts
@@ -209,6 +209,7 @@ describe('RelayServer tests', function () {
   describe('Function estimateMaxPossibleGas()', function () {
     it('should return only the initial estimation when there are no additional fees', async function () {
       sinon.stub(relayServerUtils, 'calculateFee').resolves(BigNumberJs(0));
+      sinon.stub(relayServer, 'validateInputTypes').returns();
 
       const maxPossibleGasEstimation = await relayServer.estimateMaxPossibleGas(
         {
@@ -220,6 +221,7 @@ describe('RelayServer tests', function () {
               gasPrice: GAS_PRICE,
             },
           },
+          metadata: {},
         } as HttpEnvelopingRequest
       );
 
@@ -232,6 +234,7 @@ describe('RelayServer tests', function () {
       sinon
         .stub(relayServerUtils, 'calculateFee')
         .resolves(BigNumberJs(FAKE_FEE_AMOUNT));
+      sinon.stub(relayServer, 'validateInputTypes').returns();
 
       const maxPossibleGasEstimation = await relayServer.estimateMaxPossibleGas(
         {
@@ -243,6 +246,7 @@ describe('RelayServer tests', function () {
               gasPrice: GAS_PRICE,
             },
           },
+          metadata: {},
         } as HttpEnvelopingRequest
       );
 
@@ -311,6 +315,8 @@ describe('RelayServer tests', function () {
         .stub(relayServerUtils, 'calculateFee')
         .resolves(BigNumberJs(FAKE_FEE_AMOUNT));
 
+      sinon.stub(relayServer, 'validateInputTypes').returns();
+
       const estimatedGas = await relayServer.estimateMaxPossibleGas({
         relayRequest: {
           request: {
@@ -320,6 +326,7 @@ describe('RelayServer tests', function () {
             gasPrice: GAS_PRICE,
           },
         },
+        metadata: {},
       } as HttpEnvelopingRequest);
 
       const { maxPossibleGasWithFee } = await relayServer.getMaxPossibleGas({
@@ -331,6 +338,7 @@ describe('RelayServer tests', function () {
             gasPrice: GAS_PRICE,
           },
         },
+        metadata: {},
       } as HttpEnvelopingRequest);
 
       expect(estimatedGas.estimation.toString()).to.be.eq(