p

walletrpc

package walletrpc

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Account(name: String = "", addressType: AddressType = walletrpc.AddressType.UNKNOWN, extendedPublicKey: String = "", masterKeyFingerprint: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, derivationPath: String = "", externalKeyCount: Int = 0, internalKeyCount: Int = 0, watchOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Account] with Product with Serializable

    name

    The name used to identify the account.

    addressType

    The type of addresses the account supports.

    extendedPublicKey

    The public key backing the account that all keys are derived from represented as an extended key. This will always be empty for the default imported account in which single public keys are imported into.

    masterKeyFingerprint

    The fingerprint of the root key from which the account public key was derived from. This will always be zero for the default imported account in which single public keys are imported into. The bytes are in big-endian order.

    derivationPath

    The derivation path corresponding to the account public key. This will always be empty for the default imported account in which single public keys are imported into.

    externalKeyCount

    The number of keys derived from the external branch of the account public key. This will always be zero for the default imported account in which single public keys are imported into.

    internalKeyCount

    The number of keys derived from the internal branch of the account public key. This will always be zero for the default imported account in which single public keys are imported into.

    watchOnly

    Whether the wallet stores private keys for the account.

    Annotations
    @SerialVersionUID()
  2. final case class AccountWithAddresses(name: String = "", addressType: AddressType = walletrpc.AddressType.UNKNOWN, derivationPath: String = "", addresses: Seq[AddressProperty] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AccountWithAddresses] with Product with Serializable

    name

    The name used to identify the account.

    addressType

    The type of addresses the account supports.

    derivationPath

    The derivation path corresponding to the account public key. This will always be empty for the default imported account in which single public keys are imported into.

    addresses

    List of address, its type internal/external & balance. Note that the order of addresses will be random and not according to the derivation index, since that information is not stored by the underlying wallet.

    Annotations
    @SerialVersionUID()
  3. final case class AddrRequest(account: String = "", type: AddressType = walletrpc.AddressType.UNKNOWN, change: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddrRequest] with Product with Serializable

    account

    The name of the account to retrieve the next address of. If empty, the default wallet account is used.

    type

    The type of address to derive.

    change

    Whether a change address should be derived.

    Annotations
    @SerialVersionUID()
  4. 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()
  5. final case class AddressProperty(address: String = "", isInternal: Boolean = false, balance: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddressProperty] with Product with Serializable

    address

    The address encoded using the appropriate format depending on the address type (base58, bech32, bech32m). Note that lnd's internal/custom keys for channels and other functionality are derived from the same scope. Since they aren't really used as addresses and will never have an on-chain balance, we'll show the public key instead (only if the show_custom_accounts flag is provided).

    isInternal

    Denotes if the address is a change address.

    balance

    The balance of the address.

    Annotations
    @SerialVersionUID()
  6. sealed abstract class AddressType extends GeneratedEnum
  7. final case class BumpFeeRequest(outpoint: Option[OutPoint] = _root_.scala.None, targetConf: Int = 0, satPerByte: Int = 0, force: Boolean = false, satPerVbyte: Long = 0L, 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

    Deprecated, use sat_per_vbyte. The fee rate, expressed in sat/vbyte, 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.

    satPerVbyte

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

    Annotations
    @SerialVersionUID()
  8. final case class BumpFeeResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BumpFeeResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  9. sealed abstract class ChangeAddressType extends GeneratedEnum

    The possible change address types for default accounts and single imported public keys.

    The possible change address types for default accounts and single imported public keys. By default, P2WPKH will be used. We don't provide the possibility to choose P2PKH as it is a legacy key scope, nor NP2WPKH as no key scope permits to do so. For custom accounts, no change type should be provided as the coin selection key scope will always be used to generate the change address.

  10. 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()
  11. 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()
  12. final case class FinalizePsbtRequest(fundedPsbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, account: String = "", 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.

    account

    The name of the account to finalize the PSBT with. If empty, the default wallet account is used.

    Annotations
    @SerialVersionUID()
  13. 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()
  14. final case class FundPsbtRequest(template: Template = walletrpc.FundPsbtRequest.Template.Empty, fees: Fees = walletrpc.FundPsbtRequest.Fees.Empty, account: String = "", minConfs: Int = 0, spendUnconfirmed: Boolean = false, changeType: ChangeAddressType = walletrpc.ChangeAddressType.CHANGE_ADDRESS_TYPE_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FundPsbtRequest] with Product with Serializable

    account

    The name of the account to fund the PSBT with. If empty, the default wallet account is used.

    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.

    changeType

    The address type for the change. If empty, P2WPKH addresses will be used for default accounts and single imported public keys. For custom accounts, no change type should be provided as the coin selection key scope will always be used to generate the change address.

    Annotations
    @SerialVersionUID()
  15. 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()
  16. final case class ImportAccountRequest(name: String = "", extendedPublicKey: String = "", masterKeyFingerprint: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, addressType: AddressType = walletrpc.AddressType.UNKNOWN, dryRun: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ImportAccountRequest] with Product with Serializable

    name

    A name to identify the account with.

    extendedPublicKey

    A public key that corresponds to a wallet account represented as an extended key. It must conform to a derivation path of the form m/purpose'/coin_type'/account'.

    masterKeyFingerprint

    The fingerprint of the root key (also known as the key with derivation path m/) from which the account public key was derived from. This may be required by some hardware wallets for proper identification and signing. The bytes must be in big-endian order.

    addressType

    An address type is only required when the extended account public key has a legacy version (xpub, tpub, etc.), such that the wallet cannot detect what address scheme it belongs to.

    dryRun

    Whether a dry run should be attempted when importing the account. This serves as a way to confirm whether the account is being imported correctly by returning the first N addresses for the external and internal branches of the account. If these addresses match as expected, then it should be safe to import the account as is.

    Annotations
    @SerialVersionUID()
  17. final case class ImportAccountResponse(account: Option[Account] = _root_.scala.None, dryRunExternalAddrs: Seq[String] = _root_.scala.Seq.empty, dryRunInternalAddrs: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ImportAccountResponse] with Product with Serializable

    account

    The details of the imported account.

    dryRunExternalAddrs

    The first N addresses that belong to the external branch of the account. The external branch is typically used for external non-change addresses. These are only returned if a dry run was specified within the request.

    dryRunInternalAddrs

    The first N addresses that belong to the internal branch of the account. The internal branch is typically used for change addresses. These are only returned if a dry run was specified within the request.

    Annotations
    @SerialVersionUID()
  18. final case class ImportPublicKeyRequest(publicKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, addressType: AddressType = walletrpc.AddressType.UNKNOWN, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ImportPublicKeyRequest] with Product with Serializable

    publicKey

    A compressed public key represented as raw bytes.

    addressType

    The type of address that will be generated from the public key.

    Annotations
    @SerialVersionUID()
  19. final case class ImportPublicKeyResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ImportPublicKeyResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  20. final case class ImportTapscriptRequest(internalPublicKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, script: Script = walletrpc.ImportTapscriptRequest.Script.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ImportTapscriptRequest] with Product with Serializable

    internalPublicKey

    The internal public key, serialized as 32-byte x-only public key.

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

    p2TrAddress

    The resulting pay-to-Taproot address that represents the imported internal key with the script committed to it.

    Annotations
    @SerialVersionUID()
  22. 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()
  23. 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. Note: When using gRPC, the bytes must be in little-endian (reverse) order.

    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()
  24. final case class LabelTransactionResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LabelTransactionResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  25. 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()
  26. 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()
  27. final case class ListAccountsRequest(name: String = "", addressType: AddressType = walletrpc.AddressType.UNKNOWN, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListAccountsRequest] with Product with Serializable

    name

    An optional filter to only return accounts matching this name.

    addressType

    An optional filter to only return accounts matching this address type.

    Annotations
    @SerialVersionUID()
  28. final case class ListAccountsResponse(accounts: Seq[Account] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListAccountsResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  29. final case class ListAddressesRequest(accountName: String = "", showCustomAccounts: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListAddressesRequest] with Product with Serializable

    accountName

    An optional filter to only return addresses matching this account.

    showCustomAccounts

    An optional flag to return LND's custom accounts (Purpose=1017) public key along with other addresses.

    Annotations
    @SerialVersionUID()
  30. final case class ListAddressesResponse(accountWithAddresses: Seq[AccountWithAddresses] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListAddressesResponse] with Product with Serializable

    accountWithAddresses

    A list of all the accounts and their addresses.

    Annotations
    @SerialVersionUID()
  31. final case class ListLeasesRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListLeasesRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  32. 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()
  33. final case class ListSweepsRequest(verbose: Boolean = false, startHeight: Int = 0, 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.

    startHeight

    The start height to use when fetching sweeps. If not specified (0), the result will start from the earliest sweep. If set to -1 the result will only include unconfirmed sweeps (at the time of the call).

    Annotations
    @SerialVersionUID()
  34. 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()
  35. final case class ListUnspentRequest(minConfs: Int = 0, maxConfs: Int = 0, account: String = "", unconfirmedOnly: Boolean = false, 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.

    unconfirmedOnly

    When min_confs and max_confs are zero, setting false implicitly overrides max_confs to be MaxInt32, otherwise max_confs remains zero. An error is returned if the value is true and both min_confs and max_confs are non-zero. (default: false)

    Annotations
    @SerialVersionUID()
  36. 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()
  37. 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, satPerVbyte: Long = 0L, requestedSatPerVbyte: Long = 0L, 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

    Deprecated, use sat_per_vbyte. The fee rate we'll use to sweep the output, expressed in sat/vbyte. 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

    Deprecated, use requested_sat_per_vbyte. The requested fee rate, expressed in sat/vbyte, for this output.

    satPerVbyte

    The fee rate we'll use to sweep the output, expressed in sat/vbyte. 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.

    requestedSatPerVbyte

    The requested fee rate, expressed in sat/vbyte, 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()
  38. final case class PendingSweepsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PendingSweepsRequest] with Product with Serializable
    Annotations
    @SerialVersionUID()
  39. 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()
  40. 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()
  41. 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()
  42. final case class ReleaseOutputResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ReleaseOutputResponse] with Product with Serializable
    Annotations
    @SerialVersionUID()
  43. final case class RequiredReserveRequest(additionalPublicChannels: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RequiredReserveRequest] with Product with Serializable

    additionalPublicChannels

    The number of additional channels the user would like to open.

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

    requiredReserve

    The amount of reserve required.

    Annotations
    @SerialVersionUID()
  45. 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()
  46. 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()
  47. final case class SignMessageWithAddrRequest(msg: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, addr: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignMessageWithAddrRequest] with Product with Serializable

    msg

    The message to be signed. When using REST, this field must be encoded as base64.

    addr

    The address which will be used to look up the private key and sign the corresponding message.

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

    signature

    The compact ECDSA signature for the given message encoded in base64.

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

    fundedPsbt

    The PSBT that should be signed. The PSBT must contain all required inputs, outputs, UTXO data and custom fields required to identify the signing key.

    Annotations
    @SerialVersionUID()
  50. final case class SignPsbtResponse(signedPsbt: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, signedInputs: Seq[Int] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignPsbtResponse] with Product with Serializable

    signedPsbt

    The signed transaction in PSBT format.

    signedInputs

    The indices of signed inputs.

    Annotations
    @SerialVersionUID()
  51. final case class TapLeaf(leafVersion: Int = 0, script: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TapLeaf] with Product with Serializable

    leafVersion

    The leaf version. Should be 0xc0 (192) in case of a SegWit v1 script.

    script

    The script of the tap leaf.

    Annotations
    @SerialVersionUID()
  52. final case class TapscriptFullTree(allLeaves: Seq[TapLeaf] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TapscriptFullTree] with Product with Serializable

    allLeaves

    The complete, ordered list of all tap leaves of the tree.

    Annotations
    @SerialVersionUID()
  53. final case class TapscriptPartialReveal(revealedLeaf: Option[TapLeaf] = _root_.scala.None, fullInclusionProof: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TapscriptPartialReveal] with Product with Serializable

    revealedLeaf

    The tap leaf that is known and will be revealed.

    fullInclusionProof

    The BIP-0341 serialized inclusion proof that is required to prove that the revealed leaf is part of the tree. This contains 0..n blocks of 32 bytes. If the tree only contained a single leaf (which is the revealed leaf), this can be empty.

    Annotations
    @SerialVersionUID()
  54. 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. Despite the field name, this does need to be specified in raw bytes (or base64 encoded when using REST) and not in hex. To not break existing software, the field can't simply be renamed.

    label

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

    Annotations
    @SerialVersionUID()
  55. 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()
  56. final case class UtxoLease(id: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, outpoint: Option[OutPoint] = _root_.scala.None, expiration: Long = 0L, pkScript: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, value: 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.

    pkScript

    The public key script of the leased output.

    value

    The value of the leased output in satoshis.

    Annotations
    @SerialVersionUID()
  57. final case class VerifyMessageWithAddrRequest(msg: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, signature: String = "", addr: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[VerifyMessageWithAddrRequest] with Product with Serializable

    msg

    The message to be signed. When using REST, this field must be encoded as base64.

    signature

    The compact ECDSA signature to be verified over the given message ecoded in base64.

    addr

    The address which will be used to look up the public key and verify the the signature.

    Annotations
    @SerialVersionUID()
  58. final case class VerifyMessageWithAddrResponse(valid: Boolean = false, pubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[VerifyMessageWithAddrResponse] with Product with Serializable

    valid

    Whether the signature was valid over the given message.

    pubkey

    The pubkey recovered from the signature.

    Annotations
    @SerialVersionUID()
  59. trait WalletKit extends AnyRef

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

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

    Annotations
    @PekkoGrpcGenerated()
  60. trait WalletKitClient extends WalletKit with WalletKitClientPowerApi with PekkoGrpcClient
    Annotations
    @PekkoGrpcGenerated()
  61. trait WalletKitClientPowerApi extends AnyRef
    Annotations
    @PekkoGrpcGenerated()
  62. sealed abstract class WitnessType extends GeneratedEnum

Value Members

  1. object Account extends GeneratedMessageCompanion[Account]
  2. object AccountWithAddresses extends GeneratedMessageCompanion[AccountWithAddresses]
  3. object AddrRequest extends GeneratedMessageCompanion[AddrRequest]
  4. object AddrResponse extends GeneratedMessageCompanion[AddrResponse]
  5. object AddressProperty extends GeneratedMessageCompanion[AddressProperty]
  6. object AddressType extends GeneratedEnumCompanion[AddressType]
  7. object BumpFeeRequest extends GeneratedMessageCompanion[BumpFeeRequest]
  8. object BumpFeeResponse extends GeneratedMessageCompanion[BumpFeeResponse]
  9. object ChangeAddressType extends GeneratedEnumCompanion[ChangeAddressType]
  10. object EstimateFeeRequest extends GeneratedMessageCompanion[EstimateFeeRequest]
  11. object EstimateFeeResponse extends GeneratedMessageCompanion[EstimateFeeResponse]
  12. object FinalizePsbtRequest extends GeneratedMessageCompanion[FinalizePsbtRequest]
  13. object FinalizePsbtResponse extends GeneratedMessageCompanion[FinalizePsbtResponse]
  14. object FundPsbtRequest extends GeneratedMessageCompanion[FundPsbtRequest]
  15. object FundPsbtResponse extends GeneratedMessageCompanion[FundPsbtResponse]
  16. object ImportAccountRequest extends GeneratedMessageCompanion[ImportAccountRequest]
  17. object ImportAccountResponse extends GeneratedMessageCompanion[ImportAccountResponse]
  18. object ImportPublicKeyRequest extends GeneratedMessageCompanion[ImportPublicKeyRequest]
  19. object ImportPublicKeyResponse extends GeneratedMessageCompanion[ImportPublicKeyResponse]
  20. object ImportTapscriptRequest extends GeneratedMessageCompanion[ImportTapscriptRequest]
  21. object ImportTapscriptResponse extends GeneratedMessageCompanion[ImportTapscriptResponse]
  22. object KeyReq extends GeneratedMessageCompanion[KeyReq]
  23. object LabelTransactionRequest extends GeneratedMessageCompanion[LabelTransactionRequest]
  24. object LabelTransactionResponse extends GeneratedMessageCompanion[LabelTransactionResponse]
  25. object LeaseOutputRequest extends GeneratedMessageCompanion[LeaseOutputRequest]
  26. object LeaseOutputResponse extends GeneratedMessageCompanion[LeaseOutputResponse]
  27. object ListAccountsRequest extends GeneratedMessageCompanion[ListAccountsRequest]
  28. object ListAccountsResponse extends GeneratedMessageCompanion[ListAccountsResponse]
  29. object ListAddressesRequest extends GeneratedMessageCompanion[ListAddressesRequest]
  30. object ListAddressesResponse extends GeneratedMessageCompanion[ListAddressesResponse]
  31. object ListLeasesRequest extends GeneratedMessageCompanion[ListLeasesRequest]
  32. object ListLeasesResponse extends GeneratedMessageCompanion[ListLeasesResponse]
  33. object ListSweepsRequest extends GeneratedMessageCompanion[ListSweepsRequest]
  34. object ListSweepsResponse extends GeneratedMessageCompanion[ListSweepsResponse]
  35. object ListUnspentRequest extends GeneratedMessageCompanion[ListUnspentRequest]
  36. object ListUnspentResponse extends GeneratedMessageCompanion[ListUnspentResponse]
  37. object PendingSweep extends GeneratedMessageCompanion[PendingSweep]
  38. object PendingSweepsRequest extends GeneratedMessageCompanion[PendingSweepsRequest]
  39. object PendingSweepsResponse extends GeneratedMessageCompanion[PendingSweepsResponse]
  40. object PublishResponse extends GeneratedMessageCompanion[PublishResponse]
  41. object ReleaseOutputRequest extends GeneratedMessageCompanion[ReleaseOutputRequest]
  42. object ReleaseOutputResponse extends GeneratedMessageCompanion[ReleaseOutputResponse]
  43. object RequiredReserveRequest extends GeneratedMessageCompanion[RequiredReserveRequest]
  44. object RequiredReserveResponse extends GeneratedMessageCompanion[RequiredReserveResponse]
  45. object SendOutputsRequest extends GeneratedMessageCompanion[SendOutputsRequest]
  46. object SendOutputsResponse extends GeneratedMessageCompanion[SendOutputsResponse]
  47. object SignMessageWithAddrRequest extends GeneratedMessageCompanion[SignMessageWithAddrRequest]
  48. object SignMessageWithAddrResponse extends GeneratedMessageCompanion[SignMessageWithAddrResponse]
  49. object SignPsbtRequest extends GeneratedMessageCompanion[SignPsbtRequest]
  50. object SignPsbtResponse extends GeneratedMessageCompanion[SignPsbtResponse]
  51. object TapLeaf extends GeneratedMessageCompanion[TapLeaf]
  52. object TapscriptFullTree extends GeneratedMessageCompanion[TapscriptFullTree]
  53. object TapscriptPartialReveal extends GeneratedMessageCompanion[TapscriptPartialReveal]
  54. object Transaction extends GeneratedMessageCompanion[Transaction]
  55. object TxTemplate extends GeneratedMessageCompanion[TxTemplate]
  56. object UtxoLease extends GeneratedMessageCompanion[UtxoLease]
  57. object VerifyMessageWithAddrRequest extends GeneratedMessageCompanion[VerifyMessageWithAddrRequest]
  58. object VerifyMessageWithAddrResponse extends GeneratedMessageCompanion[VerifyMessageWithAddrResponse]
  59. object WalletKit extends ServiceDescription
    Annotations
    @PekkoGrpcGenerated()
  60. object WalletKitClient
    Annotations
    @PekkoGrpcGenerated()
  61. object WalletKitHandler
    Annotations
    @ApiMayChange() @PekkoGrpcGenerated()
  62. object WalletkitProto extends GeneratedFileObject
  63. object WitnessType extends GeneratedEnumCompanion[WitnessType]

Ungrouped