Class Btc1KeyManager

constructor

• new Btc1KeyManager(params?: KeyManagerParams): Btc1KeyManager

  Creates an instance of Btc1KeyManager.

  Parameters

  • params: KeyManagerParams = {}

    The parameters to initialize the key manager.

    Params for initializing a Btc1KeyManager class instance.

    • Optionalcontroller?: string

      An optional property to specify the DID controller.\

    • Optionalid?: string

      An optional property to specify the DID contoller id.

    • Optionalkeys?: SchnorrKeyPair

      An optional property to pass in an initial key pair

    • OptionalkeyUri?: KeyIdentifier

      An optional property to specify a key URI for the key manager. If not provided, the key manager will generate a key URI based on the public key of the key pair.

    • Optionalstore?: KeyValueStore<KeyIdentifier, SchnorrMultikey>

      An optional property to specify a custom KeyValueStore instance for key management. If not provided, Btc1KeyManager uses a default MemoryStore instance. This store is responsible for managing cryptographic keys, allowing them to be retrieved, stored, and managed during cryptographic operations.

  Returns Btc1KeyManager

OptionalactiveKeyUri

Staticinstance

• get instance(): Btc1KeyManager

  Gets the singleton instance of the Btc1KeyManager.

  Returns Btc1KeyManager

  The singleton instance of the Btc1KeyManager.

  Static

digest

• digest(data: Uint8Array): Bytes

  Computes the hash of the given data.

  Parameters

  • data: Uint8Array

    The data to hash.

  Returns Bytes

  The hash of the data.

exportKey

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

  Exports the full multikeypair from the key store.

  Parameters

  • OptionalkeyUri: string

  Returns Promise<undefined | SchnorrMultikey>

  The key pair associated with the key URI.

  Throws

  If the key is not found in the key store.

getKeySigner

• getKeySigner(keyUri: string, network: keyof AvailableNetworks): Promise<Signer>

  Parameters

  • keyUri: string
  • network: keyof AvailableNetworks

  Returns Promise<Signer>

getPublicKey

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

  Gets the key pair from the key store and returns a PublicKey.

  Parameters

  • OptionalkeyUri: string

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

  Returns Promise<PublicKey>

  The public key associated with the key URI.

importKey

• importKey(
      keys: SchnorrKeyPair,
      keyUri: string,
      options?: Btc1KeyManagerOptions,
  ): Promise<string>

  Imports a keypair to the store.

  Parameters

  • keys: SchnorrKeyPair

    The keypair to import.
  • keyUri: string

    The URI of the key to import.
  • options: Btc1KeyManagerOptions = {}

    Relevant import options.

    • Optionalactive?: boolean

    • OptionalimportKey?: boolean

  Returns Promise<string>

  A promise that resolves to the key identifier of the imported key.

sign

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

  Signs the given data using the key associated with the key URI.

  Parameters

  • data: Hex

    The data to sign.
  • OptionalkeyUri: string

    The URI of the key to sign the data with.

  Returns Promise<Bytes>

  A promise resolving to the signature of the data.

signTransaction

• signTransaction(txHex: Hex, keyUri?: string): Promise<Hex>

  Signs a transaction using the key associated with the key URI.

  Parameters

  • txHex: Hex

    The transaction hex to sign.
  • OptionalkeyUri: string

    The URI of the key to sign the transaction with.

  Returns Promise<Hex>

  A promise resolving to the signed transaction hex.

verify

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

  Verifies a signature using the key associated with the key URI.

  Parameters

  • signature: Bytes

    The signature to verify.
  • data: Hex

    The data to verify the signature with.
  • OptionalkeyUri: string

    The URI of the key to verify the signature with.

  Returns Promise<boolean>

  A promise resolving to a boolean indicating the verification result.

StaticcomputeKeyUri

• computeKeyUri(id: string, controller?: string): string

  Computes the key URI of a given keypair.

  Parameters

  • id: string

    The fragment identifier (e.g. 'key-1').
  • Optionalcontroller: string

    The DID controller (e.g. 'did:btc1:xyz').

  Returns string

  A full DID fragment URI (e.g. 'did:btc1:xyz#key-1')

StaticgetKeyPair

• getKeyPair(keyUri?: string): Promise<undefined | SchnorrMultikey>

  Retrieves a keypair from the key store using the provided key URI.

  Parameters

  • OptionalkeyUri: string

    The URI of the keypair to retrieve.

  Returns Promise<undefined | SchnorrMultikey>

  The retrieved keypair, or undefined if not found.

Staticinitialize

• initialize(
      keys: SchnorrKeyPair | SchnorrKeyPairObject,
      keyUri: string,
  ): Promise<Btc1KeyManager>

  Initializes a singleton Btc1KeyManager instance.

  Parameters

  • keys: SchnorrKeyPair | SchnorrKeyPairObject

    The keypair used to initialize the key manager.
  • keyUri: string

  Returns Promise<Btc1KeyManager>

StatictoMultibaseUri

• toMultibaseUri(data: PublicKey | SchnorrKeyPair | Multibase<"zQ3s">): string

  Computes a multibase-compliant URI from a key.

  Parameters

  • data: PublicKey | SchnorrKeyPair | Multibase<"zQ3s">

  Returns string

  A multibase URI (e.g. 'urn:mb:zQ3s...')