Skip to content

LISH_NETWORK_FORMAT.md

Latest commit

 

History

History
81 lines (57 loc) · 2.84 KB

LISH_NETWORK_FORMAT.md

File metadata and controls

81 lines (57 loc) · 2.84 KB

LISH network structure format specification

Created: 29 October 2025 Last update: 29 October 2025

Overview

LISH network structure format describes a single LISH file sharing network. This format defines the network identity, connection parameters, and metadata needed to discover and join a specific LISH network. Network definitions can be shared by users to join networks.

Features

  • Network identification with unique UUID
  • Human-readable network name and description
  • Bootstrap peer configuration for network discovery
  • Support for multiple bootstrap peers
  • Creation timestamp
  • Support for IPv4, IPv6, and DNS-based multiaddrs

Representation

LISH network structure format defines a data structure that can be used in various forms:

  • As objects in memory during runtime
  • Serialized to JSON format for interchange and storage
  • Stored in files (commonly with .lishnet extension when using JSON)
  • Stored in databases or other persistent storage systems

This specification describes the logical structure, with JSON examples for clarity.

Structure

interface ILISHNetwork {
	networkID: string; // Unique UUID for this network (required)
	name: string; // Network name (required)
	description?: string; // Free-form text description such as purpose, rules, etc. (optional)
	bootstrapPeers: string[]; // Array of bootstrap peer multiaddrs for network discovery (required)
	created?: string; // ISO 8601 timestamp in UTC when network was created (optional)
}

Bootstrap peers

Bootstrap peers are initial connection points for discovering other peers in the network. They are specified as libp2p multiaddrs.

Multiaddr format examples:

  • /ip4/192.168.0.10/tcp/9090/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N
  • /dns4/bootstrap.example.com/tcp/7070/p2p/QmU3vQnXwYp7zRfKjLmN9BcDeTpRsWxYvZqNmLkJhGfTxP
  • /ip6/fd00::1/tcp/5050/p2p/QmV9wRyYzP8bNcMjDkLqTnWsXvZpRmLkJhGfTxPuOnXwYq

Example

Minimal network

{
	"networkID": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
	"name": "Public LISH Network",
	"bootstrapPeers": ["/ip4/192.168.1.10/tcp/9090/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N"]
}

Full-featured network

{
	"networkID": "a3f8c2e1-9b7d-4f2a-8c5e-1a2b3c4d5e6f",
	"name": "Research Lab Network",
	"description": "Private network for research collaboration",
	"bootstrapPeers": ["/ip4/192.168.0.10/tcp/9090/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N", "/dns4/bootstrap.example.com/tcp/7070/p2p/QmU3vQnXwYp7zRfKjLmN9BcDeTpRsWxYvZqNmLkJhGfTxP", "/ip6/fd00::1/tcp/5050/p2p/QmV9wRyYzP8bNcMjDkLqTnWsXvZpRmLkJhGfTxPuOnXwYq"],
	"created": "2025-10-20T14:30:00.000Z"
}

Notes

  • At least one bootstrap peer must be provided
  • All timestamps must use ISO 8601 format in UTC timezone (e.g., "2025-10-20T14:30:00.000Z")