nodeinfo

README

nodeinfo-go

golang lib to query federation node information.

Based on Well-known URI for nodeinfo and matrix discovery it obtains node information(s) about it's service and user stats.

This repo also contains a small CLI tool to use this lib.

Lib

go get "codeberg.org/thefederationinfo/nodeinfo-go"

import "codeberg.org/thefederationinfo/nodeinfo-go"

func main() {
  // ...
  testNodeInfos, err := nodeinfo.QueryNode("example.org")
  // ...
}

CLI Tool

how to build:

1. have go compiler installed
2. clone this repo
3. cd into cli folder
4. go build .

exec: ./nodeinfo <node domain>

Documentation

Index

• Constants
• func Extend(client *http.Client, domain string, node *Node) error
• func RegisterExtension(e Extension)
• func RegisterGenericExtension(e Extension)
• type Extension
• type Fetcher
  • func NewFetcher(opts ...QueryNodeOption) (Fetcher, error)
• type Instance
• type Node
  • func QueryNode(domain string, opts ...QueryNodeOption) ([]*Node, error)
• type QueryNodeOption
  • func QueryOptionClient(c *http.Client) QueryNodeOption
  • func QueryOptionNoMatrix() QueryNodeOption
  • func QueryOptionNoNodeinfo() QueryNodeOption
• type Services
• type Software
• type Usage
• type UsersUsage

Constants

const (
	ProtocolMatrix = "matrix"
)

Functions

func Extend

func Extend(client *http.Client, domain string, node *Node) error

func RegisterExtension

func RegisterExtension(e Extension)

func RegisterGenericExtension

func RegisterGenericExtension(e Extension)

Types

type Extension

type Extension interface {
	Name() string
	Extend(client *http.Client, domain string, node *Node) error
}

type Fetcher

type Fetcher interface {
	QueryNode(domain string) ([]*Node, error)
}

func NewFetcher

func NewFetcher(opts ...QueryNodeOption) (Fetcher, error)

type Instance

type Instance struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

Instance contain metadata specific to the instance

type Node

type Node struct {
	Version           string                 `json:"version"`
	Instance          Instance               `json:"instance"`
	Software          Software               `json:"software"`
	Protocols         []string               `json:"protocols"`
	Services          Services               `json:"services"`
	OpenRegistrations bool                   `json:"openRegistrations"`
	Usage             Usage                  `json:"usage"`
	Metadata          map[string]interface{} `json:"metadata"`
}

Node metadata about a server running in the federation

func QueryNode

func QueryNode(domain string, opts ...QueryNodeOption) ([]*Node, error)

QueryNode fetch node info based on domain, can return more than one node if e.g. matrix and mastodon share the same domain name

type QueryNodeOption

type QueryNodeOption func(f *fetcher) error

QueryNodeOption are functions to be used as options for QueryNode

func QueryOptionClient

func QueryOptionClient(c *http.Client) QueryNodeOption

QueryOptionClient return an option for QueryNode that can set an specific http client

func QueryOptionNoMatrix

func QueryOptionNoMatrix() QueryNodeOption

QueryOptionNoMatrix do not discovery based on the matrix specification

func QueryOptionNoNodeinfo

func QueryOptionNoNodeinfo() QueryNodeOption

QueryOptionNoNodeinfo do not discovery based on the nodeinfo2 specification

type Services

type Services struct {
	Inbound  []string `json:"inbound"`
	Outbound []string `json:"outbound"`
}

Services tell about third party sites the node can connect to or interact with

type Software

type Software struct {
	Name       string `json:"name"`
	Version    string `json:"version"`
	Repository string `json:"repository"`
	Homepage   string `json:"homepage"`
}

Software is about node software

type Usage

type Usage struct {
	Users         UsersUsage `json:"users"`
	LocalPosts    int64      `json:"localPosts,omitempty"`
	LocalComments int64      `json:"localComments,omitempty"`
}

Usage are usage statistics for the node

type UsersUsage

type UsersUsage struct {
	Total          int64 `json:"total,omitempty"`
	ActiveHalfyear int64 `json:"activeHalfyear,omitempty"`
	ActiveMonth    int64 `json:"activeMonth,omitempty"`
	ActiveWeek     int64 `json:"activeWeek,omitempty"`
}

UsersUsage are statistics about the users of the node