package wtclientrpc
Get desktop application:
View/edit binary Protocol Buffers messages
WatchtowerClient is a service that grants access to the watchtower client functionality of the daemon.
rpc AddTower (, )
wtclient.proto:22AddTower adds a new watchtower reachable at the given address and considers it for new sessions. If the watchtower already exists, then any new addresses included will be considered when dialing it for session negotiations and backups.
message
wtclient.proto:45bytes pubkey = 1
The identifying public key of the watchtower to add.
string address = 2
A network address the watchtower is reachable over.
message
wtclient.proto:53(message has no fields)
rpc GetTowerInfo (, )
wtclient.proto:36GetTowerInfo retrieves information for a registered watchtower.
message
wtclient.proto:71bytes pubkey = 1
The identifying public key of the watchtower to retrieve information for.
bool include_sessions = 2
Whether we should include sessions with the watchtower in the response.
bool exclude_exhausted_sessions = 3
Whether to exclude exhausted sessions in the response info. This option is only meaningful if include_sessions is true.
rpc ListTowers (, )
wtclient.proto:33ListTowers returns the list of watchtowers registered with the client.
message
wtclient.proto:153bool include_sessions = 1
Whether we should include sessions with the watchtower in the response.
bool exclude_exhausted_sessions = 2
Whether to exclude exhausted sessions in the response info. This option is only meaningful if include_sessions is true.
message
wtclient.proto:162repeated towers = 1
The list of watchtowers available for new backups.
rpc Policy (, )
wtclient.proto:42Policy returns the active watchtower client policy configuration.
message
wtclient.proto:204PolicyType policy_type = 1
The client type from which to retrieve the active offering policy.
message
wtclient.proto:211uint32 max_updates = 1
The maximum number of updates each session we negotiate with watchtowers should allow.
uint32 sweep_sat_per_byte = 2
Deprecated, use sweep_sat_per_vbyte. The fee rate, in satoshis per vbyte, that will be used by watchtowers for justice transactions in response to channel breaches.
uint32 sweep_sat_per_vbyte = 3
The fee rate, in satoshis per vbyte, that will be used by watchtowers for justice transactions in response to channel breaches.
rpc RemoveTower (, )
wtclient.proto:30RemoveTower removes a watchtower from being considered for future session negotiations and from being used for any subsequent backups until it's added again. If an address is provided, then this RPC only serves as a way of removing the address from the watchtower instead.
message
wtclient.proto:56bytes pubkey = 1
The identifying public key of the watchtower to remove.
string address = 2
If set, then the record for this address will be removed, indicating that is is stale. Otherwise, the watchtower will no longer be used for future session negotiations and backups.
message
wtclient.proto:68(message has no fields)
rpc Stats (, )
wtclient.proto:39Stats returns the in-memory statistics of the client since startup.
message
wtclient.proto:167(message has no fields)
message
wtclient.proto:170uint32 num_backups = 1
The total number of backups made to all active and exhausted watchtower sessions.
uint32 num_pending_backups = 2
The total number of backups that are pending to be acknowledged by all active and exhausted watchtower sessions.
uint32 num_failed_backups = 3
The total number of backups that all active and exhausted watchtower sessions have failed to acknowledge.
uint32 num_sessions_acquired = 4
The total number of new sessions made to watchtowers.
uint32 num_sessions_exhausted = 5
The total number of watchtower sessions that have been exhausted.
Used in: ,
LEGACY = 0
Selects the policy from the legacy tower client.
ANCHOR = 1
Selects the policy from the anchor tower client.
message
wtclient.proto:113Used as response type in: WatchtowerClient.GetTowerInfo
Used as field type in:
bytes pubkey = 1
The identifying public key of the watchtower.
repeated string addresses = 2
The list of addresses the watchtower is reachable over.
bool active_session_candidate = 3
Deprecated, use the active_session_candidate field under the correct identifier in the client_type map. Whether the watchtower is currently a candidate for new sessions.
uint32 num_sessions = 4
Deprecated, use the num_sessions field under the correct identifier in the client_type map. The number of sessions that have been negotiated with the watchtower.
repeated sessions = 5
Deprecated, use the sessions field under the correct identifier in the client_type map. The list of sessions that have been negotiated with the watchtower.
repeated session_info = 6
A list sessions held with the tower.
message
wtclient.proto:83Used in: ,
uint32 num_backups = 1
The total number of successful backups that have been made to the watchtower session.
uint32 num_pending_backups = 2
The total number of backups in the session that are currently pending to be acknowledged by the watchtower.
uint32 max_backups = 3
The maximum number of backups allowed by the watchtower session.
uint32 sweep_sat_per_byte = 4
Deprecated, use sweep_sat_per_vbyte. The fee rate, in satoshis per vbyte, that will be used by the watchtower for the justice transaction in the event of a channel breach.
uint32 sweep_sat_per_vbyte = 5
The fee rate, in satoshis per vbyte, that will be used by the watchtower for the justice transaction in the event of a channel breach.
message
wtclient.proto:139Used in:
bool active_session_candidate = 1
Whether the watchtower is currently a candidate for new sessions.
uint32 num_sessions = 2
The number of sessions that have been negotiated with the watchtower.
repeated sessions = 3
The list of sessions that have been negotiated with the watchtower.
PolicyType policy_type = 4
The session's policy type.