1993 consolidating duplicate errors #2463

hui-an-yang · 2023-05-03T16:22:50Z

closes #1993

Thank you for your contribution to Taquito.

Before submitting this PR, please make sure:

Your code builds cleanly without any errors or warnings
You have run the linter against the changes
You have added unit tests (if relevant/appropriate)
You have added integration tests (if relevant/appropriate)
All public methods or types have TypeDoc coverage with a complete description, and ideally an @example
You have added or updated corresponding documentation
If relevant, you have written a first draft summary describing the change for inclusion in Release Notes.

In this PR, please also make sure:

You have linked this PR to the issue by putting closes #TICKETNUMBER in the description box (when applicable)
You have added a concise description on your changes

Release Note Draft Snippet

If relevant, please write a summary of your change that will be suitable for
inclusion in the Release Notes for the next Taquito release.

Consolidated common error classes InvalidAddressError , InvalidBlockHashError , InvalidDerivationPathError , InvalidHexStringError , InvalidMessageError , and InvalidViewParameterError , into @taquito/core package

re #1993

…some style patches re #1993

re #1993

github-actions · 2023-05-03T16:28:22Z

New packages have been deployed to the preview repository at https://npm.preview.tezostaquito.io/.

Published packages:

npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/

re #1993

dsawali · 2023-05-03T22:49:19Z

packages/taquito-contracts-library/package.json

@@ -68,6 +68,7 @@
    ]
  },
  "dependencies": {
+    "@taquito/core": "^16.1.2-beta-RC.0",


I think master is already at 16.1.2, could you merge master into this branch for the latest versions?

dsawali · 2023-05-03T22:58:22Z

packages/taquito/src/contract/rpc-contract-provider.ts

@@ -421,10 +421,10 @@ export class RpcContractProvider
   */
  async transferTicket(params: TransferTicketParams) {
    if (validateAddress(params.destination) !== ValidationResult.VALID) {
-      throw new InvalidAddressError(params.destination, 'param destination');
+      throw new InvalidAddressError(params.destination, 'params destination');


I notice the errorDetail param being passed as params destination

How would the error message look like when an errorDetail is passed?

for now Address "${address}" is invalid. params destination
I understand it's not ideal, am looking to make it Address "${address}" is invalid. "INVALID_CHECKSUM" found in transferTicket params destination
Will need a bigger undertaking to show why it's invalid, thinking to do that in task3

personally I find the params destination bit could be a bit misleading if people don't know which part of the code throws it. I think we can omit it for now. What do you think?

Will this help? Address "${address}" is invalid. in transferTicket params destination?
Was added there cuz the params can have InvalidAddressError with params source or destination
But I don't mind omit it for now to revisit them in task3

I think displaying the PKH is clear enough to pinpoint which parameter field was invalid.

And in cases where both source and destination are the same, the errorDetail would be a bit redundant.

they're all removed

…1993-consolidating-duplicate-errors

…sError

…1993-consolidating-duplicate-errors

* 1992 create high level error categories (#2452) * build: created new package @taquito/core re #1992 * feat: added high-level error categories with unit tests re #1992 * build: new package-lock.json with @taquito-core for ci * build: updated a file name and adjusted build order * test: rename test file * chore: bump @taquito/core version to 16.1.2 * 1993 consolidating duplicate errors (#2463) * refactor: consolidated InvalidAddressError into @taquito/core re #1993 * refactor: consolidated InvalidBlockHashError into @taquito/core re #1993 * refactor: consolidated InvalidDerivationPathError into @taquito/core re #1993 * refactor: added InvalidDerivationPathError unit test in @taquito/core re #1993 * refactor: consolidated InvalidHexStringError in to @taquito/core and some style patches re #1993 * refactor: consolidated InvalidMessageError into @taquito/core re #1993 * refactor: consolidated InvalidViewParameterError into @taquito/core re #1993 * refactor: improve InvalidViewParameterError in @taquito/core re #1993 * refactor: removed tailling params destination/source in InvalidAddressError * 1994 @taquito utils error improvement (#2475) * refactor: consolidate InvalidKeyError inot @taquito/core and improve across packages BREAKING CHANGE: Class SaplingToolkit function prepareUnshieldedTransaction used to throw InvalidKeyError now throw a InvalidAddressError instead re #1994 * refactor: consolidate InvalidPublicKey into @taquito/core and improve across packages re #1994 * refactor: consolidate InvalidSignatureError into @taquito/core and improve across packages re #1994 * refactor: minor update of the improved error classes re #1994 * refactor: consolidate InvalidcontractAddressError into @taquito/core and improve across packages re #1994 * refactor: consolidate InvalidChainIdError into @taquito/core and improve across packages re #1994 * refactor: consolidate InvalidKeyHashError into @taquito/core and improve across packages re #1994 * refactor: minor update for InvalidKeyHashError re #1994 * refactor: consolidate InvalidOperationHashError into @taquito/core and improve across packages re #1994 * refactor: consolidate InvalidOperationKindError into @taquito/core and improve across packages re #1994 * refactor: consolidate DeprecationError into @taquito/core re #1994 * refactor: consolidate ProhibitedActionError into @taquito/core re #1994 * refactor: imporve InvalidProtocolHashError and ValueConversionError in @taquito/utils re #1994 * refactor: added unit tests for error classes in @taquito/core re #1994 * refactor: consolidate ValidationResult into @taquito/core re #1994 * refactor: improve InvalidAddressError to show validation result in errorDetail BREAKING CHANGE: 1. In @taquito/rpc when validateContractAddress used to throw InvalidAddressError will now throw InvalidContractAddressError. 2. In @taquito/sapling prepareUnshieldedTransaction function when validateDestinationImplicitAddress used to throw InvalidAddressError now throw InvalidKeyHashError re #1994 * refactor: improve InvalidAddressError message format to be concise re #1994 * refactor: improve InvalidBlockHashError message format to be concise re #1994 * refactor: improve InvalidDerivationPathError message format to be consistent re #1994 * refactor: improve InvalidHexStringError message format re #1994 * refactor: improve InvalidMessageError message format re #1994 * refactor: improve InvalidViewParameterError message format re #1994 * refactor: improve InvalidKeyError message format re #1994 * refactor: improve teh rest of common error classes message format * refactor: replaced deprecated substr with substring across packages * refactor: moved validationResult back to @taquito/core * refactor: addressed pr comments of wording and naming * 1994 taquito local forging error improvement (#2486) * refactor: update file name of error.ts to errors.ts for consistency * refactor: improve InvalidOperationSchemaError * refactor: improve OversizedEntryPointError * refactor: improve InvalidBallotValueError * refactor: improve DecodeBallotValueError * refactor: imrpove UnexpectedMichelsonValueError * refactor: improve OperationDecodingError * refactor: imporve OperationEncodingError * refactor: imrpove UnsupportedOperationError * refactor: improve DecodePvmKindError * refactor: improve InvalidSmartRollupAddressError * refactor: improve InvalidSmartRollupCommitmentHashError and DecodePvmKindError BREAKING CHANGE: 1. In @taquito/local-forging smartRollupAddressDecoder used to throw InvalidAddressError now throw invalidContractAddressErro 2. In @taquito/local-forging used to have class InvalidSmartRollupContractAddressError now is InvalidSmartRollupCommitmentHashError 3. In @taquito/local-forging function smartRollupContractAddressEncoder rename to smartRollupCommitmentHashEncoder * 1994 taquito signer error improvement (#2490) * refactor: imrpove InvalidMnemonicError * refactor: improve InvalidBitSize and InvalidCurveError * refactor: imporve InvalidSeedLengthError * refactor: replace PrivateKeyError with InvalidKeyError from @taquito/core and improve InvalidKeyErro BREAKING CHANGE: PrivateKeyError is replaced by common error InvalidKeyError from @taquito/core * refactor: imrpove ToBeImplemented * docs: added typedoc of InvalidSeedLengthError and ToBeImplemented * refactor: imporve InvalidPassphraseError * chore: updated pack-lock.json * fix: fix overlooked merge conflicts * chore: updated package-lock.json and keep bip39 v3.0.4

hui-an-yang added 7 commits May 2, 2023 23:47

refactor: consolidated InvalidAddressError into @taquito/core

cacfc91

re #1993

refactor: consolidated InvalidBlockHashError into @taquito/core

96e3af7

re #1993

refactor: consolidated InvalidDerivationPathError into @taquito/core

250ccb4

re #1993

refactor: added InvalidDerivationPathError unit test in @taquito/core

5a8d3a6

re #1993

refactor: consolidated InvalidHexStringError in to @taquito/core and …

72cf4be

…some style patches re #1993

refactor: consolidated InvalidMessageError into @taquito/core

2314b28

re #1993

refactor: consolidated InvalidViewParameterError into @taquito/core

990c115

re #1993

refactor: improve InvalidViewParameterError in @taquito/core

25b994e

re #1993

hui-an-yang requested review from dsawali, ac10n and zainen May 3, 2023 18:06

hui-an-yang marked this pull request as ready for review May 3, 2023 18:07

hui-an-yang self-assigned this May 3, 2023

hui-an-yang linked an issue May 3, 2023 that may be closed by this pull request

Consolidate duplicated Errors across packages #1993

Closed

dsawali reviewed May 3, 2023

View reviewed changes

hui-an-yang added 3 commits May 4, 2023 10:10

Merge branch 'error-improvement' of github.com:ecadlabs/taquito into …

c8342a3

…1993-consolidating-duplicate-errors

Merge branch 'error-improvement' of github.com:ecadlabs/taquito into …

b07efd0

…1993-consolidating-duplicate-errors

refactor: removed tailling params destination/source in InvalidAddres…

c3bad68

…sError

hui-an-yang requested a review from dsawali May 4, 2023 17:58

Merge branch 'error-improvement' of github.com:ecadlabs/taquito into …

9143207

…1993-consolidating-duplicate-errors

dsawali approved these changes May 5, 2023

View reviewed changes

hui-an-yang merged commit 282ec7d into error-improvement May 5, 2023

hui-an-yang deleted the 1993-consolidating-duplicate-errors branch May 5, 2023 20:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1993 consolidating duplicate errors #2463

1993 consolidating duplicate errors #2463

hui-an-yang commented May 3, 2023 •

edited

Loading

github-actions bot commented May 3, 2023 •

edited

Loading

dsawali May 3, 2023

hui-an-yang May 3, 2023

dsawali May 3, 2023

hui-an-yang May 3, 2023

dsawali May 3, 2023

hui-an-yang May 3, 2023

dsawali May 5, 2023

hui-an-yang May 5, 2023

1993 consolidating duplicate errors #2463

1993 consolidating duplicate errors #2463

Conversation

hui-an-yang commented May 3, 2023 • edited Loading

Release Note Draft Snippet

github-actions bot commented May 3, 2023 • edited Loading

Published packages:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hui-an-yang commented May 3, 2023 •

edited

Loading

github-actions bot commented May 3, 2023 •

edited

Loading