Options
All
  • Public
  • Public/Protected
  • All
Menu

Module util/external

Namespaces

Classes

Interfaces

Type aliases

Functions

Type aliases

BNLike

BNLike: BN | PrefixedHexString | number | Buffer

BufferLike

BufferLike: Buffer | Uint8Array | number[] | number | BN | TransformableToBuffer | PrefixedHexString

PrefixedHexString

PrefixedHexString: string

Functions

assert

  • assert(value: unknown, message?: string | Error): value

  • An alias of ok.

    since

    v0.5.9

    Parameters

    • value: unknown

      The input that is checked for being truthy.

    • Optional message: string | Error

    Returns value

Const baToJSON

  • baToJSON(ba: any): any

  • Converts a Buffer or Array to JSON.

    Parameters

    • ba: any

      (Buffer|Array)

    Returns any

    (Array|String|null)

bs58check

bs58check:

Const bufferToHex

  • bufferToHex(buf: Buffer): string

  • Converts a Buffer into a 0x-prefixed hex String.

    Parameters

    • buf: Buffer

      Buffer object to convert

    Returns string

Const bufferToInt

  • bufferToInt(buf: Buffer): number

  • Converts a Buffer to a Number.

    throws

    If the input number exceeds 53 bits.

    Parameters

    • buf: Buffer

      Buffer object to convert

    Returns number

Const ecrecover

  • ecrecover(msgHash: Buffer, v: BNLike, r: Buffer, s: Buffer, chainId?: BNLike): Buffer

  • ECDSA public key recovery from signature.

    Parameters

    • msgHash: Buffer
    • v: BNLike
    • r: Buffer
    • s: Buffer
    • Optional chainId: BNLike

    Returns Buffer

    Recovered public key

ecsign

  • Returns the ECDSA signature of a message hash.

    Parameters

    • msgHash: Buffer
    • privateKey: Buffer
    • Optional chainId: number

    Returns ECDSASignature

  • Parameters

    • msgHash: Buffer
    • privateKey: Buffer
    • chainId: BNLike

    Returns ECDSASignatureBuffer

Const ethIsValidPublic

  • ethIsValidPublic(publicKey: Buffer, sanitize?: boolean): boolean

  • Checks if the public key satisfies the rules of the curve secp256k1 and the requirements of Ethereum.

    Parameters

    • publicKey: Buffer

      The two points of an uncompressed key, unless sanitize is enabled

    • Optional sanitize: boolean

      Accept public keys in other formats

    Returns boolean

Const ethPrivateToAddress

  • ethPrivateToAddress(privateKey: Buffer): Buffer

  • Returns the ethereum address of a given private key.

    Parameters

    • privateKey: Buffer

      A private key must be 256 bits wide

    Returns Buffer

Const ethPrivateToPublic

  • ethPrivateToPublic(privateKey: Buffer): Buffer

  • Returns the ethereum public key of a given private key.

    Parameters

    • privateKey: Buffer

      A private key must be 256 bits wide

    Returns Buffer

Const ethPublicToAddress

  • ethPublicToAddress(pubKey: Buffer, sanitize?: boolean): Buffer

  • Parameters

    • pubKey: Buffer
    • Optional sanitize: boolean

    Returns Buffer

Const ethToBuffer

  • ethToBuffer(v: ToBufferInputTypes): Buffer

  • Attempts to turn a value into a Buffer. Inputs supported: Buffer, String (hex-prefixed), Number, null/undefined, BN and other objects with a toArray() or toBuffer() method.

    Parameters

    • v: ToBufferInputTypes

      the value

    Returns Buffer

Const fromRpcSig

Const rlphash

  • rlphash(a: Input): Buffer

  • Creates SHA-3 hash of the RLP encoded version of the input.

    Parameters

    • a: Input

      The input data

    Returns Buffer

Const sha256

  • sha256(msg: Buffer): Buffer

  • Parameters

    • msg: Buffer

    Returns Buffer

Const stripHexPrefix

  • stripHexPrefix(str: string): string

  • Removes '0x' from a given String if present

    Parameters

    • str: string

      the string value

    Returns string

    the string without 0x prefix

Const toRpcSig

  • toRpcSig(v: BNLike, r: Buffer, s: Buffer, chainId?: BNLike): string

  • Convert signature parameters into the format of eth_sign RPC method.

    Parameters

    Returns string

    Signature

Const unpadBuffer

  • unpadBuffer(a: Buffer): Buffer

  • Trims leading zeros from a Buffer.

    Parameters

    • a: Buffer

      (Buffer)

    Returns Buffer

    (Buffer)

Const zeros

  • zeros(bytes: number): Buffer

  • Returns a buffer filled with 0s.

    Parameters

    • bytes: number

      the number of bytes the buffer should be

    Returns Buffer

Generated using TypeDoc