feat: added phone number parser

nimiq · Oct 24, 2024 · 9533950 · 9533950
1 parent d0fbade
commit 9533950
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 12 deletions.
diff --git a/src/lib/RequestParser.js b/src/lib/RequestParser.js
@@ -158,10 +158,10 @@ class RequestParser { // eslint-disable-line no-unused-vars
             throw new Errors.InvalidRequestError('Data must not exceed 64 bytes');
         }
         if (flags === Nimiq.Transaction.Flag.CONTRACT_CREATION
-                && data.byteLength !== 78 // HTLC
-                && data.byteLength !== 24 // Vesting
-                && data.byteLength !== 36 // Vesting
-                && data.byteLength !== 44) { // Vesting
+            && data.byteLength !== 78 // HTLC
+            && data.byteLength !== 24 // Vesting
+            && data.byteLength !== 36 // Vesting
+            && data.byteLength !== 44) { // Vesting
             throw new Errors.InvalidRequestError(
                 'Contract creation data must be 78 bytes for HTLC and 24, 36, or 44 bytes for vesting contracts',
             );
@@ -359,4 +359,45 @@ class RequestParser { // eslint-disable-line no-unused-vars
         }
         return parsedUrl;
     }
+
+    /**
+     * Parses and validates a phone number.
+     * @param {string} phoneNumber - The phone number to parse. Should be in E.164 format.
+     * @param {object} [options] - Parsing options
+     * @param {boolean} [options.required] - Whether the phone number is required
+     * @param {string[]} [options.expectedCountryCodes] - Allowed country codes.
+     * @returns {string|undefined} - The formatted phone number or undefined
+     */
+    parsePhoneNumber(phoneNumber, options = {}) {
+        const { required = false, expectedCountryCodes = [] } = options;
+
+        if (phoneNumber === undefined && !required) return undefined;
+
+        if (typeof phoneNumber !== 'string') {
+            throw new Errors.InvalidRequestError('The phone number must be a string');
+        }
+
+        // If it contains spaces, it's not a valid number
+        if (phoneNumber.includes(' ')) {
+            throw new Errors.InvalidRequestError('The phone number must not contain spaces');
+        }
+
+        // Remove all non-digit characters
+        const digitsOnly = phoneNumber.replace(/\D/g, '');
+
+        // Check if the number has a valid length (assuming international format)
+        if (digitsOnly.length < 7 || digitsOnly.length > 15) {
+            throw new Errors.InvalidRequestError('The phone number has an invalid length');
+        }
+
+        if (expectedCountryCodes.length > 0) {
+            const hasValidCountryCode = expectedCountryCodes.some(countryCode => phoneNumber.startsWith(countryCode));
+            if (!hasValidCountryCode) {
+                throw new Errors.InvalidRequestError('The phone number has an invalid country code');
+            }
+        }
+
+        // Format the number (simple E.164 format)
+        return `+${digitsOnly}`;
+    }
 }
diff --git a/src/request/sign-swap/SignSwapApi.js b/src/request/sign-swap/SignSwapApi.js
@@ -367,9 +367,9 @@ class SignSwapApi extends PolygonRequestParserMixin(BitcoinRequestParserMixin(To
              *     | PolygonRedeemDescription
              *     | PolygonRedeemWithSecretInDataDescription}
              */ (usdcHtlcContract.interface.parseTransaction({
-                data: forwardRequest.data,
-                value: forwardRequest.value,
-            }));
+            data: forwardRequest.data,
+            value: forwardRequest.value,
+        }));
 
         if (!allowedMethods.includes(description.name)) {
             throw new Errors.InvalidRequestError('Requested Polygon contract method is invalid');
@@ -459,10 +459,9 @@ class SignSwapApi extends PolygonRequestParserMixin(BitcoinRequestParserMixin(To
                 const settlement = {
                     type: 'sinpemovil',
                     phoneNumber: /** @type {string} */ (
-                        this.parseLabel(
-                            /** @type {{phoneNumber: unknown}} */(obj).phoneNumber,
-                            false,
-                            `${parameterName}.phoneNumber`,
+                        this.parsePhoneNumber(
+                            /** @type {{phoneNumber: string}} */(obj).phoneNumber,
+                            { expectedCountryCodes: ['+506'] },
                         )
                     ),
                 };
@@ -481,7 +480,7 @@ class SignSwapApi extends PolygonRequestParserMixin(BitcoinRequestParserMixin(To
         if (!Iban.isValid(iban)) {
             throw new Errors.InvalidRequestError(`${parameterName} is not a valid IBAN`);
         }
-        return Iban.printFormat(/** @type {string} */ (iban), ' ');
+        return Iban.printFormat(/** @type {string} */(iban), ' ');
     }
 
     get Handler() {