Class Secp256k1KeyIdentity

_publicKey

getKeyPair

• getKeyPair(): KeyPair

• Return a copy of the key pair.

  Returns KeyPair

  KeyPair

getPublicKey

• getPublicKey(): Required<PublicKey>

• Return the public key.

  Returns Required<PublicKey>

  Required

sign

• sign(challenge: ArrayBuffer): Promise<Signature>

• Signs a blob of data, with this identity's private key.

  Parameters

  • challenge: ArrayBuffer

    challenge to sign with this identity's secretKey, producing a signature

  Returns Promise<Signature>

  signature

toJSON

• toJSON(): JsonableSecp256k1Identity

• Serialize this key to JSON-serializable object.

  Returns JsonableSecp256k1Identity

  JsonableSecp256k1Identity

StaticfromJSON

• fromJSON(json: string): Secp256k1KeyIdentity

• Parameters

  • json: string

  Returns Secp256k1KeyIdentity

StaticfromKeyPair

• fromKeyPair(
      publicKey: ArrayBuffer,
      privateKey: ArrayBuffer,
  ): Secp256k1KeyIdentity

• generates an identity from a public and private key. Please ensure that you are generating these keys securely and protect the user's private key

  Parameters

  • publicKey: ArrayBuffer

    ArrayBuffer
  • privateKey: ArrayBuffer

    ArrayBuffer

  Returns Secp256k1KeyIdentity

  Secp256k1KeyIdentity

StaticfromParsedJson

• fromParsedJson(obj: JsonableSecp256k1Identity): Secp256k1KeyIdentity

• Parameters

  • obj: JsonableSecp256k1Identity

  Returns Secp256k1KeyIdentity

StaticfromPem

• fromPem(pemKey: string): Secp256k1KeyIdentity

• Utility method to create a Secp256k1KeyIdentity from a PEM-encoded key.

  Parameters

  • pemKey: string

    PEM-encoded key as a string

  Returns Secp256k1KeyIdentity

  • Secp256k1KeyIdentity

StaticfromSecretKey

• fromSecretKey(secretKey: ArrayBuffer): Secp256k1KeyIdentity

• generates an identity from an existing secret key, and is the correct method to generate an identity from a seed phrase. Please ensure you protect the user's private key.

  Parameters

  • secretKey: ArrayBuffer

    ArrayBuffer

  Returns Secp256k1KeyIdentity

  • Secp256k1KeyIdentity

StaticfromSeedPhrase

• fromSeedPhrase(
      seedPhrase: string | string[],
      password?: string,
  ): Secp256k1KeyIdentity

• Generates an identity from a seed phrase. Use carefully - seed phrases should only be used in secure contexts, and you should avoid having users copying and pasting seed phrases as much as possible.

  Parameters

  • seedPhrase: string | string[]

    either an array of words or a string of words separated by spaces.
  • Optionalpassword: string

    optional password to be used by bip39

  Returns Secp256k1KeyIdentity

  Secp256k1KeyIdentity

Staticgenerate

• generate(seed?: Uint8Array): Secp256k1KeyIdentity

• Generates an identity. If a seed is provided, the keys are generated from the seed according to BIP 0032. Otherwise, the key pair is randomly generated. This method throws an error in case the seed is not 32 bytes long or invalid for use as a private key.

  Parameters

  • Optionalseed: Uint8Array

    the optional seed

  Returns Secp256k1KeyIdentity

  Secp256k1KeyIdentity