mooncakes.io

README

marianoguerra/atproto/identity does not have a README file

#
DidDocument

pub(all) struct DidDocument {
  id : @marianoguerra/atproto/syntax.Did
Did
  also_known_as : Array[String]
  verification_method : Array[VerificationMethod]
  service : Array[Service]
  extra : Map[String, @marianoguerra/atproto/data.LexValue
LexValue]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
DidDocument::from_lex

source

fn DidDocument::from_lex(value : @marianoguerra/atproto/data.LexValue
LexValue, path? : String) -> DidDocument raise @marianoguerra/atproto/data.DecodeError
DecodeError

Decodes a didDoc, which arrives as a lexicon unknown -- so it is a LexValue until something asks for it as this.

#
DidDocument::handle

source

fn DidDocument::handle(self : DidDocument) -> @marianoguerra/atproto/syntax.Handle
Handle?

The account's handle, from the first at:// entry in alsoKnownAs.

This is a CLAIM, not a fact. The document says what handle the account wants and anyone can write anything there; it is only true if resolving that handle leads back to this DID. verify_handle below is that second half, and @client.resolve_identity is what does both.

#
DidDocument::pds_endpoint

source

fn DidDocument::pds_endpoint(self : DidDocument) -> String?

Where this account's repository lives. Every authenticated request goes here, so a session that cannot find it has to fall back on the host it logged in to.

#
DidDocument::service_endpoint

source

fn DidDocument::service_endpoint(self : DidDocument, id : String, type_? : String) -> String?

An endpoint by service id, accepting the relative and absolute spellings of the id, and optionally requiring a type.

The endpoint must be an http/https URL. That check is not decoration: a DID document is fetched from a third party and its contents decide where this library sends an access token, so a file: or data: endpoint is an attack rather than a curiosity.

#
DidDocument::signing_key

source

fn DidDocument::signing_key(self : DidDocument) -> VerificationMethod?

The repository signing key, as publicKeyMultibase. Only useful to a caller verifying commits, which this library does not do -- exposed because the document carries it and dropping it would be lossy.

#
DidDocument::to_lex

source

fn DidDocument::to_lex(self : DidDocument) -> @marianoguerra/atproto/data.LexValue
LexValue

#
DidDocument::verify_handle

source

fn DidDocument::verify_handle(self : DidDocument, handle : @marianoguerra/atproto/syntax.Handle
Handle) -> Bool

Whether the document claims this handle -- the second half of bidirectional verification.

Compared after normalizing, because Handle::parse lower-cases and a document may not have.

#
Service

source

pub(all) struct Service {
  id : String
  type_ : String
  service_endpoint : String
  extra : Map[String, @marianoguerra/atproto/data.LexValue
LexValue]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
VerificationMethod

source

pub(all) struct VerificationMethod {
  id : String
  type_ : String
  controller : String
  public_key_multibase : String?
  extra : Map[String, @marianoguerra/atproto/data.LexValue
LexValue]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)