Header menu logo FSharp.ATProto

Commit Module

Signed commit objects for AT Protocol repositories.

Types

Type Description

SignedCommit

A signed commit object.

Functions and values

Function or value Description

create did data rev prev keyPair

Full Usage: create did data rev prev keyPair

Parameters:
Returns: SignedCommit

Create and sign a commit.

did : Did
data : Cid
rev : string
prev : Cid option
keyPair : KeyPair
Returns: SignedCommit

createRev ()

Full Usage: createRev ()

Parameters:
    () : unit

Returns: string

Create a TID-based revision string for the current time.

() : unit
Returns: string

decode data

Full Usage: decode data

Parameters:
    data : byte[]

Returns: Result<SignedCommit, string>

Decode a signed commit from DAG-CBOR bytes.

data : byte[]
Returns: Result<SignedCommit, string>

encode commit

Full Usage: encode commit

Parameters:
Returns: byte[]

Encode a signed commit to DAG-CBOR bytes (with signature).

commit : SignedCommit
Returns: byte[]

verify publicKey commitBytes

Full Usage: verify publicKey commitBytes

Parameters:
Returns: Result<bool, string>

Verify a signed commit's signature against a public key.

publicKey : PublicKey
commitBytes : byte[]
Returns: Result<bool, string>

Type something to start searching.