encodeBase58Address | @bitauth/libauth

Function encodeBase58Address

  • encodeBase58Address(type, payload, sha256?): string

  • Encode a hash as a Base58Address.

    Note, this method does not enforce error handling via the type system. The returned string will not be a valid Base58Address if hash is not exactly 20 bytes. If needed, validate the length of hash before calling this method.

    For other standards that use the Base58Address format but have other version or length requirements, use encodeCashAddressFormat.

    To decode a Base58Address, see decodeBase58Address.

    Parameters

    • type: "p2pkh" | "p2pkhCopayBCH" | "p2pkhTestnet" | "p2sh20" | "p2sh20CopayBCH" | "p2sh20Testnet"

      the type of address to encode: p2pkh, p2sh20, p2pkh-testnet, or p2sh20-testnet

    • payload: Uint8Array
    • sha256: {
          hash: ((input) => Uint8Array) & ((input) => Uint8Array);
      } = internalSha256

      an implementation of sha256 (defaults to the internal WASM implementation)

      • hash: ((input) => Uint8Array) & ((input) => Uint8Array)

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc