Class SchnorrKeyPair

Encapsulates a PublicKey and a SecretKey object as a single Keys object. SchnorrKeyPair

Implements

KeyPair

Index

Constructors

Accessors

multibase publicKey raw secretKey

Methods

json equals fromJSON fromPrivateKey fromSecret generate toHex

Constructors

constructor

new SchnorrKeyPair(secretKey?: KeyParams): SchnorrKeyPair
Creates an instance of Keys. Must provide a at least a secret key. Can optionally provide both a private and public key, but must be a valid pair.
Parameters
- secretKey: KeyParams = {}
  The secret key object
Returns SchnorrKeyPair
- Defined in pair.ts:72

Accessors

multibase

get multibase(): MultibaseKeys
Get the Keys in multibase format.

Returns MultibaseKeys
The SecretKey in multibase format
- Defined in pair.ts:156

publicKey

get publicKey(): PublicKey
Get the PublicKey.

Returns PublicKey
The PublicKey object
Implementation of KeyPair.publicKey
- Defined in pair.ts:136
set publicKey(publicKey: PublicKey): void
Set the PublicKey.
Parameters
- publicKey: PublicKey
  The PublicKey object
Returns void
Throws
If the public key is not a valid pair with the secret key.
Implementation of KeyPair.publicKey
- Defined in pair.ts:122

raw

get raw(): RawKeyPair
Get the Keys as a raw key pair.

Returns RawKeyPair
The Keys as a raw key pair
- Defined in pair.ts:145

secretKey

get secretKey(): SecretKey
Get the SecretKey.

Returns SecretKey
The SecretKey object

Throws
If the secret key is not available
Implementation of KeyPair.secretKey
- Defined in pair.ts:103

Methods

json

json(): SchnorrKeyPairObject
JSON representation of a Keys.

Returns SchnorrKeyPairObject
The Keys as a JSON object
Implementation of KeyPair.json
- Defined in pair.ts:167

`Static`equals

equals(keys: SchnorrKeyPair, otherKeys: SchnorrKeyPair): boolean
Compares two Keys objects for equality.
Parameters
- keys: SchnorrKeyPair
  The main keys.
- otherKeys: SchnorrKeyPair
  The other keys to compare.
Returns boolean
True if the public key and secret key are equal, false otherwise.
- Defined in pair.ts:236

`Static`fromJSON

fromJSON(keys: SchnorrKeyPairObject): SchnorrKeyPair
Static method creates a new Keys from a JSON object.
Parameters
- keys: SchnorrKeyPairObject
  The JSON object to initialize the Keys.
Returns SchnorrKeyPair
The initialized Keys object.
- Defined in pair.ts:179

`Static`fromPrivateKey

fromPrivateKey(data: Bytes | SecretKey): SchnorrKeyPair
Static method creates a new SchnorrKeyPair from a SecretKey object or secret key bytes.
Parameters
- data: Bytes | SecretKey
  The secret key bytes
Returns SchnorrKeyPair
A new SchnorrKeyPair object
- Defined in pair.ts:190

`Static`fromSecret

fromSecret(secret: bigint): SchnorrKeyPair
Static method creates a new Keys (SecretKey/PublicKey) bigint secret.
Parameters
- secret: bigint
  The secret key secret
Returns SchnorrKeyPair
A new Keys object
- Defined in pair.ts:215

`Static`generate

generate(): SchnorrKeyPair
Static method to generate a new random SchnorrKeyPair instance.

Returns SchnorrKeyPair
A new SecretKey object.
- Defined in pair.ts:261

`Static`toHex

toHex(keyBytes: Bytes): Hex
Converts key bytes to a hex string.
Parameters
- keyBytes: Bytes
  The key bytes (private or public).
Returns Hex
The key bytes as a hex string.
- Defined in pair.ts:226