@taquito/utils 24.2.0-beta.1 → 24.3.0-beta.0

package/dist/lib/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.payloadLength = exports.prefixV2 = exports.PrefixV2 = void 0;
 /**
- * @description base58 name to prefix mapping
+ * base58 name to prefix mapping
  */
 var PrefixV2;
 (function (PrefixV2) {
@@ -70,7 +70,7 @@ var PrefixV2;
     PrefixV2["SlotHeader"] = "sh";
 })(PrefixV2 || (exports.PrefixV2 = PrefixV2 = {}));
 /**
- * @description base58 prefix to bytes mapping
+ * base58 prefix to bytes mapping
  */
 exports.prefixV2 = {
     [PrefixV2.BlockHash]: new Uint8Array([1, 52]),
@@ -136,7 +136,7 @@ exports.prefixV2 = {
     [PrefixV2.SlotHeader]: new Uint8Array([2, 116, 180]),
 };
 /**
- * @description base58 prefix to payload length mapping
+ * base58 prefix to payload length mapping
  */
 exports.payloadLength = {
     [PrefixV2.BlockHash]: 32,

package/dist/lib/encoding.js

@@ -44,7 +44,7 @@ const bignumber_js_1 = require("bignumber.js");
 const typedarray_to_buffer_1 = require("typedarray-to-buffer");
 const core_1 = require("@taquito/core");
 /**
- * @description list of prefixes that can be used to decode an address
+ * list of prefixes that can be used to decode an address
  */
 exports.addressPrefixes = [
     constants_1.PrefixV2.P256PublicKeyHash,
@@ -56,7 +56,7 @@ exports.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
  */
 exports.publicKeyPrefixes = [
     constants_1.PrefixV2.P256PublicKey,
@@ -65,7 +65,7 @@ exports.publicKeyPrefixes = [
     constants_1.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
  */
 exports.publicKeyHashPrefixes = [
     constants_1.PrefixV2.P256PublicKeyHash,
@@ -74,7 +74,7 @@ exports.publicKeyHashPrefixes = [
     constants_1.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
  */
 exports.signaturePrefixes = [
     constants_1.PrefixV2.P256Signature,
@@ -246,7 +246,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'
@@ -274,7 +274,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'
@@ -288,7 +288,7 @@ function b58Encode(value, pre) {
     return bs58check_1.default.encode((0, typedarray_to_buffer_1.default)(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'
@@ -321,7 +321,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'
@@ -354,7 +354,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'
  */
@@ -380,7 +380,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'
@@ -389,7 +389,7 @@ function encodeBlsAddress(value) {
     return b58Encode(value, constants_1.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'
@@ -399,7 +399,7 @@ function encodeExpr(value) {
     return b58Encode(blakeHash, constants_1.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'
@@ -409,7 +409,7 @@ function encodeOpHash(value) {
     return b58Encode(blakeHash, constants_1.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}
  */
@@ -434,7 +434,7 @@ function hex2buf(hex) {
     return res;
 }
 /**
- * @description Merge 2 buffers together
+ * Merge 2 buffers together
  * @param b1 First buffer
  * @param b2 Second buffer
  */
@@ -445,7 +445,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) {
@@ -499,8 +499,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)
@@ -508,21 +508,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_1.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_1.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) {
@@ -533,7 +533,7 @@ function hex2Bytes(hex) {
     return buffer_1.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) {
@@ -543,7 +543,7 @@ function numToHexBuffer(val, bitLength = 8) {
     return buffer_1.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
  *
@@ -577,7 +577,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
  */

package/dist/lib/errors.js

@@ -19,7 +19,7 @@ Object.defineProperty(exports, "DeprecationError", { enumerable: true, get: func
 Object.defineProperty(exports, "ProhibitedActionError", { enumerable: true, get: function () { return core_2.ProhibitedActionError; } });
 /**
  *  @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 core_1.ParameterValidationError {
     constructor(protocolHash, errorDetails) {
@@ -32,7 +32,7 @@ class InvalidProtocolHashError extends core_1.ParameterValidationError {
 exports.InvalidProtocolHashError = InvalidProtocolHashError;
 /**
  *  @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 core_1.UnsupportedActionError {
     constructor(value, desiredType) {

package/dist/lib/validators.js

@@ -19,7 +19,7 @@ const core_1 = require("@taquito/core");
 var core_2 = require("@taquito/core");
 Object.defineProperty(exports, "ValidationResult", { enumerable: true, get: function () { return core_2.ValidationResult; } });
 /**
- * @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
  * ```
@@ -33,7 +33,7 @@ function isValidPrefixedValue(value, prefixes) {
     return validatePrefixedValue(value, prefixes) === core_1.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
@@ -60,7 +60,7 @@ function validatePrefixedValue(value, prefixes) {
     return core_1.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,
@@ -75,11 +75,11 @@ function validatePrefixedValue(value, prefixes) {
  * ```
  */
 function validateAddress(value) {
-    const [addr] = (0, encoding_1.splitAddress)(value !== null && value !== void 0 ? value : '');
+    const [addr] = (0, encoding_1.splitAddress)(value ?? '');
     return validatePrefixedValue(addr, encoding_1.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,
@@ -97,7 +97,7 @@ function validateChain(value) {
     return validatePrefixedValue(value, [constants_1.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,
@@ -115,7 +115,7 @@ function validateContractAddress(value) {
     return validatePrefixedValue(value, [constants_1.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,
@@ -133,7 +133,7 @@ function validateKeyHash(value) {
     return validatePrefixedValue(value, encoding_1.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,
@@ -151,7 +151,7 @@ function validateSignature(value) {
     return validatePrefixedValue(value, encoding_1.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,
@@ -169,7 +169,7 @@ function validatePublicKey(value) {
     return validatePrefixedValue(value, encoding_1.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,
@@ -187,7 +187,7 @@ function validateOperation(value) {
     return validatePrefixedValue(value, [constants_1.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,
@@ -205,7 +205,7 @@ function validateProtocol(value) {
     return validatePrefixedValue(value, [constants_1.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,
@@ -223,7 +223,7 @@ function validateBlock(value) {
     return validatePrefixedValue(value, [constants_1.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,
  *

package/dist/lib/verify-signature.js

@@ -13,14 +13,14 @@ const bls12_381_1 = require("@noble/curves/bls12-381");
 exports.BLS12_381_DST = 'BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_';
 exports.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';
@@ -93,7 +93,7 @@ function verifyEdSignature(sig, msg, publicKey) {
     try {
         return (0, ed25519_1.verify)(publicKey, hash, sig);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
@@ -102,7 +102,7 @@ function verifySpSignature(sig, msg, publicKey) {
     try {
         return secp256k1_1.secp256k1.verify(sig, hash, publicKey);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
@@ -111,7 +111,7 @@ function verifyP2Signature(sig, msg, publicKey) {
     try {
         return nist_1.p256.verify(sig, hash, publicKey);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
@@ -121,7 +121,7 @@ function verifyBLSSignature(sig, msg, publicKey) {
         const point = bls.hash(msg, exports.BLS12_381_DST);
         return bls.verify(sig, point, publicKey);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }
@@ -130,7 +130,7 @@ function verifyBLSPopSignature(sig, msg, publicKey) {
         const point = bls.hash(msg, exports.POP_DST);
         return bls.verify(sig, point, publicKey);
     }
-    catch (_a) {
+    catch {
         return false;
     }
 }

package/dist/lib/version.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // IMPORTANT: THIS FILE IS AUTO GENERATED! DO NOT MANUALLY EDIT!
 exports.VERSION = {
-    "commitHash": "3f0dac2d1edb047928bcbe89db422d4de60f007e",
-    "version": "24.2.0-beta.1"
+    "commitHash": "27675679db6515e8b092195ef5c58c2c0ea5f5c8",
+    "version": "24.3.0-beta.0"
 };