@taquito/michelson-encoder 12.0.2 → 12.1.0

package/dist/types/errors.d.ts

@@ -2,6 +2,8 @@ export { ListValidationError } from './tokens/list';
 export { MapValidationError } from './tokens/map';
 export { SetValidationError } from './tokens/set';
 export { BigMapValidationError } from './tokens/bigmap';
+export { TokenArgumentValidationError, TokenComparisonError } from './tokens/pair';
+export { OrTokenDecodingError } from './tokens/or';
 export { ChainIDValidationError } from './tokens/chain-id';
 export { KeyValidationError } from './tokens/key';
 export { ContractValidationError } from './tokens/contract';

package/dist/types/michelson-map.d.ts

@@ -1,6 +1,19 @@
 import { MichelsonV1Expression } from '@taquito/rpc';
+/**
+ *  @category Error
+ *  @description Error that indicates an invalid map type being passed or used
+ */
+export declare class InvalidMapTypeError extends Error {
+    mapType: string;
+    name: string;
+    constructor(mapType: string);
+}
 declare const michelsonMapTypeSymbol: unique symbol;
 export declare type MichelsonMapKey = Array<any> | object | string | boolean | number;
+/**
+ *  @category Error
+ *  @description Error that indicates a map type mismatch, where an attempt to set a key or value in a Map doesn't match the defined type of the Map
+ */
 export declare class MapTypecheckError extends Error {
     readonly value: any;
     readonly type: any;

package/dist/types/schema/error.d.ts

@@ -1,11 +1,86 @@
+/**
+ *  @category Error
+ *  @description Error that indicates a failure when encoding (transforming JS parameter into JSON Michelson)the parameter of the view
+ */
 export declare class ViewEncodingError extends Error {
     smartContractViewName: string;
     originalError: any;
     name: string;
     constructor(smartContractViewName: string, originalError: any);
 }
+/**
+ *  @category Error
+ *  @description Error that indicates an invalid on-chain view found on the script
+ */
 export declare class InvalidScriptError extends Error {
     message: string;
     name: string;
     constructor(message: string);
 }
+/**
+ *  @category Error
+ *  @description Error that indicates an invalid RPC response being passed or used
+ */
+export declare class InvalidRpcResponseError extends Error {
+    script: any;
+    name: string;
+    constructor(script: any);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates a failure that occurred during encoding
+ */
+export declare class ParameterEncodingError extends Error {
+    message: string;
+    args: any;
+    originalError: any;
+    name: string;
+    constructor(message: string, args: any, originalError: any);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates an invalid big map schema being passed or used
+ */
+export declare class InvalidBigMapSchema extends Error {
+    message: string;
+    name: string;
+    constructor(message: string);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates an invalid big map diff being passed or used
+ */
+export declare class InvalidBigMapDiff extends Error {
+    message: string;
+    name: string;
+    constructor(message: string);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates a failure when trying to encode big maps
+ */
+export declare class BigMapEncodingError extends Error {
+    private obj;
+    details: any;
+    name: string;
+    constructor(obj: string, details: any);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates a failure when trying to encode storage
+ */
+export declare class StorageEncodingError extends Error {
+    private obj;
+    details: any;
+    name: string;
+    constructor(obj: string, details: any);
+}
+/**
+ *  @category Error
+ *  @description General error that indicates a function not being passed a necessary argument
+ */
+export declare class MissingArgumentError extends Error {
+    message: string;
+    name: string;
+    constructor(message: string);
+}

package/dist/types/tokens/bigmap.d.ts

@@ -1,5 +1,9 @@
 import { BigMapTokenSchema } from '../schema/types';
 import { ComparableToken, Semantic, Token, TokenFactory, TokenValidationError } from './token';
+/**
+ *  @category Error
+ *  @description Error that indicates a failure happening when parsing encoding/executing Big Map types
+ */
 export declare class BigMapValidationError extends TokenValidationError {
     value: any;
     token: BigMapToken;

package/dist/types/tokens/createToken.d.ts

@@ -1,4 +1,8 @@
 import { Token } from './token';
+/**
+ *  @category Error
+ *  @description Error that indicates a script having an invalid type or it being unsupported by the Michelson Encoder. Note some protocol changes might affect this, we encourage users to open an issue so we can look into implementing support for said types.
+ */
 export declare class InvalidTokenError extends Error {
     message: string;
     data: any;

package/dist/types/tokens/or.d.ts

@@ -1,5 +1,14 @@
 import { OrTokenSchema } from '../schema/types';
 import { Token, TokenFactory, Semantic, ComparableToken } from './token';
+/**
+ *  @category Error
+ *  @description Error that indicates a failure when decoding OR Token methods
+ */
+export declare class OrTokenDecodingError extends Error {
+    message: string;
+    name: string;
+    constructor(message: string);
+}
 export declare class OrToken extends ComparableToken {
     protected val: {
         prim: string;

package/dist/types/tokens/pair.d.ts

@@ -1,5 +1,24 @@
 import { Token, TokenFactory, Semantic, ComparableToken } from './token';
 import { PairTokenSchema } from '../schema/types';
+/**
+ *  @category Error
+ *  @description Error that indicates in invalid token argument being passed
+ */
+export declare class TokenArgumentValidationError extends Error {
+    message: string;
+    name: string;
+    constructor(message: string);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates a failure occurring when doing a comparison of tokens
+ */
+export declare class TokenComparisonError extends Error {
+    val1: string;
+    val2: string;
+    name: string;
+    constructor(val1: string, val2: string);
+}
 export declare class PairToken extends ComparableToken {
     static prim: 'pair';
     constructor(val: {

package/dist/types/tokens/ticket.d.ts

@@ -1,5 +1,9 @@
 import { TicketTokenSchema } from '../schema/types';
 import { Token, TokenFactory, Semantic } from './token';
+/**
+ *  @category Error
+ *  @description Error that indicates a failure when encoding and sending a ticket to the blockchain
+ */
 export declare class EncodeTicketError extends Error {
     name: string;
     constructor();

package/dist/types/tokens/token.d.ts

@@ -1,5 +1,9 @@
 import { MichelsonV1Expression } from '@taquito/rpc';
 import { TokenSchema } from '../schema/types';
+/**
+ *  @category Error
+ *  @description Error that indicates a failure when encoding invalid or incorrect data (e.g. if an address is expected but a number is received)
+ */
 export declare abstract class TokenValidationError extends Error {
     value: any;
     token: Token;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taquito/michelson-encoder",
-  "version": "12.0.2",
+  "version": "12.1.0",
   "description": "converts michelson data and types into convenient JS/TS objects",
   "keywords": [
     "tezos",
@@ -68,8 +68,8 @@
     ]
   },
   "dependencies": {
-    "@taquito/rpc": "^12.0.2",
-    "@taquito/utils": "^12.0.2",
+    "@taquito/rpc": "^12.1.0",
+    "@taquito/utils": "^12.1.0",
     "bignumber.js": "^9.0.2",
     "fast-json-stable-stringify": "^2.1.0"
   },
@@ -103,5 +103,5 @@
     "typedoc": "^0.20.36",
     "typescript": "~4.1.5"
   },
-  "gitHead": "a224127fe138d46674af2f9605e5bb452b2e4d74"
+  "gitHead": "8e044472d87e92bfa748e8193ba84a7ee57d659f"
 }