Header menu logo FSharp.ATProto

Multikey Module

Multicodec and did:key encoding/decoding for AT Protocol public keys. Supports P-256 (multicodec 0x1200) and secp256k1 (multicodec 0xe7).

Functions and values

Function or value Description

decodeDid didKey

Full Usage: decodeDid didKey

Parameters:
    didKey : string

Returns: Result<PublicKey, string>

Decode a did:key string to a public key.

didKey : string
Returns: Result<PublicKey, string>

decodeMultibase multibase

Full Usage: decodeMultibase multibase

Parameters:
    multibase : string

Returns: Result<PublicKey, string>

Decode a multibase-encoded public key string. Expects 'z' prefix (base58btc) followed by multicodec prefix + compressed key.

multibase : string
Returns: Result<PublicKey, string>

encodeDid key

Full Usage: encodeDid key

Parameters:
Returns: string

Encode a public key as a did:key string. Format: "did:key:" + "z" + base58btc(multicodec_prefix + compressed_public_key)

key : PublicKey
Returns: string

encodeMultibase key

Full Usage: encodeMultibase key

Parameters:
Returns: string

Encode a public key to multibase (base58btc, 'z' prefix) format. This is the format used in DID document verificationMethod publicKeyMultibase fields.

key : PublicKey
Returns: string

keyPairToDid keyPair

Full Usage: keyPairToDid keyPair

Parameters:
Returns: string

Format a key pair's public key as a did:key string.

keyPair : KeyPair
Returns: string

Type something to start searching.