Interface PublicKey

interface PublicKey {
    code: number;
    type: string;
    toCID(): CID<unknown, 114, number, 1>;
    toJWK(): JsonWebKey;
    toMultihash(): MultihashDigest;
    toProtobuf(): Uint8Array<ArrayBuffer>;
    verify(
        message: Uint8Array,
        signature: Uint8Array,
        options?: AbortOptions,
    ): boolean | Promise<boolean>;
}

Index

Properties

Methods

toCID toJWK toMultihash toProtobuf verify

Properties

`Readonly`code

code: number

The code that is used as the Type field in the protobuf representation of the public/private keys

`Readonly`type

type: string

The type of the crypto implementation, e.g. Ed15519

Methods

toCID

toCID(): CID<unknown, 114, number, 1>
Return the libp2p-key CID that represents this key

Returns CID<unknown, 114, number, 1>
- Defined in index.ts:33

toJWK

toJWK(): JsonWebKey
Return this key as a RFC 7517 Json Web Key

Returns JsonWebKey
- Defined in index.ts:43

toMultihash

toMultihash(): MultihashDigest
Return a MultihashDigest that represents this key

Returns MultihashDigest
- Defined in index.ts:28

toProtobuf

toProtobuf(): Uint8Array<ArrayBuffer>
Return this key encoded as a protobuf PublicKey message

Returns Uint8Array<ArrayBuffer>
- Defined in index.ts:38

verify

verify(
    message: Uint8Array,
    signature: Uint8Array,
    options?: AbortOptions,
): boolean | Promise<boolean>
Verify the passed message against it's signature
Parameters
- message: Uint8Array
- signature: Uint8Array
- Optionaloptions: AbortOptions
Returns boolean | Promise<boolean>
- Defined in index.ts:48