@taquito/utils 16.1.2 → 16.2.0-beta-RC.0

package/dist/taquito-utils.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('buffer'), require('@stablelib/ed25519'), require('@stablelib/blake2b'), require('blakejs'), require('bs58check'), require('bignumber.js'), require('elliptic'), require('typedarray-to-buffer')) :
-  typeof define === 'function' && define.amd ? define(['exports', 'buffer', '@stablelib/ed25519', '@stablelib/blake2b', 'blakejs', 'bs58check', 'bignumber.js', 'elliptic', 'typedarray-to-buffer'], factory) :
-  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.taquitoUtils = {}, global.buffer, global.ed25519, global.blake2b, global.blake, global.bs58check, global.BigNumber, global.elliptic, global.toBuffer));
-})(this, (function (exports, buffer, ed25519, blake2b, blake, bs58check, BigNumber, elliptic, toBuffer) { 'use strict';
+  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('buffer'), require('@stablelib/ed25519'), require('@stablelib/blake2b'), require('blakejs'), require('bs58check'), require('@taquito/core'), require('bignumber.js'), require('elliptic'), require('typedarray-to-buffer')) :
+  typeof define === 'function' && define.amd ? define(['exports', 'buffer', '@stablelib/ed25519', '@stablelib/blake2b', 'blakejs', 'bs58check', '@taquito/core', 'bignumber.js', 'elliptic', 'typedarray-to-buffer'], factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.taquitoUtils = {}, global.buffer, global.ed25519, global.blake2b, global.blake, global.bs58check, global.core, global.BigNumber, global.elliptic, global.toBuffer));
+})(this, (function (exports, buffer, ed25519, blake2b, blake, bs58check, core, BigNumber, elliptic, toBuffer) { 'use strict';
 
   function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -141,194 +141,6 @@
       [exports.Prefix.SRC1]: 32,
   };
 
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid key being passed or used
-   */
-  class InvalidKeyError extends Error {
-      constructor(key, errorDetail) {
-          super();
-          this.key = key;
-          this.errorDetail = errorDetail;
-          this.name = 'InvalidKeyError';
-          const baseMessage = `The key ${key} is invalid.`;
-          this.message = errorDetail ? `${baseMessage} ${errorDetail}` : baseMessage;
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an Invalid Public Key being passed or used
-   */
-  class InvalidPublicKeyError extends Error {
-      constructor(publicKey, errorDetail) {
-          super();
-          this.publicKey = publicKey;
-          this.name = 'InvalidPublicKeyError';
-          const baseMessage = `The public key '${publicKey}' is invalid.`;
-          this.message = errorDetail ? `${baseMessage} ${errorDetail}` : baseMessage;
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid signature being passed or used
-   */
-  class InvalidSignatureError extends Error {
-      constructor(signature, errorDetail) {
-          super();
-          this.signature = signature;
-          this.name = 'InvalidSignatureError';
-          const baseMessage = `The signature '${signature}' is invalid.`;
-          this.message = errorDetail ? `${baseMessage} ${errorDetail}` : baseMessage;
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid message being passed or used
-   */
-  class InvalidMessageError extends Error {
-      constructor(msg, errorDetail) {
-          super();
-          this.msg = msg;
-          this.errorDetail = errorDetail;
-          this.name = 'InvalidMessageError';
-          const baseMessage = `The message '${msg}' is invalid.`;
-          this.message = errorDetail ? `${baseMessage} ${errorDetail}` : baseMessage;
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid contract address being passed or used
-   */
-  class InvalidContractAddressError extends Error {
-      constructor(contractAddress) {
-          super(`The contract address '${contractAddress}' is invalid`);
-          this.contractAddress = contractAddress;
-          this.name = 'InvalidContractAddressError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid address being passed or used (both contract and implicit)
-   */
-  class InvalidAddressError extends Error {
-      constructor(address, errorDetail) {
-          super();
-          this.address = address;
-          this.name = 'InvalidAddressError';
-          const baseMessage = `The address '${address}' is invalid.`;
-          this.message = errorDetail ? `${baseMessage} ${errorDetail}` : baseMessage;
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid chain id being passed or used
-   */
-  class InvalidChainIdError extends Error {
-      constructor(chainId) {
-          super(`The chain id '${chainId}' is invalid`);
-          this.chainId = chainId;
-          this.name = 'InvalidChainIdError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid key hash being passed or used
-   */
-  class InvalidKeyHashError extends Error {
-      constructor(keyHash) {
-          super(`The public key hash '${keyHash}' is invalid`);
-          this.keyHash = keyHash;
-          this.name = 'InvalidKeyHashError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid block hash being passed or used
-   */ class InvalidBlockHashError extends Error {
-      constructor(blockHash) {
-          super(`The block hash '${blockHash}' is invalid`);
-          this.blockHash = blockHash;
-          this.name = 'InvalidBlockHashError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates invalid protocol hash being passed or used
-   */
-  class InvalidProtocolHashError extends Error {
-      constructor(protocolHash) {
-          super(`The protocol hash '${protocolHash}' is invalid`);
-          this.protocolHash = protocolHash;
-          this.name = 'InvalidProtocolHashError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid operation hash being passed or used
-   */ class InvalidOperationHashError extends Error {
-      constructor(operationHash) {
-          super(`The operation hash '${operationHash}' is invalid`);
-          this.operationHash = operationHash;
-          this.name = 'InvalidOperationHashError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid operation kind being passed or used
-   */
-  class InvalidOperationKindError extends Error {
-      constructor(operationKind) {
-          super(`The operation kind '${operationKind}' is unsupported`);
-          this.operationKind = operationKind;
-          this.name = 'InvalidOperationKindError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description General error that indicates something is no longer supported and/or deprecated
-   */
-  class DeprecationError extends Error {
-      constructor(message) {
-          super(message);
-          this.message = message;
-          this.name = 'DeprecationError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description General error that indicates an action is prohibited or not allowed
-   */
-  class ProhibitedActionError extends Error {
-      constructor(message) {
-          super(message);
-          this.message = message;
-          this.name = 'ProhibitedActionError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description General error that indicates a failure when trying to convert data from one type to another
-   */
-  class ValueConversionError extends Error {
-      constructor(value, desiredType) {
-          super(`Unable to convert ${value} to a ${desiredType}`);
-          this.value = value;
-          this.desiredType = desiredType;
-          this.name = 'ValueConversionError';
-      }
-  }
-  /**
-   *  @category Error
-   *  @description Error that indicates an invalid hex string being passed or used
-   */
-  class InvalidHexStringError extends Error {
-      constructor(message) {
-          super(message);
-          this.message = message;
-          this.name = 'InvalidHexStringError';
-      }
-  }
-
   /**
    * @description Verify signature of a payload
    *
@@ -337,7 +149,7 @@
    * @param publicKey The public key to verify the signature against
    * @param signature The signature to verify
    * @returns A boolean indicating if the signature matches
-   *
+   * @throws {@link InvalidPublicKeyError} | {@link InvalidSignatureError} | {@link InvalidMessageError}
    * @example
    * ```
    * const message = '03d0c10e3ed11d7c6e3357f6ef335bab9e8f2bd54d0ce20c482e241191a6e4b8ce6c01be917311d9ac46959750e405d57e268e2ed9e174a80794fbd504e12a4a000141eb3781afed2f69679ff2bbe1c5375950b0e40d00ff000000005e05050505050507070100000024747a32526773486e74516b72794670707352466261313652546656503539684b72654a4d07070100000024747a315a6672455263414c42776d4171776f6e525859565142445439426a4e6a42484a750001';
@@ -369,44 +181,28 @@
   }
   function validateMessageNotEmpty(message) {
       if (message === '') {
-          throw new InvalidMessageError(message, 'The message provided for verifying signature cannot be empty.');
+          throw new core.InvalidMessageError(message, ': Cannot be empty.');
       }
       return message;
   }
   function validatePkAndExtractPrefix(publicKey) {
       if (publicKey === '') {
-          throw new InvalidPublicKeyError(publicKey, 'Public key cannot be empty');
+          throw new core.InvalidPublicKeyError(publicKey, ': Can not be empty');
       }
       const pkPrefix = publicKey.substring(0, 4);
-      const validation = validatePublicKey(publicKey);
-      if (validation !== exports.ValidationResult.VALID) {
-          if (validation === exports.ValidationResult.INVALID_CHECKSUM) {
-              throw new InvalidPublicKeyError(publicKey, 'The public key provided has an invalid checksum');
-          }
-          else if (validation === exports.ValidationResult.INVALID_LENGTH) {
-              throw new InvalidPublicKeyError(publicKey, 'The public key provided has an invalid length');
-          }
-          else if (validation === exports.ValidationResult.NO_PREFIX_MATCHED) {
-              throw new InvalidPublicKeyError(publicKey, `The public key provided has an unsupported prefix: ${pkPrefix}`);
-          }
+      const publicKeyValidation = validatePublicKey(publicKey);
+      if (publicKeyValidation !== exports.ValidationResult.VALID) {
+          throw new core.InvalidPublicKeyError(publicKey, invalidErrorDetail(publicKeyValidation));
       }
       return pkPrefix;
   }
   function validateSigAndExtractPrefix(signature) {
       const signaturePrefix = signature.startsWith('sig')
-          ? signature.substr(0, 3)
-          : signature.substr(0, 5);
+          ? signature.substring(0, 3)
+          : signature.substring(0, 5);
       const validation = validateSignature(signature);
       if (validation !== exports.ValidationResult.VALID) {
-          if (validation === exports.ValidationResult.INVALID_CHECKSUM) {
-              throw new InvalidSignatureError(signature, `invalid checksum`);
-          }
-          else if (validation === exports.ValidationResult.INVALID_LENGTH) {
-              throw new InvalidSignatureError(signature, 'invalid length');
-          }
-          else if (validation === exports.ValidationResult.NO_PREFIX_MATCHED) {
-              throw new InvalidSignatureError(signaturePrefix, 'unsupported prefix');
-          }
+          throw new core.InvalidSignatureError(signature, invalidErrorDetail(validation));
       }
       return signaturePrefix;
   }
@@ -441,6 +237,34 @@
       return false;
   }
 
+  /**
+   *  @category Error
+   *  @description Error indicates invalid protocol hash being passed or used
+   */
+  class InvalidProtocolHashError extends core.ParameterValidationError {
+      constructor(protocolHash, errorDetails) {
+          super();
+          this.protocolHash = protocolHash;
+          this.name = 'InvalidProtocolHashError';
+          this.name = 'InvalidProtocolHashError';
+          this.message = `The protocol hash '${protocolHash}' is invalid`;
+          errorDetails ? (this.message += `: ${errorDetails}`) : null;
+      }
+  }
+  /**
+   *  @category Error
+   *  @description Error indicates unable to convert data type from one to another
+   */
+  class ValueConversionError extends core.UnsupportedActionError {
+      constructor(value, desiredType) {
+          super();
+          this.value = value;
+          this.desiredType = desiredType;
+          this.name = 'ValueConversionError';
+          this.message = `Unable to convert ${value} to a ${desiredType}`;
+      }
+  }
+
   exports.ValidationResult = void 0;
   (function (ValidationResult) {
       ValidationResult[ValidationResult["NO_PREFIX_MATCHED"] = 0] = "NO_PREFIX_MATCHED";
@@ -499,6 +323,7 @@
   const operationPrefix = [exports.Prefix.O];
   const protocolPrefix = [exports.Prefix.P];
   const blockPrefix = [exports.Prefix.B];
+  const smartRollupPrefix = [exports.Prefix.SR1];
   /**
    * @description Used to check if an address or a contract address is valid.
    *
@@ -515,7 +340,11 @@
    * ```
    */
   function validateAddress(value) {
-      return validatePrefixedValue(value, [...implicitPrefix, ...contractPrefix]);
+      return validatePrefixedValue(value, [
+          ...implicitPrefix,
+          ...contractPrefix,
+          ...smartRollupPrefix,
+      ]);
   }
   /**
    * @description Used to check if a chain id is valid.
@@ -668,12 +497,27 @@
    */
   function validateSpendingKey(value) {
       return validatePrefixedValue(value, [exports.Prefix.SASK]);
+  }
+  function invalidErrorDetail(validation) {
+      switch (validation) {
+          case exports.ValidationResult.NO_PREFIX_MATCHED:
+              return ': Invalid prefix';
+          case exports.ValidationResult.INVALID_CHECKSUM:
+              return ': Checksum failed';
+          case exports.ValidationResult.INVALID_LENGTH:
+              return ': Invalid length';
+          default:
+              return '';
+      }
+  }
+  function validateSmartRollupAddress(value) {
+      return validatePrefixedValue(value, [...smartRollupPrefix]);
   }
 
   // IMPORTANT: THIS FILE IS AUTO GENERATED! DO NOT MANUALLY EDIT OR CHECKIN!
   const VERSION = {
-      "commitHash": "bcc2118ddfafc1995fd125cd74d198fda042bf48",
-      "version": "16.1.2"
+      "commitHash": "babcbaf464fd3571a3b88cf7023fefe87809d86d",
+      "version": "16.2.0-beta-RC.0"
   };
 
   const TZ_DECIMALS = 6;
@@ -854,6 +698,7 @@
    * @description Convert an hex string to a Uint8Array
    *
    * @param hex Hex string to convert
+   * @throws {@link ValueConversionError}
    */
   const hex2buf = (hex) => {
       const match = hex.match(/[\da-f]{2}/gi);
@@ -1008,7 +853,7 @@
    */
   function hex2Bytes(hex) {
       if (!hex.match(/[\da-f]{2}/gi)) {
-          throw new InvalidHexStringError(`The hex string ${hex} does not have an even number of characters`);
+          throw new core.InvalidHexStringError(hex, `: Expecting even number of characters`);
       }
       return buffer.Buffer.from(hex, 'hex');
   }
@@ -1065,21 +910,63 @@
       return hex.startsWith('0x') ? hex.slice(2) : hex;
   }
 
-  exports.DeprecationError = DeprecationError;
-  exports.InvalidAddressError = InvalidAddressError;
-  exports.InvalidBlockHashError = InvalidBlockHashError;
-  exports.InvalidChainIdError = InvalidChainIdError;
-  exports.InvalidContractAddressError = InvalidContractAddressError;
-  exports.InvalidHexStringError = InvalidHexStringError;
-  exports.InvalidKeyError = InvalidKeyError;
-  exports.InvalidKeyHashError = InvalidKeyHashError;
-  exports.InvalidMessageError = InvalidMessageError;
-  exports.InvalidOperationHashError = InvalidOperationHashError;
-  exports.InvalidOperationKindError = InvalidOperationKindError;
+  Object.defineProperty(exports, 'DeprecationError', {
+    enumerable: true,
+    get: function () { return core.DeprecationError; }
+  });
+  Object.defineProperty(exports, 'InvalidAddressError', {
+    enumerable: true,
+    get: function () { return core.InvalidAddressError; }
+  });
+  Object.defineProperty(exports, 'InvalidBlockHashError', {
+    enumerable: true,
+    get: function () { return core.InvalidBlockHashError; }
+  });
+  Object.defineProperty(exports, 'InvalidChainIdError', {
+    enumerable: true,
+    get: function () { return core.InvalidChainIdError; }
+  });
+  Object.defineProperty(exports, 'InvalidContractAddressError', {
+    enumerable: true,
+    get: function () { return core.InvalidContractAddressError; }
+  });
+  Object.defineProperty(exports, 'InvalidHexStringError', {
+    enumerable: true,
+    get: function () { return core.InvalidHexStringError; }
+  });
+  Object.defineProperty(exports, 'InvalidKeyError', {
+    enumerable: true,
+    get: function () { return core.InvalidKeyError; }
+  });
+  Object.defineProperty(exports, 'InvalidKeyHashError', {
+    enumerable: true,
+    get: function () { return core.InvalidKeyHashError; }
+  });
+  Object.defineProperty(exports, 'InvalidMessageError', {
+    enumerable: true,
+    get: function () { return core.InvalidMessageError; }
+  });
+  Object.defineProperty(exports, 'InvalidOperationHashError', {
+    enumerable: true,
+    get: function () { return core.InvalidOperationHashError; }
+  });
+  Object.defineProperty(exports, 'InvalidOperationKindError', {
+    enumerable: true,
+    get: function () { return core.InvalidOperationKindError; }
+  });
+  Object.defineProperty(exports, 'InvalidPublicKeyError', {
+    enumerable: true,
+    get: function () { return core.InvalidPublicKeyError; }
+  });
+  Object.defineProperty(exports, 'InvalidSignatureError', {
+    enumerable: true,
+    get: function () { return core.InvalidSignatureError; }
+  });
+  Object.defineProperty(exports, 'ProhibitedActionError', {
+    enumerable: true,
+    get: function () { return core.ProhibitedActionError; }
+  });
   exports.InvalidProtocolHashError = InvalidProtocolHashError;
-  exports.InvalidPublicKeyError = InvalidPublicKeyError;
-  exports.InvalidSignatureError = InvalidSignatureError;
-  exports.ProhibitedActionError = ProhibitedActionError;
   exports.VERSION = VERSION;
   exports.ValueConversionError = ValueConversionError;
   exports.b58cdecode = b58cdecode;
@@ -1099,6 +986,7 @@
   exports.getPkhfromPk = getPkhfromPk;
   exports.hex2Bytes = hex2Bytes;
   exports.hex2buf = hex2buf;
+  exports.invalidErrorDetail = invalidErrorDetail;
   exports.isValidPrefix = isValidPrefix;
   exports.mergebuf = mergebuf;
   exports.mic2arr = mic2arr;
@@ -1117,6 +1005,7 @@
   exports.validateProtocol = validateProtocol;
   exports.validatePublicKey = validatePublicKey;
   exports.validateSignature = validateSignature;
+  exports.validateSmartRollupAddress = validateSmartRollupAddress;
   exports.validateSpendingKey = validateSpendingKey;
   exports.verifySignature = verifySignature;