fleetmesh-schema 0.1.0__py3-none-any.whl

fleetmesh_schema/__init__.py

@@ -0,0 +1,62 @@
+"""fleetmesh_schema: the published schema files as an installable package.
+
+The files are the ones at the root of the schema repo - `schema/` (the digest
+set: constants, kinds, messages, DIGEST, PROTOCOLS, conformance) and
+`schemas/` (the JSON Schema documents). This package carries them, nothing
+more: a path for anything that opens files itself, and one cached loader for
+the JSON. Standard library only, no I/O at import time.
+
+In a checkout the two directories are reached through the symlinks beside
+this file; installed, they are package data at the same relative place, so
+`files()` is the same path arithmetic either way.
+"""
+from __future__ import annotations
+
+import functools
+import json
+import os
+from typing import Any
+
+HERE = os.path.dirname(os.path.abspath(__file__))
+SCHEMA_DIR = os.path.join(HERE, 'schema')      # constants.json, kinds.json, messages.json, DIGEST ...
+SCHEMAS_DIR = os.path.join(HERE, 'schemas')    # JSON Schema documents by plane
+
+
+def path(name: str) -> str:
+    """Absolute path of a file under schema/ (constants.json, kinds.json, DIGEST ...)."""
+    return os.path.join(SCHEMA_DIR, name)
+
+
+def schema_path(*parts: str) -> str:
+    """Absolute path of a JSON Schema document under schemas/ (plane, ..., file)."""
+    return os.path.join(SCHEMAS_DIR, *parts)
+
+
+@functools.lru_cache(maxsize=None)
+def load_json(name: str) -> Any:
+    """Parse one file under schema/, once; every importer sees the same object.
+    The path is in any error so a broken install names itself."""
+    p = path(name)
+    try:
+        with open(p, encoding='utf-8') as fh:
+            return json.load(fh)
+    except (OSError, json.JSONDecodeError) as e:
+        raise RuntimeError('cannot read schema file %s: %s' % (p, e)) from e
+
+
+@functools.lru_cache(maxsize=None)
+def text(name: str) -> str:
+    """One file under schema/ as stripped text (DIGEST, PROTOCOLS)."""
+    try:
+        with open(path(name), encoding='utf-8') as fh:
+            return fh.read().strip()
+    except OSError as e:
+        raise RuntimeError('cannot read schema file %s: %s' % (path(name), e)) from e
+
+
+def digest() -> str:
+    """The protocol version digest, schema/DIGEST."""
+    return text('DIGEST')
+
+
+__all__ = ['SCHEMA_DIR', 'SCHEMAS_DIR', 'path', 'schema_path', 'load_json', 'text', 'digest']

fleetmesh_schema/schema/DIGEST

@@ -0,0 +1 @@
+695a868c3f2b343dba6f134cc23706bf8e48db392122cce63e06b69b3f92b7a7

fleetmesh_schema/schema/PROTOCOLS

@@ -0,0 +1,10 @@
+https://fleetmesh.org/blob/1.0 1cd7a7af0622a9235e0f4b667d3459234b3144bcdc21ae4606f5eaf325a30d5e
+https://fleetmesh.org/budget/1.0 57927f029cc188df8be0fc1a8c66d22471329f3e8c2a786bcb6c3233cd405a7c
+https://fleetmesh.org/complaint/1.0 041772e8861db065ac10badb8ca69b95bc05f37dd2e0a9fae0fe4b5be59b3717
+https://fleetmesh.org/compute/1.0 4d8ccdc8618ab421f775985a705b044b3e0cf11c1b8bdb1468bb71151276b0c4
+https://fleetmesh.org/compute/1.1 e87aaea83565f4cad55e4d02cd4719439691c1085fab68e4d2cac67ea7db1d75
+https://fleetmesh.org/gossip/1.0 83171e6abf4ecd300de7de9a08c1f39242de1950d1ec0481e5f3b2fd975fc872
+https://fleetmesh.org/peering/1.0 70aeab210ab49ba4085e779aba3d97db15cf16bff5969295ca7261a82c0cab12
+https://fleetmesh.org/standing/1.0 23f50257e1143ebfb207431b0899895d208dbc0c320fa1c071c1f6684ccbfa85
+https://fleetmesh.org/sync/1.0 335a86ca87886806c8018551f6f6f4efd9ec35002c549a5922fdc890de56824b
+https://fleetmesh.org/video-transit/1.0 4dbaa35541d77a8fd5f919f2c4c0f8f3de8c6f0d8b8229aec7caba1a64e1d3cd

fleetmesh_schema/schema/conformance.json

@@ -0,0 +1,492 @@
+{
+  "about": "the conformance op catalogue (docs/conformance.md); generated, do not edit",
+  "errors": [
+    "unsupported",
+    "bad_args",
+    "internal"
+  ],
+  "ops": {
+    "bech32.npub": {
+      "about": "npub of a hex pubkey",
+      "plane": "identity"
+    },
+    "blinding.derive": {
+      "about": "blinding scalar d from shared x, info and salt strings",
+      "plane": "identity"
+    },
+    "blossom.auth_event": {
+      "about": "BUD-01 authorization event (unsigned fields given signer)",
+      "plane": "store"
+    },
+    "blossom.auth_header": {
+      "about": "Authorization header for an auth event",
+      "plane": "store"
+    },
+    "blossom.check_auth": {
+      "about": "pubkey an auth event authorizes for verb/now/sha, or refused",
+      "plane": "store"
+    },
+    "blossom.mirror_request": {
+      "about": "BUD-04 mirror request body",
+      "plane": "store"
+    },
+    "blossom.mirror_response": {
+      "about": "blob descriptor after a mirror",
+      "plane": "store"
+    },
+    "blossom.parse_auth_header": {
+      "about": "auth event from an Authorization header",
+      "plane": "store"
+    },
+    "blossom.x_tag": {
+      "about": "the x tag of an auth event",
+      "plane": "store"
+    },
+    "capacity.pressure": {
+      "about": "{pressure, binding} from measured against total",
+      "plane": "peering"
+    },
+    "capacity.rungs": {
+      "about": "ladder rungs at a pressure",
+      "plane": "peering"
+    },
+    "capacity.shed_floor": {
+      "about": "the floor a shed never crosses, from probation ceilings",
+      "plane": "peering"
+    },
+    "complaint.may_publish": {
+      "about": "whether a complaint of a severity may be published now",
+      "plane": "peering"
+    },
+    "coverage.barred_reporter": {
+      "about": "why a reporter is barred from reporting on a claim, or null",
+      "plane": "store"
+    },
+    "coverage.chain_check": {
+      "about": "problems a bare handover chain has",
+      "plane": "store"
+    },
+    "coverage.check": {
+      "about": "problems a coverage claim has for a node class",
+      "plane": "store"
+    },
+    "coverage.handover_chain": {
+      "about": "the from-pubkeys of a claim's handover chain, in order",
+      "plane": "store"
+    },
+    "coverage.handover_check": {
+      "about": "problems a handover artefact has",
+      "plane": "store"
+    },
+    "coverage.handover_id": {
+      "about": "id of a handover artefact",
+      "plane": "store"
+    },
+    "coverage.handover_verify": {
+      "about": "handover verifies under its signer",
+      "plane": "store"
+    },
+    "coverage.inline_handover": {
+      "about": "the handover a replica claim carries inline",
+      "plane": "store"
+    },
+    "crypto.ecdh_x": {
+      "about": "x coordinate of the ECDH shared point",
+      "plane": "identity"
+    },
+    "crypto.hkdf": {
+      "about": "HKDF-SHA256 (RFC 5869); ikm/info/salt hex, length bytes",
+      "plane": "identity"
+    },
+    "crypto.pubkey": {
+      "about": "x-only public key of a secret key",
+      "plane": "identity"
+    },
+    "crypto.schnorr_sign": {
+      "about": "BIP-340 signature of a 32-byte message with zero aux",
+      "plane": "identity"
+    },
+    "descriptor.validate": {
+      "about": "problems a kind 11801 has at a given clock",
+      "plane": "identity"
+    },
+    "did.document": {
+      "about": "the resolved node profile for a kind 11801, aliases included",
+      "plane": "identity"
+    },
+    "did.key": {
+      "about": "did:key of a key kind over raw hex (node = x-only hex)",
+      "plane": "identity"
+    },
+    "did.parse": {
+      "about": "{method, node[, kind]} of a did:nostr / did:key / did:peer, or refused",
+      "plane": "identity"
+    },
+    "did.peer": {
+      "about": "did:peer:2 of node x-only hex, agreement hex or null, DIDComm service or null",
+      "plane": "identity"
+    },
+    "did.peer_parse": {
+      "about": "{node, agreement, service} read back from a did:peer:2, or refused",
+      "plane": "identity"
+    },
+    "discover.answer": {
+      "about": "the disclose message a descriptor answers a query with",
+      "plane": "peering"
+    },
+    "discover.ids": {
+      "about": "disclosed ids of a disclose message",
+      "plane": "peering"
+    },
+    "discover.parse": {
+      "about": "query list of a discover-features queries message",
+      "plane": "peering"
+    },
+    "discover.protocols": {
+      "about": "protocol ids a descriptor discloses",
+      "plane": "peering"
+    },
+    "discovery.check": {
+      "about": "problems a discovery event has against its descriptor",
+      "plane": "identity"
+    },
+    "discovery.events": {
+      "about": "NIP-66 discovery events from a descriptor and NIP-11 document",
+      "plane": "identity"
+    },
+    "discovery.network": {
+      "about": "NIP-66 network label of a URL",
+      "plane": "identity"
+    },
+    "envelope.hop_message": {
+      "about": "sha256 hop message for domain|event|prev|at",
+      "plane": "store"
+    },
+    "envelope.verify": {
+      "about": "problems a delivery envelope path has ([] = verifies)",
+      "plane": "store"
+    },
+    "event.expiration": {
+      "about": "NIP-40 expiration of an event, or null: the first well-formed tag, ASCII digits only",
+      "plane": "identity"
+    },
+    "event.verify": {
+      "about": "id and signature of a Nostr event check out",
+      "plane": "identity"
+    },
+    "fingerprint.of": {
+      "about": "range fingerprint of a set of event ids",
+      "plane": "store"
+    },
+    "fingerprint.union": {
+      "about": "fingerprint of two disjoint id sets composed",
+      "plane": "store"
+    },
+    "fingerprint.varint": {
+      "about": "negentropy varint encoding",
+      "plane": "store"
+    },
+    "giftwrap.constants": {
+      "about": "seal/live/stored kinds, skew max and retention",
+      "plane": "identity"
+    },
+    "giftwrap.unwrap": {
+      "about": "open a wrap for a recipient: {payload, from}, or refused",
+      "plane": "identity"
+    },
+    "giftwrap.wrap_kind_allowed": {
+      "about": "refusal text when wrapping a kind the profile forbids",
+      "plane": "identity"
+    },
+    "heartbeat.check": {
+      "about": "[problems, notices] of a heartbeat against a descriptor",
+      "plane": "store"
+    },
+    "heartbeat.is_retiring": {
+      "about": "heartbeat announces retirement",
+      "plane": "store"
+    },
+    "lifecycle.endpoints_digest": {
+      "about": "digest of a descriptor endpoint tag set",
+      "plane": "store"
+    },
+    "negentropy.decode": {
+      "about": "decode a message to [[timestamp, prefix_hex, mode], ...]",
+      "plane": "store"
+    },
+    "negentropy.encode": {
+      "about": "encode ranges: [[timestamp, prefix_hex, mode, payload], ...]",
+      "plane": "store"
+    },
+    "negentropy.minimal_bound": {
+      "about": "shortest prefix separating previous from item",
+      "plane": "store"
+    },
+    "negentropy.reconcile": {
+      "about": "have/need after a full reconciliation",
+      "plane": "store"
+    },
+    "negentropy.version": {
+      "about": "protocol version byte, hex",
+      "plane": "store"
+    },
+    "nip44.conversation_key": {
+      "about": "NIP-44 conversation key from sk and pk",
+      "plane": "identity"
+    },
+    "nip44.decrypt": {
+      "about": "NIP-44 v2 plaintext",
+      "plane": "identity"
+    },
+    "nip44.encrypt": {
+      "about": "NIP-44 v2 payload with a given nonce",
+      "plane": "identity"
+    },
+    "nip44.padded_len": {
+      "about": "padded length for an unpadded length",
+      "plane": "identity"
+    },
+    "nip90.constants": {
+      "about": "default kinds and feedback states",
+      "plane": "services"
+    },
+    "nip90.feedback": {
+      "about": "a feedback event (unsigned fields given signer)",
+      "plane": "services"
+    },
+    "nip90.parse": {
+      "about": "{is_request, parsed, executor, job} of a job request",
+      "plane": "services"
+    },
+    "nip90.result": {
+      "about": "a result event (unsigned fields given signer)",
+      "plane": "services"
+    },
+    "nip90.result_kind": {
+      "about": "result kind for a request kind",
+      "plane": "services"
+    },
+    "nsite.base36": {
+      "about": "base36 of a hex pubkey",
+      "plane": "services"
+    },
+    "nsite.base36_decode": {
+      "about": "hex pubkey of a base36 label, or null",
+      "plane": "services"
+    },
+    "nsite.guess_type": {
+      "about": "content type of a path",
+      "plane": "services"
+    },
+    "nsite.host": {
+      "about": "site ref of a host under suffixes",
+      "plane": "services"
+    },
+    "nsite.label": {
+      "about": "{ref, filter, canonical} of a site label",
+      "plane": "services"
+    },
+    "nsite.manifest": {
+      "about": "{paths, aggregate, domains, servers} of a manifest",
+      "plane": "services"
+    },
+    "nsite.resolve": {
+      "about": "resolution of a request path against manifest paths",
+      "plane": "services"
+    },
+    "nsite.txt": {
+      "about": "site ref of a TXT binding",
+      "plane": "services"
+    },
+    "paidfetch.quote": {
+      "about": "{headers, body} of a 402 quote",
+      "plane": "services"
+    },
+    "paidfetch.sat_ceil": {
+      "about": "msat rounded up to sat",
+      "plane": "services"
+    },
+    "paidfetch.tokens": {
+      "about": "tokens of an X-Cashu header",
+      "plane": "services"
+    },
+    "peering.offer": {
+      "about": "an acceptor's reply to a proposal (type, and code or tier/limits/transports)",
+      "plane": "peering"
+    },
+    "projection.canonical_relay": {
+      "about": "canonical spelling of a relay URL, or refused",
+      "plane": "identity"
+    },
+    "projection.check": {
+      "about": "problems an assertion has against its report ([] = holds)",
+      "plane": "identity"
+    },
+    "projection.project": {
+      "about": "NIP-85 assertions from one report",
+      "plane": "identity"
+    },
+    "projection.rank": {
+      "about": "rank by outcome table",
+      "plane": "identity"
+    },
+    "projection.relay_endpoints": {
+      "about": "relay endpoints a descriptor advertises",
+      "plane": "identity"
+    },
+    "protocol.version": {
+      "about": "[name, major, minor] of a fleetmesh protocol identifier, or null",
+      "plane": "identity"
+    },
+    "receipt.link": {
+      "about": "link hash of a receipt body (signature excluded)",
+      "plane": "peering"
+    },
+    "receipt.sign": {
+      "about": "signature over an unsigned receipt",
+      "plane": "peering"
+    },
+    "receipt.verify": {
+      "about": "a receipt verifies for its subject",
+      "plane": "peering"
+    },
+    "receipt_chain.sha256": {
+      "about": "canonical JSON and sha256 of a receipt link",
+      "plane": "store"
+    },
+    "relaylist.build": {
+      "about": "the tags of the kind 10050 a node publishes for its own inbox",
+      "plane": "transport"
+    },
+    "relaylist.dm_relays": {
+      "about": "inbox relays read from a kind 10050 event",
+      "plane": "transport"
+    },
+    "relaylist.filter": {
+      "about": "the REQ filter that fetches a pubkey's kind 10050",
+      "plane": "transport"
+    },
+    "release.classify": {
+      "about": "'major'|'minor'|'patch' when candidate is newer than running, else null",
+      "plane": "operations"
+    },
+    "release.compare": {
+      "about": "-1/0/1 for a <,==,> b; prerelease below its release; refused when either is not a semver",
+      "plane": "operations"
+    },
+    "release.parse": {
+      "about": "a kind 9900 read for {release_key[, name]}: the ReleaseInfo dict, or the refusal string",
+      "plane": "operations"
+    },
+    "release.revocation": {
+      "about": "[revoked event id, reason] of a kind 9901 by release_key that verifies, else null",
+      "plane": "operations"
+    },
+    "release.select": {
+      "about": "newest_compatible / incompatible_newer / refused / revoked from events for {release_key, running, digest[, name, already_revoked]}",
+      "plane": "operations"
+    },
+    "release.semver": {
+      "about": "[major, minor, patch, prerelease] of a semver, or refused",
+      "plane": "operations"
+    },
+    "report.admissible": {
+      "about": "a report is admissible given which referenced events resolve",
+      "plane": "peering"
+    },
+    "report.evidence_id": {
+      "about": "evidence id of a signed receipt",
+      "plane": "peering"
+    },
+    "standing.tell": {
+      "about": "standing tell after a sequence of windows",
+      "plane": "peering"
+    },
+    "store.replay": {
+      "about": "insert events; result {enumerate: [id], ranges: [fingerprint hex, one per range in order]}",
+      "plane": "store"
+    },
+    "telemetry.bin_of": {
+      "about": "order-of-magnitude bin of a counter",
+      "plane": "store"
+    },
+    "telemetry.check": {
+      "about": "problems a telemetry event has",
+      "plane": "store"
+    },
+    "telemetry.constants": {
+      "about": "kind and bin labels",
+      "plane": "store"
+    },
+    "telemetry.event": {
+      "about": "the kind 21802 event for counters (unsigned fields)",
+      "plane": "store"
+    },
+    "telemetry.read": {
+      "about": "metrics read back from a telemetry event",
+      "plane": "store"
+    },
+    "trust.reporter_weight": {
+      "about": "weight of a reporter",
+      "plane": "peering"
+    },
+    "trust.view": {
+      "about": "own view given weighted reports",
+      "plane": "peering"
+    },
+    "window.adjust": {
+      "about": "{limits_after, tier_after} after a severity; refused for a severity or tier not on the ladder",
+      "plane": "peering"
+    },
+    "window.ceilings": {
+      "about": "ceilings of a tier",
+      "plane": "peering"
+    },
+    "window.evaluate": {
+      "about": "severity of a window from limits, measured and claimed",
+      "plane": "peering"
+    },
+    "window.opening_limits": {
+      "about": "opening limits of a tier",
+      "plane": "peering"
+    }
+  },
+  "planes": [
+    "identity",
+    "store",
+    "peering",
+    "transport",
+    "services",
+    "operations"
+  ],
+  "verdicts": [
+    "conformant",
+    "partial",
+    "not attempted",
+    "FAILED",
+    "no cases"
+  ],
+  "wire": {
+    "hello": {
+      "result": {
+        "implementation": "string",
+        "ops": [
+          "sorted op names"
+        ]
+      }
+    },
+    "reply": {
+      "error": {
+        "code": "one of errors",
+        "message": "text"
+      },
+      "id": "echoed",
+      "result": "value, or {refused: why}"
+    },
+    "request": {
+      "args": "object",
+      "id": "any JSON",
+      "op": "domain.verb"
+    }
+  }
+}