@taquito/utils 24.2.0 → 24.3.0-beta.1

package/dist/taquito-utils.es6.js

@@ -1992,7 +1992,7 @@ function isSlowBuffer (obj) {
 
 // ref https://gitlab.com/tezos/tezos/-/blob/master/src/lib_crypto/base58.ml
 /**
- * @description base58 name to prefix mapping
+ * base58 name to prefix mapping
  */
 var PrefixV2;
 (function (PrefixV2) {
@@ -2059,7 +2059,7 @@ var PrefixV2;
     PrefixV2["SlotHeader"] = "sh";
 })(PrefixV2 || (PrefixV2 = {}));
 /**
- * @description base58 prefix to bytes mapping
+ * base58 prefix to bytes mapping
  */
 const prefixV2 = {
     [PrefixV2.BlockHash]: new Uint8Array([1, 52]),
@@ -2125,7 +2125,7 @@ const prefixV2 = {
     [PrefixV2.SlotHeader]: new Uint8Array([2, 116, 180]),
 };
 /**
- * @description base58 prefix to payload length mapping
+ * base58 prefix to payload length mapping
  */
 const payloadLength = {
     [PrefixV2.BlockHash]: 32,
@@ -2201,7 +2201,7 @@ const payloadLength = {
  * Copyright (c) 2017 Stephen Andrews
  */
 /**
- * @description list of prefixes that can be used to decode an address
+ * list of prefixes that can be used to decode an address
  */
 const addressPrefixes = [
     PrefixV2.P256PublicKeyHash,
@@ -2213,7 +2213,7 @@ const addressPrefixes = [
     // PrefixV2.ZkRollupHash,
 ];
 /**
- * @description list of prefixes that can be used to decode a public key
+ * list of prefixes that can be used to decode a public key
  */
 const publicKeyPrefixes = [
     PrefixV2.P256PublicKey,
@@ -2222,7 +2222,7 @@ const publicKeyPrefixes = [
     PrefixV2.BLS12_381PublicKey,
 ];
 /**
- * @description list of prefixes that can be used to decode a public key hash
+ * list of prefixes that can be used to decode a public key hash
  */
 const publicKeyHashPrefixes = [
     PrefixV2.P256PublicKeyHash,
@@ -2231,7 +2231,7 @@ const publicKeyHashPrefixes = [
     PrefixV2.BLS12_381PublicKeyHash,
 ];
 /**
- * @description list of prefixes that can be used to decode a signature
+ * list of prefixes that can be used to decode a signature
  */
 const signaturePrefixes = [
     PrefixV2.P256Signature,
@@ -2403,7 +2403,7 @@ function b58DecodeAddress(value, fmt) {
     }
 }
 /**
- *  @description Gets Tezos address (PKH) from Public Key
+ *  Gets Tezos address (PKH) from Public Key
  *  @param publicKey Base58 Public Key
  *  @returns A string of the Tezos address (PKH) that was derived from the given Public Key
  *  @example getPkhfromPk('edpkuNjKKT48xBoT5asPrWdmuM1Yw8D93MwgFgVvtca8jb5pstzaCh') // return 'tz2MVED1t9Jery77Bwm1m5YhUx8Wp5KWWRQe'
@@ -2431,7 +2431,7 @@ function getPkhfromPk(publicKey) {
     return b58Encode(hashed, pkhPre);
 }
 /**
- * @description Add the prefix to a hex string or Uint8Array and Base58 encode it
+ * Add the prefix to a hex string or Uint8Array and Base58 encode it
  * @param value Value to Base58 encode
  * @param pre prefix ID to append to the encoded string
  * @example b58Encode('e96b9f8b19af9c7ffa0c0480e1977b295850961f', PrefixV2.Ed25519PublicKeyHash) // returns 'tz1gvF4cD2dDtqitL3ZTraggSR1Mju2BKFEM'
@@ -2445,7 +2445,7 @@ function b58Encode(value, pre) {
     return bs58check.encode(toBuffer(n));
 }
 /**
- * @description Parse binary public key and return Base58 representation
+ * Parse binary public key and return Base58 representation
  * @param value Binary key data
  * @returns return prefixed public key
  * @example encodeKey('02033aba7da4a2e7b5dd9f074555c118829aff16213ea1b65859686bd5fcfeaf3616') // return 'p2pk66xmhjiN7LpfrDGFwpxPtJxkLtPjQ6HUxJbKmRbxSR7RMpamDwi'
@@ -2478,7 +2478,7 @@ function encodeKey(value) {
     return b58Encode(buf.slice(1), pre);
 }
 /**
- * @description Parse binary public key hash and return Base58 representation
+ * Parse binary public key hash and return Base58 representation
  * @param value Key hash to parse
  * @returns return prefixed public key hash
  * @example encodeKeyHash('0001907d6a7e9f084df840d6e67ffa8db5464f87d4d1') // return 'tz2MVED1t9Jery77Bwm1m5YhUx8Wp5KWWRQe'
@@ -2511,7 +2511,7 @@ function encodeKeyHash(value) {
     return b58Encode(buf.slice(1, 21), pre);
 }
 /**
- * @description Parse binary Contract ID and return Base58 representation
+ * Parse binary Contract ID and return Base58 representation
  * @param value Address to parse (tz1, tz2, tz3, KT1, or sr1).
  * @example encodeAddress('0000e96b9f8b19af9c7ffa0c0480e1977b295850961f') // return 'tz1gvF4cD2dDtqitL3ZTraggSR1Mju2BKFEM'
  */
@@ -2537,7 +2537,7 @@ function encodeAddress(value) {
     }
 }
 /**
- * @description Base58 encode an address without predefined prefix
+ * Base58 encode an address without predefined prefix
  * @param value Address to base58 encode (tz4) hex dec
  * @returns return address
  * @example encodeBlsAddress('af2dc3c40667abc0e89c0ef40171d22aed08d5eb') // return 'tz4QyWfEiv56CVDATV3DT3CDVhPaMKif2Ce8'
@@ -2546,7 +2546,7 @@ function encodeBlsAddress(value) {
     return b58Encode(value, PrefixV2.BLS12_381PublicKeyHash);
 }
 /**
- * @description convert a fragment of Michelson code in hex string to an 'expr' prefix + base58 encoded BLAKE2b hash string
+ * convert a fragment of Michelson code in hex string to an 'expr' prefix + base58 encoded BLAKE2b hash string
  * @param value a fragment of Michelson code in hex string
  * @returns return 'expr' prefix + base58 encoded BLAKE2b hash
  * @example encodeExpr('050a000000160000b2e19a9e74440d86c59f13dab8a18ff873e889ea') // return 'exprv6UsC1sN3Fk2XfgcJCL8NCerP5rCGy1PRESZAqr7L2JdzX55EN'
@@ -2556,7 +2556,7 @@ function encodeExpr(value) {
     return b58Encode(blakeHash, PrefixV2.ScriptExpr);
 }
 /**
- * @description convert a signed operation in hex string to an 'op' prefix + base58 encoded BLAKE2b hash string
+ * convert a signed operation in hex string to an 'op' prefix + base58 encoded BLAKE2b hash string
  * @param value signed operation in hex string
  * @returns return 'op' prefix + base58 encoded BLAKE2b hash
  * @example encodeOpHash('0f185d8a30061e8134c162dbb7a6c3ab8f5fdb153363ccd6149b49a33481156a6c00b2e19a9e74440d86c59f13dab8a18ff873e889eaa304ab05da13000001f1585a7384f36e45fb43dc37e8ce172bced3e05700ff0000000002002110c033f3a990c2e46a3d6054ecc2f74072aae7a34b5ac4d9ce9edc11c2410a97695682108951786f05b361da03b97245dc9897e1955e08b5b8d9e153b0bdeb0d') // return 'opapqvVXmebRTCFd2GQFydr4tJj3V5QocQuTmuhbatcHm4Seo2t'
@@ -2566,7 +2566,7 @@ function encodeOpHash(value) {
     return b58Encode(blakeHash, PrefixV2.OperationHash);
 }
 /**
- * @description Convert an hex string to a Uint8Array
+ * Convert an hex string to a Uint8Array
  * @param hex Hex string to convert
  * @throws {@link ValueConversionError}
  */
@@ -2591,7 +2591,7 @@ function hex2buf(hex) {
     return res;
 }
 /**
- * @description Merge 2 buffers together
+ * Merge 2 buffers together
  * @param b1 First buffer
  * @param b2 Second buffer
  */
@@ -2602,7 +2602,7 @@ function mergebuf(b1, b2) {
     return r;
 }
 /**
- * @description Flatten a michelson json representation to an array
+ * Flatten a michelson json representation to an array
  * @param s michelson json
  */
 function mic2arr(s) {
@@ -2656,8 +2656,8 @@ function mic2arr(s) {
     return ret;
 }
 /**
- * @description Convert a Uint8Array to an hex string
- * @param buffer Uint8Array to convert
+ * Convert a Uint8Array to an hex string
+ * @param bytes Uint8Array to convert
  */
 function buf2hex(bytes) {
     return Array.from(bytes)
@@ -2665,21 +2665,21 @@ function buf2hex(bytes) {
         .join('');
 }
 /**
- * @description Convert a string to a byte string representation
+ * Convert a string to a byte string representation
  * @param str String to convert
  */
 function stringToBytes(str) {
     return Buffer.from(str, 'utf8').toString('hex');
 }
 /**
- * @description Convert byte string representation to string
+ * Convert byte string representation to string
  * @param hex byte string to convert
  */
 function bytesToString(hex) {
     return Buffer.from(hex2buf(hex)).toString('utf8');
 }
 /**
- * @description Convert hex string/UintArray/Buffer to bytes
+ * Convert hex string/UintArray/Buffer to bytes
  * @param hex String value to convert to bytes
  */
 function hex2Bytes(hex) {
@@ -2690,7 +2690,7 @@ function hex2Bytes(hex) {
     return Buffer.from(hexDigits, 'hex');
 }
 /**
- * @description Converts a number or Bignumber to hexadecimal  string
+ * Converts a number or Bignumber to hexadecimal  string
  * @param val The value  that will be converted to a hexadecimal string value
  */
 function toHexBuf(val, bitLength = 8) {
@@ -2700,7 +2700,7 @@ function numToHexBuffer(val, bitLength = 8) {
     return Buffer.from(num2PaddedHex(val, bitLength), 'hex');
 }
 /**
- * @description Converts a number or BigNumber to a padded hexadecimal string
+ * Converts a number or BigNumber to a padded hexadecimal string
  * @param val The value that will be converted into a padded hexadecimal string value
  * @param bitLength The length of bits
  *
@@ -2734,7 +2734,7 @@ function padHexWithZero(hex, targetLength) {
 }
 /**
  *
- * @description Strips the first 2 characters of a hex string (0x)
+ * Strips the first 2 characters of a hex string (0x)
  *
  * @param hex string to strip prefix from
  */
@@ -2760,7 +2760,7 @@ function compareArrays(a, b) {
 }
 
 /**
- * @description Used to check if a value has one of the allowed prefixes.
+ * Used to check if a value has one of the allowed prefixes.
  * @returns true if the value has one of the allowed prefixes, false otherwise
  * @example
  * ```
@@ -2774,7 +2774,7 @@ function isValidPrefixedValue(value, prefixes) {
     return validatePrefixedValue(value, prefixes) === ValidationResult.VALID;
 }
 /**
- * @description This function is called by the validation functions ([[validateAddress]], [[validateChain]], [[validateContractAddress]], [[validateKeyHash]], [[validateSignature]], [[validatePublicKey]]).
+ * This function is called by the validation functions ([[validateAddress]], [[validateChain]], [[validateContractAddress]], [[validateKeyHash]], [[validateSignature]], [[validatePublicKey]]).
  * Verify if the value can be decoded or return `1` (INVALID_CHECKSUM) / `5` (INVALID_ENCODING), then check if the prefix is valid or allowed or return `0` (NO_PREFIX_MATCHED) / `4` (PREFIX_NOT_ALLOWED)
  * If all checks pass, return `3` (VALID).
  * @param value Value to validate
@@ -2801,7 +2801,7 @@ function validatePrefixedValue(value, prefixes) {
     return ValidationResult.VALID;
 }
 /**
- * @description Used to check if an address or a contract address is valid.
+ * Used to check if an address or a contract address is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2816,11 +2816,11 @@ function validatePrefixedValue(value, prefixes) {
  * ```
  */
 function validateAddress(value) {
-    const [addr] = splitAddress(value !== null && value !== void 0 ? value : '');
+    const [addr] = splitAddress(value ?? '');
     return validatePrefixedValue(addr, addressPrefixes);
 }
 /**
- * @description Used to check if a chain id is valid.
+ * Used to check if a chain id is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2838,7 +2838,7 @@ function validateChain(value) {
     return validatePrefixedValue(value, [PrefixV2.ChainID]);
 }
 /**
- * @description Used to check if a contract address is valid.
+ * Used to check if a contract address is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2856,7 +2856,7 @@ function validateContractAddress(value) {
     return validatePrefixedValue(value, [PrefixV2.ContractHash]);
 }
 /**
- * @description Used to check if a key hash is valid.
+ * Used to check if a key hash is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2874,7 +2874,7 @@ function validateKeyHash(value) {
     return validatePrefixedValue(value, publicKeyHashPrefixes);
 }
 /**
- * @description Used to check if a signature is valid.
+ * Used to check if a signature is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2892,7 +2892,7 @@ function validateSignature(value) {
     return validatePrefixedValue(value, signaturePrefixes);
 }
 /**
- * @description Used to check if a public key is valid.
+ * Used to check if a public key is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2910,7 +2910,7 @@ function validatePublicKey(value) {
     return validatePrefixedValue(value, publicKeyPrefixes);
 }
 /**
- * @description Used to check if an operation hash is valid.
+ * Used to check if an operation hash is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2928,7 +2928,7 @@ function validateOperation(value) {
     return validatePrefixedValue(value, [PrefixV2.OperationHash]);
 }
 /**
- * @description Used to check if a protocol hash is valid.
+ * Used to check if a protocol hash is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2946,7 +2946,7 @@ function validateProtocol(value) {
     return validatePrefixedValue(value, [PrefixV2.ProtocolHash]);
 }
 /**
- * @description Used to check if a block hash is valid.
+ * Used to check if a block hash is valid.
  *
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
@@ -2964,7 +2964,7 @@ function validateBlock(value) {
     return validatePrefixedValue(value, [PrefixV2.BlockHash]);
 }
 /**
- * @description Used to check if a spending key is valid.
+ * Used to check if a spending key is valid.
  * @returns
  * 0 = NO_PREFIX_MATCHED, 1 = INVALID_CHECKSUM, 2 = INVALID_LENGTH, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
  *
@@ -2978,21 +2978,21 @@ function validateSmartRollupAddress(value) {
 
 // IMPORTANT: THIS FILE IS AUTO GENERATED! DO NOT MANUALLY EDIT!
 const VERSION = {
-    "commitHash": "105a7b15cfb862a0732c204e0e9741098d697775",
-    "version": "24.2.0"
+    "commitHash": "05df48fee92f846cba793920d6fa829afd6a1847",
+    "version": "24.3.0-beta.1"
 };
 
 const BLS12_381_DST = 'BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_';
 const POP_DST = 'BLS_POP_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_';
 /**
- * @description Verify signature of a payload
+ * Verify signature of a payload
  * @param message The forged message including the magic byte (11 for block, 12 for preattestation, 13 for attestation, 3 for generic, 5 for the PACK format of michelson) in string or Uint8Array
  * @param publicKey The public key to verify the signature against
  * @param signature The signature to verify
  * @param watermark Optional if not included in the message
  * @param pop Optional if verifying proof of possession signature
  * @returns A boolean indicating if the signature matches
- * @throws {@link InvalidPublicKeyError} | {@link InvalidSignatureError} | {@link InvalidMessageError}
+ * @throws InvalidPublicKeyError | InvalidSignatureError | InvalidMessageError
  * @example
  * ```
  * const message = '03d0c10e3ed11d7c6e3357f6ef335bab9e8f2bd54d0ce20c482e241191a6e4b8ce6c01be917311d9ac46959750e405d57e268e2ed9e174a80794fbd504e12a4a000141eb3781afed2f69679ff2bbe1c5375950b0e40d00ff000000005e05050505050507070100000024747a32526773486e74516b72794670707352466261313652546656503539684b72654a4d07070100000024747a315a6672455263414c42776d4171776f6e525859565142445439426a4e6a42484a750001';
@@ -3065,7 +3065,7 @@ function verifyEdSignature(sig, msg, publicKey) {
     try {
         return verify(publicKey, hash$1, sig);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
@@ -3074,7 +3074,7 @@ function verifySpSignature(sig, msg, publicKey) {
     try {
         return secp256k1.verify(sig, hash$1, publicKey);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
@@ -3083,7 +3083,7 @@ function verifyP2Signature(sig, msg, publicKey) {
     try {
         return p256.verify(sig, hash$1, publicKey);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
@@ -3093,7 +3093,7 @@ function verifyBLSSignature(sig, msg, publicKey) {
         const point = bls.hash(msg, BLS12_381_DST);
         return bls.verify(sig, point, publicKey);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
@@ -3102,14 +3102,14 @@ function verifyBLSPopSignature(sig, msg, publicKey) {
         const point = bls.hash(msg, POP_DST);
         return bls.verify(sig, point, publicKey);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
 
 /**
  *  @category Error
- *  @description Error that indicates invalid protocol hash being passed or used
+ *  Error that indicates invalid protocol hash being passed or used
  */
 class InvalidProtocolHashError extends ParameterValidationError {
     constructor(protocolHash, errorDetails) {
@@ -3121,7 +3121,7 @@ class InvalidProtocolHashError extends ParameterValidationError {
 }
 /**
  *  @category Error
- *  @description Error that indicates unable to convert data type from one to another
+ *  Error that indicates unable to convert data type from one to another
  */
 class ValueConversionError extends UnsupportedActionError {
     constructor(value, desiredType) {