Caravan Documentation
    Preparing search index...

    Function validatePublicKey

    • Validate the given public key.

      • Must be valid hex.
      • Must be a valid BIP32 public key.

      Parameters

      • pubkeyHex: undefined | null | string

        (compressed) public key in hex

      • OptionaladdressType: string

        one of P2SH, P2SH-P2WSH, P2WSH

      Returns string

      empty if valid or corresponding validation message if not

      import {validatePublicKey} from "@caravan/bitcoin";
      console.log(validatePublicKey("")); // "Public key cannot be blank."
      console.log(validatePublicKey("zzzz")); // "Invalid hex..."
      console.log(validatePublicKey("deadbeef")); // "Invalid public key."
      console.log(validatePublicKey("03b32dc780fba98db25b4b72cf2b69da228f5e10ca6aa8f46eabe7f9fe22c994ee")); // ""
      console.log(validatePublicKey("04a17f3ad2ecde2fff2abd1b9ca77f35d5449a3b50a8b2dc9a0b5432d6596afd01ee884006f7e7191f430c7881626b95ae1bcacf9b54d7073519673edaea71ee53")); // ""
      console.log(validatePublicKey("04a17f3ad2ecde2fff2abd1b9ca77f35d5449a3b50a8b2dc9a0b5432d6596afd01ee884006f7e7191f430c7881626b95ae1bcacf9b54d7073519673edaea71ee53", "P2SH")); // ""
      console.log(validatePublicKey("04a17f3ad2ecde2fff2abd1b9ca77f35d5449a3b50a8b2dc9a0b5432d6596afd01ee884006f7e7191f430c7881626b95ae1bcacf9b54d7073519673edaea71ee53", "P2WSH")); // "P2WSH does not support uncompressed public keys."

    Settings

    Member Visibility