Skip to main content

Class: MLDSAKeyPairIdentity

An identity that uses a quantum-resistant ML-DSA-87 key pair to sign messages.

Extends​

  • KeyPairIdentity

Constructors​

new MLDSAKeyPairIdentity()​

new MLDSAKeyPairIdentity(publicKey, privateKey): MLDSAKeyPairIdentity

Parameters​

publicKey​

Uint8Array

privateKey​

Uint8Array

Returns​

MLDSAKeyPairIdentity

Inherited from​

KeyPairIdentity.constructor

Properties​

privateKey​

readonly privateKey: Uint8Array

Inherited from​

KeyPairIdentity.privateKey

publicKey​

readonly publicKey: UserIDRaw

Inherited from​

KeyPairIdentity.publicKey

publicKeyString​

readonly publicKeyString: UserID

Inherited from​

KeyPairIdentity.publicKeyString

Methods​

assertKeyPairIsValid()​

assertKeyPairIsValid(): void

Should throw if the publicKey and privateKey don't match each other

Returns​

void

Overrides​

KeyPairIdentity.assertKeyPairIsValid

createMessageSignature()​

createMessageSignature(payload): Promise<Uint8Array<ArrayBufferLike>>

Parameters​

payload​

Uint8Array

Returns​

Promise<Uint8Array<ArrayBufferLike>>

Overrides​

KeyPairIdentity.createMessageSignature

getExpectedPrivateKeyLength()​

getExpectedPrivateKeyLength(): number

Returns​

number

Overrides​

KeyPairIdentity.getExpectedPrivateKeyLength

getExpectedPublicKeyLength()​

getExpectedPublicKeyLength(): number

Returns​

number

Overrides​

KeyPairIdentity.getExpectedPublicKeyLength

getPrivateKey()​

getPrivateKey(): Promise<Uint8Array<ArrayBufferLike>>

Returns​

Promise<Uint8Array<ArrayBufferLike>>

Inherited from​

KeyPairIdentity.getPrivateKey

getSignatureType()​

getSignatureType(): SignatureType

Returns​

SignatureType

Overrides​

KeyPairIdentity.getSignatureType

getTransactionSigner()​

getTransactionSigner(_rpcProviderSource): Promise<SignerWithProvider>

Parameters​

_rpcProviderSource​

RpcProviderSource

Returns​

Promise<SignerWithProvider>

Inherited from​

KeyPairIdentity.getTransactionSigner

getUserId()​

getUserId(): Promise<UserID>

Returns​

Promise<UserID>

Inherited from​

KeyPairIdentity.getUserId

getUserIdRaw()​

getUserIdRaw(): Promise<UserIDRaw>

Returns​

Promise<UserIDRaw>

Inherited from​

KeyPairIdentity.getUserIdRaw

fromConfig()​

static fromConfig(config): MLDSAKeyPairIdentity

Parameters​

config​

Pick<StrictStreamrClientConfig, "auth">

Returns​

MLDSAKeyPairIdentity

generate()​

static generate(): MLDSAKeyPairIdentity

Returns​

MLDSAKeyPairIdentity

getKeyPairFromConfig()​

static getKeyPairFromConfig(config): KeyPairIdentityConfig

Parameters​

config​

Pick<StrictStreamrClientConfig, "auth">

Returns​

KeyPairIdentityConfig

Inherited from​

KeyPairIdentity.getKeyPairFromConfig