Evolution SDK
ModulesMessage signing

message-signing/CoseKey.ts

CoseKey overview

COSE key structures (RFC 8152).

Added in v2.0.0


Table of contents


Model

COSEKey (class)

COSE key representation (RFC 8152).

Signature

export declare class COSEKey

Added in v2.0.0

toJSON (method)

Signature

toJSON()

toString (method)

Signature

toString(): string

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

EdDSA25519Key (class)

Ed25519 key for signing and verification.

Signature

export declare class EdDSA25519Key

Added in v2.0.0

toJSON (method)

Signature

toJSON()

toString (method)

Signature

toString(): string

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

setPrivateKey (method)

Set the private key for signing.

Signature

setPrivateKey(privateKey: PrivateKey.PrivateKey): this

Added in v2.0.0

isForSigning (method)

Check if key can be used for signing.

Signature

isForSigning(): boolean

Added in v2.0.0

isForVerifying (method)

Check if key can be used for verification.

Signature

isForVerifying(): boolean

Added in v2.0.0

build (method)

Build a COSEKey from this Ed25519 key.

Signature

build(): COSEKey

Added in v2.0.0

Schemas

COSEKeyFromCBORBytes

CBOR bytes transformation schema for COSEKey. Encodes COSEKey as a CBOR Map compatible with CSL.

Signature

export declare const COSEKeyFromCBORBytes: (
  options?: CBOR.CodecOptions
) => Schema.transformOrFail<
  Schema.transformOrFail<
    typeof Schema.Uint8ArrayFromSelf,
    Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
    never
  >,
  Schema.SchemaClass<COSEKey, COSEKey, never>,
  never
>

Added in v2.0.0