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 (AddTowerRequest, AddTowerResponse)

  wtclient.proto:36

  lncli: `wtclient add` AddTower 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 AddTowerRequest

  wtclient.proto:82

  • bytes pubkey = 1

    The identifying public key of the watchtower to add.

  • string address = 2

    A network address the watchtower is reachable over.

  message AddTowerResponse

  wtclient.proto:90

  (message has no fields)

• rpc RemoveTower (RemoveTowerRequest, RemoveTowerResponse)

  wtclient.proto:44

  lncli: `wtclient remove` RemoveTower 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 RemoveTowerRequest

  wtclient.proto:93

  • bytes 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 RemoveTowerResponse

  wtclient.proto:105

  (message has no fields)

• rpc DeactivateTower (DeactivateTowerRequest, DeactivateTowerResponse)

  wtclient.proto:51

  lncli: `wtclient deactivate` DeactivateTower sets the given tower's status to inactive so that it is not considered for session negotiation. Its sessions will also not be used while the tower is inactive.

  message DeactivateTowerRequest

  wtclient.proto:108

  • bytes pubkey = 1

    The identifying public key of the watchtower to deactivate.

  message DeactivateTowerResponse

  wtclient.proto:113

  • string status = 1

    A string describing the action that took place.

• rpc TerminateSession (TerminateSessionRequest, TerminateSessionResponse)

  wtclient.proto:58

  lncli: `wtclient session terminate` Terminate terminates the given session and marks it as terminal so that it is not used for backups anymore.

  message TerminateSessionRequest

  wtclient.proto:118

  • bytes session_id = 1

    The ID of the session that should be terminated.

  message TerminateSessionResponse

  wtclient.proto:123

  • string status = 1

    A string describing the action that took place.

• rpc ListTowers (ListTowersRequest, ListTowersResponse)

  wtclient.proto:64

  lncli: `wtclient towers` ListTowers returns the list of watchtowers registered with the client.

  message ListTowersRequest

  wtclient.proto:215

  • bool 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 ListTowersResponse

  wtclient.proto:224

  • repeated Tower towers = 1

    The list of watchtowers available for new backups.

• rpc GetTowerInfo (GetTowerInfoRequest, Tower)

  wtclient.proto:69

  lncli: `wtclient tower` GetTowerInfo retrieves information for a registered watchtower.

  message GetTowerInfoRequest

  wtclient.proto:128

  • bytes 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 Stats (StatsRequest, StatsResponse)

  wtclient.proto:74

  lncli: `wtclient stats` Stats returns the in-memory statistics of the client since startup.

  message StatsRequest

  wtclient.proto:229

  (message has no fields)

  message StatsResponse

  wtclient.proto:232

  • uint32 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.

• rpc Policy (PolicyRequest, PolicyResponse)

  wtclient.proto:79

  lncli: `wtclient policy` Policy returns the active watchtower client policy configuration.

  message PolicyRequest

  wtclient.proto:269

  • PolicyType policy_type = 1

    The client type from which to retrieve the active offering policy.

  message PolicyResponse

  wtclient.proto:276

  • uint32 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.

Used in: PolicyRequest, TowerSessionInfo

• LEGACY = 0

  Selects the policy from the legacy tower client.

• ANCHOR = 1

  Selects the policy from the anchor tower client.

• TAPROOT = 2

  Selects the policy from the taproot tower client.

Used as response type in: WatchtowerClient.GetTowerInfo

Used as field type in: ListTowersResponse

• 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 TowerSession 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 TowerSessionInfo session_info = 6

  A list sessions held with the tower.

Used in: Tower, TowerSessionInfo

• 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.

• bytes id = 6

  The ID of the session.

Used in: Tower

• 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 TowerSession sessions = 3

  The list of sessions that have been negotiated with the watchtower.

• PolicyType policy_type = 4

  The session's policy type.