@bitgo-beta/sdk-coin-icp 1.0.1-beta.95 → 1.0.1-beta.97

package/dist/src/lib/utils.d.ts

@@ -1,25 +1,279 @@
-import { BaseUtils, KeyPair } from '@bitgo-beta/sdk-core';
+import { BaseUtils, KeyPair, Recipient } from '@bitgo-beta/sdk-core';
 import { Principal as DfinityPrincipal } from '@dfinity/principal';
+import { HttpCanisterUpdate, IcpTransactionData, ReadState, Signatures, IcpMetadata } from './iface';
+import BigNumber from 'bignumber.js';
+export declare const REQUEST_STATUS = "request_status";
 export declare class Utils implements BaseUtils {
-    isValidAddress(address: string): boolean;
+    /** @inheritdoc */
     isValidTransactionId(txId: string): boolean;
+    /** @inheritdoc */
+    isValidBlockId(hash: string): boolean;
+    /** @inheritdoc */
+    isValidSignature(signature: string): boolean;
+    /**
+     * gets the gas data of this transaction.
+     */
+    gasData(): string;
+    /**
+     * Checks if the provided address is a valid hexadecimal string.
+     *
+     * @param {string} address - The address to validate.
+     * @returns {boolean} - Returns `true` if the address is a valid 64-character hexadecimal string, otherwise `false`.
+     */
+    isValidAddress(address: string): boolean;
+    /**
+     * Checks if the provided hex string is a valid public key.
+     *
+     * A valid public key can be either compressed or uncompressed:
+     * - Compressed public keys are 33 bytes long and start with either 0x02 or 0x03.
+     * - Uncompressed public keys are 65 bytes long and start with 0x04.
+     *
+     * @param {string} hexStr - The hex string representation of the public key to validate.
+     * @returns {boolean} - Returns `true` if the hex string is a valid public key, otherwise `false`.
+     */
     isValidPublicKey(hexStr: string): boolean;
+    /**
+     * Encodes a value into CBOR format and returns it as a hex string.
+     *
+     * @param {unknown} value - The value to encode.
+     * @returns {string} - The CBOR encoded value as a hex string.
+     */
+    cborEncode(value: unknown): string;
+    /**
+     * Checks if the length of the given hexadecimal string is valid.
+     * A valid length is either 66 characters (33 bytes) or 130 characters (65 bytes).
+     *
+     * @param {string} hexStr - The hexadecimal string to check.
+     * @returns {boolean} - Returns `true` if the length is valid, otherwise `false`.
+     */
     isValidLength(hexStr: string): boolean;
+    /**
+     * Checks if the provided string is a valid hexadecimal string.
+     *
+     * A valid hexadecimal string consists of pairs of hexadecimal digits (0-9, a-f, A-F).
+     *
+     * @param hexStr - The string to be validated as a hexadecimal string.
+     * @returns True if the string is a valid hexadecimal string, false otherwise.
+     */
     isValidHex(hexStr: string): boolean;
+    /**
+     * Converts a hexadecimal string to a Uint8Array.
+     *
+     * @param {string} hex - The hexadecimal string to convert.
+     * @returns {Uint8Array} The resulting byte array.
+     */
     hexToBytes(hex: string): Uint8Array;
     /** @inheritdoc */
     isValidPrivateKey(key: string): boolean;
+    /**
+     * Validates whether the provided key is a valid ICP private key.
+     *
+     * This function attempts to create a new instance of `IcpKeyPair` using the provided key.
+     * If the key is valid, the function returns `true`. If the key is invalid, an error is thrown,
+     * and the function returns `false`.
+     *
+     * @param {string} key - The private key to validate.
+     * @returns {boolean} - `true` if the key is valid, `false` otherwise.
+     */
     isValidKey(key: string): boolean;
-    isValidSignature(signature: string): boolean;
-    isValidBlockId(hash: string): boolean;
-    getHeaders(): Record<string, string>;
-    getNetworkIdentifier(): Record<string, string>;
+    /**
+     * Compresses an uncompressed public key.
+     *
+     * @param {string} uncompressedKey - The uncompressed public key in hexadecimal format.
+     * @returns {string} - The compressed public key in hexadecimal format.
+     * @throws {Error} - If the input key is not a valid uncompressed public key.
+     */
     compressPublicKey(uncompressedKey: string): string;
-    getCurveType(): string;
+    /**
+     * Converts a public key from its hexadecimal string representation to DER format.
+     *
+     * @param {string} publicKeyHex - The public key in hexadecimal string format.
+     * @returns The public key in DER format as a Uint8Array.
+     */
+    getPublicKeyInDERFormat(publicKeyHex: string): Uint8Array;
+    /**
+     * Converts a public key in hexadecimal format to a Dfinity Principal ID.
+     *
+     * @param {string} publicKeyHex - The public key in hexadecimal format.
+     * @returns The corresponding Dfinity Principal ID.
+     */
+    getPrincipalIdFromPublicKey(publicKeyHex: string): DfinityPrincipal;
+    /**
+     * Derives a DfinityPrincipal from a given public key in hexadecimal format.
+     *
+     * @param {string} publicKeyHex - The public key in hexadecimal format.
+     * @returns The derived DfinityPrincipal.
+     * @throws Will throw an error if the principal cannot be derived from the public key.
+     */
     derivePrincipalFromPublicKey(publicKeyHex: string): DfinityPrincipal;
+    /**
+     * Converts a DfinityPrincipal and an optional subAccount to a string representation of an account ID.
+     *
+     * @param {DfinityPrincipal} principal - The principal to convert.
+     * @param {Uint8Array} [subAccount=new Uint8Array(32)] - An optional sub-account, defaults to a 32-byte array of zeros.
+     * @returns {string} The hexadecimal string representation of the account ID.
+     */
     fromPrincipal(principal: DfinityPrincipal, subAccount?: Uint8Array): string;
+    /**
+     * Retrieves the address associated with a given hex-encoded public key.
+     *
+     * @param {string} hexEncodedPublicKey - The public key in hex-encoded format.
+     * @returns {Promise<string>} A promise that resolves to the address derived from the provided public key.
+     * @throws {Error} Throws an error if the provided public key is not in a valid hex-encoded format.
+     */
     getAddressFromPublicKey(hexEncodedPublicKey: string): Promise<string>;
+    /**
+     * Generates a new key pair. If a seed is provided, it will be used to generate the key pair.
+     *
+     * @param {Buffer} [seed] - Optional seed for key generation.
+     * @returns {KeyPair} - The generated key pair containing both public and private keys.
+     * @throws {Error} - If the private key is missing in the generated key pair.
+     */
     generateKeyPair(seed?: Buffer): KeyPair;
+    validateFee(fee: string): void;
+    /** @inheritdoc */
+    validateValue(value: BigNumber): void;
+    validateMemo(memo: number | BigInt): void;
+    validateExpireTime(expireTime: number | BigInt): void;
+    /**
+     * Validates the raw transaction data to ensure it has a valid format in the blockchain context.
+     *
+     * @param {IcpTransactionData} transactionData - The transaction data to validate.
+     * @throws {ParseTransactionError} If the transaction data is invalid.
+     */
+    validateRawTransaction(transactionData: IcpTransactionData): void;
+    /**
+     *
+     * @param {object} update
+     * @returns {Buffer}
+     */
+    generateHttpCanisterUpdateId(update: HttpCanisterUpdate): Buffer;
+    /**
+     * Generates a representation-independent hash for an HTTP canister update.
+     *
+     * @param {HttpCanisterUpdate} update - The HTTP canister update object.
+     * @returns {Buffer} - The hash of the update object.
+     */
+    HttpCanisterUpdateRepresentationIndependentHash(update: HttpCanisterUpdate): Buffer;
+    /**
+     * Generates a SHA-256 hash for a given map object.
+     *
+     * @param {Record<string, unknown>} map - The map object to hash.
+     * @returns {Buffer} - The resulting hash as a Buffer.
+     */
+    hashOfMap(map: Record<string, any>): Buffer;
+    /**
+     * Generates a hash for a key-value pair.
+     *
+     * @param {string} key - The key to hash.
+     * @param {string | Buffer | BigInt} val - The value to hash.
+     * @returns {Buffer} - The resulting hash as a Buffer.
+     */
+    hashKeyVal(key: string, val: any): Buffer;
+    /**
+     * Generates a SHA-256 hash for a given string.
+     *
+     * @param {string} value - The string to hash.
+     * @returns {Buffer} - The resulting hash as a Buffer.
+     */
+    hashString(value: string): Buffer;
+    /**
+     * Generates a hash for a 64-bit unsigned integer.
+     *
+     * @param {bigint} n - The 64-bit unsigned integer to hash.
+     * @returns {Buffer} - The resulting hash as a Buffer.
+     */
+    hashU64(n: bigint): Buffer;
+    /**
+     * Generates a SHA-256 hash for an array of elements.
+     *
+     * @param {Array<any>} elements - The array of elements to hash.
+     * @returns {Buffer} - The resulting hash as a Buffer.
+     */
+    hashArray(elements: Array<any>): Buffer;
+    /**
+     * Generates a hash for a given value.
+     *
+     * @param {string | Buffer | BigInt | number | Array<unknown>} val - The value to hash.
+     * @returns {Buffer} - The resulting hash as a Buffer.
+     * @throws {Error} - If the value type is unsupported.
+     */
+    hashVal(val: string | Buffer | BigInt | number | Array<unknown>): Buffer;
+    /**
+     * Computes the SHA-256 hash of the given buffer.
+     *
+     * @param value - The buffer to hash.
+     * @returns The SHA-256 hash of the input buffer.
+     */
+    hashBytes(value: Buffer): Buffer;
+    /**
+     * Computes the SHA-256 hash of the provided array of Buffer chunks.
+     *
+     * @param {Array<Buffer>} chunks - An array of Buffer objects to be hashed.
+     * @returns {Buffer} - The resulting SHA-256 hash as a Buffer.
+     */
+    sha256(chunks: Array<Buffer>): Buffer;
+    /**
+     * Converts a hexadecimal string to a Buffer.
+     *
+     * @param hex - The hexadecimal string to convert.
+     * @returns A Buffer containing the binary data represented by the hexadecimal string.
+     */
+    blobFromHex(hex: string): Buffer;
+    /**
+     * Converts a binary blob (Buffer) to a hexadecimal string.
+     *
+     * @param {Buffer} blob - The binary data to be converted.
+     * @returns {string} The hexadecimal representation of the binary data.
+     */
+    blobToHex(blob: Buffer): string;
+    /**
+     * Decodes a given CBOR-encoded buffer.
+     *
+     * @param buffer - The CBOR-encoded buffer to decode.
+     * @returns The decoded data.
+     */
+    cborDecode(buffer: Buffer): unknown;
+    /**
+     * Generates a Buffer containing the domain IC request string.
+     *
+     * @returns {Buffer} A Buffer object initialized with the string '\x0Aic-request'.
+     */
+    getDomainICRequest(): Buffer;
+    /**
+     * Combines the domain IC request buffer with the provided message ID buffer to create signature data.
+     *
+     * @param {Buffer} messageId - The buffer containing the message ID.
+     * @returns {Buffer} - The concatenated buffer containing the domain IC request and the message ID.
+     */
+    makeSignatureData(messageId: Buffer): Buffer;
+    /**
+     * Generates a read state object from an HTTP canister update.
+     *
+     * @param {HttpCanisterUpdate} update - The HTTP canister update object.
+     * @returns {ReadState} The read state object containing the sender, paths, and ingress expiry.
+     */
+    makeReadStateFromUpdate(update: HttpCanisterUpdate): ReadState;
+    /**
+     * Generates a representation-independent hash for an HTTP read state object.
+     *
+     * @param {ReadState} readState - The HTTP read state object.
+     * @returns {Buffer} - The hash of the read state object.
+     */
+    HttpReadStateRepresentationIndependentHash(readState: ReadState): Buffer;
+    /**
+     * Extracts the recipient information from the provided ICP transaction data.
+     *
+     * @param {IcpTransactionData} icpTransactionData - The ICP transaction data containing the receiver's address and amount.
+     * @returns {Recipient[]} An array containing a single recipient object with the receiver's address and amount.
+     */
+    getRecipients(icpTransactionData: IcpTransactionData): Recipient;
+    getTransactionSignature(signatureMap: Map<string, Signatures>, update: HttpCanisterUpdate): Signatures | undefined;
+    getReadStateSignature(signatureMap: Map<string, Signatures>, readState: ReadState): Signatures | undefined;
+    getMetaData(memo: number | BigInt): {
+        metaData: IcpMetadata;
+        ingressEndTime: number | BigInt;
+    };
 }
 declare const utils: Utils;
 export default utils;

package/dist/src/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,SAAS,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAMnE,qBAAa,KAAM,YAAW,SAAS;IACrC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3C,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAiBzC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAItC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAInC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IAInC,kBAAkB;IAClB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIvC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAShC,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI5C,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIrC,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAMpC,oBAAoB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAO9C,iBAAiB,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM;IAgBlD,YAAY,IAAI,MAAM;IAItB,4BAA4B,CAAC,YAAY,EAAE,MAAM,GAAG,gBAAgB;IAapE,aAAa,CAAC,SAAS,EAAE,gBAAgB,EAAE,UAAU,GAAE,UAA+B,GAAG,MAAM;IAiBzF,uBAAuB,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUpE,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;CAW/C;AAED,QAAA,MAAM,KAAK,OAAc,CAAC;AAC1B,eAAe,KAAK,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAyB,SAAS,EAAyB,MAAM,sBAAsB,CAAC;AACnH,OAAO,EAAE,SAAS,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAInE,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,SAAS,EAAe,UAAU,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAIlH,OAAO,SAAS,MAAM,cAAc,CAAC;AAGrC,eAAO,MAAM,cAAc,mBAAmB,CAAC;AAE/C,qBAAa,KAAM,YAAW,SAAS;IACrC,kBAAkB;IAClB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3C,kBAAkB;IAClB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIrC,kBAAkB;IAClB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI5C;;OAEG;IAEH,OAAO,IAAI,MAAM;IAIjB;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;;;;;;OASG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAazC;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAQlC;;;;;;OAMG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAItC;;;;;;;OAOG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAInC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IAQnC,kBAAkB;IAClB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIvC;;;;;;;;;OASG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAShC;;;;;;OAMG;IACH,iBAAiB,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM;IAgBlD;;;;;OAKG;IACH,uBAAuB,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU;IAQzD;;;;;OAKG;IACH,2BAA2B,CAAC,YAAY,EAAE,MAAM,GAAG,gBAAgB;IAMnE;;;;;;OAMG;IACH,4BAA4B,CAAC,YAAY,EAAE,MAAM,GAAG,gBAAgB;IAWpE;;;;;;OAMG;IACH,aAAa,CAAC,SAAS,EAAE,gBAAgB,EAAE,UAAU,GAAE,UAA+B,GAAG,MAAM;IAa/F;;;;;;OAMG;IACG,uBAAuB,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAS3E;;;;;;OAMG;IACI,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAS9C,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAS9B,kBAAkB;IAClB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAMrC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAMzC,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAMrD;;;;;OAKG;IACH,sBAAsB,CAAC,eAAe,EAAE,kBAAkB,GAAG,IAAI;IAoBjE;;;;OAIG;IACH,4BAA4B,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAIhE;;;;;OAKG;IACH,+CAA+C,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAYnF;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM;IAS3C;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,MAAM;IAMzC;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIjC;;;;;OAKG;IACH,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAiB1B;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM;IAIvC;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM;IAcxE;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIhC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM;IAMrC;;;;;OAKG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIhC;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI/B;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAKnC;;;;OAIG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;;;OAKG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;;OAKG;IACH,uBAAuB,CAAC,MAAM,EAAE,kBAAkB,GAAG,SAAS;IAQ9D;;;;;OAKG;IACH,0CAA0C,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM;IASxE;;;;;OAKG;IACH,aAAa,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,SAAS;IAOhE,uBAAuB,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,kBAAkB,GAAG,UAAU,GAAG,SAAS;IAIlH,qBAAqB,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,SAAS,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS;IAM1G,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG;QAAE,QAAQ,EAAE,WAAW,CAAC;QAAC,cAAc,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;CAY/F;AAED,QAAA,MAAM,KAAK,OAAc,CAAC;AAC1B,eAAe,KAAK,CAAC"}