@integraledger/lcp/discovery

InterfacesCopy Anchor Link

LegalContextDocumentCopy Anchor Link

LCP §2.4–§2.5; members in the order of their tables.

PropertiesCopy Anchor Link

VariablesCopy Anchor Link

MAX_DOCUMENT_BYTESCopy Anchor Link

const MAX_DOCUMENT_BYTES: 65536 = 65_536

---

WELL_KNOWN_PATHCopy Anchor Link

const WELL_KNOWN_PATH: "/.well-known/legal-context.json" = "/.well-known/legal-context.json"

FunctionsCopy Anchor Link

emit()Copy Anchor Link

emit(document): Uint8Array<ArrayBufferLike> | Refusal

The document's bytes: its checked members in table order, atrHash in lowercase, and no other member.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Uint8Array<ArrayBufferLike> | Refusal

---

parse()Copy Anchor Link

parse(bytes): Refusal | { document: LegalContextDocument; ignored: string[]; }

One UTF-8 JSON object of at most MAX_DOCUMENT_BYTES, checked as LCP §2 states. Unknown members, at the top level or inside disputeResolution and contact, are left out of document and named in ignored by dotted path.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Refusal | { document: LegalContextDocument; ignored: string[]; }