lnrpc

package lnrpc

Ordering

Alphabetic

Visibility

Public
Protected

Type Members

final case class AMP(rootShare: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, setId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, childIndex: UInt32 = lnrpc.AMP._typemapper_childIndex.toCustom(0), hash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, preimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AMP] with Product with Serializable
Details specific to AMP HTLCs.
Details specific to AMP HTLCs.
rootShare
An n-of-n secret share of the root seed from which child payment hashes and preimages are derived.
setId
An identifier for the HTLC set that this HTLC belongs to.
childIndex
A nonce used to randomize the child preimage and child hash from a given root_share.
hash
The payment hash of the AMP HTLC.
preimage
The preimage used to settle this AMP htlc. This field will only be populated if the invoice is in InvoiceState_ACCEPTED or InvoiceState_SETTLED.
Annotations
@SerialVersionUID()
final case class AMPInvoiceState(state: InvoiceHTLCState = lnrpc.InvoiceHTLCState.ACCEPTED, settleIndex: UInt64 = lnrpc.AMPInvoiceState._typemapper_settleIndex.toCustom(0L), settleTime: Long = 0L, amtPaidMsat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AMPInvoiceState] with Product with Serializable
state
The state the HTLCs associated with this setID are in.
settleIndex
The settle index of this HTLC set, if the invoice state is settled.
settleTime
The time this HTLC set was settled expressed in unix epoch.
amtPaidMsat
The total amount paid for the sub-invoice expressed in milli satoshis.
Annotations
@SerialVersionUID()
final case class AMPRecord(rootShare: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, setId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, childIndex: UInt32 = lnrpc.AMPRecord._typemapper_childIndex.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AMPRecord] with Product with Serializable
Annotations
@SerialVersionUID()
final case class AbandonChannelRequest(channelPoint: Option[ChannelPoint] = _root_.scala.None, pendingFundingShimOnly: Boolean = false, iKnowWhatIAmDoing: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AbandonChannelRequest] with Product with Serializable
iKnowWhatIAmDoing
Override the requirement for being in dev mode by setting this to true and confirming the user knows what they are doing and this is a potential foot gun to lose funds if used on active channels.
Annotations
@SerialVersionUID()
final case class AbandonChannelResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AbandonChannelResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class AddInvoiceResponse(rHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, paymentRequest: String = "", addIndex: UInt64 = lnrpc.AddInvoiceResponse._typemapper_addIndex.toCustom(0L), paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddInvoiceResponse] with Product with Serializable
paymentRequest
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.
addIndex
The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one.
paymentAddr
The payment address of the generated invoice. This value should be used in all payments for this invoice as we require it for end to end security.
Annotations
@SerialVersionUID()
sealed abstract class AddressType extends GeneratedEnum
AddressType has to be one of:
AddressType has to be one of:
- p2wkh: Pay to witness key hash (WITNESS_PUBKEY_HASH = 0) - np2wkh: Pay to nested witness key hash (NESTED_PUBKEY_HASH = 1) - p2tr: Pay to taproot pubkey (TAPROOT_PUBKEY = 4)
final case class AliasMap(baseScid: UInt64 = lnrpc.AliasMap._typemapper_baseScid.toCustom(0L), aliases: Seq[UInt64] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AliasMap] with Product with Serializable
baseScid
For non-zero-conf channels, this is the confirmed SCID. Otherwise, this is the first assigned "base" alias.
aliases
The set of all aliases stored for the base SCID.
Annotations
@SerialVersionUID()
final case class Amount(sat: UInt64 = lnrpc.Amount._typemapper_sat.toCustom(0L), msat: UInt64 = lnrpc.Amount._typemapper_msat.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Amount] with Product with Serializable
sat
Value denominated in satoshis.
msat
Value denominated in milli-satoshis.
Annotations
@SerialVersionUID()
final case class BakeMacaroonRequest(permissions: Seq[MacaroonPermission] = _root_.scala.Seq.empty, rootKeyId: UInt64 = lnrpc.BakeMacaroonRequest._typemapper_rootKeyId.toCustom(0L), allowExternalPermissions: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BakeMacaroonRequest] with Product with Serializable
permissions
The list of permissions the new macaroon should grant.
rootKeyId
The root key ID used to create the macaroon, must be a positive integer.
allowExternalPermissions
Informs the RPC on whether to allow external permissions that LND is not aware of.
Annotations
@SerialVersionUID()
final case class BakeMacaroonResponse(macaroon: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BakeMacaroonResponse] with Product with Serializable
macaroon
The hex encoded macaroon, serialized in binary format.
Annotations
@SerialVersionUID()
final case class BatchOpenChannel(nodePubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, localFundingAmount: Long = 0L, pushSat: Long = 0L, private: Boolean = false, minHtlcMsat: Long = 0L, remoteCsvDelay: UInt32 = lnrpc.BatchOpenChannel._typemapper_remoteCsvDelay.toCustom(0), closeAddress: String = "", pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, remoteMaxValueInFlightMsat: UInt64 = lnrpc.BatchOpenChannel._typemapper_remoteMaxValueInFlightMsat.toCustom(0L), remoteMaxHtlcs: UInt32 = lnrpc.BatchOpenChannel._typemapper_remoteMaxHtlcs.toCustom(0), maxLocalCsv: UInt32 = lnrpc.BatchOpenChannel._typemapper_maxLocalCsv.toCustom(0), zeroConf: Boolean = false, scidAlias: Boolean = false, baseFee: UInt64 = lnrpc.BatchOpenChannel._typemapper_baseFee.toCustom(0L), feeRate: UInt64 = lnrpc.BatchOpenChannel._typemapper_feeRate.toCustom(0L), useBaseFee: Boolean = false, useFeeRate: Boolean = false, remoteChanReserveSat: UInt64 = lnrpc.BatchOpenChannel._typemapper_remoteChanReserveSat.toCustom(0L), memo: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BatchOpenChannel] with Product with Serializable
nodePubkey
The pubkey of the node to open a channel with. When using REST, this field must be encoded as base64.
localFundingAmount
The number of satoshis the wallet should commit to the channel.
pushSat
The number of satoshis to push to the remote side as part of the initial commitment state.
private
Whether this channel should be private, not announced to the greater network.
minHtlcMsat
The minimum value in millisatoshi we will require for incoming HTLCs on the channel.
remoteCsvDelay
The delay we require on the remote's commitment transaction. If this is not set, it will be scaled automatically with the channel size.
closeAddress
Close address is an optional address which specifies the address to which funds should be paid out to upon cooperative close. This field may only be set if the peer supports the option upfront feature bit (call listpeers to check). The remote peer will only accept cooperative closes to this address if it is set. Note: If this value is set on channel creation, you will *not* be able to cooperatively close out to a different address.
pendingChanId
An optional, unique identifier of 32 random bytes that will be used as the pending channel ID to identify the channel while it is in the pre-pending state.
commitmentType
The explicit commitment type to use. Note this field will only be used if the remote peer supports explicit channel negotiation.
remoteMaxValueInFlightMsat
The maximum amount of coins in millisatoshi that can be pending within the channel. It only applies to the remote party.
remoteMaxHtlcs
The maximum number of concurrent HTLCs we will allow the remote party to add to the commitment transaction.
maxLocalCsv
Max local csv is the maximum csv delay we will allow for our own commitment transaction.
zeroConf
If this is true, then a zero-conf channel open will be attempted.
scidAlias
If this is true, then an option-scid-alias channel-type open will be attempted.
baseFee
The base fee charged regardless of the number of milli-satoshis sent.
feeRate
The fee rate in ppm (parts per million) that will be charged in proportion of the value of each forwarded HTLC.
useBaseFee
If use_base_fee is true the open channel announcement will update the channel base fee with the value specified in base_fee. In the case of a base_fee of 0 use_base_fee is needed downstream to distinguish whether to use the default base fee value specified in the config or 0.
useFeeRate
If use_fee_rate is true the open channel announcement will update the channel fee rate with the value specified in fee_rate. In the case of a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether to use the default fee rate value specified in the config or 0.
remoteChanReserveSat
The number of satoshis we require the remote peer to reserve. This value, if specified, must be above the dust limit and below 20% of the channel capacity.
memo
An optional note-to-self to go along with the channel containing some useful information. This is only ever stored locally and in no way impacts the channel's operation.
Annotations
@SerialVersionUID()
final case class BatchOpenChannelRequest(channels: Seq[BatchOpenChannel] = _root_.scala.Seq.empty, targetConf: Int = 0, satPerVbyte: Long = 0L, minConfs: Int = 0, spendUnconfirmed: Boolean = false, label: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BatchOpenChannelRequest] with Product with Serializable
channels
The list of channels to open.
targetConf
The target number of blocks that the funding transaction should be confirmed by.
satPerVbyte
A manual fee rate set in sat/vByte that should be used when crafting the funding transaction.
minConfs
The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.
spendUnconfirmed
Whether unconfirmed outputs should be used as inputs for the funding transaction.
label
An optional label for the batch transaction, limited to 500 characters.
Annotations
@SerialVersionUID()
final case class BatchOpenChannelResponse(pendingChannels: Seq[PendingUpdate] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BatchOpenChannelResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class Chain(chain: String = "", network: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Chain] with Product with Serializable
chain
The blockchain the node is on (eg bitcoin, litecoin)
network
The network the node is on (eg regtest, testnet, mainnet)
Annotations
@SerialVersionUID()
final case class ChanBackupExportRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChanBackupExportRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ChanBackupSnapshot(singleChanBackups: Option[ChannelBackups] = _root_.scala.None, multiChanBackup: Option[MultiChanBackup] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChanBackupSnapshot] with Product with Serializable
singleChanBackups
The set of new channels that have been added since the last channel backup snapshot was requested.
multiChanBackup
A multi-channel backup that covers all open channels currently known to lnd.
Annotations
@SerialVersionUID()
final case class ChanInfoRequest(chanId: UInt64 = lnrpc.ChanInfoRequest._typemapper_chanId.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChanInfoRequest] with Product with Serializable
chanId
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
Annotations
@SerialVersionUID()
final case class ChanPointShim(amt: Long = 0L, chanPoint: Option[ChannelPoint] = _root_.scala.None, localKey: Option[KeyDescriptor] = _root_.scala.None, remoteKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, thawHeight: UInt32 = lnrpc.ChanPointShim._typemapper_thawHeight.toCustom(0), musig2: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChanPointShim] with Product with Serializable
amt
The size of the pre-crafted output to be used as the channel point for this channel funding.
chanPoint
The target channel point to refrence in created commitment transactions.
localKey
Our local key to use when creating the multi-sig output.
remoteKey
The key of the remote party to use when creating the multi-sig output.
pendingChanId
If non-zero, then this will be used as the pending channel ID on the wire protocol to initate the funding request. This is an optional field, and should only be set if the responder is already expecting a specific pending channel ID.
thawHeight
This uint32 indicates if this channel is to be considered 'frozen'. A frozen channel does not allow a cooperative channel close by the initiator. The thaw_height is the height that this restriction stops applying to the channel. The height can be interpreted in two ways: as a relative height if the value is less than 500,000, or as an absolute height otherwise.
musig2
Indicates that the funding output is using a MuSig2 multi-sig output.
Annotations
@SerialVersionUID()
final case class ChangePasswordRequest(currentPassword: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, newPassword: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, statelessInit: Boolean = false, newMacaroonRootKey: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChangePasswordRequest] with Product with Serializable
currentPassword
current_password should be the current valid passphrase used to unlock the daemon. When using REST, this field must be encoded as base64.
newPassword
new_password should be the new passphrase that will be needed to unlock the daemon. When using REST, this field must be encoded as base64.
statelessInit
stateless_init is an optional argument instructing the daemon NOT to create any *.macaroon files in its filesystem. If this parameter is set, then the admin macaroon returned in the response MUST be stored by the caller of the RPC as otherwise all access to the daemon will be lost!
newMacaroonRootKey
new_macaroon_root_key is an optional argument instructing the daemon to rotate the macaroon root key when set to true. This will invalidate all previously generated macaroons.
Annotations
@SerialVersionUID()
final case class ChangePasswordResponse(adminMacaroon: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChangePasswordResponse] with Product with Serializable
adminMacaroon
The binary serialized admin macaroon that can be used to access the daemon after rotating the macaroon root key. If both the stateless_init and new_macaroon_root_key parameter were set to true, this is the ONLY copy of the macaroon that was created from the new root key and MUST be stored safely by the caller. Otherwise a copy of this macaroon is also persisted on disk by the daemon, together with other macaroon files.
Annotations
@SerialVersionUID()
final case class Channel(active: Boolean = false, remotePubkey: String = "", channelPoint: String = "", chanId: UInt64 = lnrpc.Channel._typemapper_chanId.toCustom(0L), capacity: Long = 0L, localBalance: Long = 0L, remoteBalance: Long = 0L, commitFee: Long = 0L, commitWeight: Long = 0L, feePerKw: Long = 0L, unsettledBalance: Long = 0L, totalSatoshisSent: Long = 0L, totalSatoshisReceived: Long = 0L, numUpdates: UInt64 = lnrpc.Channel._typemapper_numUpdates.toCustom(0L), pendingHtlcs: Seq[HTLC] = _root_.scala.Seq.empty, csvDelay: UInt32 = lnrpc.Channel._typemapper_csvDelay.toCustom(0), private: Boolean = false, initiator: Boolean = false, chanStatusFlags: String = "", localChanReserveSat: Long = 0L, remoteChanReserveSat: Long = 0L, staticRemoteKey: Boolean = false, commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, lifetime: Long = 0L, uptime: Long = 0L, closeAddress: String = "", pushAmountSat: UInt64 = lnrpc.Channel._typemapper_pushAmountSat.toCustom(0L), thawHeight: UInt32 = lnrpc.Channel._typemapper_thawHeight.toCustom(0), localConstraints: Option[ChannelConstraints] = _root_.scala.None, remoteConstraints: Option[ChannelConstraints] = _root_.scala.None, aliasScids: Seq[UInt64] = _root_.scala.Seq.empty, zeroConf: Boolean = false, zeroConfConfirmedScid: UInt64 = lnrpc.Channel._typemapper_zeroConfConfirmedScid.toCustom(0L), peerAlias: String = "", peerScidAlias: UInt64 = lnrpc.Channel._typemapper_peerScidAlias.toCustom(0L), memo: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Channel] with Product with Serializable
active
Whether this channel is active or not
remotePubkey
The identity pubkey of the remote node
channelPoint
The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice's version of the commitment transaction.
chanId
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
capacity
The total amount of funds held in this channel
localBalance
This node's current balance in this channel
remoteBalance
The counterparty's current balance in this channel
commitFee
The amount calculated to be paid in fees for the current set of commitment transactions. The fee amount is persisted with the channel in order to allow the fee amount to be removed and recalculated with each channel state update, including updates that happen after a system restart.
commitWeight
The weight of the commitment transaction
feePerKw
The required number of satoshis per kilo-weight that the requester will pay at all times, for both the funding transaction and commitment transaction. This value can later be updated once the channel is open.
unsettledBalance
The unsettled balance in this channel
totalSatoshisSent
The total number of satoshis we've sent within this channel.
totalSatoshisReceived
The total number of satoshis we've received within this channel.
numUpdates
The total number of updates conducted within this channel.
pendingHtlcs
The list of active, uncleared HTLCs currently pending within the channel.
csvDelay
Deprecated. The CSV delay expressed in relative blocks. If the channel is force closed, we will need to wait for this many blocks before we can regain our funds.
private
Whether this channel is advertised to the network or not.
initiator
True if we were the ones that created the channel.
chanStatusFlags
A set of flags showing the current state of the channel.
localChanReserveSat
Deprecated. The minimum satoshis this node is required to reserve in its balance.
remoteChanReserveSat
Deprecated. The minimum satoshis the other node is required to reserve in its balance.
staticRemoteKey
Deprecated. Use commitment_type.
commitmentType
The commitment type used by this channel.
lifetime
The number of seconds that the channel has been monitored by the channel scoring system. Scores are currently not persisted, so this value may be less than the lifetime of the channel [EXPERIMENTAL].
uptime
The number of seconds that the remote peer has been observed as being online by the channel scoring system over the lifetime of the channel [EXPERIMENTAL].
closeAddress
Close address is the address that we will enforce payout to on cooperative close if the channel was opened utilizing option upfront shutdown. This value can be set on channel open by setting close_address in an open channel request. If this value is not set, you can still choose a payout address by cooperatively closing with the delivery_address field set.
pushAmountSat
The amount that the initiator of the channel optionally pushed to the remote party on channel open. This amount will be zero if the channel initiator did not push any funds to the remote peer. If the initiator field is true, we pushed this amount to our peer, if it is false, the remote peer pushed this amount to us.
thawHeight
This uint32 indicates if this channel is to be considered 'frozen'. A frozen channel doest not allow a cooperative channel close by the initiator. The thaw_height is the height that this restriction stops applying to the channel. This field is optional, not setting it or using a value of zero will mean the channel has no additional restrictions. The height can be interpreted in two ways: as a relative height if the value is less than 500,000, or as an absolute height otherwise.
localConstraints
List constraints for the local node.
remoteConstraints
List constraints for the remote node.
aliasScids
This lists out the set of alias short channel ids that exist for a channel. This may be empty.
zeroConf
Whether or not this is a zero-conf channel.
zeroConfConfirmedScid
This is the confirmed / on-chain zero-conf SCID.
peerAlias
The configured alias name of our peer.
peerScidAlias
This is the peer SCID alias.
memo
An optional note-to-self to go along with the channel containing some useful information. This is only ever stored locally and in no way impacts the channel's operation.
Annotations
@SerialVersionUID()
final case class ChannelAcceptRequest(nodePubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, chainHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, fundingAmt: UInt64 = lnrpc.ChannelAcceptRequest._typemapper_fundingAmt.toCustom(0L), pushAmt: UInt64 = lnrpc.ChannelAcceptRequest._typemapper_pushAmt.toCustom(0L), dustLimit: UInt64 = lnrpc.ChannelAcceptRequest._typemapper_dustLimit.toCustom(0L), maxValueInFlight: UInt64 = lnrpc.ChannelAcceptRequest._typemapper_maxValueInFlight.toCustom(0L), channelReserve: UInt64 = lnrpc.ChannelAcceptRequest._typemapper_channelReserve.toCustom(0L), minHtlc: UInt64 = lnrpc.ChannelAcceptRequest._typemapper_minHtlc.toCustom(0L), feePerKw: UInt64 = lnrpc.ChannelAcceptRequest._typemapper_feePerKw.toCustom(0L), csvDelay: UInt32 = lnrpc.ChannelAcceptRequest._typemapper_csvDelay.toCustom(0), maxAcceptedHtlcs: UInt32 = lnrpc.ChannelAcceptRequest._typemapper_maxAcceptedHtlcs.toCustom(0), channelFlags: UInt32 = lnrpc.ChannelAcceptRequest._typemapper_channelFlags.toCustom(0), commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, wantsZeroConf: Boolean = false, wantsScidAlias: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelAcceptRequest] with Product with Serializable
nodePubkey
The pubkey of the node that wishes to open an inbound channel.
chainHash
The hash of the genesis block that the proposed channel resides in.
pendingChanId
The pending channel id.
fundingAmt
The funding amount in satoshis that initiator wishes to use in the channel.
pushAmt
The push amount of the proposed channel in millisatoshis.
dustLimit
The dust limit of the initiator's commitment tx.
maxValueInFlight
The maximum amount of coins in millisatoshis that can be pending in this channel.
channelReserve
The minimum amount of satoshis the initiator requires us to have at all times.
minHtlc
The smallest HTLC in millisatoshis that the initiator will accept.
feePerKw
The initial fee rate that the initiator suggests for both commitment transactions.
csvDelay
The number of blocks to use for the relative time lock in the pay-to-self output of both commitment transactions.
maxAcceptedHtlcs
The total number of incoming HTLC's that the initiator will accept.
channelFlags
A bit-field which the initiator uses to specify proposed channel behavior.
commitmentType
The commitment type the initiator wishes to use for the proposed channel.
wantsZeroConf
Whether the initiator wants to open a zero-conf channel via the channel type.
wantsScidAlias
Whether the initiator wants to use the scid-alias channel type. This is separate from the feature bit.
Annotations
@SerialVersionUID()
final case class ChannelAcceptResponse(accept: Boolean = false, pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, error: String = "", upfrontShutdown: String = "", csvDelay: UInt32 = lnrpc.ChannelAcceptResponse._typemapper_csvDelay.toCustom(0), reserveSat: UInt64 = lnrpc.ChannelAcceptResponse._typemapper_reserveSat.toCustom(0L), inFlightMaxMsat: UInt64 = lnrpc.ChannelAcceptResponse._typemapper_inFlightMaxMsat.toCustom(0L), maxHtlcCount: UInt32 = lnrpc.ChannelAcceptResponse._typemapper_maxHtlcCount.toCustom(0), minHtlcIn: UInt64 = lnrpc.ChannelAcceptResponse._typemapper_minHtlcIn.toCustom(0L), minAcceptDepth: UInt32 = lnrpc.ChannelAcceptResponse._typemapper_minAcceptDepth.toCustom(0), zeroConf: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelAcceptResponse] with Product with Serializable
accept
Whether or not the client accepts the channel.
pendingChanId
The pending channel id to which this response applies.
error
An optional error to send the initiating party to indicate why the channel was rejected. This field *should not* contain sensitive information, it will be sent to the initiating party. This field should only be set if accept is false, the channel will be rejected if an error is set with accept=true because the meaning of this response is ambiguous. Limited to 500 characters.
upfrontShutdown
The upfront shutdown address to use if the initiating peer supports option upfront shutdown script (see ListPeers for the features supported). Note that the channel open will fail if this value is set for a peer that does not support this feature bit.
csvDelay
The csv delay (in blocks) that we require for the remote party.
reserveSat
The reserve amount in satoshis that we require the remote peer to adhere to. We require that the remote peer always have some reserve amount allocated to them so that there is always a disincentive to broadcast old state (if they hold 0 sats on their side of the channel, there is nothing to lose).
inFlightMaxMsat
The maximum amount of funds in millisatoshis that we allow the remote peer to have in outstanding htlcs.
maxHtlcCount
The maximum number of htlcs that the remote peer can offer us.
minHtlcIn
The minimum value in millisatoshis for incoming htlcs on the channel.
minAcceptDepth
The number of confirmations we require before we consider the channel open.
zeroConf
Whether the responder wants this to be a zero-conf channel. This will fail if either side does not have the scid-alias feature bit set. The minimum depth field must be zero if this is true.
Annotations
@SerialVersionUID()
final case class ChannelBackup(chanPoint: Option[ChannelPoint] = _root_.scala.None, chanBackup: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelBackup] with Product with Serializable
chanPoint
Identifies the channel that this backup belongs to.
chanBackup
Is an encrypted single-chan backup. this can be passed to RestoreChannelBackups, or the WalletUnlocker Init and Unlock methods in order to trigger the recovery protocol. When using REST, this field must be encoded as base64.
Annotations
@SerialVersionUID()
final case class ChannelBackupSubscription(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelBackupSubscription] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ChannelBackups(chanBackups: Seq[ChannelBackup] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelBackups] with Product with Serializable
chanBackups
A set of single-chan static channel backups.
Annotations
@SerialVersionUID()
final case class ChannelBalanceRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelBalanceRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ChannelBalanceResponse(balance: Long = 0L, pendingOpenBalance: Long = 0L, localBalance: Option[Amount] = _root_.scala.None, remoteBalance: Option[Amount] = _root_.scala.None, unsettledLocalBalance: Option[Amount] = _root_.scala.None, unsettledRemoteBalance: Option[Amount] = _root_.scala.None, pendingOpenLocalBalance: Option[Amount] = _root_.scala.None, pendingOpenRemoteBalance: Option[Amount] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelBalanceResponse] with Product with Serializable
balance
Deprecated. Sum of channels balances denominated in satoshis
pendingOpenBalance
Deprecated. Sum of channels pending balances denominated in satoshis
localBalance
Sum of channels local balances.
remoteBalance
Sum of channels remote balances.
unsettledLocalBalance
Sum of channels local unsettled balances.
unsettledRemoteBalance
Sum of channels remote unsettled balances.
pendingOpenLocalBalance
Sum of channels pending local balances.
pendingOpenRemoteBalance
Sum of channels pending remote balances.
Annotations
@SerialVersionUID()
final case class ChannelCloseSummary(channelPoint: String = "", chanId: UInt64 = lnrpc.ChannelCloseSummary._typemapper_chanId.toCustom(0L), chainHash: String = "", closingTxHash: String = "", remotePubkey: String = "", capacity: Long = 0L, closeHeight: UInt32 = lnrpc.ChannelCloseSummary._typemapper_closeHeight.toCustom(0), settledBalance: Long = 0L, timeLockedBalance: Long = 0L, closeType: ClosureType = lnrpc.ChannelCloseSummary.ClosureType.COOPERATIVE_CLOSE, openInitiator: Initiator = lnrpc.Initiator.INITIATOR_UNKNOWN, closeInitiator: Initiator = lnrpc.Initiator.INITIATOR_UNKNOWN, resolutions: Seq[Resolution] = _root_.scala.Seq.empty, aliasScids: Seq[UInt64] = _root_.scala.Seq.empty, zeroConfConfirmedScid: UInt64 = lnrpc.ChannelCloseSummary._typemapper_zeroConfConfirmedScid.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelCloseSummary] with Product with Serializable
channelPoint
The outpoint (txid:index) of the funding transaction.
chanId
The unique channel ID for the channel.
chainHash
The hash of the genesis block that this channel resides within.
closingTxHash
The txid of the transaction which ultimately closed this channel.
remotePubkey
Public key of the remote peer that we formerly had a channel with.
capacity
Total capacity of the channel.
closeHeight
Height at which the funding transaction was spent.
settledBalance
Settled balance at the time of channel closure
timeLockedBalance
The sum of all the time-locked outputs at the time of channel closure
closeType
Details on how the channel was closed.
openInitiator
Open initiator is the party that initiated opening the channel. Note that this value may be unknown if the channel was closed before we migrated to store open channel information after close.
closeInitiator
Close initiator indicates which party initiated the close. This value will be unknown for channels that were cooperatively closed before we started tracking cooperative close initiators. Note that this indicates which party initiated a close, and it is possible for both to initiate cooperative or force closes, although only one party's close will be confirmed on chain.
aliasScids
This lists out the set of alias short channel ids that existed for the closed channel. This may be empty.
zeroConfConfirmedScid
The confirmed SCID for a zero-conf channel.
Annotations
@SerialVersionUID()
final case class ChannelCloseUpdate(closingTxid: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, success: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelCloseUpdate] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ChannelConstraints(csvDelay: UInt32 = lnrpc.ChannelConstraints._typemapper_csvDelay.toCustom(0), chanReserveSat: UInt64 = lnrpc.ChannelConstraints._typemapper_chanReserveSat.toCustom(0L), dustLimitSat: UInt64 = lnrpc.ChannelConstraints._typemapper_dustLimitSat.toCustom(0L), maxPendingAmtMsat: UInt64 = lnrpc.ChannelConstraints._typemapper_maxPendingAmtMsat.toCustom(0L), minHtlcMsat: UInt64 = lnrpc.ChannelConstraints._typemapper_minHtlcMsat.toCustom(0L), maxAcceptedHtlcs: UInt32 = lnrpc.ChannelConstraints._typemapper_maxAcceptedHtlcs.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelConstraints] with Product with Serializable
csvDelay
The CSV delay expressed in relative blocks. If the channel is force closed, we will need to wait for this many blocks before we can regain our funds.
chanReserveSat
The minimum satoshis this node is required to reserve in its balance.
dustLimitSat
The dust limit (in satoshis) of the initiator's commitment tx.
maxPendingAmtMsat
The maximum amount of coins in millisatoshis that can be pending in this channel.
minHtlcMsat
The smallest HTLC in millisatoshis that the initiator will accept.
maxAcceptedHtlcs
The total number of incoming HTLC's that the initiator will accept.
Annotations
@SerialVersionUID()
final case class ChannelEdge(channelId: UInt64 = lnrpc.ChannelEdge._typemapper_channelId.toCustom(0L), chanPoint: String = "", lastUpdate: UInt32 = lnrpc.ChannelEdge._typemapper_lastUpdate.toCustom(0), node1Pub: String = "", node2Pub: String = "", capacity: Long = 0L, node1Policy: Option[RoutingPolicy] = _root_.scala.None, node2Policy: Option[RoutingPolicy] = _root_.scala.None, customRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelEdge] with Product with Serializable
A fully authenticated channel along with all its unique attributes.
A fully authenticated channel along with all its unique attributes. Once an authenticated channel announcement has been processed on the network, then an instance of ChannelEdgeInfo encapsulating the channels attributes is stored. The other portions relevant to routing policy of a channel are stored within a ChannelEdgePolicy for each direction of the channel.
channelId
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
customRecords
Custom channel announcement tlv records.
Annotations
@SerialVersionUID()
final case class ChannelEdgeUpdate(chanId: UInt64 = lnrpc.ChannelEdgeUpdate._typemapper_chanId.toCustom(0L), chanPoint: Option[ChannelPoint] = _root_.scala.None, capacity: Long = 0L, routingPolicy: Option[RoutingPolicy] = _root_.scala.None, advertisingNode: String = "", connectingNode: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelEdgeUpdate] with Product with Serializable
chanId
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
Annotations
@SerialVersionUID()
final case class ChannelEventSubscription(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelEventSubscription] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ChannelEventUpdate(channel: ChannelEventUpdate.Channel = lnrpc.ChannelEventUpdate.Channel.Empty, type: UpdateType = lnrpc.ChannelEventUpdate.UpdateType.OPEN_CHANNEL, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelEventUpdate] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ChannelFeeReport(chanId: UInt64 = lnrpc.ChannelFeeReport._typemapper_chanId.toCustom(0L), channelPoint: String = "", baseFeeMsat: Long = 0L, feePerMil: Long = 0L, feeRate: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelFeeReport] with Product with Serializable
chanId
The short channel id that this fee report belongs to.
channelPoint
The channel that this fee report belongs to.
baseFeeMsat
The base fee charged regardless of the number of milli-satoshis sent.
feePerMil
The amount charged per milli-satoshis transferred expressed in millionths of a satoshi.
feeRate
The effective fee rate in milli-satoshis. Computed by dividing the fee_per_mil value by 1 million.
Annotations
@SerialVersionUID()
final case class ChannelGraph(nodes: Seq[LightningNode] = _root_.scala.Seq.empty, edges: Seq[ChannelEdge] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelGraph] with Product with Serializable
Returns a new instance of the directed channel graph.
Returns a new instance of the directed channel graph.
nodes
The list of LightningNodes in this channel graph
edges
The list of ChannelEdges in this channel graph
Annotations
@SerialVersionUID()
final case class ChannelGraphRequest(includeUnannounced: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelGraphRequest] with Product with Serializable
includeUnannounced
Whether unannounced channels are included in the response or not. If set, unannounced channels are included. Unannounced channels are both private channels, and public channels that are not yet announced to the network.
Annotations
@SerialVersionUID()
final case class ChannelOpenUpdate(channelPoint: Option[ChannelPoint] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelOpenUpdate] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ChannelPoint(fundingTxid: FundingTxid = lnrpc.ChannelPoint.FundingTxid.Empty, outputIndex: UInt32 = lnrpc.ChannelPoint._typemapper_outputIndex.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelPoint] with Product with Serializable
outputIndex
The index of the output of the funding transaction
Annotations
@SerialVersionUID()
final case class ChannelUpdate(signature: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, chainHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, chanId: UInt64 = lnrpc.ChannelUpdate._typemapper_chanId.toCustom(0L), timestamp: UInt32 = lnrpc.ChannelUpdate._typemapper_timestamp.toCustom(0), messageFlags: UInt32 = lnrpc.ChannelUpdate._typemapper_messageFlags.toCustom(0), channelFlags: UInt32 = lnrpc.ChannelUpdate._typemapper_channelFlags.toCustom(0), timeLockDelta: UInt32 = lnrpc.ChannelUpdate._typemapper_timeLockDelta.toCustom(0), htlcMinimumMsat: UInt64 = lnrpc.ChannelUpdate._typemapper_htlcMinimumMsat.toCustom(0L), baseFee: UInt32 = lnrpc.ChannelUpdate._typemapper_baseFee.toCustom(0), feeRate: UInt32 = lnrpc.ChannelUpdate._typemapper_feeRate.toCustom(0), htlcMaximumMsat: UInt64 = lnrpc.ChannelUpdate._typemapper_htlcMaximumMsat.toCustom(0L), extraOpaqueData: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ChannelUpdate] with Product with Serializable
signature
The signature that validates the announced data and proves the ownership of node id.
chainHash
The target chain that this channel was opened within. This value should be the genesis hash of the target chain. Along with the short channel ID, this uniquely identifies the channel globally in a blockchain.
chanId
The unique description of the funding transaction.
timestamp
A timestamp that allows ordering in the case of multiple announcements. We should ignore the message if timestamp is not greater than the last-received.
messageFlags
The bitfield that describes whether optional fields are present in this update. Currently, the least-significant bit must be set to 1 if the optional field MaxHtlc is present.
channelFlags
The bitfield that describes additional meta-data concerning how the update is to be interpreted. Currently, the least-significant bit must be set to 0 if the creating node corresponds to the first node in the previously sent channel announcement and 1 otherwise. If the second bit is set, then the channel is set to be disabled.
timeLockDelta
The minimum number of blocks this node requires to be added to the expiry of HTLCs. This is a security parameter determined by the node operator. This value represents the required gap between the time locks of the incoming and outgoing HTLC's set to this node.
htlcMinimumMsat
The minimum HTLC value which will be accepted.
baseFee
The base fee that must be used for incoming HTLC's to this particular channel. This value will be tacked onto the required for a payment independent of the size of the payment.
feeRate
The fee rate that will be charged per millionth of a satoshi.
htlcMaximumMsat
The maximum HTLC value which will be accepted.
extraOpaqueData
The set of data that was appended to this message, some of which we may not actually know how to iterate or parse. By holding onto this data, we ensure that we're able to properly validate the set of signatures that cover these new fields, and ensure we're able to make upgrades to the network in a forwards compatible manner.
Annotations
@SerialVersionUID()
final case class CheckMacPermRequest(macaroon: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, permissions: Seq[MacaroonPermission] = _root_.scala.Seq.empty, fullMethod: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CheckMacPermRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class CheckMacPermResponse(valid: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CheckMacPermResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class CloseChannelRequest(channelPoint: Option[ChannelPoint] = _root_.scala.None, force: Boolean = false, targetConf: Int = 0, satPerByte: Long = 0L, deliveryAddress: String = "", satPerVbyte: UInt64 = lnrpc.CloseChannelRequest._typemapper_satPerVbyte.toCustom(0L), maxFeePerVbyte: UInt64 = lnrpc.CloseChannelRequest._typemapper_maxFeePerVbyte.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CloseChannelRequest] with Product with Serializable
channelPoint
The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice's version of the commitment transaction.
force
If true, then the channel will be closed forcibly. This means the current commitment transaction will be signed and broadcast.
targetConf
The target number of blocks that the closure transaction should be confirmed by.
satPerByte
Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte that should be used when crafting the closure transaction.
deliveryAddress
An optional address to send funds to in the case of a cooperative close. If the channel was opened with an upfront shutdown script and this field is set, the request to close will fail because the channel must pay out to the upfront shutdown addresss.
satPerVbyte
A manual fee rate set in sat/vbyte that should be used when crafting the closure transaction.
maxFeePerVbyte
The maximum fee rate the closer is willing to pay. NOTE: This field is only respected if we're the initiator of the channel.
Annotations
@SerialVersionUID()
final case class CloseStatusUpdate(update: Update = lnrpc.CloseStatusUpdate.Update.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CloseStatusUpdate] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ClosedChannelUpdate(chanId: UInt64 = lnrpc.ClosedChannelUpdate._typemapper_chanId.toCustom(0L), capacity: Long = 0L, closedHeight: UInt32 = lnrpc.ClosedChannelUpdate._typemapper_closedHeight.toCustom(0), chanPoint: Option[ChannelPoint] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ClosedChannelUpdate] with Product with Serializable
chanId
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
Annotations
@SerialVersionUID()
final case class ClosedChannelsRequest(cooperative: Boolean = false, localForce: Boolean = false, remoteForce: Boolean = false, breach: Boolean = false, fundingCanceled: Boolean = false, abandoned: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ClosedChannelsRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ClosedChannelsResponse(channels: Seq[ChannelCloseSummary] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ClosedChannelsResponse] with Product with Serializable
Annotations
@SerialVersionUID()
sealed abstract class CommitmentType extends GeneratedEnum
final case class ConfirmationUpdate(blockSha: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, blockHeight: Int = 0, numConfsLeft: UInt32 = lnrpc.ConfirmationUpdate._typemapper_numConfsLeft.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ConfirmationUpdate] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ConnectPeerRequest(addr: Option[LightningAddress] = _root_.scala.None, perm: Boolean = false, timeout: UInt64 = lnrpc.ConnectPeerRequest._typemapper_timeout.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ConnectPeerRequest] with Product with Serializable
addr
Lightning address of the peer to connect to.
perm
If set, the daemon will attempt to persistently connect to the target peer. Otherwise, the call will be synchronous.
timeout
The connection timeout value (in seconds) for this request. It won't affect other requests.
Annotations
@SerialVersionUID()
final case class ConnectPeerResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ConnectPeerResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class CustomMessage(peer: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, type: UInt32 = lnrpc.CustomMessage._typemapper_type.toCustom(0), data: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CustomMessage] with Product with Serializable
peer
Peer from which the message originates
type
Message type. This value will be in the custom range (>= 32768).
data
Raw message data
Annotations
@SerialVersionUID()
final case class DebugLevelRequest(show: Boolean = false, levelSpec: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DebugLevelRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class DebugLevelResponse(subSystems: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DebugLevelResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class DeleteAllPaymentsRequest(failedPaymentsOnly: Boolean = false, failedHtlcsOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteAllPaymentsRequest] with Product with Serializable
failedPaymentsOnly
Only delete failed payments.
failedHtlcsOnly
Only delete failed HTLCs from payments, not the payment itself.
Annotations
@SerialVersionUID()
final case class DeleteAllPaymentsResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteAllPaymentsResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class DeleteMacaroonIDRequest(rootKeyId: UInt64 = lnrpc.DeleteMacaroonIDRequest._typemapper_rootKeyId.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteMacaroonIDRequest] with Product with Serializable
rootKeyId
The root key ID to be removed.
Annotations
@SerialVersionUID()
final case class DeleteMacaroonIDResponse(deleted: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeleteMacaroonIDResponse] with Product with Serializable
deleted
A boolean indicates that the deletion is successful.
Annotations
@SerialVersionUID()
final case class DeletePaymentRequest(paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, failedHtlcsOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeletePaymentRequest] with Product with Serializable
paymentHash
Payment hash to delete.
failedHtlcsOnly
Only delete failed HTLCs from the payment, not the payment itself.
Annotations
@SerialVersionUID()
final case class DeletePaymentResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DeletePaymentResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class DisconnectPeerRequest(pubKey: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DisconnectPeerRequest] with Product with Serializable
pubKey
The pubkey of the node to disconnect from
Annotations
@SerialVersionUID()
final case class DisconnectPeerResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DisconnectPeerResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class EdgeLocator(channelId: UInt64 = lnrpc.EdgeLocator._typemapper_channelId.toCustom(0L), directionReverse: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EdgeLocator] with Product with Serializable
channelId
The short channel id of this edge.
directionReverse
The direction of this edge. If direction_reverse is false, the direction of this edge is from the channel endpoint with the lexicographically smaller pub key to the endpoint with the larger pub key. If direction_reverse is is true, the edge goes the other way.
Annotations
@SerialVersionUID()
final case class EstimateFeeRequest(addrToAmount: Map[String, Long] = _root_.scala.collection.immutable.Map.empty, targetConf: Int = 0, minConfs: Int = 0, spendUnconfirmed: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EstimateFeeRequest] with Product with Serializable
addrToAmount
The map from addresses to amounts for the transaction.
targetConf
The target number of blocks that this transaction should be confirmed by.
minConfs
The minimum number of confirmations each one of your outputs used for the transaction must satisfy.
spendUnconfirmed
Whether unconfirmed outputs should be used as inputs for the transaction.
Annotations
@SerialVersionUID()
final case class EstimateFeeResponse(feeSat: Long = 0L, feerateSatPerByte: Long = 0L, satPerVbyte: UInt64 = lnrpc.EstimateFeeResponse._typemapper_satPerVbyte.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EstimateFeeResponse] with Product with Serializable
feeSat
The total fee in satoshis.
feerateSatPerByte
Deprecated, use sat_per_vbyte. The fee rate in satoshi/vbyte.
satPerVbyte
The fee rate in satoshi/vbyte.
Annotations
@SerialVersionUID()
final case class ExportChannelBackupRequest(chanPoint: Option[ChannelPoint] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ExportChannelBackupRequest] with Product with Serializable
chanPoint
The target channel point to obtain a back up for.
Annotations
@SerialVersionUID()
final case class FailedUpdate(outpoint: Option[OutPoint] = _root_.scala.None, reason: UpdateFailure = lnrpc.UpdateFailure.UPDATE_FAILURE_UNKNOWN, updateError: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FailedUpdate] with Product with Serializable
outpoint
The outpoint in format txid:n
reason
Reason for the policy update failure.
updateError
A string representation of the policy update error.
Annotations
@SerialVersionUID()
final case class Failure(code: FailureCode = lnrpc.Failure.FailureCode.RESERVED, channelUpdate: Option[ChannelUpdate] = _root_.scala.None, htlcMsat: UInt64 = lnrpc.Failure._typemapper_htlcMsat.toCustom(0L), onionSha256: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cltvExpiry: UInt32 = lnrpc.Failure._typemapper_cltvExpiry.toCustom(0), flags: UInt32 = lnrpc.Failure._typemapper_flags.toCustom(0), failureSourceIndex: UInt32 = lnrpc.Failure._typemapper_failureSourceIndex.toCustom(0), height: UInt32 = lnrpc.Failure._typemapper_height.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Failure] with Product with Serializable
code
Failure code as defined in the Lightning spec
channelUpdate
An optional channel update message.
htlcMsat
A failure type-dependent htlc value.
onionSha256
The sha256 sum of the onion payload.
cltvExpiry
A failure type-dependent cltv expiry value.
flags
A failure type-dependent flags value.
failureSourceIndex
The position in the path of the intermediate or final node that generated the failure message. Position zero is the sender node.
height
A failure type-dependent block height.
Annotations
@SerialVersionUID()
final case class Feature(name: String = "", isRequired: Boolean = false, isKnown: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Feature] with Product with Serializable
Annotations
@SerialVersionUID()
sealed abstract class FeatureBit extends GeneratedEnum
final case class FeeLimit(limit: Limit = lnrpc.FeeLimit.Limit.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FeeLimit] with Product with Serializable
Annotations
@SerialVersionUID()
final case class FeeReportRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FeeReportRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class FeeReportResponse(channelFees: Seq[ChannelFeeReport] = _root_.scala.Seq.empty, dayFeeSum: UInt64 = lnrpc.FeeReportResponse._typemapper_dayFeeSum.toCustom(0L), weekFeeSum: UInt64 = lnrpc.FeeReportResponse._typemapper_weekFeeSum.toCustom(0L), monthFeeSum: UInt64 = lnrpc.FeeReportResponse._typemapper_monthFeeSum.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FeeReportResponse] with Product with Serializable
channelFees
An array of channel fee reports which describes the current fee schedule for each channel.
dayFeeSum
The total amount of fee revenue (in satoshis) the switch has collected over the past 24 hrs.
weekFeeSum
The total amount of fee revenue (in satoshis) the switch has collected over the past 1 week.
monthFeeSum
The total amount of fee revenue (in satoshis) the switch has collected over the past 1 month.
Annotations
@SerialVersionUID()
final case class FloatMetric(value: Double = 0.0, normalizedValue: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FloatMetric] with Product with Serializable
value
Arbitrary float value.
normalizedValue
The value normalized to [0,1] or [-1,1].
Annotations
@SerialVersionUID()
final case class ForwardingEvent(timestamp: UInt64 = lnrpc.ForwardingEvent._typemapper_timestamp.toCustom(0L), chanIdIn: UInt64 = lnrpc.ForwardingEvent._typemapper_chanIdIn.toCustom(0L), chanIdOut: UInt64 = lnrpc.ForwardingEvent._typemapper_chanIdOut.toCustom(0L), amtIn: UInt64 = lnrpc.ForwardingEvent._typemapper_amtIn.toCustom(0L), amtOut: UInt64 = lnrpc.ForwardingEvent._typemapper_amtOut.toCustom(0L), fee: UInt64 = lnrpc.ForwardingEvent._typemapper_fee.toCustom(0L), feeMsat: UInt64 = lnrpc.ForwardingEvent._typemapper_feeMsat.toCustom(0L), amtInMsat: UInt64 = lnrpc.ForwardingEvent._typemapper_amtInMsat.toCustom(0L), amtOutMsat: UInt64 = lnrpc.ForwardingEvent._typemapper_amtOutMsat.toCustom(0L), timestampNs: UInt64 = lnrpc.ForwardingEvent._typemapper_timestampNs.toCustom(0L), peerAliasIn: String = "", peerAliasOut: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ForwardingEvent] with Product with Serializable
timestamp
Timestamp is the time (unix epoch offset) that this circuit was completed. Deprecated by timestamp_ns.
chanIdIn
The incoming channel ID that carried the HTLC that created the circuit.
chanIdOut
The outgoing channel ID that carried the preimage that completed the circuit.
amtIn
The total amount (in satoshis) of the incoming HTLC that created half the circuit.
amtOut
The total amount (in satoshis) of the outgoing HTLC that created the second half of the circuit.
fee
The total fee (in satoshis) that this payment circuit carried.
feeMsat
The total fee (in milli-satoshis) that this payment circuit carried.
amtInMsat
The total amount (in milli-satoshis) of the incoming HTLC that created half the circuit.
amtOutMsat
The total amount (in milli-satoshis) of the outgoing HTLC that created the second half of the circuit.
timestampNs
The number of nanoseconds elapsed since January 1, 1970 UTC when this circuit was completed.
peerAliasIn
The peer alias of the incoming channel.
peerAliasOut
The peer alias of the outgoing channel.
Annotations
@SerialVersionUID()
final case class ForwardingHistoryRequest(startTime: UInt64 = lnrpc.ForwardingHistoryRequest._typemapper_startTime.toCustom(0L), endTime: UInt64 = lnrpc.ForwardingHistoryRequest._typemapper_endTime.toCustom(0L), indexOffset: UInt32 = lnrpc.ForwardingHistoryRequest._typemapper_indexOffset.toCustom(0), numMaxEvents: UInt32 = lnrpc.ForwardingHistoryRequest._typemapper_numMaxEvents.toCustom(0), peerAliasLookup: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ForwardingHistoryRequest] with Product with Serializable
startTime
Start time is the starting point of the forwarding history request. All records beyond this point will be included, respecting the end time, and the index offset.
endTime
End time is the end point of the forwarding history request. The response will carry at most 50k records between the start time and the end time. The index offset can be used to implement pagination.
indexOffset
Index offset is the offset in the time series to start at. As each response can only contain 50k records, callers can use this to skip around within a packed time series.
numMaxEvents
The max number of events to return in the response to this query.
peerAliasLookup
Informs the server if the peer alias should be looked up for each forwarding event.
Annotations
@SerialVersionUID()
final case class ForwardingHistoryResponse(forwardingEvents: Seq[ForwardingEvent] = _root_.scala.Seq.empty, lastOffsetIndex: UInt32 = lnrpc.ForwardingHistoryResponse._typemapper_lastOffsetIndex.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ForwardingHistoryResponse] with Product with Serializable
forwardingEvents
A list of forwarding events from the time slice of the time series specified in the request.
lastOffsetIndex
The index of the last time in the set of returned forwarding events. Can be used to seek further, pagination style.
Annotations
@SerialVersionUID()
final case class FundingPsbtFinalize(signedPsbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, finalRawTx: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundingPsbtFinalize] with Product with Serializable
signedPsbt
The funded PSBT that contains all witness data to send the exact channel capacity amount to the PK script returned in the open channel message in a previous step. Cannot be set at the same time as final_raw_tx.
pendingChanId
The pending channel ID of the channel to get the PSBT for.
finalRawTx
As an alternative to the signed PSBT with all witness data, the final raw wire format transaction can also be specified directly. Cannot be set at the same time as signed_psbt.
Annotations
@SerialVersionUID()
final case class FundingPsbtVerify(fundedPsbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, skipFinalize: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundingPsbtVerify] with Product with Serializable
fundedPsbt
The funded but not yet signed PSBT that sends the exact channel capacity amount to the PK script returned in the open channel message in a previous step.
pendingChanId
The pending channel ID of the channel to get the PSBT for.
skipFinalize
Can only be used if the no_publish flag was set to true in the OpenChannel call meaning that the caller is solely responsible for publishing the final funding transaction. If skip_finalize is set to true then lnd will not wait for a FundingPsbtFinalize state step and instead assumes that a transaction with the same TXID as the passed in PSBT will eventually confirm. IT IS ABSOLUTELY IMPERATIVE that the TXID of the transaction that is eventually published does have the _same TXID_ as the verified PSBT. That means no inputs or outputs can change, only signatures can be added. If the TXID changes between this call and the publish step then the channel will never be created and the funds will be in limbo.
Annotations
@SerialVersionUID()
final case class FundingShim(shim: Shim = lnrpc.FundingShim.Shim.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundingShim] with Product with Serializable
Annotations
@SerialVersionUID()
final case class FundingShimCancel(pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundingShimCancel] with Product with Serializable
pendingChanId
The pending channel ID of the channel to cancel the funding shim for.
Annotations
@SerialVersionUID()
final case class FundingStateStepResp(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundingStateStepResp] with Product with Serializable
Annotations
@SerialVersionUID()
final case class FundingTransitionMsg(trigger: Trigger = lnrpc.FundingTransitionMsg.Trigger.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundingTransitionMsg] with Product with Serializable
Annotations
@SerialVersionUID()
final case class GenSeedRequest(aezeedPassphrase: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, seedEntropy: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GenSeedRequest] with Product with Serializable
aezeedPassphrase
aezeed_passphrase is an optional user provided passphrase that will be used to encrypt the generated aezeed cipher seed. When using REST, this field must be encoded as base64.
seedEntropy
seed_entropy is an optional 16-bytes generated via CSPRNG. If not specified, then a fresh set of randomness will be used to create the seed. When using REST, this field must be encoded as base64.
Annotations
@SerialVersionUID()
final case class GenSeedResponse(cipherSeedMnemonic: Seq[String] = _root_.scala.Seq.empty, encipheredSeed: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GenSeedResponse] with Product with Serializable
cipherSeedMnemonic
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This field is optional, as if not provided, then the daemon will generate a new cipher seed for the user. Otherwise, then the daemon will attempt to recover the wallet state linked to this cipher seed.
encipheredSeed
enciphered_seed are the raw aezeed cipher seed bytes. This is the raw cipher text before run through our mnemonic encoding scheme.
Annotations
@SerialVersionUID()
final case class GetInfoRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetInfoRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class GetInfoResponse(version: String = "", commitHash: String = "", identityPubkey: String = "", alias: String = "", color: String = "", numPendingChannels: UInt32 = lnrpc.GetInfoResponse._typemapper_numPendingChannels.toCustom(0), numActiveChannels: UInt32 = lnrpc.GetInfoResponse._typemapper_numActiveChannels.toCustom(0), numInactiveChannels: UInt32 = lnrpc.GetInfoResponse._typemapper_numInactiveChannels.toCustom(0), numPeers: UInt32 = lnrpc.GetInfoResponse._typemapper_numPeers.toCustom(0), blockHeight: UInt32 = lnrpc.GetInfoResponse._typemapper_blockHeight.toCustom(0), blockHash: String = "", bestHeaderTimestamp: Long = 0L, syncedToChain: Boolean = false, syncedToGraph: Boolean = false, testnet: Boolean = false, chains: Seq[Chain] = _root_.scala.Seq.empty, uris: Seq[String] = _root_.scala.Seq.empty, features: Map[UInt32, Feature] = _root_.scala.collection.immutable.Map.empty, requireHtlcInterceptor: Boolean = false, storeFinalHtlcResolutions: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetInfoResponse] with Product with Serializable
version
The version of the LND software that the node is running.
commitHash
The SHA1 commit hash that the daemon is compiled with.
identityPubkey
The identity pubkey of the current node.
alias
If applicable, the alias of the current node, e.g. "bob"
color
The color of the current node in hex code format
numPendingChannels
Number of pending channels
numActiveChannels
Number of active channels
numInactiveChannels
Number of inactive channels
numPeers
Number of peers
blockHeight
The node's current view of the height of the best block
blockHash
The node's current view of the hash of the best block
bestHeaderTimestamp
Timestamp of the block best known to the wallet
syncedToChain
Whether the wallet's view is synced to the main chain
syncedToGraph
Whether we consider ourselves synced with the public channel graph.
testnet
Whether the current node is connected to testnet. This field is deprecated and the network field should be used instead
chains
A list of active chains the node is connected to
uris
The URIs of the current node.
features
Features that our node has advertised in our init message, node announcements and invoices.
requireHtlcInterceptor
Indicates whether the HTLC interceptor API is in always-on mode.
storeFinalHtlcResolutions
Indicates whether final htlc resolutions are stored on disk.
Annotations
@SerialVersionUID()
final case class GetRecoveryInfoRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetRecoveryInfoRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class GetRecoveryInfoResponse(recoveryMode: Boolean = false, recoveryFinished: Boolean = false, progress: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetRecoveryInfoResponse] with Product with Serializable
recoveryMode
Whether the wallet is in recovery mode
recoveryFinished
Whether the wallet recovery progress is finished
progress
The recovery progress, ranging from 0 to 1.
Annotations
@SerialVersionUID()
final case class GetStateRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetStateRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class GetStateResponse(state: WalletState = lnrpc.WalletState.NON_EXISTING, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetStateResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class GetTransactionsRequest(startHeight: Int = 0, endHeight: Int = 0, account: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetTransactionsRequest] with Product with Serializable
startHeight
The height from which to list transactions, inclusive. If this value is greater than end_height, transactions will be read in reverse.
endHeight
The height until which to list transactions, inclusive. To include unconfirmed transactions, this value should be set to -1, which will return transactions from start_height until the current chain tip and unconfirmed transactions. If no end_height is provided, the call will default to this option.
account
An optional filter to only include transactions relevant to an account.
Annotations
@SerialVersionUID()
final case class GraphTopologySubscription(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GraphTopologySubscription] with Product with Serializable
Annotations
@SerialVersionUID()
final case class GraphTopologyUpdate(nodeUpdates: Seq[NodeUpdate] = _root_.scala.Seq.empty, channelUpdates: Seq[ChannelEdgeUpdate] = _root_.scala.Seq.empty, closedChans: Seq[ClosedChannelUpdate] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GraphTopologyUpdate] with Product with Serializable
Annotations
@SerialVersionUID()
final case class HTLC(incoming: Boolean = false, amount: Long = 0L, hashLock: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, expirationHeight: UInt32 = lnrpc.HTLC._typemapper_expirationHeight.toCustom(0), htlcIndex: UInt64 = lnrpc.HTLC._typemapper_htlcIndex.toCustom(0L), forwardingChannel: UInt64 = lnrpc.HTLC._typemapper_forwardingChannel.toCustom(0L), forwardingHtlcIndex: UInt64 = lnrpc.HTLC._typemapper_forwardingHtlcIndex.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HTLC] with Product with Serializable
htlcIndex
Index identifying the htlc on the channel.
forwardingChannel
If this HTLC is involved in a forwarding operation, this field indicates the forwarding channel. For an outgoing htlc, it is the incoming channel. For an incoming htlc, it is the outgoing channel. When the htlc originates from this node or this node is the final destination, forwarding_channel will be zero. The forwarding channel will also be zero for htlcs that need to be forwarded but don't have a forwarding decision persisted yet.
forwardingHtlcIndex
Index identifying the htlc on the forwarding channel.
Annotations
@SerialVersionUID()
final case class HTLCAttempt(attemptId: UInt64 = lnrpc.HTLCAttempt._typemapper_attemptId.toCustom(0L), status: HTLCStatus = lnrpc.HTLCAttempt.HTLCStatus.IN_FLIGHT, route: Option[Route] = _root_.scala.None, attemptTimeNs: Long = 0L, resolveTimeNs: Long = 0L, failure: Option[Failure] = _root_.scala.None, preimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HTLCAttempt] with Product with Serializable
attemptId
The unique ID that is used for this attempt.
status
The status of the HTLC.
route
The route taken by this HTLC.
attemptTimeNs
The time in UNIX nanoseconds at which this HTLC was sent.
resolveTimeNs
The time in UNIX nanoseconds at which this HTLC was settled or failed. This value will not be set if the HTLC is still IN_FLIGHT.
failure
Detailed htlc failure info.
preimage
The preimage that was used to settle the HTLC.
Annotations
@SerialVersionUID()
final case class Hop(chanId: UInt64 = lnrpc.Hop._typemapper_chanId.toCustom(0L), chanCapacity: Long = 0L, amtToForward: Long = 0L, fee: Long = 0L, expiry: UInt32 = lnrpc.Hop._typemapper_expiry.toCustom(0), amtToForwardMsat: Long = 0L, feeMsat: Long = 0L, pubKey: String = "", tlvPayload: Boolean = false, mppRecord: Option[MPPRecord] = _root_.scala.None, ampRecord: Option[AMPRecord] = _root_.scala.None, customRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, metadata: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Hop] with Product with Serializable
chanId
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
pubKey
An optional public key of the hop. If the public key is given, the payment can be executed without relying on a copy of the channel graph.
tlvPayload
If set to true, then this hop will be encoded using the new variable length TLV format. Note that if any custom tlv_records below are specified, then this field MUST be set to true for them to be encoded properly.
mppRecord
An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that the same mpp_record is included in the final hop payload of all non-zero payments in the HTLC set. If empty, a regular single-shot payment is or was attempted.
ampRecord
An optional TLV record that signals the use of an AMP payment. If present, the receiver will treat all received payments including the same (payment_addr, set_id) pair as being part of one logical payment. The payment will be settled by XORing the root_share's together and deriving the child hashes and preimages according to BOLT XX. Must be used in conjunction with mpp_record.
customRecords
An optional set of key-value TLV records. This is useful within the context of the SendToRoute call as it allows callers to specify arbitrary K-V pairs to drop off at each hop within the onion.
metadata
The payment metadata to send along with the payment to the payee.
Annotations
@SerialVersionUID()
final case class HopHint(nodeId: String = "", chanId: UInt64 = lnrpc.HopHint._typemapper_chanId.toCustom(0L), feeBaseMsat: UInt32 = lnrpc.HopHint._typemapper_feeBaseMsat.toCustom(0), feeProportionalMillionths: UInt32 = lnrpc.HopHint._typemapper_feeProportionalMillionths.toCustom(0), cltvExpiryDelta: UInt32 = lnrpc.HopHint._typemapper_cltvExpiryDelta.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HopHint] with Product with Serializable
nodeId
The public key of the node at the start of the channel.
chanId
The unique identifier of the channel.
feeBaseMsat
The base fee of the channel denominated in millisatoshis.
feeProportionalMillionths
The fee rate of the channel for sending one satoshi across it denominated in millionths of a satoshi.
cltvExpiryDelta
The time-lock delta of the channel.
Annotations
@SerialVersionUID()
final case class InitWalletRequest(walletPassword: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cipherSeedMnemonic: Seq[String] = _root_.scala.Seq.empty, aezeedPassphrase: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, recoveryWindow: Int = 0, channelBackups: Option[ChanBackupSnapshot] = _root_.scala.None, statelessInit: Boolean = false, extendedMasterKey: String = "", extendedMasterKeyBirthdayTimestamp: UInt64 = lnrpc.InitWalletRequest._typemapper_extendedMasterKeyBirthdayTimestamp.toCustom(0L), watchOnly: Option[WatchOnly] = _root_.scala.None, macaroonRootKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InitWalletRequest] with Product with Serializable
walletPassword
wallet_password is the passphrase that should be used to encrypt the wallet. This MUST be at least 8 chars in length. After creation, this password is required to unlock the daemon. When using REST, this field must be encoded as base64.
cipherSeedMnemonic
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This may have been generated by the GenSeed method, or be an existing seed.
aezeedPassphrase
aezeed_passphrase is an optional user provided passphrase that will be used to encrypt the generated aezeed cipher seed. When using REST, this field must be encoded as base64.
recoveryWindow
recovery_window is an optional argument specifying the address lookahead when restoring a wallet seed. The recovery window applies to each individual branch of the BIP44 derivation paths. Supplying a recovery window of zero indicates that no addresses should be recovered, such after the first initialization of the wallet.
channelBackups
channel_backups is an optional argument that allows clients to recover the settled funds within a set of channels. This should be populated if the user was unable to close out all channels and sweep funds before partial or total data loss occurred. If specified, then after on-chain recovery of funds, lnd begin to carry out the data loss recovery protocol in order to recover the funds in each channel from a remote force closed transaction.
statelessInit
stateless_init is an optional argument instructing the daemon NOT to create any *.macaroon files in its filesystem. If this parameter is set, then the admin macaroon returned in the response MUST be stored by the caller of the RPC as otherwise all access to the daemon will be lost!
extendedMasterKey
extended_master_key is an alternative to specifying cipher_seed_mnemonic and aezeed_passphrase. Instead of deriving the master root key from the entropy of an aezeed cipher seed, the given extended master root key is used directly as the wallet's master key. This allows users to import/use a master key from another wallet. When doing so, lnd still uses its default SegWit only (BIP49/84) derivation paths and funds from custom/non-default derivation paths will not automatically appear in the on-chain wallet. Using an 'xprv' instead of an aezeed also has the disadvantage that the wallet's birthday is not known as that is an information that's only encoded in the aezeed, not the xprv. Therefore a birthday needs to be specified in extended_master_key_birthday_timestamp or a "safe" default value will be used.
extendedMasterKeyBirthdayTimestamp
extended_master_key_birthday_timestamp is the optional unix timestamp in seconds to use as the wallet's birthday when using an extended master key to restore the wallet. lnd will only start scanning for funds in blocks that are after the birthday which can speed up the process significantly. If the birthday is not known, this should be left at its default value of 0 in which case lnd will start scanning from the first SegWit block (481824 on mainnet).
watchOnly
watch_only is the third option of initializing a wallet: by importing account xpubs only and therefore creating a watch-only wallet that does not contain any private keys. That means the wallet won't be able to sign for any of the keys and _needs_ to be run with a remote signer that has the corresponding private keys and can serve signing RPC requests.
macaroonRootKey
macaroon_root_key is an optional 32 byte macaroon root key that can be provided when initializing the wallet rather than letting lnd generate one on its own.
Annotations
@SerialVersionUID()
final case class InitWalletResponse(adminMacaroon: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InitWalletResponse] with Product with Serializable
adminMacaroon
The binary serialized admin macaroon that can be used to access the daemon after creating the wallet. If the stateless_init parameter was set to true, this is the ONLY copy of the macaroon and MUST be stored safely by the caller. Otherwise a copy of this macaroon is also persisted on disk by the daemon, together with other macaroon files.
Annotations
@SerialVersionUID()
sealed abstract class Initiator extends GeneratedEnum
final case class InterceptFeedback(error: String = "", replaceResponse: Boolean = false, replacementSerialized: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InterceptFeedback] with Product with Serializable
error
The error to return to the user. If this is non-empty, the incoming gRPC stream/request is aborted and the error is returned to the gRPC client. If this value is empty, it means the middleware accepts the stream/request/ response and the processing of it can continue.
replaceResponse
A boolean indicating that the gRPC message should be replaced/overwritten. This boolean is needed because in protobuf an empty message is serialized as a 0-length or nil byte slice and we wouldn't be able to distinguish between an empty replacement message and the "don't replace anything" case.
replacementSerialized
If the replace_response field is set to true, this field must contain the binary serialized gRPC message in the protobuf format.
Annotations
@SerialVersionUID()
final case class Invoice(memo: String = "", rPreimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, rHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, value: Long = 0L, valueMsat: Long = 0L, settled: Boolean = false, creationDate: Long = 0L, settleDate: Long = 0L, paymentRequest: String = "", descriptionHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, expiry: Long = 0L, fallbackAddr: String = "", cltvExpiry: UInt64 = lnrpc.Invoice._typemapper_cltvExpiry.toCustom(0L), routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, private: Boolean = false, addIndex: UInt64 = lnrpc.Invoice._typemapper_addIndex.toCustom(0L), settleIndex: UInt64 = lnrpc.Invoice._typemapper_settleIndex.toCustom(0L), amtPaid: Long = 0L, amtPaidSat: Long = 0L, amtPaidMsat: Long = 0L, state: InvoiceState = lnrpc.Invoice.InvoiceState.OPEN, htlcs: Seq[InvoiceHTLC] = _root_.scala.Seq.empty, features: Map[UInt32, Feature] = _root_.scala.collection.immutable.Map.empty, isKeysend: Boolean = false, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, isAmp: Boolean = false, ampInvoiceState: Map[String, AMPInvoiceState] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Invoice] with Product with Serializable
memo
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.
rPreimage
The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage. When using REST, this field must be encoded as base64.
rHash
The hash of the preimage. When using REST, this field must be encoded as base64. Note: Output only, don't specify for creating an invoice.
value
The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
valueMsat
The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.
settled
Whether this invoice has been fulfilled. The field is deprecated. Use the state field instead (compare to SETTLED).
creationDate
When this invoice was created. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
settleDate
When this invoice was settled. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
paymentRequest
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. Note: Output only, don't specify for creating an invoice.
descriptionHash
Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. When using REST, this field must be encoded as base64.
expiry
Payment request expiry time in seconds. Default is 86400 (24 hours).
fallbackAddr
Fallback on-chain address.
cltvExpiry
Delta to use for the time-lock of the CLTV extended to the final hop.
routeHints
Route hints that can each be individually used to assist in reaching the invoice's destination.
private
Whether this invoice should include routing hints for private channels. Note: When enabled, if value and value_msat are zero, a large number of hints with these channels can be included, which might not be desirable.
addIndex
The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one. Note: Output only, don't specify for creating an invoice.
settleIndex
The "settle" index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all settled invoices with an settle_index greater than this one. Note: Output only, don't specify for creating an invoice.
amtPaid
Deprecated, use amt_paid_sat or amt_paid_msat.
amtPaidSat
The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled or accepted. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well. Note: Output only, don't specify for creating an invoice.
amtPaidMsat
The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled or accepted. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well. Note: Output only, don't specify for creating an invoice.
state
The state the invoice is in. Note: Output only, don't specify for creating an invoice.
htlcs
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
features
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
isKeysend
Indicates if this invoice was a spontaneous payment that arrived via keysend [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
paymentAddr
The payment address of this invoice. This value will be used in MPP payments, and also for newer invoices that always require the MPP payload for added end-to-end security. Note: Output only, don't specify for creating an invoice.
isAmp
Signals whether or not this is an AMP invoice.
ampInvoiceState
[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
Annotations
@SerialVersionUID()
final case class InvoiceHTLC(chanId: UInt64 = lnrpc.InvoiceHTLC._typemapper_chanId.toCustom(0L), htlcIndex: UInt64 = lnrpc.InvoiceHTLC._typemapper_htlcIndex.toCustom(0L), amtMsat: UInt64 = lnrpc.InvoiceHTLC._typemapper_amtMsat.toCustom(0L), acceptHeight: Int = 0, acceptTime: Long = 0L, resolveTime: Long = 0L, expiryHeight: Int = 0, state: InvoiceHTLCState = lnrpc.InvoiceHTLCState.ACCEPTED, customRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, mppTotalAmtMsat: UInt64 = lnrpc.InvoiceHTLC._typemapper_mppTotalAmtMsat.toCustom(0L), amp: Option[AMP] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InvoiceHTLC] with Product with Serializable
Details of an HTLC that paid to an invoice
Details of an HTLC that paid to an invoice
chanId
Short channel id over which the htlc was received.
htlcIndex
Index identifying the htlc on the channel.
amtMsat
The amount of the htlc in msat.
acceptHeight
Block height at which this htlc was accepted.
acceptTime
Time at which this htlc was accepted.
resolveTime
Time at which this htlc was settled or canceled.
expiryHeight
Block height at which this htlc expires.
state
Current state the htlc is in.
customRecords
Custom tlv records.
mppTotalAmtMsat
The total amount of the mpp payment in msat.
amp
Details relevant to AMP HTLCs, only populated if this is an AMP HTLC.
Annotations
@SerialVersionUID()
sealed abstract class InvoiceHTLCState extends GeneratedEnum
final case class InvoiceSubscription(addIndex: UInt64 = lnrpc.InvoiceSubscription._typemapper_addIndex.toCustom(0L), settleIndex: UInt64 = lnrpc.InvoiceSubscription._typemapper_settleIndex.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InvoiceSubscription] with Product with Serializable
addIndex
If specified (non-zero), then we'll first start by sending out notifications for all added indexes with an add_index greater than this value. This allows callers to catch up on any events they missed while they weren't connected to the streaming RPC.
settleIndex
If specified (non-zero), then we'll first start by sending out notifications for all settled indexes with an settle_index greater than this value. This allows callers to catch up on any events they missed while they weren't connected to the streaming RPC.
Annotations
@SerialVersionUID()
final case class KeyDescriptor(rawKeyBytes: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, keyLoc: Option[KeyLocator] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[KeyDescriptor] with Product with Serializable
rawKeyBytes
The raw bytes of the key being identified.
keyLoc
The key locator that identifies which key to use for signing.
Annotations
@SerialVersionUID()
final case class KeyLocator(keyFamily: Int = 0, keyIndex: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[KeyLocator] with Product with Serializable
keyFamily
The family of key being identified.
keyIndex
The precise index of the key being identified.
Annotations
@SerialVersionUID()
trait Lightning extends AnyRef
Lightning is the main RPC server of the daemon.
Lightning is the main RPC server of the daemon.
Annotations
@PekkoGrpcGenerated()
final case class LightningAddress(pubkey: String = "", host: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LightningAddress] with Product with Serializable
pubkey
The identity pubkey of the Lightning node.
host
The network location of the lightning node, e.g. 69.69.69.69:1337 or localhost:10011.
Annotations
@SerialVersionUID()
trait LightningClient extends Lightning with LightningClientPowerApi with PekkoGrpcClient
Annotations
@PekkoGrpcGenerated()
trait LightningClientPowerApi extends AnyRef
Annotations
@PekkoGrpcGenerated()
final case class LightningNode(lastUpdate: UInt32 = lnrpc.LightningNode._typemapper_lastUpdate.toCustom(0), pubKey: String = "", alias: String = "", addresses: Seq[NodeAddress] = _root_.scala.Seq.empty, color: String = "", features: Map[UInt32, Feature] = _root_.scala.collection.immutable.Map.empty, customRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LightningNode] with Product with Serializable
An individual vertex/node within the channel graph.
An individual vertex/node within the channel graph. A node is connected to other nodes by one or more channel edges emanating from it. As the graph is directed, a node will also have an incoming edge attached to it for each outgoing edge.
customRecords
Custom node announcement tlv records.
Annotations
@SerialVersionUID()
final case class ListAliasesRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListAliasesRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ListAliasesResponse(aliasMaps: Seq[AliasMap] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListAliasesResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ListChannelsRequest(activeOnly: Boolean = false, inactiveOnly: Boolean = false, publicOnly: Boolean = false, privateOnly: Boolean = false, peer: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, peerAliasLookup: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListChannelsRequest] with Product with Serializable
peer
Filters the response for channels with a target peer's pubkey. If peer is empty, all channels will be returned.
peerAliasLookup
Informs the server if the peer alias lookup per channel should be enabled. It is turned off by default in order to avoid degradation of performance for existing clients.
Annotations
@SerialVersionUID()
final case class ListChannelsResponse(channels: Seq[Channel] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListChannelsResponse] with Product with Serializable
channels
The list of active channels
Annotations
@SerialVersionUID()
final case class ListInvoiceRequest(pendingOnly: Boolean = false, indexOffset: UInt64 = lnrpc.ListInvoiceRequest._typemapper_indexOffset.toCustom(0L), numMaxInvoices: UInt64 = lnrpc.ListInvoiceRequest._typemapper_numMaxInvoices.toCustom(0L), reversed: Boolean = false, creationDateStart: UInt64 = lnrpc.ListInvoiceRequest._typemapper_creationDateStart.toCustom(0L), creationDateEnd: UInt64 = lnrpc.ListInvoiceRequest._typemapper_creationDateEnd.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListInvoiceRequest] with Product with Serializable
pendingOnly
If set, only invoices that are not settled and not canceled will be returned in the response.
indexOffset
The index of an invoice that will be used as either the start or end of a query to determine which invoices should be returned in the response.
numMaxInvoices
The max number of invoices to return in the response to this query.
reversed
If set, the invoices returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards.
creationDateStart
If set, returns all invoices with a creation date greater than or equal to it. Measured in seconds since the unix epoch.
creationDateEnd
If set, returns all invoices with a creation date less than or equal to it. Measured in seconds since the unix epoch.
Annotations
@SerialVersionUID()
final case class ListInvoiceResponse(invoices: Seq[Invoice] = _root_.scala.Seq.empty, lastIndexOffset: UInt64 = lnrpc.ListInvoiceResponse._typemapper_lastIndexOffset.toCustom(0L), firstIndexOffset: UInt64 = lnrpc.ListInvoiceResponse._typemapper_firstIndexOffset.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListInvoiceResponse] with Product with Serializable
invoices
A list of invoices from the time slice of the time series specified in the request.
lastIndexOffset
The index of the last item in the set of returned invoices. This can be used to seek further, pagination style.
firstIndexOffset
The index of the last item in the set of returned invoices. This can be used to seek backwards, pagination style.
Annotations
@SerialVersionUID()
final case class ListMacaroonIDsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListMacaroonIDsRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ListMacaroonIDsResponse(rootKeyIds: Seq[UInt64] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListMacaroonIDsResponse] with Product with Serializable
rootKeyIds
The list of root key IDs that are in use.
Annotations
@SerialVersionUID()
final case class ListPaymentsRequest(includeIncomplete: Boolean = false, indexOffset: UInt64 = lnrpc.ListPaymentsRequest._typemapper_indexOffset.toCustom(0L), maxPayments: UInt64 = lnrpc.ListPaymentsRequest._typemapper_maxPayments.toCustom(0L), reversed: Boolean = false, countTotalPayments: Boolean = false, creationDateStart: UInt64 = lnrpc.ListPaymentsRequest._typemapper_creationDateStart.toCustom(0L), creationDateEnd: UInt64 = lnrpc.ListPaymentsRequest._typemapper_creationDateEnd.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListPaymentsRequest] with Product with Serializable
includeIncomplete
If true, then return payments that have not yet fully completed. This means that pending payments, as well as failed payments will show up if this field is set to true. This flag doesn't change the meaning of the indices, which are tied to individual payments.
indexOffset
The index of a payment that will be used as either the start or end of a query to determine which payments should be returned in the response. The index_offset is exclusive. In the case of a zero index_offset, the query will start with the oldest payment when paginating forwards, or will end with the most recent payment when paginating backwards.
maxPayments
The maximal number of payments returned in the response to this query.
reversed
If set, the payments returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards. The order of the returned payments is always oldest first (ascending index order).
countTotalPayments
If set, all payments (complete and incomplete, independent of the max_payments parameter) will be counted. Note that setting this to true will increase the run time of the call significantly on systems that have a lot of payments, as all of them have to be iterated through to be counted.
creationDateStart
If set, returns all invoices with a creation date greater than or equal to it. Measured in seconds since the unix epoch.
creationDateEnd
If set, returns all invoices with a creation date less than or equal to it. Measured in seconds since the unix epoch.
Annotations
@SerialVersionUID()
final case class ListPaymentsResponse(payments: Seq[Payment] = _root_.scala.Seq.empty, firstIndexOffset: UInt64 = lnrpc.ListPaymentsResponse._typemapper_firstIndexOffset.toCustom(0L), lastIndexOffset: UInt64 = lnrpc.ListPaymentsResponse._typemapper_lastIndexOffset.toCustom(0L), totalNumPayments: UInt64 = lnrpc.ListPaymentsResponse._typemapper_totalNumPayments.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListPaymentsResponse] with Product with Serializable
payments
The list of payments
firstIndexOffset
The index of the first item in the set of returned payments. This can be used as the index_offset to continue seeking backwards in the next request.
lastIndexOffset
The index of the last item in the set of returned payments. This can be used as the index_offset to continue seeking forwards in the next request.
totalNumPayments
Will only be set if count_total_payments in the request was set. Represents the total number of payments (complete and incomplete, independent of the number of payments requested in the query) currently present in the payments database.
Annotations
@SerialVersionUID()
final case class ListPeersRequest(latestError: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListPeersRequest] with Product with Serializable
latestError
If true, only the last error that our peer sent us will be returned with the peer's information, rather than the full set of historic errors we have stored.
Annotations
@SerialVersionUID()
final case class ListPeersResponse(peers: Seq[Peer] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListPeersResponse] with Product with Serializable
peers
The list of currently connected peers
Annotations
@SerialVersionUID()
final case class ListPermissionsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListPermissionsRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class ListPermissionsResponse(methodPermissions: Map[String, MacaroonPermissionList] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListPermissionsResponse] with Product with Serializable
methodPermissions
A map between all RPC method URIs and their required macaroon permissions to access them.
Annotations
@SerialVersionUID()
final case class ListUnspentRequest(minConfs: Int = 0, maxConfs: Int = 0, account: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListUnspentRequest] with Product with Serializable
minConfs
The minimum number of confirmations to be included.
maxConfs
The maximum number of confirmations to be included.
account
An optional filter to only include outputs belonging to an account.
Annotations
@SerialVersionUID()
final case class ListUnspentResponse(utxos: Seq[Utxo] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListUnspentResponse] with Product with Serializable
utxos
A list of utxos
Annotations
@SerialVersionUID()
final case class LookupHtlcResolutionRequest(chanId: UInt64 = lnrpc.LookupHtlcResolutionRequest._typemapper_chanId.toCustom(0L), htlcIndex: UInt64 = lnrpc.LookupHtlcResolutionRequest._typemapper_htlcIndex.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LookupHtlcResolutionRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class LookupHtlcResolutionResponse(settled: Boolean = false, offchain: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LookupHtlcResolutionResponse] with Product with Serializable
settled
Settled is true is the htlc was settled. If false, the htlc was failed.
offchain
Offchain indicates whether the htlc was resolved off-chain or on-chain.
Annotations
@SerialVersionUID()
final case class MPPRecord(paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, totalAmtMsat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MPPRecord] with Product with Serializable
paymentAddr
A unique, random identifier used to authenticate the sender as the intended payer of a multi-path payment. The payment_addr must be the same for all subpayments, and match the payment_addr provided in the receiver's invoice. The same payment_addr must be used on all subpayments.
totalAmtMsat
The total amount in milli-satoshis being sent as part of a larger multi-path payment. The caller is responsible for ensuring subpayments to the same node and payment_hash sum exactly to total_amt_msat. The same total_amt_msat must be used on all subpayments.
Annotations
@SerialVersionUID()
final case class MacaroonId(nonce: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, storageId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, ops: Seq[Op] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MacaroonId] with Product with Serializable
Annotations
@SerialVersionUID()
final case class MacaroonPermission(entity: String = "", action: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MacaroonPermission] with Product with Serializable
entity
The entity a permission grants access to.
action
The action that is granted.
Annotations
@SerialVersionUID()
final case class MacaroonPermissionList(permissions: Seq[MacaroonPermission] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MacaroonPermissionList] with Product with Serializable
permissions
A list of macaroon permissions.
Annotations
@SerialVersionUID()
final case class MiddlewareRegistration(middlewareName: String = "", customMacaroonCaveatName: String = "", readOnlyMode: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MiddlewareRegistration] with Product with Serializable
middlewareName
The name of the middleware to register. The name should be as informative as possible and is logged on registration.
customMacaroonCaveatName
The name of the custom macaroon caveat that this middleware is responsible for. Only requests/responses that contain a macaroon with the registered custom caveat are forwarded for interception to the middleware. The exception being the read-only mode: All requests/responses are forwarded to a middleware that requests read-only access but such a middleware won't be allowed to _alter_ responses. As a security measure, _no_ middleware can change responses to requests made with _unencumbered_ macaroons! NOTE: Cannot be used at the same time as read_only_mode.
readOnlyMode
Instead of defining a custom macaroon caveat name a middleware can register itself for read-only access only. In that mode all requests/responses are forwarded to the middleware but the middleware isn't allowed to alter any of the responses. NOTE: Cannot be used at the same time as custom_macaroon_caveat_name.
Annotations
@SerialVersionUID()
final case class MultiChanBackup(chanPoints: Seq[ChannelPoint] = _root_.scala.Seq.empty, multiChanBackup: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MultiChanBackup] with Product with Serializable
chanPoints
Is the set of all channels that are included in this multi-channel backup.
multiChanBackup
A single encrypted blob containing all the static channel backups of the channel listed above. This can be stored as a single file or blob, and safely be replaced with any prior/future versions. When using REST, this field must be encoded as base64.
Annotations
@SerialVersionUID()
final case class NetworkInfo(graphDiameter: UInt32 = lnrpc.NetworkInfo._typemapper_graphDiameter.toCustom(0), avgOutDegree: Double = 0.0, maxOutDegree: UInt32 = lnrpc.NetworkInfo._typemapper_maxOutDegree.toCustom(0), numNodes: UInt32 = lnrpc.NetworkInfo._typemapper_numNodes.toCustom(0), numChannels: UInt32 = lnrpc.NetworkInfo._typemapper_numChannels.toCustom(0), totalNetworkCapacity: Long = 0L, avgChannelSize: Double = 0.0, minChannelSize: Long = 0L, maxChannelSize: Long = 0L, medianChannelSizeSat: Long = 0L, numZombieChans: UInt64 = lnrpc.NetworkInfo._typemapper_numZombieChans.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NetworkInfo] with Product with Serializable
numZombieChans
The number of edges marked as zombies.
Annotations
@SerialVersionUID()
final case class NetworkInfoRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NetworkInfoRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class NewAddressRequest(type: AddressType = lnrpc.AddressType.WITNESS_PUBKEY_HASH, account: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NewAddressRequest] with Product with Serializable
type
The type of address to generate.
account
The name of the account to generate a new address for. If empty, the default wallet account is used.
Annotations
@SerialVersionUID()
final case class NewAddressResponse(address: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NewAddressResponse] with Product with Serializable
address
The newly generated wallet address
Annotations
@SerialVersionUID()
final case class NodeAddress(network: String = "", addr: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NodeAddress] with Product with Serializable
Annotations
@SerialVersionUID()
final case class NodeInfo(node: Option[LightningNode] = _root_.scala.None, numChannels: UInt32 = lnrpc.NodeInfo._typemapper_numChannels.toCustom(0), totalCapacity: Long = 0L, channels: Seq[ChannelEdge] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NodeInfo] with Product with Serializable
node
An individual vertex/node within the channel graph. A node is connected to other nodes by one or more channel edges emanating from it. As the graph is directed, a node will also have an incoming edge attached to it for each outgoing edge.
numChannels
The total number of channels for the node.
totalCapacity
The sum of all channels capacity for the node, denominated in satoshis.
channels
A list of all public channels for the node.
Annotations
@SerialVersionUID()
final case class NodeInfoRequest(pubKey: String = "", includeChannels: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NodeInfoRequest] with Product with Serializable
pubKey
The 33-byte hex-encoded compressed public of the target node
includeChannels
If true, will include all known channels associated with the node.
Annotations
@SerialVersionUID()
sealed abstract class NodeMetricType extends GeneratedEnum
final case class NodeMetricsRequest(types: Seq[NodeMetricType] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NodeMetricsRequest] with Product with Serializable
types
The requested node metrics.
Annotations
@SerialVersionUID()
final case class NodeMetricsResponse(betweennessCentrality: Map[String, FloatMetric] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NodeMetricsResponse] with Product with Serializable
betweennessCentrality
Betweenness centrality is the sum of the ratio of shortest paths that pass through the node for each pair of nodes in the graph (not counting paths starting or ending at this node). Map of node pubkey to betweenness centrality of the node. Normalized values are in the [0,1] closed interval.
Annotations
@SerialVersionUID()
final case class NodePair(from: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, to: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NodePair] with Product with Serializable
from
The sending node of the pair. When using REST, this field must be encoded as base64.
to
The receiving node of the pair. When using REST, this field must be encoded as base64.
Annotations
@SerialVersionUID()
final case class NodeUpdate(addresses: Seq[String] = _root_.scala.Seq.empty, identityKey: String = "", globalFeatures: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, alias: String = "", color: String = "", nodeAddresses: Seq[NodeAddress] = _root_.scala.Seq.empty, features: Map[UInt32, Feature] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[NodeUpdate] with Product with Serializable
addresses
Deprecated, use node_addresses.
globalFeatures
Deprecated, use features.
features
Features that the node has advertised in the init message, node announcements and invoices.
Annotations
@SerialVersionUID()
final case class Op(entity: String = "", actions: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Op] with Product with Serializable
Annotations
@SerialVersionUID()
final case class OpenChannelRequest(satPerVbyte: UInt64 = lnrpc.OpenChannelRequest._typemapper_satPerVbyte.toCustom(0L), nodePubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, nodePubkeyString: String = "", localFundingAmount: Long = 0L, pushSat: Long = 0L, targetConf: Int = 0, satPerByte: Long = 0L, private: Boolean = false, minHtlcMsat: Long = 0L, remoteCsvDelay: UInt32 = lnrpc.OpenChannelRequest._typemapper_remoteCsvDelay.toCustom(0), minConfs: Int = 0, spendUnconfirmed: Boolean = false, closeAddress: String = "", fundingShim: Option[FundingShim] = _root_.scala.None, remoteMaxValueInFlightMsat: UInt64 = lnrpc.OpenChannelRequest._typemapper_remoteMaxValueInFlightMsat.toCustom(0L), remoteMaxHtlcs: UInt32 = lnrpc.OpenChannelRequest._typemapper_remoteMaxHtlcs.toCustom(0), maxLocalCsv: UInt32 = lnrpc.OpenChannelRequest._typemapper_maxLocalCsv.toCustom(0), commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, zeroConf: Boolean = false, scidAlias: Boolean = false, baseFee: UInt64 = lnrpc.OpenChannelRequest._typemapper_baseFee.toCustom(0L), feeRate: UInt64 = lnrpc.OpenChannelRequest._typemapper_feeRate.toCustom(0L), useBaseFee: Boolean = false, useFeeRate: Boolean = false, remoteChanReserveSat: UInt64 = lnrpc.OpenChannelRequest._typemapper_remoteChanReserveSat.toCustom(0L), fundMax: Boolean = false, memo: String = "", outpoints: Seq[OutPoint] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[OpenChannelRequest] with Product with Serializable
satPerVbyte
A manual fee rate set in sat/vbyte that should be used when crafting the funding transaction.
nodePubkey
The pubkey of the node to open a channel with. When using REST, this field must be encoded as base64.
nodePubkeyString
The hex encoded pubkey of the node to open a channel with. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
localFundingAmount
The number of satoshis the wallet should commit to the channel
pushSat
The number of satoshis to push to the remote side as part of the initial commitment state
targetConf
The target number of blocks that the funding transaction should be confirmed by.
satPerByte
Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte that should be used when crafting the funding transaction.
private
Whether this channel should be private, not announced to the greater network.
minHtlcMsat
The minimum value in millisatoshi we will require for incoming HTLCs on the channel.
remoteCsvDelay
The delay we require on the remote's commitment transaction. If this is not set, it will be scaled automatically with the channel size.
minConfs
The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.
spendUnconfirmed
Whether unconfirmed outputs should be used as inputs for the funding transaction.
closeAddress
Close address is an optional address which specifies the address to which funds should be paid out to upon cooperative close. This field may only be set if the peer supports the option upfront feature bit (call listpeers to check). The remote peer will only accept cooperative closes to this address if it is set. Note: If this value is set on channel creation, you will *not* be able to cooperatively close out to a different address.
fundingShim
Funding shims are an optional argument that allow the caller to intercept certain funding functionality. For example, a shim can be provided to use a particular key for the commitment key (ideally cold) rather than use one that is generated by the wallet as normal, or signal that signing will be carried out in an interactive manner (PSBT based).
remoteMaxValueInFlightMsat
The maximum amount of coins in millisatoshi that can be pending within the channel. It only applies to the remote party.
remoteMaxHtlcs
The maximum number of concurrent HTLCs we will allow the remote party to add to the commitment transaction.
maxLocalCsv
Max local csv is the maximum csv delay we will allow for our own commitment transaction.
commitmentType
The explicit commitment type to use. Note this field will only be used if the remote peer supports explicit channel negotiation.
zeroConf
If this is true, then a zero-conf channel open will be attempted.
scidAlias
If this is true, then an option-scid-alias channel-type open will be attempted.
baseFee
The base fee charged regardless of the number of milli-satoshis sent.
feeRate
The fee rate in ppm (parts per million) that will be charged in proportion of the value of each forwarded HTLC.
useBaseFee
If use_base_fee is true the open channel announcement will update the channel base fee with the value specified in base_fee. In the case of a base_fee of 0 use_base_fee is needed downstream to distinguish whether to use the default base fee value specified in the config or 0.
useFeeRate
If use_fee_rate is true the open channel announcement will update the channel fee rate with the value specified in fee_rate. In the case of a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether to use the default fee rate value specified in the config or 0.
remoteChanReserveSat
The number of satoshis we require the remote peer to reserve. This value, if specified, must be above the dust limit and below 20% of the channel capacity.
fundMax
If set, then lnd will attempt to commit all the coins under control of the internal wallet to open the channel, and the LocalFundingAmount field must be zero and is ignored.
memo
An optional note-to-self to go along with the channel containing some useful information. This is only ever stored locally and in no way impacts the channel's operation.
outpoints
A list of selected outpoints that are allocated for channel funding.
Annotations
@SerialVersionUID()
final case class OpenStatusUpdate(update: Update = lnrpc.OpenStatusUpdate.Update.Empty, pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[OpenStatusUpdate] with Product with Serializable
pendingChanId
The pending channel ID of the created channel. This value may be used to further the funding flow manually via the FundingStateStep method.
Annotations
@SerialVersionUID()
final case class OutPoint(txidBytes: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, txidStr: String = "", outputIndex: UInt32 = lnrpc.OutPoint._typemapper_outputIndex.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[OutPoint] with Product with Serializable
txidBytes
Raw bytes representing the transaction id.
txidStr
Reversed, hex-encoded string representing the transaction id.
outputIndex
The index of the output on the transaction.
Annotations
@SerialVersionUID()
final case class OutputDetail(outputType: OutputScriptType = lnrpc.OutputScriptType.SCRIPT_TYPE_PUBKEY_HASH, address: String = "", pkScript: String = "", outputIndex: Long = 0L, amount: Long = 0L, isOurAddress: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[OutputDetail] with Product with Serializable
outputType
The type of the output
address
The address
pkScript
The pkscript in hex
outputIndex
The output index used in the raw transaction
amount
The value of the output coin in satoshis
isOurAddress
Denotes if the output is controlled by the internal wallet
Annotations
@SerialVersionUID()
sealed abstract class OutputScriptType extends GeneratedEnum
final case class PayReq(destination: String = "", paymentHash: String = "", numSatoshis: Long = 0L, timestamp: Long = 0L, expiry: Long = 0L, description: String = "", descriptionHash: String = "", fallbackAddr: String = "", cltvExpiry: Long = 0L, routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, numMsat: Long = 0L, features: Map[UInt32, Feature] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PayReq] with Product with Serializable
Annotations
@SerialVersionUID()
final case class PayReqString(payReq: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PayReqString] with Product with Serializable
payReq
The payment request string to be decoded
Annotations
@SerialVersionUID()
final case class Payment(paymentHash: String = "", value: Long = 0L, creationDate: Long = 0L, fee: Long = 0L, paymentPreimage: String = "", valueSat: Long = 0L, valueMsat: Long = 0L, paymentRequest: String = "", status: PaymentStatus = lnrpc.Payment.PaymentStatus.UNKNOWN, feeSat: Long = 0L, feeMsat: Long = 0L, creationTimeNs: Long = 0L, htlcs: Seq[HTLCAttempt] = _root_.scala.Seq.empty, paymentIndex: UInt64 = lnrpc.Payment._typemapper_paymentIndex.toCustom(0L), failureReason: PaymentFailureReason = lnrpc.PaymentFailureReason.FAILURE_REASON_NONE, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Payment] with Product with Serializable
paymentHash
The payment hash
value
Deprecated, use value_sat or value_msat.
creationDate
Deprecated, use creation_time_ns
fee
Deprecated, use fee_sat or fee_msat.
paymentPreimage
The payment preimage
valueSat
The value of the payment in satoshis
valueMsat
The value of the payment in milli-satoshis
paymentRequest
The optional payment request being fulfilled.
status
The status of the payment.
feeSat
The fee paid for this payment in satoshis
feeMsat
The fee paid for this payment in milli-satoshis
creationTimeNs
The time in UNIX nanoseconds at which the payment was created.
htlcs
The HTLCs made in attempt to settle the payment.
paymentIndex
The creation index of this payment. Each payment can be uniquely identified by this index, which may not strictly increment by 1 for payments made in older versions of lnd.
Annotations
@SerialVersionUID()
sealed abstract class PaymentFailureReason extends GeneratedEnum
final case class PaymentHash(rHashStr: String = "", rHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PaymentHash] with Product with Serializable
rHashStr
The hex-encoded payment hash of the invoice to be looked up. The passed payment hash must be exactly 32 bytes, otherwise an error is returned. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
rHash
The payment hash of the invoice to be looked up. When using REST, this field must be encoded as base64.
Annotations
@SerialVersionUID()
final case class Peer(pubKey: String = "", address: String = "", bytesSent: UInt64 = lnrpc.Peer._typemapper_bytesSent.toCustom(0L), bytesRecv: UInt64 = lnrpc.Peer._typemapper_bytesRecv.toCustom(0L), satSent: Long = 0L, satRecv: Long = 0L, inbound: Boolean = false, pingTime: Long = 0L, syncType: SyncType = lnrpc.Peer.SyncType.UNKNOWN_SYNC, features: Map[UInt32, Feature] = _root_.scala.collection.immutable.Map.empty, errors: Seq[TimestampedError] = _root_.scala.Seq.empty, flapCount: Int = 0, lastFlapNs: Long = 0L, lastPingPayload: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Peer] with Product with Serializable
pubKey
The identity pubkey of the peer
address
Network address of the peer; eg 127.0.0.1:10011
bytesSent
Bytes of data transmitted to this peer
bytesRecv
Bytes of data transmitted from this peer
satSent
Satoshis sent to this peer
satRecv
Satoshis received from this peer
inbound
A channel is inbound if the counterparty initiated the channel
pingTime
Ping time to this peer
syncType
The type of sync we are currently performing with this peer.
features
Features advertised by the remote peer in their init message.
errors
The latest errors received from our peer with timestamps, limited to the 10 most recent errors. These errors are tracked across peer connections, but are not persisted across lnd restarts. Note that these errors are only stored for peers that we have channels open with, to prevent peers from spamming us with errors at no cost.
flapCount
The number of times we have recorded this peer going offline or coming online, recorded across restarts. Note that this value is decreased over time if the peer has not recently flapped, so that we can forgive peers with historically high flap counts.
lastFlapNs
The timestamp of the last flap we observed for this peer. If this value is zero, we have not observed any flaps for this peer.
lastPingPayload
The last ping payload the peer has sent to us.
Annotations
@SerialVersionUID()
final case class PeerEvent(pubKey: String = "", type: EventType = lnrpc.PeerEvent.EventType.PEER_ONLINE, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PeerEvent] with Product with Serializable
pubKey
The identity pubkey of the peer.
Annotations
@SerialVersionUID()
final case class PeerEventSubscription(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PeerEventSubscription] with Product with Serializable
Annotations
@SerialVersionUID()
final case class PendingChannelsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PendingChannelsRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class PendingChannelsResponse(totalLimboBalance: Long = 0L, pendingOpenChannels: Seq[PendingOpenChannel] = _root_.scala.Seq.empty, pendingClosingChannels: Seq[ClosedChannel] = _root_.scala.Seq.empty, pendingForceClosingChannels: Seq[ForceClosedChannel] = _root_.scala.Seq.empty, waitingCloseChannels: Seq[WaitingCloseChannel] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PendingChannelsResponse] with Product with Serializable
totalLimboBalance
The balance in satoshis encumbered in pending channels
pendingOpenChannels
Channels pending opening
pendingClosingChannels
Deprecated: Channels pending closing previously contained cooperatively closed channels with a single confirmation. These channels are now considered closed from the time we see them on chain.
pendingForceClosingChannels
Channels pending force closing
waitingCloseChannels
Channels waiting for closing tx to confirm
Annotations
@SerialVersionUID()
final case class PendingHTLC(incoming: Boolean = false, amount: Long = 0L, outpoint: String = "", maturityHeight: UInt32 = lnrpc.PendingHTLC._typemapper_maturityHeight.toCustom(0), blocksTilMaturity: Int = 0, stage: UInt32 = lnrpc.PendingHTLC._typemapper_stage.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PendingHTLC] with Product with Serializable
incoming
The direction within the channel that the htlc was sent
amount
The total value of the htlc
outpoint
The final output to be swept back to the user's wallet
maturityHeight
The next block height at which we can spend the current stage
blocksTilMaturity
The number of blocks remaining until the current stage can be swept. Negative values indicate how many blocks have passed since becoming mature.
stage
Indicates whether the htlc is in its first or second stage of recovery
Annotations
@SerialVersionUID()
final case class PendingUpdate(txid: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, outputIndex: UInt32 = lnrpc.PendingUpdate._typemapper_outputIndex.toCustom(0), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PendingUpdate] with Product with Serializable
Annotations
@SerialVersionUID()
final case class PolicyUpdateRequest(scope: Scope = lnrpc.PolicyUpdateRequest.Scope.Empty, baseFeeMsat: Long = 0L, feeRate: Double = 0.0, feeRatePpm: UInt32 = lnrpc.PolicyUpdateRequest._typemapper_feeRatePpm.toCustom(0), timeLockDelta: UInt32 = lnrpc.PolicyUpdateRequest._typemapper_timeLockDelta.toCustom(0), maxHtlcMsat: UInt64 = lnrpc.PolicyUpdateRequest._typemapper_maxHtlcMsat.toCustom(0L), minHtlcMsat: UInt64 = lnrpc.PolicyUpdateRequest._typemapper_minHtlcMsat.toCustom(0L), minHtlcMsatSpecified: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PolicyUpdateRequest] with Product with Serializable
baseFeeMsat
The base fee charged regardless of the number of milli-satoshis sent.
feeRate
The effective fee rate in milli-satoshis. The precision of this value goes up to 6 decimal places, so 1e-6.
feeRatePpm
The effective fee rate in micro-satoshis (parts per million).
timeLockDelta
The required timelock delta for HTLCs forwarded over the channel.
maxHtlcMsat
If set, the maximum HTLC size in milli-satoshis. If unset, the maximum HTLC will be unchanged.
minHtlcMsat
The minimum HTLC size in milli-satoshis. Only applied if min_htlc_msat_specified is true.
minHtlcMsatSpecified
If true, min_htlc_msat is applied.
Annotations
@SerialVersionUID()
final case class PolicyUpdateResponse(failedUpdates: Seq[FailedUpdate] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PolicyUpdateResponse] with Product with Serializable
failedUpdates
List of failed policy updates.
Annotations
@SerialVersionUID()
final case class PreviousOutPoint(outpoint: String = "", isOurOutput: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PreviousOutPoint] with Product with Serializable
outpoint
The outpoint in format txid:n.
isOurOutput
Denotes if the outpoint is controlled by the internal wallet. The flag will only detect p2wkh, np2wkh and p2tr inputs as its own.
Annotations
@SerialVersionUID()
final case class PsbtShim(pendingChanId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, basePsbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, noPublish: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PsbtShim] with Product with Serializable
pendingChanId
A unique identifier of 32 random bytes that will be used as the pending channel ID to identify the PSBT state machine when interacting with it and on the wire protocol to initiate the funding request.
basePsbt
An optional base PSBT the new channel output will be added to. If this is non-empty, it must be a binary serialized PSBT.
noPublish
If a channel should be part of a batch (multiple channel openings in one transaction), it can be dangerous if the whole batch transaction is published too early before all channel opening negotiations are completed. This flag prevents this particular channel from broadcasting the transaction after the negotiation with the remote peer. In a batch of channel openings this flag should be set to true for every channel but the very last.
Annotations
@SerialVersionUID()
final case class QueryRoutesRequest(pubKey: String = "", amt: Long = 0L, amtMsat: Long = 0L, finalCltvDelta: Int = 0, feeLimit: Option[FeeLimit] = _root_.scala.None, ignoredNodes: Seq[ByteString] = _root_.scala.Seq.empty, ignoredEdges: Seq[EdgeLocator] = _root_.scala.Seq.empty, sourcePubKey: String = "", useMissionControl: Boolean = false, ignoredPairs: Seq[NodePair] = _root_.scala.Seq.empty, cltvLimit: UInt32 = lnrpc.QueryRoutesRequest._typemapper_cltvLimit.toCustom(0), destCustomRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, outgoingChanId: UInt64 = lnrpc.QueryRoutesRequest._typemapper_outgoingChanId.toCustom(0L), lastHopPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, timePref: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[QueryRoutesRequest] with Product with Serializable
pubKey
The 33-byte hex-encoded public key for the payment destination
amt
The amount to send expressed in satoshis. The fields amt and amt_msat are mutually exclusive.
amtMsat
The amount to send expressed in millisatoshis. The fields amt and amt_msat are mutually exclusive.
finalCltvDelta
An optional CLTV delta from the current height that should be used for the timelock of the final hop. Note that unlike SendPayment, QueryRoutes does not add any additional block padding on top of final_ctlv_delta. This padding of a few blocks needs to be added manually or otherwise failures may happen when a block comes in while the payment is in flight.
feeLimit
The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment. If not specified, lnd will use a default value of 100% fees for small amounts (<=1k sat) or 5% fees for larger amounts.
ignoredNodes
A list of nodes to ignore during path finding. When using REST, these fields must be encoded as base64.
ignoredEdges
Deprecated. A list of edges to ignore during path finding.
sourcePubKey
The source node where the request route should originated from. If empty, self is assumed.
useMissionControl
If set to true, edge probabilities from mission control will be used to get the optimal route.
ignoredPairs
A list of directed node pairs that will be ignored during path finding.
cltvLimit
An optional maximum total time lock for the route. If the source is empty or ourselves, this should not exceed lnd's --max-cltv-expiry setting. If zero, then the value of --max-cltv-expiry is used as the limit.
destCustomRecords
An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. If the destination does not support the specified records, an error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.
outgoingChanId
The channel id of the channel that must be taken to the first hop. If zero, any channel may be used.
lastHopPubkey
The pubkey of the last hop of the route. If empty, any hop may be used.
routeHints
Optional route hints to reach the destination through private channels.
destFeatures
Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.
timePref
The time preference for this payment. Set to -1 to optimize for fees only, to 1 to optimize for reliability only or a value inbetween for a mix.
Annotations
@SerialVersionUID()
final case class QueryRoutesResponse(routes: Seq[Route] = _root_.scala.Seq.empty, successProb: Double = 0.0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[QueryRoutesResponse] with Product with Serializable
routes
The route that results from the path finding operation. This is still a repeated field to retain backwards compatibility.
successProb
The success probability of the returned route based on the current mission control state. [EXPERIMENTAL]
Annotations
@SerialVersionUID()
final case class RPCMessage(methodFullUri: String = "", streamRpc: Boolean = false, typeName: String = "", serialized: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, isError: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RPCMessage] with Product with Serializable
methodFullUri
The full URI (in the format /<rpcpackage>.<ServiceName>/MethodName, for example /lnrpc.Lightning/GetInfo) of the RPC method the message was sent to/from.
streamRpc
Indicates whether the message was sent over a streaming RPC method or not.
typeName
The full canonical gRPC name of the message type (in the format <rpcpackage>.TypeName, for example lnrpc.GetInfoRequest). In case of an error being returned from lnd, this simply contains the string "error".
serialized
The full content of the gRPC message, serialized in the binary protobuf format.
isError
Indicates that the response from lnd was an error, not a gRPC response. If this is set to true then the type_name contains the string "error" and serialized contains the error string.
Annotations
@SerialVersionUID()
final case class RPCMiddlewareRequest(requestId: UInt64 = lnrpc.RPCMiddlewareRequest._typemapper_requestId.toCustom(0L), rawMacaroon: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, customCaveatCondition: String = "", interceptType: InterceptType = lnrpc.RPCMiddlewareRequest.InterceptType.Empty, msgId: UInt64 = lnrpc.RPCMiddlewareRequest._typemapper_msgId.toCustom(0L), unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RPCMiddlewareRequest] with Product with Serializable
requestId
The unique ID of the intercepted original gRPC request. Useful for mapping request to response when implementing full duplex message interception. For streaming requests, this will be the same ID for all incoming and outgoing middleware intercept messages of the _same_ stream.
rawMacaroon
The raw bytes of the complete macaroon as sent by the gRPC client in the original request. This might be empty for a request that doesn't require macaroons such as the wallet unlocker RPCs.
customCaveatCondition
The parsed condition of the macaroon's custom caveat for convenient access. This field only contains the value of the custom caveat that the handling middleware has registered itself for. The condition _must_ be validated for messages of intercept_type stream_auth and request!
msgId
The unique message ID of this middleware intercept message. There can be multiple middleware intercept messages per single gRPC request (one for the incoming request and one for the outgoing response) or gRPC stream (one for each incoming message and one for each outgoing response). This message ID must be referenced when responding (accepting/rejecting/modifying) to an intercept message.
Annotations
@SerialVersionUID()
final case class RPCMiddlewareResponse(refMsgId: UInt64 = lnrpc.RPCMiddlewareResponse._typemapper_refMsgId.toCustom(0L), middlewareMessage: MiddlewareMessage = lnrpc.RPCMiddlewareResponse.MiddlewareMessage.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RPCMiddlewareResponse] with Product with Serializable
refMsgId
The request message ID this response refers to. Must always be set when giving feedback to an intercept but is ignored for the initial registration message.
Annotations
@SerialVersionUID()
final case class ReadyForPsbtFunding(fundingAddress: String = "", fundingAmount: Long = 0L, psbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ReadyForPsbtFunding] with Product with Serializable
fundingAddress
The P2WSH address of the channel funding multisig address that the below specified amount in satoshis needs to be sent to.
fundingAmount
The exact amount in satoshis that needs to be sent to the above address to fund the pending channel.
psbt
A raw PSBT that contains the pending channel output. If a base PSBT was provided in the PsbtShim, this is the base PSBT with one additional output. If no base PSBT was specified, this is an otherwise empty PSBT with exactly one output.
Annotations
@SerialVersionUID()
final case class Resolution(resolutionType: ResolutionType = lnrpc.ResolutionType.TYPE_UNKNOWN, outcome: ResolutionOutcome = lnrpc.ResolutionOutcome.OUTCOME_UNKNOWN, outpoint: Option[OutPoint] = _root_.scala.None, amountSat: UInt64 = lnrpc.Resolution._typemapper_amountSat.toCustom(0L), sweepTxid: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Resolution] with Product with Serializable
resolutionType
The type of output we are resolving.
outcome
The outcome of our on chain action that resolved the outpoint.
outpoint
The outpoint that was spent by the resolution.
amountSat
The amount that was claimed by the resolution.
sweepTxid
The hex-encoded transaction ID of the sweep transaction that spent the output.
Annotations
@SerialVersionUID()
sealed abstract class ResolutionOutcome extends GeneratedEnum
sealed abstract class ResolutionType extends GeneratedEnum
final case class RestoreBackupResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RestoreBackupResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class RestoreChanBackupRequest(backup: Backup = lnrpc.RestoreChanBackupRequest.Backup.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RestoreChanBackupRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class Route(totalTimeLock: UInt32 = lnrpc.Route._typemapper_totalTimeLock.toCustom(0), totalFees: Long = 0L, totalAmt: Long = 0L, hops: Seq[Hop] = _root_.scala.Seq.empty, totalFeesMsat: Long = 0L, totalAmtMsat: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Route] with Product with Serializable
A path through the channel graph which runs over one or more channels in succession.
A path through the channel graph which runs over one or more channels in succession. This struct carries all the information required to craft the Sphinx onion packet, and send the payment along the first hop in the path. A route is only selected as valid if all the channels have sufficient capacity to carry the initial payment amount after fees are accounted for.
totalTimeLock
The cumulative (final) time lock across the entire route. This is the CLTV value that should be extended to the first hop in the route. All other hops will decrement the time-lock as advertised, leaving enough time for all hops to wait for or present the payment preimage to complete the payment.
totalFees
The sum of the fees paid at each hop within the final route. In the case of a one-hop payment, this value will be zero as we don't need to pay a fee to ourselves.
totalAmt
The total amount of funds required to complete a payment over this route. This value includes the cumulative fees at each hop. As a result, the HTLC extended to the first-hop in the route will need to have at least this many satoshis, otherwise the route will fail at an intermediate node due to an insufficient amount of fees.
hops
Contains details concerning the specific forwarding details at each hop.
totalFeesMsat
The total fees in millisatoshis.
totalAmtMsat
The total amount in millisatoshis.
Annotations
@SerialVersionUID()
final case class RouteHint(hopHints: Seq[HopHint] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RouteHint] with Product with Serializable
hopHints
A list of hop hints that when chained together can assist in reaching a specific destination.
Annotations
@SerialVersionUID()
final case class RoutingPolicy(timeLockDelta: UInt32 = lnrpc.RoutingPolicy._typemapper_timeLockDelta.toCustom(0), minHtlc: Long = 0L, feeBaseMsat: Long = 0L, feeRateMilliMsat: Long = 0L, disabled: Boolean = false, maxHtlcMsat: UInt64 = lnrpc.RoutingPolicy._typemapper_maxHtlcMsat.toCustom(0L), lastUpdate: UInt32 = lnrpc.RoutingPolicy._typemapper_lastUpdate.toCustom(0), customRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RoutingPolicy] with Product with Serializable
customRecords
Custom channel update tlv records.
Annotations
@SerialVersionUID()
final case class SendCoinsRequest(addr: String = "", amount: Long = 0L, targetConf: Int = 0, satPerVbyte: UInt64 = lnrpc.SendCoinsRequest._typemapper_satPerVbyte.toCustom(0L), satPerByte: Long = 0L, sendAll: Boolean = false, label: String = "", minConfs: Int = 0, spendUnconfirmed: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendCoinsRequest] with Product with Serializable
addr
The address to send coins to
amount
The amount in satoshis to send
targetConf
The target number of blocks that this transaction should be confirmed by.
satPerVbyte
A manual fee rate set in sat/vbyte that should be used when crafting the transaction.
satPerByte
Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte that should be used when crafting the transaction.
sendAll
If set, then the amount field will be ignored, and lnd will attempt to send all the coins under control of the internal wallet to the specified address.
label
An optional label for the transaction, limited to 500 characters.
minConfs
The minimum number of confirmations each one of your outputs used for the transaction must satisfy.
spendUnconfirmed
Whether unconfirmed outputs should be used as inputs for the transaction.
Annotations
@SerialVersionUID()
final case class SendCoinsResponse(txid: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendCoinsResponse] with Product with Serializable
txid
The transaction ID of the transaction
Annotations
@SerialVersionUID()
final case class SendCustomMessageRequest(peer: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, type: UInt32 = lnrpc.SendCustomMessageRequest._typemapper_type.toCustom(0), data: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendCustomMessageRequest] with Product with Serializable
peer
Peer to send the message to
type
Message type. This value needs to be in the custom range (>= 32768). To send a type < custom range, lnd needs to be compiled with the dev build tag, and the message type to override should be specified in lnd's experimental protocol configuration.
data
Raw message data.
Annotations
@SerialVersionUID()
final case class SendCustomMessageResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendCustomMessageResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class SendManyRequest(addrToAmount: Map[String, Long] = _root_.scala.collection.immutable.Map.empty, targetConf: Int = 0, satPerVbyte: UInt64 = lnrpc.SendManyRequest._typemapper_satPerVbyte.toCustom(0L), satPerByte: Long = 0L, label: String = "", minConfs: Int = 0, spendUnconfirmed: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendManyRequest] with Product with Serializable
addrToAmount
The map from addresses to amounts
targetConf
The target number of blocks that this transaction should be confirmed by.
satPerVbyte
A manual fee rate set in sat/vbyte that should be used when crafting the transaction.
satPerByte
Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte that should be used when crafting the transaction.
label
An optional label for the transaction, limited to 500 characters.
minConfs
The minimum number of confirmations each one of your outputs used for the transaction must satisfy.
spendUnconfirmed
Whether unconfirmed outputs should be used as inputs for the transaction.
Annotations
@SerialVersionUID()
final case class SendManyResponse(txid: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendManyResponse] with Product with Serializable
txid
The id of the transaction
Annotations
@SerialVersionUID()
final case class SendRequest(dest: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, destString: String = "", amt: Long = 0L, amtMsat: Long = 0L, paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, paymentHashString: String = "", paymentRequest: String = "", finalCltvDelta: Int = 0, feeLimit: Option[FeeLimit] = _root_.scala.None, outgoingChanId: UInt64 = lnrpc.SendRequest._typemapper_outgoingChanId.toCustom(0L), lastHopPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cltvLimit: UInt32 = lnrpc.SendRequest._typemapper_cltvLimit.toCustom(0), destCustomRecords: Map[UInt64, ByteString] = _root_.scala.collection.immutable.Map.empty, allowSelfPayment: Boolean = false, destFeatures: Seq[FeatureBit] = _root_.scala.Seq.empty, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendRequest] with Product with Serializable
dest
The identity pubkey of the payment recipient. When using REST, this field must be encoded as base64.
destString
The hex-encoded identity pubkey of the payment recipient. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
amt
The amount to send expressed in satoshis. The fields amt and amt_msat are mutually exclusive.
amtMsat
The amount to send expressed in millisatoshis. The fields amt and amt_msat are mutually exclusive.
paymentHash
The hash to use within the payment's HTLC. When using REST, this field must be encoded as base64.
paymentHashString
The hex-encoded hash to use within the payment's HTLC. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
paymentRequest
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.
finalCltvDelta
The CLTV delta from the current height that should be used to set the timelock for the final hop.
feeLimit
The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment. If not specified, lnd will use a default value of 100% fees for small amounts (<=1k sat) or 5% fees for larger amounts.
outgoingChanId
The channel id of the channel that must be taken to the first hop. If zero, any channel may be used.
lastHopPubkey
The pubkey of the last hop of the route. If empty, any hop may be used.
cltvLimit
An optional maximum total time lock for the route. This should not exceed lnd's --max-cltv-expiry setting. If zero, then the value of --max-cltv-expiry is enforced.
destCustomRecords
An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.
allowSelfPayment
If set, circular payments to self are permitted.
destFeatures
Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.
paymentAddr
The payment address of the generated invoice.
Annotations
@SerialVersionUID()
final case class SendResponse(paymentError: String = "", paymentPreimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, paymentRoute: Option[Route] = _root_.scala.None, paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class SendToRouteRequest(paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, paymentHashString: String = "", route: Option[Route] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendToRouteRequest] with Product with Serializable
paymentHash
The payment hash to use for the HTLC. When using REST, this field must be encoded as base64.
paymentHashString
An optional hex-encoded payment hash to be used for the HTLC. Deprecated now that the REST gateway supports base64 encoding of bytes fields.
route
Route that should be used to attempt to complete the payment.
Annotations
@SerialVersionUID()
final case class SetID(setId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SetID] with Product with Serializable
Annotations
@SerialVersionUID()
final case class SignMessageRequest(msg: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, singleHash: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignMessageRequest] with Product with Serializable
msg
The message to be signed. When using REST, this field must be encoded as base64.
singleHash
Instead of the default double-SHA256 hashing of the message before signing, only use one round of hashing instead.
Annotations
@SerialVersionUID()
final case class SignMessageResponse(signature: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignMessageResponse] with Product with Serializable
signature
The signature for the given message
Annotations
@SerialVersionUID()
trait State extends AnyRef
State service is a always running service that exposes the current state of the wallet and RPC server.
State service is a always running service that exposes the current state of the wallet and RPC server.
Annotations
@PekkoGrpcGenerated()
trait StateClient extends State with StateClientPowerApi with PekkoGrpcClient
Annotations
@PekkoGrpcGenerated()
trait StateClientPowerApi extends AnyRef
Annotations
@PekkoGrpcGenerated()
final case class StopRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StopRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class StopResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StopResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class StreamAuth(methodFullUri: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StreamAuth] with Product with Serializable
methodFullUri
The full URI (in the format /<rpcpackage>.<ServiceName>/MethodName, for example /lnrpc.Lightning/GetInfo) of the streaming RPC method that was just established.
Annotations
@SerialVersionUID()
final case class SubscribeCustomMessagesRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SubscribeCustomMessagesRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class SubscribeStateRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SubscribeStateRequest] with Product with Serializable
Annotations
@SerialVersionUID()
final case class SubscribeStateResponse(state: WalletState = lnrpc.WalletState.NON_EXISTING, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SubscribeStateResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class TimestampedError(timestamp: UInt64 = lnrpc.TimestampedError._typemapper_timestamp.toCustom(0L), error: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TimestampedError] with Product with Serializable
timestamp
The unix timestamp in seconds when the error occurred.
error
The string representation of the error sent by our peer.
Annotations
@SerialVersionUID()
final case class Transaction(txHash: String = "", amount: Long = 0L, numConfirmations: Int = 0, blockHash: String = "", blockHeight: Int = 0, timeStamp: Long = 0L, totalFees: Long = 0L, destAddresses: Seq[String] = _root_.scala.Seq.empty, outputDetails: Seq[OutputDetail] = _root_.scala.Seq.empty, rawTxHex: String = "", label: String = "", previousOutpoints: Seq[PreviousOutPoint] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Transaction] with Product with Serializable
txHash
The transaction hash
amount
The transaction amount, denominated in satoshis
numConfirmations
The number of confirmations
blockHash
The hash of the block this transaction was included in
blockHeight
The height of the block this transaction was included in
timeStamp
Timestamp of this transaction
totalFees
Fees paid for this transaction
destAddresses
Addresses that received funds for this transaction. Deprecated as it is now incorporated in the output_details field.
outputDetails
Outputs that received funds for this transaction
rawTxHex
The raw transaction hex.
label
A label that was optionally set on transaction broadcast.
previousOutpoints
PreviousOutpoints/Inputs of this transaction.
Annotations
@SerialVersionUID()
final case class TransactionDetails(transactions: Seq[Transaction] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TransactionDetails] with Product with Serializable
transactions
The list of transactions relevant to the wallet.
Annotations
@SerialVersionUID()
final case class UnlockWalletRequest(walletPassword: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, recoveryWindow: Int = 0, channelBackups: Option[ChanBackupSnapshot] = _root_.scala.None, statelessInit: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UnlockWalletRequest] with Product with Serializable
walletPassword
wallet_password should be the current valid passphrase for the daemon. This will be required to decrypt on-disk material that the daemon requires to function properly. When using REST, this field must be encoded as base64.
recoveryWindow
recovery_window is an optional argument specifying the address lookahead when restoring a wallet seed. The recovery window applies to each individual branch of the BIP44 derivation paths. Supplying a recovery window of zero indicates that no addresses should be recovered, such after the first initialization of the wallet.
channelBackups
channel_backups is an optional argument that allows clients to recover the settled funds within a set of channels. This should be populated if the user was unable to close out all channels and sweep funds before partial or total data loss occurred. If specified, then after on-chain recovery of funds, lnd begin to carry out the data loss recovery protocol in order to recover the funds in each channel from a remote force closed transaction.
statelessInit
stateless_init is an optional argument instructing the daemon NOT to create any *.macaroon files in its file system.
Annotations
@SerialVersionUID()
final case class UnlockWalletResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UnlockWalletResponse] with Product with Serializable
Annotations
@SerialVersionUID()
sealed abstract class UpdateFailure extends GeneratedEnum
final case class Utxo(addressType: AddressType = lnrpc.AddressType.WITNESS_PUBKEY_HASH, address: String = "", amountSat: Long = 0L, pkScript: String = "", outpoint: Option[OutPoint] = _root_.scala.None, confirmations: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Utxo] with Product with Serializable
addressType
The type of address
address
The address
amountSat
The value of the unspent coin in satoshis
pkScript
The pkscript in hex
outpoint
The outpoint in format txid:n
confirmations
The number of confirmations for the Utxo
Annotations
@SerialVersionUID()
final case class VerifyChanBackupResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[VerifyChanBackupResponse] with Product with Serializable
Annotations
@SerialVersionUID()
final case class VerifyMessageRequest(msg: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, signature: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[VerifyMessageRequest] with Product with Serializable
msg
The message over which the signature is to be verified. When using REST, this field must be encoded as base64.
signature
The signature to be verified over the given message
Annotations
@SerialVersionUID()
final case class VerifyMessageResponse(valid: Boolean = false, pubkey: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[VerifyMessageResponse] with Product with Serializable
valid
Whether the signature was valid over the given message
pubkey
The pubkey recovered from the signature
Annotations
@SerialVersionUID()
final case class WalletAccountBalance(confirmedBalance: Long = 0L, unconfirmedBalance: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[WalletAccountBalance] with Product with Serializable
confirmedBalance
The confirmed balance of the account (with >= 1 confirmations).
unconfirmedBalance
The unconfirmed balance of the account (with 0 confirmations).
Annotations
@SerialVersionUID()
final case class WalletBalanceRequest(account: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[WalletBalanceRequest] with Product with Serializable
account
The wallet account the balance is shown for. If this is not specified, the balance of the "default" account is shown.
Annotations
@SerialVersionUID()
final case class WalletBalanceResponse(totalBalance: Long = 0L, confirmedBalance: Long = 0L, unconfirmedBalance: Long = 0L, lockedBalance: Long = 0L, reservedBalanceAnchorChan: Long = 0L, accountBalance: Map[String, WalletAccountBalance] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[WalletBalanceResponse] with Product with Serializable
totalBalance
The balance of the wallet
confirmedBalance
The confirmed balance of a wallet(with >= 1 confirmations)
unconfirmedBalance
The unconfirmed balance of a wallet(with 0 confirmations)
lockedBalance
The total amount of wallet UTXOs held in outputs that are locked for other usage.
reservedBalanceAnchorChan
The amount of reserve required.
accountBalance
A mapping of each wallet account's name to its balance.
Annotations
@SerialVersionUID()
sealed abstract class WalletState extends GeneratedEnum
trait WalletUnlocker extends AnyRef
WalletUnlocker is a service that is used to set up a wallet password for lnd at first startup, and unlock a previously set up wallet.
WalletUnlocker is a service that is used to set up a wallet password for lnd at first startup, and unlock a previously set up wallet.
Annotations
@PekkoGrpcGenerated()
trait WalletUnlockerClient extends WalletUnlocker with WalletUnlockerClientPowerApi with PekkoGrpcClient
Annotations
@PekkoGrpcGenerated()
trait WalletUnlockerClientPowerApi extends AnyRef
Annotations
@PekkoGrpcGenerated()
final case class WatchOnly(masterKeyBirthdayTimestamp: UInt64 = lnrpc.WatchOnly._typemapper_masterKeyBirthdayTimestamp.toCustom(0L), masterKeyFingerprint: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, accounts: Seq[WatchOnlyAccount] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[WatchOnly] with Product with Serializable
masterKeyBirthdayTimestamp
The unix timestamp in seconds of when the master key was created. lnd will only start scanning for funds in blocks that are after the birthday which can speed up the process significantly. If the birthday is not known, this should be left at its default value of 0 in which case lnd will start scanning from the first SegWit block (481824 on mainnet).
masterKeyFingerprint
The fingerprint of the root key (also known as the key with derivation path m/) from which the account public keys were derived from. This may be required by some hardware wallets for proper identification and signing. The bytes must be in big-endian order.
accounts
The list of accounts to import. There _must_ be an account for all of lnd's main key scopes: BIP49/BIP84 (m/49'/0'/0', m/84'/0'/0', note that the coin type is always 0, even for testnet/regtest) and lnd's internal key scope (m/1017'/<coin_type>'/<account>'), where account is the key family as defined in keychain/derivation.go (currently indices 0 to 9).
Annotations
@SerialVersionUID()
final case class WatchOnlyAccount(purpose: UInt32 = lnrpc.WatchOnlyAccount._typemapper_purpose.toCustom(0), coinType: UInt32 = lnrpc.WatchOnlyAccount._typemapper_coinType.toCustom(0), account: UInt32 = lnrpc.WatchOnlyAccount._typemapper_account.toCustom(0), xpub: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[WatchOnlyAccount] with Product with Serializable
purpose
Purpose is the first number in the derivation path, must be either 49, 84 or 1017.
coinType
Coin type is the second number in the derivation path, this is _always_ 0 for purposes 49 and 84. It only needs to be set to 1 for purpose 1017 on testnet or regtest.
account
Account is the third number in the derivation path. For purposes 49 and 84 at least the default account (index 0) needs to be created but optional additional accounts are allowed. For purpose 1017 there needs to be exactly one account for each of the key families defined in keychain/derivation.go (currently indices 0 to 9)
xpub
The extended public key at depth 3 for the given account.
Annotations
@SerialVersionUID()

Value Members

object AMP extends GeneratedMessageCompanion[AMP]
object AMPInvoiceState extends GeneratedMessageCompanion[AMPInvoiceState]
object AMPRecord extends GeneratedMessageCompanion[AMPRecord]
object AbandonChannelRequest extends GeneratedMessageCompanion[AbandonChannelRequest]
object AbandonChannelResponse extends GeneratedMessageCompanion[AbandonChannelResponse]
object AddInvoiceResponse extends GeneratedMessageCompanion[AddInvoiceResponse]
object AddressType extends GeneratedEnumCompanion[AddressType]
object AliasMap extends GeneratedMessageCompanion[AliasMap]
object Amount extends GeneratedMessageCompanion[Amount]
object BakeMacaroonRequest extends GeneratedMessageCompanion[BakeMacaroonRequest]
object BakeMacaroonResponse extends GeneratedMessageCompanion[BakeMacaroonResponse]
object BatchOpenChannel extends GeneratedMessageCompanion[BatchOpenChannel]
object BatchOpenChannelRequest extends GeneratedMessageCompanion[BatchOpenChannelRequest]
object BatchOpenChannelResponse extends GeneratedMessageCompanion[BatchOpenChannelResponse]
object Chain extends GeneratedMessageCompanion[Chain]
object ChanBackupExportRequest extends GeneratedMessageCompanion[ChanBackupExportRequest]
object ChanBackupSnapshot extends GeneratedMessageCompanion[ChanBackupSnapshot]
object ChanInfoRequest extends GeneratedMessageCompanion[ChanInfoRequest]
object ChanPointShim extends GeneratedMessageCompanion[ChanPointShim]
object ChangePasswordRequest extends GeneratedMessageCompanion[ChangePasswordRequest]
object ChangePasswordResponse extends GeneratedMessageCompanion[ChangePasswordResponse]
object Channel extends GeneratedMessageCompanion[Channel]
object ChannelAcceptRequest extends GeneratedMessageCompanion[ChannelAcceptRequest]
object ChannelAcceptResponse extends GeneratedMessageCompanion[ChannelAcceptResponse]
object ChannelBackup extends GeneratedMessageCompanion[ChannelBackup]
object ChannelBackupSubscription extends GeneratedMessageCompanion[ChannelBackupSubscription]
object ChannelBackups extends GeneratedMessageCompanion[ChannelBackups]
object ChannelBalanceRequest extends GeneratedMessageCompanion[ChannelBalanceRequest]
object ChannelBalanceResponse extends GeneratedMessageCompanion[ChannelBalanceResponse]
object ChannelCloseSummary extends GeneratedMessageCompanion[ChannelCloseSummary]
object ChannelCloseUpdate extends GeneratedMessageCompanion[ChannelCloseUpdate]
object ChannelConstraints extends GeneratedMessageCompanion[ChannelConstraints]
object ChannelEdge extends GeneratedMessageCompanion[ChannelEdge]
object ChannelEdgeUpdate extends GeneratedMessageCompanion[ChannelEdgeUpdate]
object ChannelEventSubscription extends GeneratedMessageCompanion[ChannelEventSubscription]
object ChannelEventUpdate extends GeneratedMessageCompanion[ChannelEventUpdate]
object ChannelFeeReport extends GeneratedMessageCompanion[ChannelFeeReport]
object ChannelGraph extends GeneratedMessageCompanion[ChannelGraph]
object ChannelGraphRequest extends GeneratedMessageCompanion[ChannelGraphRequest]
object ChannelOpenUpdate extends GeneratedMessageCompanion[ChannelOpenUpdate]
object ChannelPoint extends GeneratedMessageCompanion[ChannelPoint]
object ChannelUpdate extends GeneratedMessageCompanion[ChannelUpdate]
object CheckMacPermRequest extends GeneratedMessageCompanion[CheckMacPermRequest]
object CheckMacPermResponse extends GeneratedMessageCompanion[CheckMacPermResponse]
object CloseChannelRequest extends GeneratedMessageCompanion[CloseChannelRequest]
object CloseStatusUpdate extends GeneratedMessageCompanion[CloseStatusUpdate]
object ClosedChannelUpdate extends GeneratedMessageCompanion[ClosedChannelUpdate]
object ClosedChannelsRequest extends GeneratedMessageCompanion[ClosedChannelsRequest]
object ClosedChannelsResponse extends GeneratedMessageCompanion[ClosedChannelsResponse]
object CommitmentType extends GeneratedEnumCompanion[CommitmentType]
object ConfirmationUpdate extends GeneratedMessageCompanion[ConfirmationUpdate]
object ConnectPeerRequest extends GeneratedMessageCompanion[ConnectPeerRequest]
object ConnectPeerResponse extends GeneratedMessageCompanion[ConnectPeerResponse]
object CustomMessage extends GeneratedMessageCompanion[CustomMessage]
object DebugLevelRequest extends GeneratedMessageCompanion[DebugLevelRequest]
object DebugLevelResponse extends GeneratedMessageCompanion[DebugLevelResponse]
object DeleteAllPaymentsRequest extends GeneratedMessageCompanion[DeleteAllPaymentsRequest]
object DeleteAllPaymentsResponse extends GeneratedMessageCompanion[DeleteAllPaymentsResponse]
object DeleteMacaroonIDRequest extends GeneratedMessageCompanion[DeleteMacaroonIDRequest]
object DeleteMacaroonIDResponse extends GeneratedMessageCompanion[DeleteMacaroonIDResponse]
object DeletePaymentRequest extends GeneratedMessageCompanion[DeletePaymentRequest]
object DeletePaymentResponse extends GeneratedMessageCompanion[DeletePaymentResponse]
object DisconnectPeerRequest extends GeneratedMessageCompanion[DisconnectPeerRequest]
object DisconnectPeerResponse extends GeneratedMessageCompanion[DisconnectPeerResponse]
object EdgeLocator extends GeneratedMessageCompanion[EdgeLocator]
object EstimateFeeRequest extends GeneratedMessageCompanion[EstimateFeeRequest]
object EstimateFeeResponse extends GeneratedMessageCompanion[EstimateFeeResponse]
object ExportChannelBackupRequest extends GeneratedMessageCompanion[ExportChannelBackupRequest]
object FailedUpdate extends GeneratedMessageCompanion[FailedUpdate]
object Failure extends GeneratedMessageCompanion[Failure]
object Feature extends GeneratedMessageCompanion[Feature]
object FeatureBit extends GeneratedEnumCompanion[FeatureBit]
object FeeLimit extends GeneratedMessageCompanion[FeeLimit]
object FeeReportRequest extends GeneratedMessageCompanion[FeeReportRequest]
object FeeReportResponse extends GeneratedMessageCompanion[FeeReportResponse]
object FloatMetric extends GeneratedMessageCompanion[FloatMetric]
object ForwardingEvent extends GeneratedMessageCompanion[ForwardingEvent]
object ForwardingHistoryRequest extends GeneratedMessageCompanion[ForwardingHistoryRequest]
object ForwardingHistoryResponse extends GeneratedMessageCompanion[ForwardingHistoryResponse]
object FundingPsbtFinalize extends GeneratedMessageCompanion[FundingPsbtFinalize]
object FundingPsbtVerify extends GeneratedMessageCompanion[FundingPsbtVerify]
object FundingShim extends GeneratedMessageCompanion[FundingShim]
object FundingShimCancel extends GeneratedMessageCompanion[FundingShimCancel]
object FundingStateStepResp extends GeneratedMessageCompanion[FundingStateStepResp]
object FundingTransitionMsg extends GeneratedMessageCompanion[FundingTransitionMsg]
object GenSeedRequest extends GeneratedMessageCompanion[GenSeedRequest]
object GenSeedResponse extends GeneratedMessageCompanion[GenSeedResponse]
object GetInfoRequest extends GeneratedMessageCompanion[GetInfoRequest]
object GetInfoResponse extends GeneratedMessageCompanion[GetInfoResponse]
object GetRecoveryInfoRequest extends GeneratedMessageCompanion[GetRecoveryInfoRequest]
object GetRecoveryInfoResponse extends GeneratedMessageCompanion[GetRecoveryInfoResponse]
object GetStateRequest extends GeneratedMessageCompanion[GetStateRequest]
object GetStateResponse extends GeneratedMessageCompanion[GetStateResponse]
object GetTransactionsRequest extends GeneratedMessageCompanion[GetTransactionsRequest]
object GraphTopologySubscription extends GeneratedMessageCompanion[GraphTopologySubscription]
object GraphTopologyUpdate extends GeneratedMessageCompanion[GraphTopologyUpdate]
object HTLC extends GeneratedMessageCompanion[HTLC]
object HTLCAttempt extends GeneratedMessageCompanion[HTLCAttempt]
object Hop extends GeneratedMessageCompanion[Hop]
object HopHint extends GeneratedMessageCompanion[HopHint]
object InitWalletRequest extends GeneratedMessageCompanion[InitWalletRequest]
object InitWalletResponse extends GeneratedMessageCompanion[InitWalletResponse]
object Initiator extends GeneratedEnumCompanion[Initiator]
object InterceptFeedback extends GeneratedMessageCompanion[InterceptFeedback]
object Invoice extends GeneratedMessageCompanion[Invoice]
object InvoiceHTLC extends GeneratedMessageCompanion[InvoiceHTLC]
object InvoiceHTLCState extends GeneratedEnumCompanion[InvoiceHTLCState]
object InvoiceSubscription extends GeneratedMessageCompanion[InvoiceSubscription]
object KeyDescriptor extends GeneratedMessageCompanion[KeyDescriptor]
object KeyLocator extends GeneratedMessageCompanion[KeyLocator]
object Lightning extends ServiceDescription
Annotations
@PekkoGrpcGenerated()
object LightningAddress extends GeneratedMessageCompanion[LightningAddress]
object LightningClient
Annotations
@PekkoGrpcGenerated()
object LightningHandler
Annotations
@ApiMayChange() @PekkoGrpcGenerated()
object LightningNode extends GeneratedMessageCompanion[LightningNode]
object LightningProto extends GeneratedFileObject
object ListAliasesRequest extends GeneratedMessageCompanion[ListAliasesRequest]
object ListAliasesResponse extends GeneratedMessageCompanion[ListAliasesResponse]
object ListChannelsRequest extends GeneratedMessageCompanion[ListChannelsRequest]
object ListChannelsResponse extends GeneratedMessageCompanion[ListChannelsResponse]
object ListInvoiceRequest extends GeneratedMessageCompanion[ListInvoiceRequest]
object ListInvoiceResponse extends GeneratedMessageCompanion[ListInvoiceResponse]
object ListMacaroonIDsRequest extends GeneratedMessageCompanion[ListMacaroonIDsRequest]
object ListMacaroonIDsResponse extends GeneratedMessageCompanion[ListMacaroonIDsResponse]
object ListPaymentsRequest extends GeneratedMessageCompanion[ListPaymentsRequest]
object ListPaymentsResponse extends GeneratedMessageCompanion[ListPaymentsResponse]
object ListPeersRequest extends GeneratedMessageCompanion[ListPeersRequest]
object ListPeersResponse extends GeneratedMessageCompanion[ListPeersResponse]
object ListPermissionsRequest extends GeneratedMessageCompanion[ListPermissionsRequest]
object ListPermissionsResponse extends GeneratedMessageCompanion[ListPermissionsResponse]
object ListUnspentRequest extends GeneratedMessageCompanion[ListUnspentRequest]
object ListUnspentResponse extends GeneratedMessageCompanion[ListUnspentResponse]
object LookupHtlcResolutionRequest extends GeneratedMessageCompanion[LookupHtlcResolutionRequest]
object LookupHtlcResolutionResponse extends GeneratedMessageCompanion[LookupHtlcResolutionResponse]
object MPPRecord extends GeneratedMessageCompanion[MPPRecord]
object MacaroonId extends GeneratedMessageCompanion[MacaroonId]
object MacaroonPermission extends GeneratedMessageCompanion[MacaroonPermission]
object MacaroonPermissionList extends GeneratedMessageCompanion[MacaroonPermissionList]
object MiddlewareRegistration extends GeneratedMessageCompanion[MiddlewareRegistration]
object MultiChanBackup extends GeneratedMessageCompanion[MultiChanBackup]
object NetworkInfo extends GeneratedMessageCompanion[NetworkInfo]
object NetworkInfoRequest extends GeneratedMessageCompanion[NetworkInfoRequest]
object NewAddressRequest extends GeneratedMessageCompanion[NewAddressRequest]
object NewAddressResponse extends GeneratedMessageCompanion[NewAddressResponse]
object NodeAddress extends GeneratedMessageCompanion[NodeAddress]
object NodeInfo extends GeneratedMessageCompanion[NodeInfo]
object NodeInfoRequest extends GeneratedMessageCompanion[NodeInfoRequest]
object NodeMetricType extends GeneratedEnumCompanion[NodeMetricType]
object NodeMetricsRequest extends GeneratedMessageCompanion[NodeMetricsRequest]
object NodeMetricsResponse extends GeneratedMessageCompanion[NodeMetricsResponse]
object NodePair extends GeneratedMessageCompanion[NodePair]
object NodeUpdate extends GeneratedMessageCompanion[NodeUpdate]
object Op extends GeneratedMessageCompanion[Op]
object OpenChannelRequest extends GeneratedMessageCompanion[OpenChannelRequest]
object OpenStatusUpdate extends GeneratedMessageCompanion[OpenStatusUpdate]
object OutPoint extends GeneratedMessageCompanion[OutPoint]
object OutputDetail extends GeneratedMessageCompanion[OutputDetail]
object OutputScriptType extends GeneratedEnumCompanion[OutputScriptType]
object PayReq extends GeneratedMessageCompanion[PayReq]
object PayReqString extends GeneratedMessageCompanion[PayReqString]
object Payment extends GeneratedMessageCompanion[Payment]
object PaymentFailureReason extends GeneratedEnumCompanion[PaymentFailureReason]
object PaymentHash extends GeneratedMessageCompanion[PaymentHash]
object Peer extends GeneratedMessageCompanion[Peer]
object PeerEvent extends GeneratedMessageCompanion[PeerEvent]
object PeerEventSubscription extends GeneratedMessageCompanion[PeerEventSubscription]
object PendingChannelsRequest extends GeneratedMessageCompanion[PendingChannelsRequest]
object PendingChannelsResponse extends GeneratedMessageCompanion[PendingChannelsResponse]
object PendingHTLC extends GeneratedMessageCompanion[PendingHTLC]
object PendingUpdate extends GeneratedMessageCompanion[PendingUpdate]
object PolicyUpdateRequest extends GeneratedMessageCompanion[PolicyUpdateRequest]
object PolicyUpdateResponse extends GeneratedMessageCompanion[PolicyUpdateResponse]
object PreviousOutPoint extends GeneratedMessageCompanion[PreviousOutPoint]
object PsbtShim extends GeneratedMessageCompanion[PsbtShim]
object QueryRoutesRequest extends GeneratedMessageCompanion[QueryRoutesRequest]
object QueryRoutesResponse extends GeneratedMessageCompanion[QueryRoutesResponse]
object RPCMessage extends GeneratedMessageCompanion[RPCMessage]
object RPCMiddlewareRequest extends GeneratedMessageCompanion[RPCMiddlewareRequest]
object RPCMiddlewareResponse extends GeneratedMessageCompanion[RPCMiddlewareResponse]
object ReadyForPsbtFunding extends GeneratedMessageCompanion[ReadyForPsbtFunding]
object Resolution extends GeneratedMessageCompanion[Resolution]
object ResolutionOutcome extends GeneratedEnumCompanion[ResolutionOutcome]
object ResolutionType extends GeneratedEnumCompanion[ResolutionType]
object RestoreBackupResponse extends GeneratedMessageCompanion[RestoreBackupResponse]
object RestoreChanBackupRequest extends GeneratedMessageCompanion[RestoreChanBackupRequest]
object Route extends GeneratedMessageCompanion[Route]
object RouteHint extends GeneratedMessageCompanion[RouteHint]
object RoutingPolicy extends GeneratedMessageCompanion[RoutingPolicy]
object SendCoinsRequest extends GeneratedMessageCompanion[SendCoinsRequest]
object SendCoinsResponse extends GeneratedMessageCompanion[SendCoinsResponse]
object SendCustomMessageRequest extends GeneratedMessageCompanion[SendCustomMessageRequest]
object SendCustomMessageResponse extends GeneratedMessageCompanion[SendCustomMessageResponse]
object SendManyRequest extends GeneratedMessageCompanion[SendManyRequest]
object SendManyResponse extends GeneratedMessageCompanion[SendManyResponse]
object SendRequest extends GeneratedMessageCompanion[SendRequest]
object SendResponse extends GeneratedMessageCompanion[SendResponse]
object SendToRouteRequest extends GeneratedMessageCompanion[SendToRouteRequest]
object SetID extends GeneratedMessageCompanion[SetID]
object SignMessageRequest extends GeneratedMessageCompanion[SignMessageRequest]
object SignMessageResponse extends GeneratedMessageCompanion[SignMessageResponse]
object State extends ServiceDescription
Annotations
@PekkoGrpcGenerated()
object StateClient
Annotations
@PekkoGrpcGenerated()
object StateHandler
Annotations
@ApiMayChange() @PekkoGrpcGenerated()
object StateserviceProto extends GeneratedFileObject
object StopRequest extends GeneratedMessageCompanion[StopRequest]
object StopResponse extends GeneratedMessageCompanion[StopResponse]
object StreamAuth extends GeneratedMessageCompanion[StreamAuth]
object SubscribeCustomMessagesRequest extends GeneratedMessageCompanion[SubscribeCustomMessagesRequest]
object SubscribeStateRequest extends GeneratedMessageCompanion[SubscribeStateRequest]
object SubscribeStateResponse extends GeneratedMessageCompanion[SubscribeStateResponse]
object TimestampedError extends GeneratedMessageCompanion[TimestampedError]
object Transaction extends GeneratedMessageCompanion[Transaction]
object TransactionDetails extends GeneratedMessageCompanion[TransactionDetails]
object UnlockWalletRequest extends GeneratedMessageCompanion[UnlockWalletRequest]
object UnlockWalletResponse extends GeneratedMessageCompanion[UnlockWalletResponse]
object UpdateFailure extends GeneratedEnumCompanion[UpdateFailure]
object Utxo extends GeneratedMessageCompanion[Utxo]
object VerifyChanBackupResponse extends GeneratedMessageCompanion[VerifyChanBackupResponse]
object VerifyMessageRequest extends GeneratedMessageCompanion[VerifyMessageRequest]
object VerifyMessageResponse extends GeneratedMessageCompanion[VerifyMessageResponse]
object WalletAccountBalance extends GeneratedMessageCompanion[WalletAccountBalance]
object WalletBalanceRequest extends GeneratedMessageCompanion[WalletBalanceRequest]
object WalletBalanceResponse extends GeneratedMessageCompanion[WalletBalanceResponse]
object WalletState extends GeneratedEnumCompanion[WalletState]
object WalletUnlocker extends ServiceDescription
Annotations
@PekkoGrpcGenerated()
object WalletUnlockerClient
Annotations
@PekkoGrpcGenerated()
object WalletUnlockerHandler
Annotations
@ApiMayChange() @PekkoGrpcGenerated()
object WalletunlockerProto extends GeneratedFileObject
object WatchOnly extends GeneratedMessageCompanion[WatchOnly]
object WatchOnlyAccount extends GeneratedMessageCompanion[WatchOnlyAccount]

Packages

lnrpc

package lnrpc

Type Members

Value Members

Ungrouped

Packages

lnrpc

package lnrpc

Type Members

Value Members

Ungrouped

lnrpc