nip48

Documentation

Overview

Package nip48 implements NIP-48: Proxy tags, which let an event declare that it originated on another protocol (ActivityPub, AT Protocol, RSS, or the web) and reference its source object there.

Index

• Constants
• func AddProxyTag(ev *nip01.Event, id, protocol string)
• func ValidateProxyTag(event *nip01.Event) error
• type ProxyTag
  • func ParseProxyTag(event *nip01.Event) (*ProxyTag, error)

Constants

const (
	ProtocolActivityPub = "activitypub"
	ProtocolATProto     = "atproto"
	ProtocolRSS         = "rss"
	ProtocolWeb         = "web"
)

Known protocol identifiers for the proxy tag's third element.

const (
	TagNameProxy = "proxy"
)

Functions

func AddProxyTag

func AddProxyTag(ev *nip01.Event, id, protocol string)

AddProxyTag appends a ["proxy", id, protocol] tag to ev.

func ValidateProxyTag

func ValidateProxyTag(event *nip01.Event) error

ValidateProxyTag checks the structural shape of event's proxy tag, if any. An event without a proxy tag is valid — NIP-48 is opt-in per event.

Types

type ProxyTag

type ProxyTag struct {
	ID       string
	Protocol string
}

ProxyTag is a parsed ["proxy", <id>, <protocol>] tag.

func ParseProxyTag

func ParseProxyTag(event *nip01.Event) (*ProxyTag, error)

ParseProxyTag extracts the proxy tag from event, if present.