Function privateKeyToP2pkhCashAddress

  • Derive the P2PKH address of the provided private key.

    Note that this function defaults to throwing an error if provided with an invalid private key. To handle errors in a type-safe way, set throwErrors to false.

    To derive only the locking bytecode, use privateKeyToP2pkhLockingBytecode. For HD private keys, use hdPrivateKeyToP2pkhCashAddress. For the public key equivalent, see publicKeyToP2pkhCashAddress.

    Type Parameters

    • ThrowErrors extends boolean = true

    Parameters

    • __namedParameters: {
          prefix?: "bitcoincash" | "bchtest" | "bchreg";
          privateKey: Uint8Array;
          throwErrors?: ThrowErrors;
          tokenSupport?: boolean;
      }
      • Optional prefix?: "bitcoincash" | "bchtest" | "bchreg"

        The CashAddressNetworkPrefix to use when encoding the address. (Default: bitcoincash)

      • privateKey: Uint8Array

        The private key from which to derive the P2PKH address.

      • Optional throwErrors?: ThrowErrors

        If true, this function will throw an Error if the provided privateKey is invalid rather than returning the error as a string (defaults to true).

      • Optional tokenSupport?: boolean

        If true, the address will indicate that the receiver accepts CashTokens; defaults to false.

    Returns ThrowErrors extends true
        ? CashAddressResult
        : string | CashAddressResult

Generated using TypeDoc