@taquito/utils 17.3.2 → 17.4.0

package/dist/types/taquito-utils.d.ts

@@ -1,165 +1,165 @@
-/**
- * @packageDocumentation
- * @module @taquito/utils
- */
-/// <reference types="node" />
-import { Buffer } from 'buffer';
-import BigNumber from 'bignumber.js';
-export * from './validators';
-export { VERSION } from './version';
-export { prefix, Prefix, prefixLength } from './constants';
-export { verifySignature, validatePkAndExtractPrefix } from './verify-signature';
-export * from './errors';
-export { format } from './format';
-/**
- *
- * @description Hash a string using the BLAKE2b algorithm, base58 encode the hash obtained and appends the prefix 'expr' to it
- *
- * @param value Value in hex
- */
-export declare function encodeExpr(value: string): string;
-/**
- *
- * @description Return the operation hash of a signed operation
- * @param value Value in hex of a signed operation
- */
-export declare function encodeOpHash(value: string): string;
-/**
- *
- * @description Base58 encode a string or a Uint8Array and append a prefix to it
- *
- * @param value Value to base58 encode
- * @param prefix prefix to append to the encoded string
- */
-export declare function b58cencode(value: string | Uint8Array, prefix: Uint8Array): string;
-/**
- *
- * @description Base58 decode a string and remove the prefix from it
- *
- * @param value Value to base58 decode
- * @param prefix prefix to remove from the decoded string
- */
-export declare const b58cdecode: (enc: string, prefixArg: Uint8Array) => Uint8Array;
-/**
- *
- * @description Base58 decode a string with predefined prefix
- *
- * @param value Value to base58 decode
- */
-export declare function b58decode(payload: string): string;
-/**
- *
- * @description b58 decode a string without predefined prefix
- * @param value
- * @returns string of bytes
- */
-export declare function b58decodeL2Address(payload: string): string;
-/**
- *
- * @description Base58 encode an address using predefined prefix
- *
- * @param value Address to base58 encode (tz1, tz2, tz3 or KT1)
- */
-export declare function encodePubKey(value: string): string;
-/**
- *
- * @description Base58 encode an address without predefined prefix
- * @param value Address to base58 encode (tz4) hex dec
- * @returns return address
- */
-export declare function encodeL2Address(value: string): string;
-/**
- *
- * @description Base58 encode a key according to its prefix
- *
- * @param value Key to base58 encode
- */
-export declare function encodeKey(value: string): string | undefined;
-/**
- *
- * @description Base58 encode a key hash according to its prefix
- *
- * @param value Key hash to base58 encode
- */
-export declare function encodeKeyHash(value: string): string | undefined;
-/**
- *
- * @description Convert an hex string to a Uint8Array
- *
- * @param hex Hex string to convert
- * @throws {@link ValueConversionError}
- */
-export declare const hex2buf: (hex: string) => Uint8Array;
-/**
- *
- * @description Merge 2 buffers together
- *
- * @param b1 First buffer
- * @param b2 Second buffer
- */
-export declare const mergebuf: (b1: Uint8Array, b2: Uint8Array) => Uint8Array;
-/**
- *
- * @description Flatten a michelson json representation to an array
- *
- * @param s michelson json
- */
-export declare const mic2arr: (s: any) => any;
-/**
- *
- * @description Convert a buffer to an hex string
- *
- * @param buffer Buffer to convert
- */
-export declare const buf2hex: (buffer: Buffer) => string;
-/**
- *
- *  @description Gets Tezos address (PKH) from Public Key
- *
- *  @param publicKey Public Key
- *  @returns A string of the Tezos address (PKH) that was derived from the given Public Key
- */
-export declare const getPkhfromPk: (publicKey: string) => string;
-/**
- *
- * @description Convert a string to bytes
- *
- * @param str String to convert
- */
-export declare function char2Bytes(str: string): string;
-/**
- *
- * @description Convert bytes to a string
- *
- * @param str Bytes to convert
- */
-export declare function bytes2Char(hex: string): string;
-/**
- *
- * @description 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
- *
- * @param val The value  that will be converted to a hexadecimal string value
- */
-export declare function toHexBuf(val: number | BigNumber, bitLength?: number): Buffer;
-/**
- *
- * @description 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
- *
- */
-export declare function num2PaddedHex(val: number | BigNumber, bitLength?: number): string;
-/**
- *
- * @description Strips the first 2 characters of a hex string (0x)
- *
- * @param hex string to strip prefix from
- */
-export declare function stripHexPrefix(hex: string): string;
+/**
+ * @packageDocumentation
+ * @module @taquito/utils
+ */
+/// <reference types="node" />
+import { Buffer } from 'buffer';
+import BigNumber from 'bignumber.js';
+export * from './validators';
+export { VERSION } from './version';
+export { prefix, Prefix, prefixLength } from './constants';
+export { verifySignature, validatePkAndExtractPrefix } from './verify-signature';
+export * from './errors';
+export { format } from './format';
+/**
+ *
+ * @description Hash a string using the BLAKE2b algorithm, base58 encode the hash obtained and appends the prefix 'expr' to it
+ *
+ * @param value Value in hex
+ */
+export declare function encodeExpr(value: string): string;
+/**
+ *
+ * @description Return the operation hash of a signed operation
+ * @param value Value in hex of a signed operation
+ */
+export declare function encodeOpHash(value: string): string;
+/**
+ *
+ * @description Base58 encode a string or a Uint8Array and append a prefix to it
+ *
+ * @param value Value to base58 encode
+ * @param prefix prefix to append to the encoded string
+ */
+export declare function b58cencode(value: string | Uint8Array, prefix: Uint8Array): string;
+/**
+ *
+ * @description Base58 decode a string and remove the prefix from it
+ *
+ * @param value Value to base58 decode
+ * @param prefix prefix to remove from the decoded string
+ */
+export declare const b58cdecode: (enc: string, prefixArg: Uint8Array) => Uint8Array;
+/**
+ *
+ * @description Base58 decode a string with predefined prefix
+ *
+ * @param value Value to base58 decode
+ */
+export declare function b58decode(payload: string): string;
+/**
+ *
+ * @description b58 decode a string without predefined prefix
+ * @param value
+ * @returns string of bytes
+ */
+export declare function b58decodeL2Address(payload: string): string;
+/**
+ *
+ * @description Base58 encode an address using predefined prefix
+ *
+ * @param value Address to base58 encode (tz1, tz2, tz3 or KT1)
+ */
+export declare function encodePubKey(value: string): string;
+/**
+ *
+ * @description Base58 encode an address without predefined prefix
+ * @param value Address to base58 encode (tz4) hex dec
+ * @returns return address
+ */
+export declare function encodeL2Address(value: string): string;
+/**
+ *
+ * @description Base58 encode a key according to its prefix
+ *
+ * @param value Key to base58 encode
+ */
+export declare function encodeKey(value: string): string | undefined;
+/**
+ *
+ * @description Base58 encode a key hash according to its prefix
+ *
+ * @param value Key hash to base58 encode
+ */
+export declare function encodeKeyHash(value: string): string | undefined;
+/**
+ *
+ * @description Convert an hex string to a Uint8Array
+ *
+ * @param hex Hex string to convert
+ * @throws {@link ValueConversionError}
+ */
+export declare const hex2buf: (hex: string) => Uint8Array;
+/**
+ *
+ * @description Merge 2 buffers together
+ *
+ * @param b1 First buffer
+ * @param b2 Second buffer
+ */
+export declare const mergebuf: (b1: Uint8Array, b2: Uint8Array) => Uint8Array;
+/**
+ *
+ * @description Flatten a michelson json representation to an array
+ *
+ * @param s michelson json
+ */
+export declare const mic2arr: (s: any) => any;
+/**
+ *
+ * @description Convert a Uint8Array to an hex string
+ *
+ * @param buffer Uint8Array to convert
+ */
+export declare const buf2hex: (buffer: Uint8Array) => string;
+/**
+ *
+ *  @description Gets Tezos address (PKH) from Public Key
+ *
+ *  @param publicKey Public Key
+ *  @returns A string of the Tezos address (PKH) that was derived from the given Public Key
+ */
+export declare const getPkhfromPk: (publicKey: string) => string;
+/**
+ *
+ * @description Convert a string to bytes
+ *
+ * @param str String to convert
+ */
+export declare function char2Bytes(str: string): string;
+/**
+ *
+ * @description Convert bytes to a string
+ *
+ * @param str Bytes to convert
+ */
+export declare function bytes2Char(hex: string): string;
+/**
+ *
+ * @description 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
+ *
+ * @param val The value  that will be converted to a hexadecimal string value
+ */
+export declare function toHexBuf(val: number | BigNumber, bitLength?: number): Buffer;
+/**
+ *
+ * @description 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
+ *
+ */
+export declare function num2PaddedHex(val: number | BigNumber, bitLength?: number): string;
+/**
+ *
+ * @description Strips the first 2 characters of a hex string (0x)
+ *
+ * @param hex string to strip prefix from
+ */
+export declare function stripHexPrefix(hex: string): string;

package/dist/types/validators.d.ts

@@ -1,160 +1,160 @@
-import { Prefix } from './constants';
-export declare enum ValidationResult {
-    NO_PREFIX_MATCHED = 0,
-    INVALID_CHECKSUM = 1,
-    INVALID_LENGTH = 2,
-    VALID = 3
-}
-export declare function isValidPrefix(value: unknown): value is Prefix;
-/**
- * @description Used to check if an address or a contract address is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validateAddress } from '@taquito/utils';
- * const pkh = 'tz1L9r8mWmRPndRhuvMCWESLGSVeFzQ9NAWx'
- * const validation = validateAddress(pkh)
- * console.log(validation)
- * // This example return 3 which correspond to VALID
- * ```
- */
-export declare function validateAddress(value: string): ValidationResult;
-/**
- * @description Used to check if a chain id is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validateChain } from '@taquito/utils';
- * const chainId = 'NetXdQprcVkpaWU'
- * const validation = validateChain(chainId)
- * console.log(validation)
- * // This example return 3 which correspond to VALID
- * ```
- */
-export declare function validateChain(value: string): ValidationResult;
-/**
- * @description Used to check if a contract address is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validateContractAddress } from '@taquito/utils';
- * const contractAddress = 'KT1JVErLYTgtY8uGGZ4mso2npTSxqVLDRVbC'
- * const validation = validateContractAddress(contractAddress)
- * console.log(validation)
- * // This example return 3 which correspond to VALID
- * ```
- */
-export declare function validateContractAddress(value: string): ValidationResult;
-/**
- * @description Used to check if a key hash is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validateKeyHash } from '@taquito/utils';
- * const keyHashWithoutPrefix = '1L9r8mWmRPndRhuvMCWESLGSVeFzQ9NAWx'
- * const validation = validateKeyHash(keyHashWithoutPrefix)
- * console.log(validation)
- * // This example return 0 which correspond to NO_PREFIX_MATCHED
- * ```
- */
-export declare function validateKeyHash(value: string): ValidationResult;
-/**
- * @description Used to check if a signature is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validateSignature } from '@taquito/utils';
- * const signature = 'edsigtkpiSSschcaCt9pUVrpNPf7TTcgvgDEDD6NCEHMy8NNQJCGnMfLZzYoQj74yLjo9wx6MPVV29CvVzgi7qEcEUok3k7AuMg'
- * const validation = validateSignature(signature)
- * console.log(validation)
- * // This example return 3 which correspond to VALID
- * ```
- */
-export declare function validateSignature(value: string): ValidationResult;
-/**
- * @description Used to check if a public key is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validatePublicKey } from '@taquito/utils';
- * const publicKey = 'edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g'
- * const validation = validatePublicKey(publicKey)
- * console.log(validation)
- * // This example return 3 which correspond to VALID
- * ```
- */
-export declare function validatePublicKey(value: string): ValidationResult;
-/**
- * @description Used to check if an operation hash is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validateOperation } from '@taquito/utils';
- * const operationHash = 'oo6JPEAy8VuMRGaFuMmLNFFGdJgiaKfnmT1CpHJfKP3Ye5ZahiP'
- * const validation = validateOperation(operationHash)
- * console.log(validation)
- * // This example return 3 which correspond to VALID
- * ```
- */
-export declare function validateOperation(value: string): ValidationResult;
-/**
- * @description Used to check if a protocol hash is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validateProtocol } from '@taquito/utils';
- * const protocolHash = 'PtHangz2aRngywmSRGGvrcTyMbbdpWdpFKuS4uMWxg2RaH9i1qx'
- * const validation = validateProtocol(protocolHash)
- * console.log(validation)
- * // This example return 3 which correspond to VALID
- * ```
- */
-export declare function validateProtocol(value: string): ValidationResult;
-/**
- * @description Used to check if a block hash is valid.
- *
- * @returns
- * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- * @example
- * ```
- * import { validateBlock } from '@taquito/utils';
- * const blockHash = 'PtHangz2aRngywmSRGGvrcTyMbbdpWdpFKuS4uMWxg2RaH9i1qx'
- * const validation = validateBlock(blockHash)
- * console.log(validation)
- * // This example return 3 which correspond to VALID
- * ```
- */
-export declare function validateBlock(value: string): ValidationResult;
-/**
- * @description Used to check if a spending key is valid.
- * @returns 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
- *
- */
-export declare function validateSpendingKey(value: any): ValidationResult;
-export declare function invalidDetail(validation: ValidationResult): string;
-export declare function validateSmartRollupAddress(value: string): ValidationResult;
+import { Prefix } from './constants';
+export declare enum ValidationResult {
+    NO_PREFIX_MATCHED = 0,
+    INVALID_CHECKSUM = 1,
+    INVALID_LENGTH = 2,
+    VALID = 3
+}
+export declare function isValidPrefix(value: unknown): value is Prefix;
+/**
+ * @description Used to check if an address or a contract address is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validateAddress } from '@taquito/utils';
+ * const pkh = 'tz1L9r8mWmRPndRhuvMCWESLGSVeFzQ9NAWx'
+ * const validation = validateAddress(pkh)
+ * console.log(validation)
+ * // This example return 3 which correspond to VALID
+ * ```
+ */
+export declare function validateAddress(value: string): ValidationResult;
+/**
+ * @description Used to check if a chain id is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validateChain } from '@taquito/utils';
+ * const chainId = 'NetXdQprcVkpaWU'
+ * const validation = validateChain(chainId)
+ * console.log(validation)
+ * // This example return 3 which correspond to VALID
+ * ```
+ */
+export declare function validateChain(value: string): ValidationResult;
+/**
+ * @description Used to check if a contract address is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validateContractAddress } from '@taquito/utils';
+ * const contractAddress = 'KT1JVErLYTgtY8uGGZ4mso2npTSxqVLDRVbC'
+ * const validation = validateContractAddress(contractAddress)
+ * console.log(validation)
+ * // This example return 3 which correspond to VALID
+ * ```
+ */
+export declare function validateContractAddress(value: string): ValidationResult;
+/**
+ * @description Used to check if a key hash is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validateKeyHash } from '@taquito/utils';
+ * const keyHashWithoutPrefix = '1L9r8mWmRPndRhuvMCWESLGSVeFzQ9NAWx'
+ * const validation = validateKeyHash(keyHashWithoutPrefix)
+ * console.log(validation)
+ * // This example return 0 which correspond to NO_PREFIX_MATCHED
+ * ```
+ */
+export declare function validateKeyHash(value: string): ValidationResult;
+/**
+ * @description Used to check if a signature is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validateSignature } from '@taquito/utils';
+ * const signature = 'edsigtkpiSSschcaCt9pUVrpNPf7TTcgvgDEDD6NCEHMy8NNQJCGnMfLZzYoQj74yLjo9wx6MPVV29CvVzgi7qEcEUok3k7AuMg'
+ * const validation = validateSignature(signature)
+ * console.log(validation)
+ * // This example return 3 which correspond to VALID
+ * ```
+ */
+export declare function validateSignature(value: string): ValidationResult;
+/**
+ * @description Used to check if a public key is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validatePublicKey } from '@taquito/utils';
+ * const publicKey = 'edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g'
+ * const validation = validatePublicKey(publicKey)
+ * console.log(validation)
+ * // This example return 3 which correspond to VALID
+ * ```
+ */
+export declare function validatePublicKey(value: string): ValidationResult;
+/**
+ * @description Used to check if an operation hash is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validateOperation } from '@taquito/utils';
+ * const operationHash = 'oo6JPEAy8VuMRGaFuMmLNFFGdJgiaKfnmT1CpHJfKP3Ye5ZahiP'
+ * const validation = validateOperation(operationHash)
+ * console.log(validation)
+ * // This example return 3 which correspond to VALID
+ * ```
+ */
+export declare function validateOperation(value: string): ValidationResult;
+/**
+ * @description Used to check if a protocol hash is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validateProtocol } from '@taquito/utils';
+ * const protocolHash = 'PtHangz2aRngywmSRGGvrcTyMbbdpWdpFKuS4uMWxg2RaH9i1qx'
+ * const validation = validateProtocol(protocolHash)
+ * console.log(validation)
+ * // This example return 3 which correspond to VALID
+ * ```
+ */
+export declare function validateProtocol(value: string): ValidationResult;
+/**
+ * @description Used to check if a block hash is valid.
+ *
+ * @returns
+ * 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ * @example
+ * ```
+ * import { validateBlock } from '@taquito/utils';
+ * const blockHash = 'PtHangz2aRngywmSRGGvrcTyMbbdpWdpFKuS4uMWxg2RaH9i1qx'
+ * const validation = validateBlock(blockHash)
+ * console.log(validation)
+ * // This example return 3 which correspond to VALID
+ * ```
+ */
+export declare function validateBlock(value: string): ValidationResult;
+/**
+ * @description Used to check if a spending key is valid.
+ * @returns 0 (NO_PREFIX_MATCHED), 1 (INVALID_CHECKSUM), 2 (INVALID_LENGTH) or 3 (VALID).
+ *
+ */
+export declare function validateSpendingKey(value: any): ValidationResult;
+export declare function invalidDetail(validation: ValidationResult): string;
+export declare function validateSmartRollupAddress(value: string): ValidationResult;