invite

Documentation

Overview

Package invite contains functions for parsing invite codes and dialing a pub as a guest to redeem a token. The muxrpc handlers and storage are found in plugins/legacyinvite.

Index

• Variables
• func NewPubMessageFromToken(tok Token) (*refs.OldPubMessage, error)
• func Redeem(ctx context.Context, tok Token, longTerm refs.FeedRef) error
• type Token
  • func ParseLegacyToken(input string) (Token, error)
  • func (c Token) String() string

Variables

var ErrInvalidToken = errors.New("invite: invalid token")

Functions

func NewPubMessageFromToken

func NewPubMessageFromToken(tok Token) (*refs.OldPubMessage, error)

func Redeem

func Redeem(ctx context.Context, tok Token, longTerm refs.FeedRef) error

Redeem takes an invite token and a long term key. It uses the information in the token to build a guest-client connection and place an 'invite.use' rpc call with it's longTerm key. If the peer responds with a message it returns nil

Types

type Token

type Token struct {
	Peer    refs.FeedRef
	Address net.Addr

	Seed [32]byte
}

func ParseLegacyToken

func ParseLegacyToken(input string) (Token, error)

ParseLegacyToken takes an legacy invite token of the form host:port:@feed.Ref~base64Seed

func (Token) String

func (c Token) String() string