p

walletrpc

package walletrpc

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class AddrRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddrRequest] with Product with Serializable

    No fields, as we always give out a p2wkh address.

    No fields, as we always give out a p2wkh address.

    Annotations
    @SerialVersionUID()
  2. final case class AddrResponse(addr: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddrResponse] with Product with Serializable

    addr

    The address encoded using a bech32 format.

    Annotations
    @SerialVersionUID()
  3. final case class BumpFeeRequest(outpoint: Option[OutPoint] = _root_.scala.None, targetConf: Int = 0, satPerByte: Int = 0, force: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BumpFeeRequest] with Product with Serializable

    outpoint

    The input we're attempting to bump the fee of.

    targetConf

    The target number of blocks that the input should be spent within.

    satPerByte

    The fee rate, expressed in sat/byte, that should be used to spend the input with.

    force

    Whether this input must be force-swept. This means that it is swept even if it has a negative yield.

    Annotations
    @SerialVersionUID()
  4. final case class BumpFeeResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BumpFeeResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  5. final class DefaultWalletKitClient extends WalletKitClient
  6. final case class EstimateFeeRequest(confTarget: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EstimateFeeRequest] with Product with Serializable

    confTarget

    The number of confirmations to shoot for when estimating the fee.

    Annotations
    @SerialVersionUID()
  7. final case class EstimateFeeResponse(satPerKw: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EstimateFeeResponse] with Product with Serializable

    satPerKw

    The amount of satoshis per kw that should be used in order to reach the confirmation target in the request.

    Annotations
    @SerialVersionUID()
  8. final case class FinalizePsbtRequest(fundedPsbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FinalizePsbtRequest] with Product with Serializable

    fundedPsbt

    A PSBT that should be signed and finalized. The PSBT must contain all required inputs, outputs, UTXO data and partial signatures of all other signers.

    Annotations
    @SerialVersionUID()
  9. final case class FinalizePsbtResponse(signedPsbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, rawFinalTx: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FinalizePsbtResponse] with Product with Serializable

    signedPsbt

    The fully signed and finalized transaction in PSBT format.

    rawFinalTx

    The fully signed and finalized transaction in the raw wire format.

    Annotations
    @SerialVersionUID()
  10. final case class FundPsbtRequest(template: Template = walletrpc.FundPsbtRequest.Template.Empty, fees: Fees = walletrpc.FundPsbtRequest.Fees.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundPsbtRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  11. final case class FundPsbtResponse(fundedPsbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, changeOutputIndex: Int = 0, lockedUtxos: Seq[UtxoLease] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundPsbtResponse] with Product with Serializable

    fundedPsbt

    The funded but not yet signed PSBT packet.

    changeOutputIndex

    The index of the added change output or -1 if no change was left over.

    lockedUtxos

    The list of lock leases that were acquired for the inputs in the funded PSBT packet.

    Annotations
    @SerialVersionUID()
  12. final case class KeyReq(keyFingerPrint: Int = 0, keyFamily: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[KeyReq] with Product with Serializable

    keyFingerPrint

    Is the key finger print of the root pubkey that this request is targeting. This allows the WalletKit to possibly serve out keys for multiple HD chains via public derivation.

    keyFamily

    The target key family to derive a key from. In other contexts, this is known as the "account".

    Annotations
    @SerialVersionUID()
  13. final case class LabelTransactionRequest(txid: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, label: String = "", overwrite: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LabelTransactionRequest] with Product with Serializable

    txid

    The txid of the transaction to label.

    label

    The label to add to the transaction, limited to 500 characters.

    overwrite

    Whether to overwrite the existing label, if it is present.

    Annotations
    @SerialVersionUID()
  14. final case class LabelTransactionResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LabelTransactionResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  15. final case class LeaseOutputRequest(id: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, outpoint: Option[OutPoint] = _root_.scala.None, expirationSeconds: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LeaseOutputRequest] with Product with Serializable

    id

    An ID of 32 random bytes that must be unique for each distinct application using this RPC which will be used to bound the output lease to.

    outpoint

    The identifying outpoint of the output being leased.

    expirationSeconds

    The time in seconds before the lock expires. If set to zero, the default lock duration is used.

    Annotations
    @SerialVersionUID()
  16. final case class LeaseOutputResponse(expiration: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LeaseOutputResponse] with Product with Serializable

    expiration

    The absolute expiration of the output lease represented as a unix timestamp.

    Annotations
    @SerialVersionUID()
  17. final case class ListLeasesRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListLeasesRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  18. final case class ListLeasesResponse(lockedUtxos: Seq[UtxoLease] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListLeasesResponse] with Product with Serializable

    lockedUtxos

    The list of currently leased utxos.

    Annotations
    @SerialVersionUID()
  19. final case class ListSweepsRequest(verbose: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSweepsRequest] with Product with Serializable

    verbose

    Retrieve the full sweep transaction details. If false, only the sweep txids will be returned. Note that some sweeps that LND publishes will have been replaced-by-fee, so will not be included in this output.

    Annotations
    @SerialVersionUID()
  20. final case class ListSweepsResponse(sweeps: Sweeps = walletrpc.ListSweepsResponse.Sweeps.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSweepsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  21. final case class ListUnspentRequest(minConfs: Int = 0, maxConfs: Int = 0, 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.

    Annotations
    @SerialVersionUID()
  22. 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 satisfying the specified number of confirmations.

    Annotations
    @SerialVersionUID()
  23. final case class PendingSweep(outpoint: Option[OutPoint] = _root_.scala.None, witnessType: WitnessType = walletrpc.WitnessType.UNKNOWN_WITNESS, amountSat: Int = 0, satPerByte: Int = 0, broadcastAttempts: Int = 0, nextBroadcastHeight: Int = 0, requestedConfTarget: Int = 0, requestedSatPerByte: Int = 0, force: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PendingSweep] with Product with Serializable

    outpoint

    The outpoint of the output we're attempting to sweep.

    witnessType

    The witness type of the output we're attempting to sweep.

    amountSat

    The value of the output we're attempting to sweep.

    satPerByte

    The fee rate we'll use to sweep the output. The fee rate is only determined once a sweeping transaction for the output is created, so it's possible for this to be 0 before this.

    broadcastAttempts

    The number of broadcast attempts we've made to sweep the output.

    nextBroadcastHeight

    The next height of the chain at which we'll attempt to broadcast the sweep transaction of the output.

    requestedConfTarget

    The requested confirmation target for this output.

    requestedSatPerByte

    The requested fee rate, expressed in sat/byte, for this output.

    force

    Whether this input must be force-swept. This means that it is swept even if it has a negative yield.

    Annotations
    @SerialVersionUID()
  24. final case class PendingSweepsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PendingSweepsRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  25. final case class PendingSweepsResponse(pendingSweeps: Seq[PendingSweep] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PendingSweepsResponse] with Product with Serializable

    pendingSweeps

    The set of outputs currently being swept by lnd's central batching engine.

    Annotations
    @SerialVersionUID()
  26. final case class PublishResponse(publishError: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PublishResponse] with Product with Serializable

    publishError

    If blank, then no error occurred and the transaction was successfully published. If not the empty string, then a string representation of the broadcast error. TODO(roasbeef): map to a proper enum type

    Annotations
    @SerialVersionUID()
  27. final case class ReleaseOutputRequest(id: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, outpoint: Option[OutPoint] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ReleaseOutputRequest] with Product with Serializable

    id

    The unique ID that was used to lock the output.

    outpoint

    The identifying outpoint of the output being released.

    Annotations
    @SerialVersionUID()
  28. final case class ReleaseOutputResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ReleaseOutputResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  29. final case class SendOutputsRequest(satPerKw: Long = 0L, outputs: Seq[TxOut] = _root_.scala.Seq.empty, label: String = "", minConfs: Int = 0, spendUnconfirmed: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendOutputsRequest] with Product with Serializable

    satPerKw

    The number of satoshis per kilo weight that should be used when crafting this transaction.

    outputs

    A slice of the outputs that should be created in the transaction produced.

    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()
  30. final case class SendOutputsResponse(rawTx: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SendOutputsResponse] with Product with Serializable

    rawTx

    The serialized transaction sent out on the network.

    Annotations
    @SerialVersionUID()
  31. final case class Transaction(txHex: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, label: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Transaction] with Product with Serializable

    txHex

    The raw serialized transaction.

    label

    An optional label to save with the transaction. Limited to 500 characters.

    Annotations
    @SerialVersionUID()
  32. final case class TxTemplate(inputs: Seq[OutPoint] = _root_.scala.Seq.empty, outputs: Map[String, Long] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TxTemplate] with Product with Serializable

    inputs

    An optional list of inputs to use. Every input must be an UTXO known to the wallet that has not been locked before. The sum of all inputs must be sufficiently greater than the sum of all outputs to pay a miner fee with the fee rate specified in the parent message. If no inputs are specified, coin selection will be performed instead and inputs of sufficient value will be added to the resulting PSBT.

    outputs

    A map of all addresses and the amounts to send to in the funded PSBT.

    Annotations
    @SerialVersionUID()
  33. final case class UtxoLease(id: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, outpoint: Option[OutPoint] = _root_.scala.None, expiration: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UtxoLease] with Product with Serializable

    id

    A 32 byte random ID that identifies the lease.

    outpoint

    The identifying outpoint of the output being leased.

    expiration

    The absolute expiration of the output lease represented as a unix timestamp.

    Annotations
    @SerialVersionUID()
  34. trait WalletKit extends AnyRef

    WalletKit is a service that gives access to the core functionalities of the daemon's wallet.

  35. trait WalletKitClient extends WalletKit with WalletKitClientPowerApi with AkkaGrpcClient
  36. trait WalletKitClientPowerApi extends AnyRef
  37. sealed abstract class WitnessType extends GeneratedEnum

Value Members

  1. object AddrRequest extends GeneratedMessageCompanion[AddrRequest] with Serializable
  2. object AddrResponse extends GeneratedMessageCompanion[AddrResponse] with Serializable
  3. object BumpFeeRequest extends GeneratedMessageCompanion[BumpFeeRequest] with Serializable
  4. object BumpFeeResponse extends GeneratedMessageCompanion[BumpFeeResponse] with Serializable
  5. object DefaultWalletKitClient
  6. object EstimateFeeRequest extends GeneratedMessageCompanion[EstimateFeeRequest] with Serializable
  7. object EstimateFeeResponse extends GeneratedMessageCompanion[EstimateFeeResponse] with Serializable
  8. object FinalizePsbtRequest extends GeneratedMessageCompanion[FinalizePsbtRequest] with Serializable
  9. object FinalizePsbtResponse extends GeneratedMessageCompanion[FinalizePsbtResponse] with Serializable
  10. object FundPsbtRequest extends GeneratedMessageCompanion[FundPsbtRequest] with Serializable
  11. object FundPsbtResponse extends GeneratedMessageCompanion[FundPsbtResponse] with Serializable
  12. object KeyReq extends GeneratedMessageCompanion[KeyReq] with Serializable
  13. object LabelTransactionRequest extends GeneratedMessageCompanion[LabelTransactionRequest] with Serializable
  14. object LabelTransactionResponse extends GeneratedMessageCompanion[LabelTransactionResponse] with Serializable
  15. object LeaseOutputRequest extends GeneratedMessageCompanion[LeaseOutputRequest] with Serializable
  16. object LeaseOutputResponse extends GeneratedMessageCompanion[LeaseOutputResponse] with Serializable
  17. object ListLeasesRequest extends GeneratedMessageCompanion[ListLeasesRequest] with Serializable
  18. object ListLeasesResponse extends GeneratedMessageCompanion[ListLeasesResponse] with Serializable
  19. object ListSweepsRequest extends GeneratedMessageCompanion[ListSweepsRequest] with Serializable
  20. object ListSweepsResponse extends GeneratedMessageCompanion[ListSweepsResponse] with Serializable
  21. object ListUnspentRequest extends GeneratedMessageCompanion[ListUnspentRequest] with Serializable
  22. object ListUnspentResponse extends GeneratedMessageCompanion[ListUnspentResponse] with Serializable
  23. object PendingSweep extends GeneratedMessageCompanion[PendingSweep] with Serializable
  24. object PendingSweepsRequest extends GeneratedMessageCompanion[PendingSweepsRequest] with Serializable
  25. object PendingSweepsResponse extends GeneratedMessageCompanion[PendingSweepsResponse] with Serializable
  26. object PublishResponse extends GeneratedMessageCompanion[PublishResponse] with Serializable
  27. object ReleaseOutputRequest extends GeneratedMessageCompanion[ReleaseOutputRequest] with Serializable
  28. object ReleaseOutputResponse extends GeneratedMessageCompanion[ReleaseOutputResponse] with Serializable
  29. object SendOutputsRequest extends GeneratedMessageCompanion[SendOutputsRequest] with Serializable
  30. object SendOutputsResponse extends GeneratedMessageCompanion[SendOutputsResponse] with Serializable
  31. object Transaction extends GeneratedMessageCompanion[Transaction] with Serializable
  32. object TxTemplate extends GeneratedMessageCompanion[TxTemplate] with Serializable
  33. object UtxoLease extends GeneratedMessageCompanion[UtxoLease] with Serializable
  34. object WalletKit extends ServiceDescription
  35. object WalletKitClient
  36. object WalletKitHandler
    Annotations
    @ApiMayChange()
  37. object WalletkitProto extends GeneratedFileObject
  38. object WitnessType extends GeneratedEnumCompanion[WitnessType] with Serializable

Ungrouped