webhooks

Documentation

Index

• Constants
• type AvailabilityHooks
• type BadBlockHooks
• type DoubleSignWebHooks
• type Hooks
  • func NewWebHooksFromPath(yamlPath string) (*Hooks, error)
• type ReportResult
  • func DoPost(url string, record interface{}) (*ReportResult, error)
  • func NewFailure(payload string) *ReportResult
  • func NewSuccess(payload string) *ReportResult

Constants

const (
	// DefaultWebHookPath ..
	DefaultWebHookPath = "webhooks/webhook.example.yaml"
)

Types

type AvailabilityHooks

type AvailabilityHooks struct {
	OnDroppedBelowThreshold string `yaml:"on-dropped-below-threshold"`
}

AvailabilityHooks ..

type BadBlockHooks

type BadBlockHooks struct {
	OnCannotCommit string `yaml:"on-cannot-commit-block"`
}

BadBlockHooks ..

type DoubleSignWebHooks

type DoubleSignWebHooks struct {
	OnNoticeDoubleSign string `yaml:"on-notice-double-sign"`
}

DoubleSignWebHooks ..

type Hooks

type Hooks struct {
	Slashing       *DoubleSignWebHooks `yaml:"slashing-hooks"`
	Availability   *AvailabilityHooks  `yaml:"availability-hooks"`
	ProtocolIssues *BadBlockHooks      `yaml:"protocol-hooks"`
}

Hooks ..

func NewWebHooksFromPath

func NewWebHooksFromPath(yamlPath string) (*Hooks, error)

NewWebHooksFromPath ..

type ReportResult

type ReportResult struct {
	Result  string `json:"result"`
	Payload string `json:"payload"`
}

ReportResult ..

func DoPost

func DoPost(url string, record interface{}) (*ReportResult, error)

DoPost is a fire and forget helper

func NewFailure

func NewFailure(payload string) *ReportResult

NewFailure ..

func NewSuccess

func NewSuccess(payload string) *ReportResult

NewSuccess ..