node

Documentation

Index

• Constants
• func RandomUint64() uint64
• type LndConfig
• type LndNode
  • func NewLndNode(cfg *LndConfig) (node LndNode, err error)
• type Node

Constants

const (
	NodePubkeyKeysendType   uint64 = 555555
	MessageKeysendType      uint64 = 684931
	MessageOrderKeysendType uint64 = 123456
)

const MAX_CUST_SIZE = 900

Functions

func RandomUint64

func RandomUint64() uint64

Types

type LndConfig

type LndConfig struct {
	MacaroonPath string
	MacaroonHex  string
	TlsCertPath  string
	TlsCertHex   string
	Pubkey       string
	IpAddress    string
	Port         string
	ShouldListen bool
}

type LndNode

type LndNode interface {
	Node
}

func NewLndNode

func NewLndNode(cfg *LndConfig) (node LndNode, err error)

type Node

type Node interface {
	// GetPubkey will get the node's public key.
	GetPubkey() string

	// Subscribe will subscribe to keysends through the channel from the node.
	Subscribe(chan comm.IncomingDIDMessage) error

	// Keysend will send a message through Lightning to another node with an amount.
	Keysend(pubKey string, msgData []byte, amt int64) error

	// SignMessage will sign the provided message using a node
	SignMessage([]byte) ([]byte, error)

	// VerifySignature will verify the provided signature using a node
	VerifySignature(msg, signature []byte) (bool, error)

	// VerifySignature will verify the provided signature using a specific node pubkey.
	VerifySignatureFromPubkey(msg, signature, pubkey []byte) (bool, error)

	// GenerateInvoice will generate an invoice from one of the active nodes.
	GenerateInvoice(int64, string) (string, error)

	// PayInvoice will pay an invoice from one of the active nodes.
	PayInvoice(string) (string, error)

	// PayInvoice will check an invoice for payment.
	CheckInvoice(string) (bool, error)

	// Disconnect will disconnect safely from the node.
	Disconnect() error

	// ShouldListen indicates if this node should listen to incoming messages
	ShouldListen() bool
}

Node is an implementation of a single lightning node with only the functionality that the LightningManager needs to worry about.