health

Documentation

Overview

Package health provides functions to check the status of an LND lightning node

Index

• func Check(twilioConfig TwilioConfig, node db.Node, lndClient *lndclient.LightningClient) error
• type GithubLatestReleaseResponse
• type MonitorParams
• type SmsDetails
• type TwilioConfig

Functions

func Check

func Check(twilioConfig TwilioConfig, node db.Node, lndClient *lndclient.LightningClient) error

Check node status, send a text message if user has SMS enabled

Types

type GithubLatestReleaseResponse

type GithubLatestReleaseResponse struct {
	TagName string `json:"tag_name"`
}

GithubLatestReleaseResponse is the response from the Github API

type MonitorParams

type MonitorParams struct {
	Interval   time.Duration
	NotifyTime int
}

MonitorParams contains the parameters for monitoring an LND node

type SmsDetails

type SmsDetails struct {
	To           string
	From         string
	Body         string
	TwilioClient *twilio.RestClient
}

SmsDetails contains the parameters for sending an SMS message

type TwilioConfig

type TwilioConfig struct {
	From             string
	TwilioClient     *twilio.RestClient
	TwilioAccountSID string
	TwilioAuthToken  string
}

TwilioConfig contains the parameters for sending an SMS message