mirror of
https://github.com/pezkuwichain/pezkuwi-common.git
synced 2026-04-22 02:07:56 +00:00
22 lines
803 B
TypeScript
22 lines
803 B
TypeScript
import type { ToBnOptions } from '../types.js';
|
|
import { BN } from '../bn/bn.js';
|
|
/**
|
|
* @name hexToBn
|
|
* @summary Creates a BN.js object from a hex string.
|
|
* @description
|
|
* `null` inputs returns a `BN(0)` result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the `0x` prefix) throws an error.
|
|
* @param _value The value to convert
|
|
* @param _options Options to pass while converting
|
|
* @param _options.isLe Convert using Little Endian
|
|
* @param _options.isNegative Convert using two's complement
|
|
* @example
|
|
* <BR>
|
|
*
|
|
* ```javascript
|
|
* import { hexToBn } from '@pezkuwi/util';
|
|
*
|
|
* hexToBn('0x123480001f'); // => BN(0x123480001f)
|
|
* ```
|
|
*/
|
|
export declare function hexToBn(value?: string | null, { isLe, isNegative }?: ToBnOptions): BN;
|