Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

1994 @taquito utils error improvement #2475

Merged
merged 27 commits into from
May 12, 2023
Merged

1994 @taquito utils error improvement #2475

merged 27 commits into from
May 12, 2023

Conversation

hui-an-yang
Copy link
Collaborator

@hui-an-yang hui-an-yang commented May 8, 2023 •
edited
Loading

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.

Improved error classes from @taquito/utils by having a consistent format and concise error message. Most have been consolidated into @taquito/core as common error classes. Also, replaced the deprecated substr String function use with substring.

@hui-an-yang
Merge branch 'error-improvement' of github.com:ecadlabs/taquito into …
7409577 
…error-improvement
@hui-an-yang
refactor: consolidate InvalidKeyError inot @taquito/core and improve …
7c57f97 
…across packages

BREAKING CHANGE: Class SaplingToolkit function prepareUnshieldedTransaction used to throw
InvalidKeyError now throw a InvalidAddressError instead

re #1994
@github-actions
Copy link

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

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/

@hui-an-yang
refactor: consolidate InvalidPublicKey into @taquito/core and improve…
c77cef0 
… across packages

re #1994
@hui-an-yang
refactor: consolidate InvalidSignatureError into @taquito/core and im…
eca9d41 
…prove across packages

re #1994
@hui-an-yang
refactor: minor update of the improved error classes
e7f372d 
re #1994
@hui-an-yang
refactor: consolidate InvalidcontractAddressError into @taquito/core …
7b3432e 
…and improve across packages

re #1994
@hui-an-yang
refactor: consolidate InvalidChainIdError into @taquito/core and impr…
2a19bdf 
…ove across packages

re #1994
@hui-an-yang
refactor: consolidate InvalidKeyHashError into @taquito/core and impr…
35f09f2 
…ove across packages

re #1994
@hui-an-yang
refactor: minor update for InvalidKeyHashError
15add2f 
re #1994
@hui-an-yang
refactor: consolidate InvalidOperationHashError into @taquito/core an…
8847cf2 
…d improve across packages

re #1994
@hui-an-yang
refactor: consolidate InvalidOperationKindError into @taquito/core an…
c302630 
…d improve across packages

re #1994
@hui-an-yang
refactor: consolidate DeprecationError into @taquito/core
46435a8 
re #1994
@hui-an-yang
refactor: consolidate ProhibitedActionError into @taquito/core
ef00092 
re #1994
@hui-an-yang
refactor: imporve InvalidProtocolHashError and ValueConversionError i…
1dee9a1 
…n @taquito/utils

re #1994
@hui-an-yang
refactor: added unit tests for error classes in @taquito/core
6801968 
re #1994
@hui-an-yang
refactor: consolidate ValidationResult into @taquito/core
d3f804e 
re #1994
@hui-an-yang
refactor: improve InvalidAddressError to show validation result in er…
2b08fc9 
…rorDetail

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
@hui-an-yang
refactor: improve InvalidAddressError message format to be concise
3224083 
re #1994
@hui-an-yang
refactor: improve InvalidBlockHashError message format to be concise
38ec5e2 
re #1994
@hui-an-yang
refactor: improve InvalidDerivationPathError message format to be con…
f873b90 
…sistent

re #1994
@hui-an-yang
refactor: improve InvalidHexStringError message format
7f42f9e 
re #1994
@hui-an-yang
refactor: improve InvalidMessageError message format
c1987f3 
re #1994
@hui-an-yang
refactor: improve InvalidViewParameterError message format
f78a1bd 
re #1994
@hui-an-yang
refactor: improve InvalidKeyError message format
782ce0d 
re #1994
@hui-an-yang
refactor: improve teh rest of common error classes message format
1d497a4
@hui-an-yang
refactor: replaced deprecated substr with substring across packages
b4605f4
@hui-an-yang hui-an-yang marked this pull request as ready for review May 11, 2023 22:26
@hui-an-yang hui-an-yang requested a review from ac10n May 11, 2023 22:27
@hui-an-yang hui-an-yang linked an issue May 11, 2023 that may be closed by this pull request
Error improvements per packages part1 #1994
Closed
3 tasks
@hui-an-yang hui-an-yang self-assigned this May 11, 2023
dsawali
dsawali reviewed May 12, 2023
View reviewed changes
packages/taquito-core/src/enums.ts Outdated
@@ -0,0 +1,6 @@
export enum ValidationResult {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is mainly a validation enum and is only one of its kind, wouldn't this be much simpler to put it in validators.ts still?

packages/taquito-signer/src/ed-key.ts
@@ -23,11 +17,15 @@ export class Tz1 {
* @param key Encoded private key
* @param encrypted Is the private key encrypted
* @param decrypt Decrypt function
* @throws {@link InvalidKeyError}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good addition to the typedoc 👍

@hui-an-yang hui-an-yang merged commit 7e0c059 into error-improvement May 12, 2023
@hui-an-yang hui-an-yang deleted the 1994-@taquito-utils-error-improvement branch May 12, 2023 22:54
hui-an-yang added a commit that referenced this pull request May 23, 2023
@hui-an-yang
Error improvement (#2470)
babcbaf 
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dsawali dsawali dsawali approved these changes

@zainen zainen Awaiting requested review from zainen

@ac10n ac10n Awaiting requested review from ac10n

Assignees

@hui-an-yang hui-an-yang

Labels
None yet
Projects
Taquito Dev
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Error improvements per packages part1
2 participants
@hui-an-yang @dsawali