wtclientrpc
package wtclientrpc
- Alphabetic
- Public
- Protected
Type Members
- final case class AddTowerRequest(pubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, address: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddTowerRequest] with Product with Serializable
- pubkey
The identifying public key of the watchtower to add.
- address
A network address the watchtower is reachable over.
- Annotations
- @SerialVersionUID()
- final case class AddTowerResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddTowerResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetTowerInfoRequest(pubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, includeSessions: Boolean = false, excludeExhaustedSessions: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetTowerInfoRequest] with Product with Serializable
- pubkey
The identifying public key of the watchtower to retrieve information for.
- includeSessions
Whether we should include sessions with the watchtower in the response.
- excludeExhaustedSessions
Whether to exclude exhausted sessions in the response info. This option is only meaningful if include_sessions is true.
- Annotations
- @SerialVersionUID()
- final case class ListTowersRequest(includeSessions: Boolean = false, excludeExhaustedSessions: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListTowersRequest] with Product with Serializable
- includeSessions
Whether we should include sessions with the watchtower in the response.
- excludeExhaustedSessions
Whether to exclude exhausted sessions in the response info. This option is only meaningful if include_sessions is true.
- Annotations
- @SerialVersionUID()
- final case class ListTowersResponse(towers: Seq[Tower] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListTowersResponse] with Product with Serializable
- towers
The list of watchtowers available for new backups.
- Annotations
- @SerialVersionUID()
- final case class PolicyRequest(policyType: PolicyType = wtclientrpc.PolicyType.LEGACY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PolicyRequest] with Product with Serializable
- policyType
The client type from which to retrieve the active offering policy.
- Annotations
- @SerialVersionUID()
- final case class PolicyResponse(maxUpdates: Int = 0, sweepSatPerByte: Int = 0, sweepSatPerVbyte: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PolicyResponse] with Product with Serializable
- maxUpdates
The maximum number of updates each session we negotiate with watchtowers should allow.
- sweepSatPerByte
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.
- sweepSatPerVbyte
The fee rate, in satoshis per vbyte, that will be used by watchtowers for justice transactions in response to channel breaches.
- Annotations
- @SerialVersionUID()
- sealed abstract class PolicyType extends GeneratedEnum
- final case class RemoveTowerRequest(pubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, address: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RemoveTowerRequest] with Product with Serializable
- pubkey
The identifying public key of the watchtower to remove.
- address
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.
- Annotations
- @SerialVersionUID()
- final case class RemoveTowerResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RemoveTowerResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class StatsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StatsRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class StatsResponse(numBackups: Int = 0, numPendingBackups: Int = 0, numFailedBackups: Int = 0, numSessionsAcquired: Int = 0, numSessionsExhausted: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StatsResponse] with Product with Serializable
- numBackups
The total number of backups made to all active and exhausted watchtower sessions.
- numPendingBackups
The total number of backups that are pending to be acknowledged by all active and exhausted watchtower sessions.
- numFailedBackups
The total number of backups that all active and exhausted watchtower sessions have failed to acknowledge.
- numSessionsAcquired
The total number of new sessions made to watchtowers.
- numSessionsExhausted
The total number of watchtower sessions that have been exhausted.
- Annotations
- @SerialVersionUID()
- final case class Tower(pubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, addresses: Seq[String] = _root_.scala.Seq.empty, activeSessionCandidate: Boolean = false, numSessions: Int = 0, sessions: Seq[TowerSession] = _root_.scala.Seq.empty, sessionInfo: Seq[TowerSessionInfo] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Tower] with Product with Serializable
- pubkey
The identifying public key of the watchtower.
- addresses
The list of addresses the watchtower is reachable over.
- activeSessionCandidate
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.
- numSessions
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.
- sessions
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.
- sessionInfo
A list sessions held with the tower.
- Annotations
- @SerialVersionUID()
- final case class TowerSession(numBackups: Int = 0, numPendingBackups: Int = 0, maxBackups: Int = 0, sweepSatPerByte: Int = 0, sweepSatPerVbyte: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TowerSession] with Product with Serializable
- numBackups
The total number of successful backups that have been made to the watchtower session.
- numPendingBackups
The total number of backups in the session that are currently pending to be acknowledged by the watchtower.
- maxBackups
The maximum number of backups allowed by the watchtower session.
- sweepSatPerByte
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.
- sweepSatPerVbyte
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.
- Annotations
- @SerialVersionUID()
- final case class TowerSessionInfo(activeSessionCandidate: Boolean = false, numSessions: Int = 0, sessions: Seq[TowerSession] = _root_.scala.Seq.empty, policyType: PolicyType = wtclientrpc.PolicyType.LEGACY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TowerSessionInfo] with Product with Serializable
- activeSessionCandidate
Whether the watchtower is currently a candidate for new sessions.
- numSessions
The number of sessions that have been negotiated with the watchtower.
- sessions
The list of sessions that have been negotiated with the watchtower.
- policyType
The session's policy type.
- Annotations
- @SerialVersionUID()
- trait WatchtowerClient extends AnyRef
WatchtowerClient is a service that grants access to the watchtower client functionality of the daemon.
WatchtowerClient is a service that grants access to the watchtower client functionality of the daemon.
- Annotations
- @PekkoGrpcGenerated()
- trait WatchtowerClientClient extends WatchtowerClient with WatchtowerClientClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- trait WatchtowerClientClientPowerApi extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
Value Members
- object AddTowerRequest extends GeneratedMessageCompanion[AddTowerRequest]
- object AddTowerResponse extends GeneratedMessageCompanion[AddTowerResponse]
- object GetTowerInfoRequest extends GeneratedMessageCompanion[GetTowerInfoRequest]
- object ListTowersRequest extends GeneratedMessageCompanion[ListTowersRequest]
- object ListTowersResponse extends GeneratedMessageCompanion[ListTowersResponse]
- object PolicyRequest extends GeneratedMessageCompanion[PolicyRequest]
- object PolicyResponse extends GeneratedMessageCompanion[PolicyResponse]
- object PolicyType extends GeneratedEnumCompanion[PolicyType]
- object RemoveTowerRequest extends GeneratedMessageCompanion[RemoveTowerRequest]
- object RemoveTowerResponse extends GeneratedMessageCompanion[RemoveTowerResponse]
- object StatsRequest extends GeneratedMessageCompanion[StatsRequest]
- object StatsResponse extends GeneratedMessageCompanion[StatsResponse]
- object Tower extends GeneratedMessageCompanion[Tower]
- object TowerSession extends GeneratedMessageCompanion[TowerSession]
- object TowerSessionInfo extends GeneratedMessageCompanion[TowerSessionInfo]
- object WatchtowerClient extends ServiceDescription
- Annotations
- @PekkoGrpcGenerated()
- object WatchtowerClientClient
- Annotations
- @PekkoGrpcGenerated()
- object WatchtowerClientHandler
- Annotations
- @ApiMayChange() @PekkoGrpcGenerated()
- object WtclientProto extends GeneratedFileObject