Caravan Documentation
    Preparing search index...

    Function validateExtendedPublicKey

    • Validate the given extended public key.

      • Must start with the appropriate (network-dependent) prefix.
      • Must be a valid BIP32 extended public key

      Parameters

      • xpubString: undefined | null | string

        base58 encoded extended public key (xpub...)

      • network: BitcoinNetwork

        bitcoin network

      Returns string

      empty if valid or corresponding validation message if not

      import {validateExtendedPublicKey} from "@caravan/bitcoin";
      console.log(validateExtendedPublicKey("", MAINNET)); // "Extended public key cannot be blank."
      console.log(validateExtendedPublicKey("foo", MAINNET)); // "Extended public key must begin with ..."
      console.log(validateExtendedPublicKey("xpub123", MAINNET)); // "Extended public key is too short."
      console.log(validateExtendedPublicKey("tpub123...", MAINNET)); // "Extended public key must begin with ...."
      console.log(validateExtendedPublicKey("xpub123%%!~~...", MAINNET)); // "Invalid extended public key"
      console.log(validateExtendedPublicKey("xpub123...", MAINNET)); // ""