Interface KeyManager

OptionalactiveKeyUri

digest

• digest(data: Uint8Array): Bytes

  Returns the sha256 hash of the input data.

  Parameters

  • data: Uint8Array

    The data to hash.

  Returns Bytes

  The sha256 hash of the input data.

exportKey

• exportKey(keyUri?: string): Promise<undefined | KeyPair>

  Exports the full key pair from the key store.

  Parameters

  • OptionalkeyUri: string

    The URI of the key to export.

  Returns Promise<undefined | KeyPair>

  The key pair associated with the key URI.

  Throws

  If the key is not found in the key store.

getPublicKey

• getPublicKey(keyUri: string): Promise<PublicKey>

  Gets the public key of a key pair.

  Parameters

  • keyUri: string

    The URI of the key to get the public key for.

  Returns Promise<PublicKey>

  The public key of the key pair.

importKey

• importKey(keyPair: KeyPair, options: Btc1KeyManagerOptions): Promise<string>

  Imports a key pair into the key store.

  Parameters

  • keyPair: KeyPair

    The key pair to import.
  • options: Btc1KeyManagerOptions

    The options for importing the key pair.

    • Optionalactive?: boolean

    • OptionalimportKey?: boolean

  Returns Promise<string>

  The URI of the imported key pair.

sign

• sign(data: Hex, keyUri?: string): Promise<Bytes>

  Signs a message with a key pair.

  Parameters

  • data: Hex

    The data to sign.
  • OptionalkeyUri: string

    The URI of the key to sign the data with.

  Returns Promise<Bytes>

  The signature of the input data.

verify

• verify(signature: Bytes, data: Hex, keyUri?: string): Promise<boolean>

  Verifies if a signature was produced by a key pair.

  Parameters

  • signature: Bytes

    The signature to verify.
  • data: Hex

    The data that was signed.
  • OptionalkeyUri: string

    The URI of the key to use for verification.

  Returns Promise<boolean>

  A promise that resolves if the signature is valid, and rejects otherwise.