Class EcKeyPair

constructor

• new EcKeyPair(): EcKeyPair

• Returns EcKeyPair

StaticBIP32

StaticECPair

StaticfromPrivateKey

• fromPrivateKey(privateKey, network?): ECPairInterface

• Generate a keypair from a private key

  Parameters

  • privateKey: Uint8Array | Buffer

    The private key to use
  • network: Network = networks.bitcoin

    The network to use

  Returns ECPairInterface

  • The generated keypair

StaticfromPublicKey

• fromPublicKey(publicKey, network?): ECPairInterface

• Generate a keypair from a public key

  Parameters

  • publicKey: Uint8Array | Buffer

    The public key to use
  • network: Network = networks.bitcoin

    The network to use

  Returns ECPairInterface

  • The generated keypair

StaticfromSeed

• fromSeed(seed, network?): BIP32Interface

• Generate a BIP32 keypair from a seed

  Parameters

  • seed: Buffer

    The seed to generate the keypair from
  • network: Network = networks.bitcoin

    The network to use

  Returns BIP32Interface

  • The generated keypair

StaticfromSeedKeyPair

• fromSeedKeyPair(seed, network?): ECPairInterface

• Get a keypair from a given seed.

  Parameters

  • seed: Buffer

    The seed to generate the key pair from
  • network: Network = networks.bitcoin

    The network to use

  Returns ECPairInterface

  • The generated key pair

StaticfromWIF

• fromWIF(wif, network?): ECPairInterface

• Generate a keypair from a WIF

  Parameters

  • wif: string

    The WIF to use
  • network: Network = networks.bitcoin

    The network to use

  Returns ECPairInterface

  • The generated keypair

StaticgenerateMultiSigAddress

• generateMultiSigAddress(pubKeys, minimumSignatureRequired, network?): string

• Generate a multi-sig address

  Parameters

  • pubKeys: Buffer[]

    The public keys to use
  • minimumSignatureRequired: number

    The minimum number of signatures required
  • network: Network = networks.bitcoin

    The network to use

  Returns string

  • The generated address

  Throws

  • If the address cannot be generated

StaticgenerateRandomKeyPair

• generateRandomKeyPair(network?): ECPairInterface

• Generate a random keypair

  Parameters

  • network: Network = networks.bitcoin

    The network to use

  Returns ECPairInterface

  • The generated keypair

StaticgenerateWallet

• generateWallet(network?): IWallet

• Generate a random wallet

  Parameters

  • network: Network = networks.bitcoin

    The network to use

  Returns IWallet

  • The generated wallet

StaticgetLegacyAddress

• getLegacyAddress(keyPair, network?): string

• Get the legacy address from a keypair

  Parameters

  • keyPair: ECPairInterface

    The keypair to get the address for
  • network: Network = networks.bitcoin

    The network to use

  Returns string

  • The legacy address

StaticgetLegacySegwitAddress

• getLegacySegwitAddress(keyPair, network?): string

• Get the legacy segwit address from a keypair

  Parameters

  • keyPair: ECPairInterface

    The keypair to get the address for
  • network: Network = networks.bitcoin

    The network to use

  Returns string

  • The legacy address

StaticgetP2PKAddress

• getP2PKAddress(keyPair, network?): string

• Get the legacy address from a keypair

  Parameters

  • keyPair: ECPairInterface

    The keypair to get the address for
  • network: Network = networks.bitcoin

    The network to use

  Returns string

  • The legacy address

StaticgetP2WPKHAddress

• getP2WPKHAddress(keyPair, network?): string

• Get a P2WPKH address from a keypair

  Parameters

  • keyPair: ECPairInterface

    The keypair to get the address for
  • network: Network = networks.bitcoin

    The network to use

  Returns string

  • The address

StaticgetTaprootAddress

• getTaprootAddress(keyPair, network?): string

• Get taproot address from keypair

  Parameters

  • keyPair: ECPairInterface | Signer

    The keypair to get the taproot address for
  • network: Network = networks.bitcoin

    The network to use

  Returns string

  • The taproot address

StaticgetTaprootAddressFromAddress

• getTaprootAddressFromAddress(inAddr, network?): string

• Get taproot address from address

  Parameters

  • inAddr: string

    The address to convert to taproot
  • network: Network = networks.bitcoin

    The network to use

  Returns string

  • The taproot address

StatictweakedPubKeyBufferToAddress

• tweakedPubKeyBufferToAddress(tweakedPubKeyBuffer, network): string

• Get the address of a tweaked public key

  Parameters

  • tweakedPubKeyBuffer: Uint8Array | Buffer

    The tweaked public key buffer
  • network: Network

    The network to use

  Returns string

  • The address

  Throws

  • If the address cannot be generated

StatictweakedPubKeyToAddress

• tweakedPubKeyToAddress(tweakedPubKeyHex, network): string

• Get the address of a tweaked public key

  Parameters

  • tweakedPubKeyHex: string

    The tweaked public key hex string
  • network: Network

    The network to use

  Returns string

  • The address

  Throws

  • If the address cannot be generated

StatictweakPublicKey

• tweakPublicKey(compressedPubKeyHex): string

• Tweak a public key

  Parameters

  • compressedPubKeyHex: string

    The compressed public key hex string

  Returns string

  • The tweaked public key hex string

  Throws

  • If the public key cannot be tweaked

StaticverifyContractAddress

• verifyContractAddress(contractAddress, network?): boolean

• Verify that a contract address is a valid p2tr address

  Parameters

  • contractAddress: string

    The contract address to verify
  • network: Network = networks.bitcoin

    The network to use

  Returns boolean

  • Whether the address is valid

StaticverifyPubKeys

• verifyPubKeys(pubKeys, network?): Buffer[]

• Verify public keys and return the public keys

  Parameters

  • pubKeys: Buffer[]

    The public keys to verify
  • network: Network = networks.bitcoin

    The network to use

  Returns Buffer[]

  • The verified public keys

  Throws

  • If the key cannot be regenerated

StaticxOnlyTweakedPubKeyToAddress

• xOnlyTweakedPubKeyToAddress(tweakedPubKeyHex, network): string

• Get the address of a xOnly tweaked public key

  Parameters

  • tweakedPubKeyHex: string

    The xOnly tweaked public key hex string
  • network: Network

    The network to use

  Returns string

  • The address

  Throws

  • If the address cannot be generated