rpcmessages

Documentation

Index

• Constants
• type GetEnvResponse
• type ResyncBitcoinArgs
• type ResyncBitcoinResponse
• type SampleInfoResponse
• type VerificationProgressResponse

Constants

const (
	// OpRPCCall is prepended to every rpc response messages, to indicate that the message is rpc response and not a notification.
	OpRPCCall = "r"
	// OpUCanHasSampleInfo notifies when new SampleInfo data is available.
	OpUCanHasSampleInfo = "d"
	// OpUCanHasVerificationProgress notifies when new VerificationProgress data is available.
	OpUCanHasVerificationProgress = "v"
)

Put notification constants here. Notifications for new rpc data should have the format 'OpUCanHas' + 'RPC Method Name'.

Types

type GetEnvResponse

type GetEnvResponse struct {
	Network        string
	ElectrsRPCPort string
}

GetEnvResponse is the struct that gets sent by the rpc server during a GetSystemEnv call

type ResyncBitcoinArgs

type ResyncBitcoinArgs int

ResyncBitcoinArgs is an iota that holds the options for the ResyncBitcoin rpc call

const (
	Resync ResyncBitcoinArgs = iota
	Reindex
)

The ResyncBitcoinArgs has two options. Either resync bitcon from scratch with an IBD, or delete the chainstate and reindex.

type ResyncBitcoinResponse

type ResyncBitcoinResponse struct {
	Success bool
}

ResyncBitcoinResponse is the struct that gets sent by the rpc server during a ResyncBitcoin call

type SampleInfoResponse

type SampleInfoResponse struct {
	Blocks         int64   `json:"blocks"`
	Difficulty     float64 `json:"difficulty"`
	LightningAlias string  `json:"lightningAlias"`
}

SampleInfoResponse holds sample information from c-lightning and bitcoind. It is temporary for testing purposes

type VerificationProgressResponse

type VerificationProgressResponse struct {
	Blocks               int64   `json:"blocks"`
	Headers              int64   `json:"headers"`
	VerificationProgress float64 `json:"verificationProgress"`
}

VerificationProgressResponse is the struct that gets sent by the rpc server during a VerificationProgress rpc call