@happyvertical/smrt-gnode

Federation library for inter-gnode peer-to-peer discovery and communication.

v0.20.44Stubs OnlyNot Implemented

Overview

smrt-gnode is intended to provide federation protocols for inter-gnode peer-to-peer discovery and communication. Gnodes are federated local knowledge bases that will eventually support P2P discovery and cross-gnode communication.

Installation

bash
pnpm add @happyvertical/smrt-gnode

No dependencies. Standalone stub package.

Exports (All Stubs)

Classes

ExportStatusDescription
FederationStubdiscoverPeers() and exchangePeers() return []
WebFingerProtocolStub.well-known/gnode discovery. discover() returns null
PeerExchangeProtocolStub/api/federation/peers peer list exchange. exchange() returns []

Types

ExportDescription
GnodePeerPeer descriptor: url, name, discoveredAt, lastSeen?
FederationConfigConfig: enabled, discoverability, peers, autodiscovery, peerExchange
WebFingerResponseWebFinger response: subject, links[]

Constants

version: Package version string ('0.1.0')

Planned Architecture

  • WebFinger-based peer discovery via GET /.well-known/gnode
  • Peer exchange protocol via GET /api/federation/peers
  • ActivityPub-inspired cross-gnode queries

Related Modules