@tezos-x/octez.js-utils 0.9.0

package/dist/octez.js-utils.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"octez.js-utils.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/types/constants.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @description base58 name to prefix mapping
+ */
+export declare enum PrefixV2 {
+    BlockHash = "B",
+    OperationHash = "o",
+    OperationListHash = "Lo",
+    OperationListListHash = "LLo",
+    ProtocolHash = "P",
+    ContextHash = "Co",
+    BlockMetadataHash = "bm",
+    OperationMetadataHash = "r",
+    OperationMetadataListHash = "Lr",
+    OperationMetadataListListHash = "LLr",
+    Ed25519PublicKeyHash = "tz1",
+    Secp256k1PublicKeyHash = "tz2",
+    P256PublicKeyHash = "tz3",
+    ContractHash = "KT1",
+    BlindedPublicKeyHash = "btz1",
+    BLS12_381PublicKeyHash = "tz4",
+    TXRollupAddress = "txr1",
+    ZkRollupHash = "epx1",
+    ScRollupHash = "scr1",
+    SmartRollupHash = "sr1",
+    CryptoboxPublicKeyHash = "id",
+    Ed25519Seed = "edsk",
+    Ed25519PublicKey = "edpk",
+    Secp256k1SecretKey = "spsk",
+    P256SecretKey = "p2sk",
+    BLS12_381SecretKey = "BLsk",
+    ValueHash = "vh",
+    CycleNonce = "nce",
+    ScriptExpr = "expr",
+    InboxHash = "txi",
+    MessageHash = "txm",
+    CommitmentHash = "txc",
+    MessageResultHash = "txmr",
+    MessageResultListHash = "txM",
+    WithdrawListHash = "txw",
+    ScRollupStateHash = "scs1",
+    ScRollupCommitmentHash = "scc1",
+    SmartRollupStateHash = "srs1",
+    SmartRollupCommitmentHash = "src1",
+    Ed25519EncryptedSeed = "edesk",
+    Secp256k1EncryptedSecretKey = "spesk",
+    P256EncryptedSecretKey = "p2esk",
+    BLS12_381EncryptedSecretKey = "BLesk",
+    Secp256k1EncryptedScalar = "seesk",
+    Secp256k1PublicKey = "sppk",
+    P256PublicKey = "p2pk",
+    Secp256k1Scalar = "SSp",
+    Secp256k1Element = "GSp",
+    Ed25519SecretKey = "_edsk",
+    Ed25519Signature = "edsig",
+    Secp256k1Signature = "spsig1",
+    P256Signature = "p2sig",
+    GenericSignature = "sig",
+    ChainID = "Net",
+    SaplingSpendingKey = "sask",
+    EncryptedSaplingSpendingKey = "_sask",
+    SaplingAddress = "zet1",
+    GenericAggregateSignature = "asig",
+    BLS12_381Signature = "BLsig",
+    BLS12_381PublicKey = "BLpk",
+    SlotHeader = "sh"
+}
+/**
+ * @description base58 prefix to bytes mapping
+ */
+export declare const prefixV2: {
+    [key in PrefixV2]: Uint8Array;
+};
+/**
+ * @description base58 prefix to payload length mapping
+ */
+export declare const payloadLength: {
+    [key in PrefixV2]: number;
+};

package/dist/types/encoding.d.ts

@@ -0,0 +1,184 @@
+/**
+ * @packageDocumentation
+ * @module @tezos-x/octez.js-utils
+ */
+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
+ */
+export declare const addressPrefixes: PrefixV2[];
+/**
+ * @description 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
+ */
+export declare const publicKeyHashPrefixes: PrefixV2[];
+/**
+ * @description 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
+ * @param src Base58 string
+ * @returns Payload and prefix
+ * @example b58DecodeAndCheckPrefix('tz1gvF4cD2dDtqitL3ZTraggSR1Mju2BKFEM') // returns [Uint8Array, PrefixV2.Ed25519PublicKeyHash]
+ * @example b58DecodeAndCheckPrefix('tz1gvF4cD2dDtqitL3ZTraggSR1Mju2BKFEM', [PrefixV2.Ed25519PublicKeyHash]) // returns [Uint8Array, PrefixV2.Ed25519PublicKeyHash]
+ * @example b58DecodeAndCheckPrefix('tz1gvF4cD2dDtqitL3ZTraggSR1Mju2BKFEM', [PrefixV2.Ed25519PublicKeyHash], true) // returns Uint8Array
+ */
+export declare function b58DecodeAndCheckPrefix<T extends readonly PrefixV2[]>(src: string, allowed?: T): [Uint8Array, T[number]];
+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
+ * @param value Value to decode
+ * @param fmt optional format of the decoded return value, 'hex' or 'array'
+ * @returns string or Uint8Array of bytes
+ * @example b58DecodePublicKey('edpkuNjKKT48xBoT5asPrWdmuM1Yw8D93MwgFgVvtca8jb5pstzaCh') // return '0060842d4ba23a9940ef5dcf4404fdaa430cfaaccb5029fad06cb5ea894e4562ae'
+ */
+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
+ * @param value Value to decode
+ * @param fmt optional format of the decoded return value, 'hex' or 'array'
+ * @returns string or Uint8Array of bytes
+ * @example b58DecodePublicKeyHash('tz2MVED1t9Jery77Bwm1m5YhUx8Wp5KWWRQe') // return '0001907d6a7e9f084df840d6e67ffa8db5464f87d4d1'
+ */
+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
+ * @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
+ * @example b58DecodeBlsAddress('tz4QyWfEiv56CVDATV3DT3CDVhPaMKif2Ce8') // return 'af2dc3c40667abc0e89c0ef40171d22aed08d5eb'
+ */
+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
+ * @param value Value to decode
+ * @param fmt optional format of the decoded return value, 'hex' or 'array'
+ * @returns string or Uint8Array of bytes
+ * @example b58DecodeAddress('tz1gvF4cD2dDtqitL3ZTraggSR1Mju2BKFEM') // return '0000e96b9f8b19af9c7ffa0c0480e1977b295850961f'
+ */
+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
+ *  @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
+ * @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
+ * @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
+ * @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
+ * @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
+ * @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
+ * @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
+ * @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
+ * @param hex Hex string to convert
+ * @throws {@link ValueConversionError}
+ */
+export declare function hex2buf(hex: string): Uint8Array;
+/**
+ * @description 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
+ * @param s michelson json
+ */
+export declare function mic2arr(s: any): any;
+/**
+ * @description Convert a Uint8Array to an hex string
+ * @param buffer Uint8Array to convert
+ */
+export declare function buf2hex(bytes: ArrayLike<number>): string;
+/**
+ * @description 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
+ * @param hex byte string to convert
+ */
+export declare function bytesToString(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;
+export declare function numToHexBuffer(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;
+export declare function splitAddress(addr: string): [string, string | null];
+export declare function compareArrays(a: ArrayLike<number>, b: ArrayLike<number>): number;

package/dist/types/errors.d.ts

@@ -0,0 +1,20 @@
+import { ParameterValidationError, UnsupportedActionError, ValidationResult } from '@tezos-x/octez.js-core';
+export { InvalidAddressError, InvalidBlockHashError, InvalidHexStringError, InvalidMessageError, InvalidKeyError, InvalidPublicKeyError, InvalidSignatureError, InvalidContractAddressError, InvalidChainIdError, InvalidKeyHashError, InvalidOperationHashError, InvalidOperationKindError, DeprecationError, ProhibitedActionError, } from '@tezos-x/octez.js-core';
+/**
+ *  @category Error
+ *  @description Error that indicates invalid protocol hash being passed or used
+ */
+export declare class InvalidProtocolHashError extends ParameterValidationError {
+    readonly protocolHash: string;
+    name: string;
+    constructor(protocolHash: string, errorDetails?: string | ValidationResult);
+}
+/**
+ *  @category Error
+ *  @description Error that indicates unable to convert data type from one to another
+ */
+export declare class ValueConversionError extends UnsupportedActionError {
+    readonly value: string;
+    readonly desiredType: string;
+    constructor(value: string, desiredType: string);
+}

package/dist/types/format.d.ts

@@ -0,0 +1,4 @@
+import BigNumber from 'bignumber.js';
+type Format = 'tz' | 'mtz' | 'mutez';
+export declare function format(from: Format | undefined, to: Format | undefined, amount: number | string | BigNumber): string | number | BigNumber;
+export {};

package/dist/types/octez.js-utils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @packageDocumentation
+ * @module @tezos-x/octez.js-utils
+ */
+export * from './encoding';
+export * from './validators';
+export { VERSION } from './version';
+export { PrefixV2, payloadLength } from './constants';
+export { verifySignature, BLS12_381_DST, POP_DST } from './verify-signature';
+export * from './errors';
+export { format } from './format';

package/dist/types/validators.d.ts

@@ -0,0 +1,167 @@
+import { PrefixV2 } from './constants';
+import { ValidationResult } from '@tezos-x/octez.js-core';
+export { ValidationResult } from '@tezos-x/octez.js-core';
+/**
+ * @description 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
+ * ```
+ * import { isValidPrefixedValue } from '@tezos-x/octez.js-utils';
+ * const value = 'tz1L9r8mWmRPndRhuvMCWESLGSVeFzQ9NAWx'
+ * const isValid = isValidPrefixedValue(value, [PrefixV2.Ed25519PublicKeyHash])
+ * console.log(isValid) // true
+ * ```
+ */
+export declare function isValidPrefixedValue(value: string, prefixes?: PrefixV2[]): boolean;
+/**
+ * @description 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,
+ *
+ * @example
+ * ```
+ * import { validateAddress } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ * @example
+ * ```
+ * import { validateChain } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ * @example
+ * ```
+ * import { validateContractAddress } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ * @example
+ * ```
+ * import { validateKeyHash } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ * @example
+ * ```
+ * import { validateSignature } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ * @example
+ * ```
+ * import { validatePublicKey } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ * @example
+ * ```
+ * import { validateOperation } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ * @example
+ * ```
+ * import { validateProtocol } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ * @example
+ * ```
+ * import { validateBlock } from '@tezos-x/octez.js-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, 3 = VALID, 4 = PREFIX_NOT_ALLOWED, 5 = INVALID_ENCODING, 6 = OTHER,
+ *
+ */
+export declare function validateSpendingKey(value: string): ValidationResult;
+export declare function validateSmartRollupAddress(value: string): ValidationResult;

package/dist/types/verify-signature.d.ts

@@ -0,0 +1,22 @@
+export declare const BLS12_381_DST = "BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_";
+export declare const POP_DST = "BLS_POP_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_";
+/**
+ * @description 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}
+ * @example
+ * ```
+ * const message = '03d0c10e3ed11d7c6e3357f6ef335bab9e8f2bd54d0ce20c482e241191a6e4b8ce6c01be917311d9ac46959750e405d57e268e2ed9e174a80794fbd504e12a4a000141eb3781afed2f69679ff2bbe1c5375950b0e40d00ff000000005e05050505050507070100000024747a32526773486e74516b72794670707352466261313652546656503539684b72654a4d07070100000024747a315a6672455263414c42776d4171776f6e525859565142445439426a4e6a42484a750001';
+ * const pk = 'sppk7c7hkPj47yjYFEHX85q46sFJGw6RBrqoVSHwAJAT4e14KJwzoey';
+ * const sig = 'spsig1cdLkp1RLgUHAp13aRFkZ6MQDPp7xCnjAExGL3MBSdMDmT6JgQSX8cufyDgJRM3sinFtiCzLbsyP6d365EHoNevxhT47nx'
+ *
+ * const response = verifySignature(message, pk, sig);
+ * ```
+ *
+ */
+export declare function verifySignature(message: string | Uint8Array, publicKey: string, signature: string, watermark?: Uint8Array, pop?: boolean): boolean;

package/dist/types/version.d.ts

@@ -0,0 +1,4 @@
+export declare const VERSION: {
+    commitHash: string;
+    version: string;
+};

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@tezos-x/octez.js-utils",
+  "version": "0.9.0",
+  "description": "converts michelson data and types into convenient JS/TS objects",
+  "keywords": [
+    "tezos",
+    "blockchain",
+    "michelson",
+    "smart-contract"
+  ],
+  "main": "dist/octez.js-utils.umd.js",
+  "module": "dist/octez.js-utils.es6.js",
+  "typings": "dist/types/octez.js-utils.d.ts",
+  "files": [
+    "dist",
+    "signature.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Simon Boissonneault-Robert <simon@ecadlabs.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/trilitech/octez.js.git"
+  },
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "lint": "eslint --ext .js,.ts .",
+    "precommit": "lint-staged",
+    "prebuild": "rimraf dist",
+    "version-stamp": "node ../octez.js/version-stamping.js",
+    "build": "tsc --project ./tsconfig.prod.json --module commonjs && rollup -c rollup.config.ts --bundleConfigAsCjs",
+    "start": "rollup -c rollup.config.ts --bundleConfigAsCjs -w",
+    "test": "jest"
+  },
+  "lint-staged": {
+    "{src,test}/**/*.ts": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "jest": {
+    "transform": {
+      ".(ts|tsx)": "ts-jest"
+    },
+    "testEnvironment": "node",
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js"
+    ],
+    "coveragePathIgnorePatterns": [
+      "/node_modules/",
+      "/test/"
+    ],
+    "collectCoverageFrom": [
+      "src/**/*.{js,ts}"
+    ]
+  },
+  "dependencies": {
+    "@noble/curves": "^1.9.7",
+    "@stablelib/blake2b": "^1.0.1",
+    "@stablelib/ed25519": "^1.0.3",
+    "@tezos-x/octez.js-core": "*",
+    "@types/bs58check": "^2.1.2",
+    "bignumber.js": "^9.1.2",
+    "blakejs": "^1.2.1",
+    "bs58check": "^3.0.1",
+    "buffer": "^6.0.3",
+    "typedarray-to-buffer": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/bluebird": "^3.5.42",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20",
+    "@types/typedarray-to-buffer": "^4.0.4",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "colors": "^1.4.0",
+    "coveralls": "^3.1.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "jest-config": "^29.7.0",
+    "lint-staged": "^15.2.7",
+    "lodash.camelcase": "^4.3.0",
+    "prettier": "^3.3.3",
+    "prompt": "^1.3.0",
+    "replace-in-file": "^8.1.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.22.4",
+    "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-polyfill-node": "^0.13.0",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "shelljs": "^0.8.5",
+    "ts-jest": "^29.2.3",
+    "ts-node": "^10.9.2",
+    "ts-toolbelt": "^9.6.0",
+    "typescript": "~5.5.4"
+  },
+  "gitHead": "551e35aeff7d6dcde1c72284238c0ed3c3aae77e"
+}