refactor: improve InvalidAddressError message format to be concise

re #1994
ecadlabs · May 10, 2023 · 3224083 · 3224083
1 parent 2b08fc9
commit 3224083
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 19 deletions.
diff --git a/packages/taquito-contracts-library/test/taquito-contracts-library.spec.ts b/packages/taquito-contracts-library/test/taquito-contracts-library.spec.ts
@@ -107,7 +107,7 @@ describe('ContractsLibrary tests', () => {
       })
     ).toThrow(
       expect.objectContaining({
-        message: expect.stringContaining(`Address "KTinvalid" is invalid`),
+        message: expect.stringContaining(`Invalid address "KTinvalid": Invalid prefix`),
       })
     );
   });

diff --git a/packages/taquito-core/src/errors.ts b/packages/taquito-core/src/errors.ts
@@ -54,8 +54,8 @@ export class InvalidAddressError extends ParameterValidationError {
   constructor(public address: string, errorDetail?: string) {
     super();
     this.name = 'InvalidAddressError';
-    this.message = `Address "${address}" is invalid`;
-    errorDetail ? (this.message += ` ${errorDetail}`) : null;
+    this.message = `Invalid address "${address}"`;
+    errorDetail ? (this.message += `${errorDetail}`) : null;
   }
 }
 

diff --git a/packages/taquito-core/test/errors.spec.ts b/packages/taquito-core/test/errors.spec.ts
@@ -93,7 +93,7 @@ describe('common error classes', () => {
     } catch (error) {
       expect(error).toBeInstanceOf(ParameterValidationError);
       expect(error).toBeInstanceOf(InvalidAddressError);
-      expect(error.message).toEqual(`Address "foo" is invalid`);
+      expect(error.message).toEqual(`Invalid address "foo"`);
     }
   });
 

diff --git a/packages/taquito-local-forging/src/codec.ts b/packages/taquito-local-forging/src/codec.ts
@@ -293,7 +293,7 @@ export const addressDecoder = (val: Uint8ArrayConsumer) => {
       return address;
     }
     default:
-      throw new InvalidAddressError(val.toString(), 'unable to decode');
+      throw new InvalidAddressError(val.toString(), ': Unable to decode.');
   }
 };
 

diff --git a/packages/taquito-sapling/src/taquito-sapling.ts b/packages/taquito-sapling/src/taquito-sapling.ts
@@ -278,11 +278,8 @@ export class SaplingToolkit {
       default: {
         throw new InvalidAddressError(
           destination,
-          `${invalidErrorDetail(
-            ValidationResult.NO_PREFIX_MATCHED
-          )}, expecting one of the following prefix '${Prefix.TZ1}', '${Prefix.TZ2}' or '${
-            Prefix.TZ3
-          }'.`
+          invalidErrorDetail(ValidationResult.NO_PREFIX_MATCHED) +
+            ` expecting one of the following prefix '${Prefix.TZ1}', '${Prefix.TZ2}' or '${Prefix.TZ3}'.`
         );
       }
     }

diff --git a/packages/taquito-sapling/test/taquito-sapling.spec.ts b/packages/taquito-sapling/test/taquito-sapling.spec.ts
@@ -265,7 +265,7 @@ describe('SaplingToolkit', () => {
         },
       ])
     ).rejects.toThrowError(
-      `Address "tz1awHvfqEVsmNpXtLsLoHcjLk9HaXkzHf7Z" is invalid wtih invalid prefix expecting prefix zet1.`
+      `Invalid address "tz1awHvfqEVsmNpXtLsLoHcjLk9HaXkzHf7Z": Invalid prefix expecting prefix zet1.`
     );
 
     done();
@@ -654,7 +654,7 @@ describe('SaplingToolkit', () => {
         },
       ])
     ).rejects.toThrowError(
-      `Address "tz2V17qQHTuQ3GJLu5bmPQDJTLDVwiWCrYFh" is invalid wtih invalid prefix expecting prefix zet1`
+      `Invalid address "tz2V17qQHTuQ3GJLu5bmPQDJTLDVwiWCrYFh": Invalid prefix expecting prefix zet1`
     );
 
     done();

diff --git a/packages/taquito-utils/src/validators.ts b/packages/taquito-utils/src/validators.ts
@@ -248,16 +248,12 @@ export function validateSpendingKey(value: any): ValidationResult {
 export function invalidErrorDetail(validation: ValidationResult): string {
   switch (validation) {
     case ValidationResult.NO_PREFIX_MATCHED:
-      return 'wtih invalid prefix';
-      break;
+      return ': Invalid prefix';
     case ValidationResult.INVALID_CHECKSUM:
-      return 'wtih invalid checksum';
-      break;
+      return ': Checksum failed';
     case ValidationResult.INVALID_LENGTH:
-      return 'with invalid length';
-      break;
+      return ': Invalid length';
     default:
       return '';
-      break;
   }
 }