@taquito/utils 24.2.0 → 24.3.0-beta.0

package/dist/taquito-utils.umd.js

@@ -1987,7 +1987,7 @@
 
   // ref https://gitlab.com/tezos/tezos/-/blob/master/src/lib_crypto/base58.ml
   /**
-   * @description base58 name to prefix mapping
+   * base58 name to prefix mapping
    */
   exports.PrefixV2 = void 0;
   (function (PrefixV2) {
@@ -2054,7 +2054,7 @@
       PrefixV2["SlotHeader"] = "sh";
   })(exports.PrefixV2 || (exports.PrefixV2 = {}));
   /**
-   * @description base58 prefix to bytes mapping
+   * base58 prefix to bytes mapping
    */
   const prefixV2 = {
       [exports.PrefixV2.BlockHash]: new Uint8Array([1, 52]),
@@ -2120,7 +2120,7 @@
       [exports.PrefixV2.SlotHeader]: new Uint8Array([2, 116, 180]),
   };
   /**
-   * @description base58 prefix to payload length mapping
+   * base58 prefix to payload length mapping
    */
   const payloadLength = {
       [exports.PrefixV2.BlockHash]: 32,
@@ -2196,7 +2196,7 @@
    * 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 = [
       exports.PrefixV2.P256PublicKeyHash,
@@ -2208,7 +2208,7 @@
       // 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 = [
       exports.PrefixV2.P256PublicKey,
@@ -2217,7 +2217,7 @@
       exports.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 = [
       exports.PrefixV2.P256PublicKeyHash,
@@ -2226,7 +2226,7 @@
       exports.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 = [
       exports.PrefixV2.P256Signature,
@@ -2398,7 +2398,7 @@
       }
   }
   /**
-   *  @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'
@@ -2426,7 +2426,7 @@
       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'
@@ -2440,7 +2440,7 @@
       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'
@@ -2473,7 +2473,7 @@
       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'
@@ -2506,7 +2506,7 @@
       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'
    */
@@ -2532,7 +2532,7 @@
       }
   }
   /**
-   * @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'
@@ -2541,7 +2541,7 @@
       return b58Encode(value, exports.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'
@@ -2551,7 +2551,7 @@
       return b58Encode(blakeHash, exports.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'
@@ -2561,7 +2561,7 @@
       return b58Encode(blakeHash, exports.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}
    */
@@ -2586,7 +2586,7 @@
       return res;
   }
   /**
-   * @description Merge 2 buffers together
+   * Merge 2 buffers together
    * @param b1 First buffer
    * @param b2 Second buffer
    */
@@ -2597,7 +2597,7 @@
       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) {
@@ -2651,8 +2651,8 @@
       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)
@@ -2660,21 +2660,21 @@
           .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) {
@@ -2685,7 +2685,7 @@
       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) {
@@ -2695,7 +2695,7 @@
       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
    *
@@ -2729,7 +2729,7 @@
   }
   /**
    *
-   * @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
    */
@@ -2755,7 +2755,7 @@
   }
 
   /**
-   * @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
    * ```
@@ -2769,7 +2769,7 @@
       return validatePrefixedValue(value, prefixes) === core.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
@@ -2796,7 +2796,7 @@
       return core.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,
@@ -2811,11 +2811,11 @@
    * ```
    */
   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,
@@ -2833,7 +2833,7 @@
       return validatePrefixedValue(value, [exports.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,
@@ -2851,7 +2851,7 @@
       return validatePrefixedValue(value, [exports.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,
@@ -2869,7 +2869,7 @@
       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,
@@ -2887,7 +2887,7 @@
       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,
@@ -2905,7 +2905,7 @@
       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,
@@ -2923,7 +2923,7 @@
       return validatePrefixedValue(value, [exports.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,
@@ -2941,7 +2941,7 @@
       return validatePrefixedValue(value, [exports.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,
@@ -2959,7 +2959,7 @@
       return validatePrefixedValue(value, [exports.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,
    *
@@ -2973,21 +2973,21 @@
 
   // IMPORTANT: THIS FILE IS AUTO GENERATED! DO NOT MANUALLY EDIT!
   const VERSION = {
-      "commitHash": "105a7b15cfb862a0732c204e0e9741098d697775",
-      "version": "24.2.0"
+      "commitHash": "27675679db6515e8b092195ef5c58c2c0ea5f5c8",
+      "version": "24.3.0-beta.0"
   };
 
   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';
@@ -3060,7 +3060,7 @@
       try {
           return ed25519.verify(publicKey, hash, sig);
       }
-      catch (_a) {
+      catch {
           return false;
       }
   }
@@ -3069,7 +3069,7 @@
       try {
           return secp256k1.secp256k1.verify(sig, hash, publicKey);
       }
-      catch (_a) {
+      catch {
           return false;
       }
   }
@@ -3078,7 +3078,7 @@
       try {
           return nist.p256.verify(sig, hash, publicKey);
       }
-      catch (_a) {
+      catch {
           return false;
       }
   }
@@ -3088,7 +3088,7 @@
           const point = bls.hash(msg, BLS12_381_DST);
           return bls.verify(sig, point, publicKey);
       }
-      catch (_a) {
+      catch {
           return false;
       }
   }
@@ -3097,14 +3097,14 @@
           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 core.ParameterValidationError {
       constructor(protocolHash, errorDetails) {
@@ -3116,7 +3116,7 @@
   }
   /**
    *  @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.UnsupportedActionError {
       constructor(value, desiredType) {

package/dist/types/constants.d.ts

@@ -1,5 +1,5 @@
 /**
- * @description base58 name to prefix mapping
+ * base58 name to prefix mapping
  */
 export declare enum PrefixV2 {
     BlockHash = "B",
@@ -65,13 +65,13 @@ export declare enum PrefixV2 {
     SlotHeader = "sh"
 }
 /**
- * @description base58 prefix to bytes mapping
+ * base58 prefix to bytes mapping
  */
 export declare const prefixV2: {
     [key in PrefixV2]: Uint8Array;
 };
 /**
- * @description base58 prefix to payload length mapping
+ * base58 prefix to payload length mapping
  */
 export declare const payloadLength: {
     [key in PrefixV2]: number;

package/dist/types/encoding.d.ts

@@ -6,23 +6,23 @@ import { Buffer } from 'buffer';
 import { PrefixV2 } from './constants';
 import BigNumber from 'bignumber.js';
 /**
- * @description list of prefixes that can be used to decode an address
+ * list of prefixes that can be used to decode an address
  */
 export declare const addressPrefixes: PrefixV2[];
 /**
- * @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
  */
 export declare const publicKeyPrefixes: PrefixV2[];
 /**
- * @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
  */
 export declare const publicKeyHashPrefixes: PrefixV2[];
 /**
- * @description list of prefixes that can be used to decode a signature
+ * list of prefixes that can be used to decode a signature
  */
 export declare const signaturePrefixes: PrefixV2[];
 /**
- * @description Decodes Base58 string, looks for known prefix and strips it
+ * Decodes Base58 string, looks for known prefix and strips it
  * @param src Base58 string
  * @returns Payload and prefix
  * @example b58DecodeAndCheckPrefix('tz1gvF4cD2dDtqitL3ZTraggSR1Mju2BKFEM') // returns [Uint8Array, PrefixV2.Ed25519PublicKeyHash]
@@ -33,7 +33,7 @@ export declare function b58DecodeAndCheckPrefix<T extends readonly PrefixV2[]>(s
 export declare function b58DecodeAndCheckPrefix<T extends readonly PrefixV2[]>(src: string, allowed: T, payloadOnly: false): [Uint8Array, T[number]];
 export declare function b58DecodeAndCheckPrefix<T extends readonly PrefixV2[]>(src: string, allowed: T, payloadOnly: true): Uint8Array;
 /**
- * @description Decode a Base58 public key and return its binary representation
+ * Decode a Base58 public key and return its binary representation
  * @param value Value to decode
  * @param fmt optional format of the decoded return value, 'hex' or 'array'
  * @returns string or Uint8Array of bytes
@@ -42,7 +42,7 @@ export declare function b58DecodeAndCheckPrefix<T extends readonly PrefixV2[]>(s
 export declare function b58DecodePublicKey(value: string, fmt?: 'hex'): string;
 export declare function b58DecodePublicKey(value: string, fmt: 'array'): Uint8Array;
 /**
- * @description Decode a Base58 public key hash and return its binary representation
+ * Decode a Base58 public key hash and return its binary representation
  * @param value Value to decode
  * @param fmt optional format of the decoded return value, 'hex' or 'array'
  * @returns string or Uint8Array of bytes
@@ -51,7 +51,7 @@ export declare function b58DecodePublicKey(value: string, fmt: 'array'): Uint8Ar
 export declare function b58DecodePublicKeyHash(value: string, fmt?: 'hex'): string;
 export declare function b58DecodePublicKeyHash(value: string, fmt: 'array'): Uint8Array;
 /**
- * @description Decode a Base58 string and assert tz4 type
+ * Decode a Base58 string and assert tz4 type
  * @param value a bls address(tz4) to decode
  * @param fmt optional format of the decoded return value, 'hex' or 'array'
  * @returns string or Uint8Array of bytes
@@ -60,7 +60,7 @@ export declare function b58DecodePublicKeyHash(value: string, fmt: 'array'): Uin
 export declare function b58DecodeBlsAddress(value: string, fmt?: 'hex'): string;
 export declare function b58DecodeBlsAddress(value: string, fmt: 'array'): Uint8Array;
 /**
- * @description Decode a Base58 contract ID and return its binary representation
+ * Decode a Base58 contract ID and return its binary representation
  * @param value Value to decode
  * @param fmt optional format of the decoded return value, 'hex' or 'array'
  * @returns string or Uint8Array of bytes
@@ -69,105 +69,105 @@ export declare function b58DecodeBlsAddress(value: string, fmt: 'array'): Uint8A
 export declare function b58DecodeAddress(value: string, fmt?: 'hex'): string;
 export declare function b58DecodeAddress(value: string, fmt: 'array'): Uint8Array;
 /**
- *  @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'
  */
 export declare function getPkhfromPk(publicKey: string): string;
 /**
- * @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'
  */
 export declare function b58Encode(value: string | Uint8Array, pre: PrefixV2): string;
 /**
- * @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'
  */
 export declare function encodeKey(value: string | Uint8Array): string;
 /**
- * @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'
  */
 export declare function encodeKeyHash(value: string | Uint8Array): string;
 /**
- * @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'
  */
 export declare function encodeAddress(value: string | Uint8Array): string;
 /**
- * @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'
  */
 export declare function encodeBlsAddress(value: string): string;
 /**
- * @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'
  */
 export declare function encodeExpr(value: string): string;
 /**
- * @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'
  */
 export declare function encodeOpHash(value: string): string;
 /**
- * @description Convert an hex string to a Uint8Array
+ * Convert an hex string to a Uint8Array
  * @param hex Hex string to convert
  * @throws {@link ValueConversionError}
  */
 export declare function hex2buf(hex: string): Uint8Array;
 /**
- * @description Merge 2 buffers together
+ * Merge 2 buffers together
  * @param b1 First buffer
  * @param b2 Second buffer
  */
 export declare function mergebuf(b1: Uint8Array, b2: Uint8Array): Uint8Array;
 /**
- * @description Flatten a michelson json representation to an array
+ * Flatten a michelson json representation to an array
  * @param s michelson json
  */
 export declare function mic2arr(s: any): any;
 /**
- * @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
  */
 export declare function buf2hex(bytes: ArrayLike<number>): string;
 /**
- * @description Convert a string to a byte string representation
+ * Convert a string to a byte string representation
  * @param str String to convert
  */
 export declare function stringToBytes(str: string): string;
 /**
- * @description Convert byte string representation to string
+ * Convert byte string representation to string
  * @param hex byte string to convert
  */
 export declare function bytesToString(hex: string): string;
 /**
- * @description Convert hex string/UintArray/Buffer to bytes
+ * Convert hex string/UintArray/Buffer to bytes
  * @param hex String value to convert to bytes
  */
 export declare function hex2Bytes(hex: string): Buffer;
 /**
- * @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
  */
-export declare function toHexBuf(val: number | BigNumber, bitLength?: number): Buffer;
-export declare function numToHexBuffer(val: number | BigNumber, bitLength?: number): Buffer;
+export declare function toHexBuf(val: number | BigNumber, bitLength?: number): Buffer<ArrayBuffer>;
+export declare function numToHexBuffer(val: number | BigNumber, bitLength?: number): Buffer<ArrayBuffer>;
 /**
- * @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
  *
@@ -175,7 +175,7 @@ export declare function numToHexBuffer(val: number | BigNumber, bitLength?: numb
 export declare function num2PaddedHex(val: number | BigNumber, bitLength?: number): string;
 /**
  *
- * @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/types/errors.d.ts

@@ -2,7 +2,7 @@ import { ParameterValidationError, UnsupportedActionError, ValidationResult } fr
 export { InvalidAddressError, InvalidBlockHashError, InvalidHexStringError, InvalidMessageError, InvalidKeyError, InvalidPublicKeyError, InvalidSignatureError, InvalidContractAddressError, InvalidChainIdError, InvalidKeyHashError, InvalidOperationHashError, InvalidOperationKindError, DeprecationError, ProhibitedActionError, } from '@taquito/core';
 /**
  *  @category Error
- *  @description Error that indicates invalid protocol hash being passed or used
+ *  Error that indicates invalid protocol hash being passed or used
  */
 export declare class InvalidProtocolHashError extends ParameterValidationError {
     readonly protocolHash: string;
@@ -11,7 +11,7 @@ export declare 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
  */
 export declare class ValueConversionError extends UnsupportedActionError {
     readonly value: string;