1994 taquito local forging error improvement #2486

hui-an-yang · 2023-05-17T18:30:01Z

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.

Overall error improvement of @local-forging package

…1994-taquito-local-forging-error-improvement

…KindError 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

github-actions · 2023-05-17T18:35:38Z

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/

ac10n · 2023-05-17T19:18:09Z

packages/taquito-local-forging/src/schema/operation.ts

@@ -236,7 +236,11 @@ export const schemaEncoder =
        const values = value[key];

        if (!Array.isArray(values)) {
-          throw new OperationEncodingError(`Expected value to be Array ${JSON.stringify(values)}`);
+          throw new OperationEncodingError(
+            `Invalid operation value "${JSON.stringify(


A general concern regarding JSON.stringify in errors: If the value cannot be stringified (for instance, if it has circular references), then the error cannot be shown. This makes it very difficult to diagnose the problem.

Maybe we need a safeStringify to be used almost everywhere?

https://stackoverflow.com/questions/11616630/how-can-i-print-a-circular-structure-in-a-json-like-format

dsawali · 2023-05-17T23:00:18Z

packages/taquito-local-forging/src/codec.ts

@@ -286,12 +289,15 @@ export const publicKeyDecoder = (val: Uint8ArrayConsumer) => {
  }
 };

-export const smartRollupContractAddressEncoder = (val: string): string => {
+export const smartRollupCommitmentHashEncoder = (val: string): string => {


good catch, thanks for fixing this

* 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 13 commits May 15, 2023 12:07

refactor: update file name of error.ts to errors.ts for consistency

51c2bc7

refactor: improve InvalidOperationSchemaError

71eca13

refactor: improve OversizedEntryPointError

9eda1ec

refactor: improve InvalidBallotValueError

6ce9d84

refactor: improve DecodeBallotValueError

361bd44

refactor: imrpove UnexpectedMichelsonValueError

75eeff3

refactor: improve OperationDecodingError

8bd8bb8

refactor: imporve OperationEncodingError

b7bd237

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

af4b1eb

…1994-taquito-local-forging-error-improvement

refactor: imrpove UnsupportedOperationError

14e8d19

refactor: improve DecodePvmKindError

c9d1929

refactor: improve InvalidSmartRollupAddressError

5c33012

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

Error improvements per packages part1 #1994

Closed

3 tasks

hui-an-yang added this to the v16.2 milestone May 17, 2023

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

hui-an-yang requested review from dsawali and ac10n May 17, 2023 18:57

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

ac10n reviewed May 17, 2023

View reviewed changes

ac10n approved these changes May 17, 2023

View reviewed changes

dsawali reviewed May 17, 2023

View reviewed changes

dsawali approved these changes May 17, 2023

View reviewed changes

hui-an-yang merged commit cf81c08 into error-improvement May 18, 2023

hui-an-yang deleted the 1994-taquito-local-forging-error-improvement branch May 18, 2023 18:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1994 taquito local forging error improvement #2486

1994 taquito local forging error improvement #2486

hui-an-yang commented May 17, 2023 •

edited

Loading

github-actions bot commented May 17, 2023

ac10n May 17, 2023

dsawali May 17, 2023

1994 taquito local forging error improvement #2486

1994 taquito local forging error improvement #2486

Conversation

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

Release Note Draft Snippet

github-actions bot commented May 17, 2023

Published packages:

ac10n May 17, 2023

Choose a reason for hiding this comment

dsawali May 17, 2023

Choose a reason for hiding this comment

hui-an-yang commented May 17, 2023 •

edited

Loading