trait WalletKitClient extends WalletKit with WalletKitClientPowerApi with AkkaGrpcClient

Annotations
@AkkaGrpcGenerated()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WalletKitClient
  2. AkkaGrpcClient
  3. WalletKitClientPowerApi
  4. WalletKit
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def bumpFee(in: BumpFeeRequest): Future[BumpFeeResponse]

    BumpFee bumps the fee of an arbitrary input within a transaction.

    BumpFee bumps the fee of an arbitrary input within a transaction. This RPC takes a different approach than bitcoind's bumpfee command. lnd has a central batching engine in which inputs with similar fee rates are batched together to save on transaction fees. Due to this, we cannot rely on bumping the fee on a specific transaction, since transactions can change at any point with the addition of new inputs. The list of inputs that currently exist within lnd's central batching engine can be retrieved through the PendingSweeps RPC. When bumping the fee of an input that currently exists within lnd's central batching engine, a higher fee transaction will be created that replaces the lower fee transaction through the Replace-By-Fee (RBF) policy. If it This RPC also serves useful when wanting to perform a Child-Pays-For-Parent (CPFP), where the child transaction pays for its parent's fee. This can be done by specifying an outpoint within the low fee transaction that is under the control of the wallet. The fee preference can be expressed either as a specific fee rate or a delta of blocks in which the output should be swept on-chain within. If a fee preference is not explicitly specified, then an error is returned. Note that this RPC currently doesn't perform any validation checks on the fee preference being provided. For now, the responsibility of ensuring that the new fee preference is sufficient is delegated to the user.

    Definition Classes
    WalletKit
  2. abstract def close(): Future[Done]
    Definition Classes
    AkkaGrpcClient
  3. abstract def closed: Future[Done]
    Definition Classes
    AkkaGrpcClient
  4. abstract def deriveKey(in: KeyLocator): Future[KeyDescriptor]

    DeriveKey attempts to derive an arbitrary key specified by the passed KeyLocator.

    DeriveKey attempts to derive an arbitrary key specified by the passed KeyLocator.

    Definition Classes
    WalletKit
  5. abstract def deriveNextKey(in: KeyReq): Future[KeyDescriptor]

    DeriveNextKey attempts to derive the *next* key within the key family (account in BIP43) specified.

    DeriveNextKey attempts to derive the *next* key within the key family (account in BIP43) specified. This method should return the next external child within this branch.

    Definition Classes
    WalletKit
  6. abstract def estimateFee(in: EstimateFeeRequest): Future[EstimateFeeResponse]

    EstimateFee attempts to query the internal fee estimator of the wallet to determine the fee (in sat/kw) to attach to a transaction in order to achieve the confirmation target.

    EstimateFee attempts to query the internal fee estimator of the wallet to determine the fee (in sat/kw) to attach to a transaction in order to achieve the confirmation target.

    Definition Classes
    WalletKit
  7. abstract def finalizePsbt(in: FinalizePsbtRequest): Future[FinalizePsbtResponse]

    FinalizePsbt expects a partial transaction with all inputs and outputs fully declared and tries to sign all inputs that belong to the wallet.

    FinalizePsbt expects a partial transaction with all inputs and outputs fully declared and tries to sign all inputs that belong to the wallet. Lnd must be the last signer of the transaction. That means, if there are any unsigned non-witness inputs or inputs without UTXO information attached or inputs without witness data that do not belong to lnd's wallet, this method will fail. If no error is returned, the PSBT is ready to be extracted and the final TX within to be broadcast. NOTE: This method does NOT publish the transaction once finalized. It is the caller's responsibility to either publish the transaction on success or unlock/release any locked UTXOs in case of an error in this method.

    Definition Classes
    WalletKit
  8. abstract def fundPsbt(in: FundPsbtRequest): Future[FundPsbtResponse]

    FundPsbt creates a fully populated PSBT that contains enough inputs to fund the outputs specified in the template.

    FundPsbt creates a fully populated PSBT that contains enough inputs to fund the outputs specified in the template. There are two ways of specifying a template: Either by passing in a PSBT with at least one output declared or by passing in a raw TxTemplate message. If there are no inputs specified in the template, coin selection is performed automatically. If the template does contain any inputs, it is assumed that full coin selection happened externally and no additional inputs are added. If the specified inputs aren't enough to fund the outputs with the given fee rate, an error is returned. After either selecting or verifying the inputs, all input UTXOs are locked with an internal app ID. NOTE: If this method returns without an error, it is the caller's responsibility to either spend the locked UTXOs (by finalizing and then publishing the transaction) or to unlock/release the locked UTXOs in case of an error on the caller's side.

    Definition Classes
    WalletKit
  9. abstract def importAccount(in: ImportAccountRequest): Future[ImportAccountResponse]

    ImportAccount imports an account backed by an account extended public key.

    ImportAccount imports an account backed by an account extended public key. The master key fingerprint denotes the fingerprint of the root key corresponding to the account public key (also known as the key with derivation path m/). This may be required by some hardware wallets for proper identification and signing. The address type can usually be inferred from the key's version, but may be required for certain keys to map them into the proper scope. For BIP-0044 keys, an address type must be specified as we intend to not support importing BIP-0044 keys into the wallet using the legacy pay-to-pubkey-hash (P2PKH) scheme. A nested witness address type will force the standard BIP-0049 derivation scheme, while a witness address type will force the standard BIP-0084 derivation scheme. For BIP-0049 keys, an address type must also be specified to make a distinction between the standard BIP-0049 address schema (nested witness pubkeys everywhere) and our own BIP-0049Plus address schema (nested pubkeys externally, witness pubkeys internally). NOTE: Events (deposits/spends) for keys derived from an account will only be detected by lnd if they happen after the import. Rescans to detect past events will be supported later on.

    Definition Classes
    WalletKit
  10. abstract def importPublicKey(in: ImportPublicKeyRequest): Future[ImportPublicKeyResponse]

    ImportPublicKey imports a public key as watch-only into the wallet.

    ImportPublicKey imports a public key as watch-only into the wallet. NOTE: Events (deposits/spends) for a key will only be detected by lnd if they happen after the import. Rescans to detect past events will be supported later on.

    Definition Classes
    WalletKit
  11. abstract def labelTransaction(in: LabelTransactionRequest): Future[LabelTransactionResponse]

    LabelTransaction adds a label to a transaction.

    LabelTransaction adds a label to a transaction. If the transaction already has a label the call will fail unless the overwrite bool is set. This will overwrite the exiting transaction label. Labels must not be empty, and cannot exceed 500 characters.

    Definition Classes
    WalletKit
  12. abstract def leaseOutput(in: LeaseOutputRequest): Future[LeaseOutputResponse]

    LeaseOutput locks an output to the given ID, preventing it from being available for any future coin selection attempts.

    LeaseOutput locks an output to the given ID, preventing it from being available for any future coin selection attempts. The absolute time of the lock's expiration is returned. The expiration of the lock can be extended by successive invocations of this RPC. Outputs can be unlocked before their expiration through ReleaseOutput.

    Definition Classes
    WalletKit
  13. abstract def listAccounts(in: ListAccountsRequest): Future[ListAccountsResponse]

    ListAccounts retrieves all accounts belonging to the wallet by default.

    ListAccounts retrieves all accounts belonging to the wallet by default. A name and key scope filter can be provided to filter through all of the wallet accounts and return only those matching.

    Definition Classes
    WalletKit
  14. abstract def listLeases(in: ListLeasesRequest): Future[ListLeasesResponse]

    ListLeases lists all currently locked utxos.

    ListLeases lists all currently locked utxos.

    Definition Classes
    WalletKit
  15. abstract def listSweeps(in: ListSweepsRequest): Future[ListSweepsResponse]

    ListSweeps returns a list of the sweep transactions our node has produced.

    ListSweeps returns a list of the sweep transactions our node has produced. Note that these sweeps may not be confirmed yet, as we record sweeps on broadcast, not confirmation.

    Definition Classes
    WalletKit
  16. abstract def listUnspent(in: ListUnspentRequest): Future[ListUnspentResponse]

    ListUnspent returns a list of all utxos spendable by the wallet with a number of confirmations between the specified minimum and maximum.

    ListUnspent returns a list of all utxos spendable by the wallet with a number of confirmations between the specified minimum and maximum. By default, all utxos are listed. To list only the unconfirmed utxos, set the unconfirmed_only to true.

    Definition Classes
    WalletKit
  17. abstract def nextAddr(in: AddrRequest): Future[AddrResponse]

    NextAddr returns the next unused address within the wallet.

    NextAddr returns the next unused address within the wallet.

    Definition Classes
    WalletKit
  18. abstract def pendingSweeps(in: PendingSweepsRequest): Future[PendingSweepsResponse]

    PendingSweeps returns lists of on-chain outputs that lnd is currently attempting to sweep within its central batching engine.

    PendingSweeps returns lists of on-chain outputs that lnd is currently attempting to sweep within its central batching engine. Outputs with similar fee rates are batched together in order to sweep them within a single transaction. NOTE: Some of the fields within PendingSweepsRequest are not guaranteed to remain supported. This is an advanced API that depends on the internals of the UtxoSweeper, so things may change.

    Definition Classes
    WalletKit
  19. abstract def publishTransaction(in: Transaction): Future[PublishResponse]

    PublishTransaction attempts to publish the passed transaction to the network.

    PublishTransaction attempts to publish the passed transaction to the network. Once this returns without an error, the wallet will continually attempt to re-broadcast the transaction on start up, until it enters the chain.

    Definition Classes
    WalletKit
  20. abstract def releaseOutput(in: ReleaseOutputRequest): Future[ReleaseOutputResponse]

    ReleaseOutput unlocks an output, allowing it to be available for coin selection if it remains unspent.

    ReleaseOutput unlocks an output, allowing it to be available for coin selection if it remains unspent. The ID should match the one used to originally lock the output.

    Definition Classes
    WalletKit
  21. abstract def sendOutputs(in: SendOutputsRequest): Future[SendOutputsResponse]

    SendOutputs is similar to the existing sendmany call in Bitcoind, and allows the caller to create a transaction that sends to several outputs at once.

    SendOutputs is similar to the existing sendmany call in Bitcoind, and allows the caller to create a transaction that sends to several outputs at once. This is ideal when wanting to batch create a set of transactions.

    Definition Classes
    WalletKit
  22. abstract def signPsbt(in: SignPsbtRequest): Future[SignPsbtResponse]

    SignPsbt expects a partial transaction with all inputs and outputs fully declared and tries to sign all unsigned inputs that have all required fields (UTXO information, BIP32 derivation information, witness or sig scripts) set.

    SignPsbt expects a partial transaction with all inputs and outputs fully declared and tries to sign all unsigned inputs that have all required fields (UTXO information, BIP32 derivation information, witness or sig scripts) set. If no error is returned, the PSBT is ready to be given to the next signer or to be finalized if lnd was the last signer. NOTE: This RPC only signs inputs (and only those it can sign), it does not perform any other tasks (such as coin selection, UTXO locking or input/output/fee value validation, PSBT finalization). Any input that is incomplete will be skipped.

    Definition Classes
    WalletKit

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def bumpFee(): SingleResponseRequestBuilder[BumpFeeRequest, BumpFeeResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer bumpFee(walletrpc.BumpFeeRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def deriveKey(): SingleResponseRequestBuilder[KeyLocator, KeyDescriptor]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer deriveKey(signrpc.KeyLocator) if possible.

    Definition Classes
    WalletKitClientPowerApi
  8. def deriveNextKey(): SingleResponseRequestBuilder[KeyReq, KeyDescriptor]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer deriveNextKey(walletrpc.KeyReq) if possible.

    Definition Classes
    WalletKitClientPowerApi
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def estimateFee(): SingleResponseRequestBuilder[EstimateFeeRequest, EstimateFeeResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer estimateFee(walletrpc.EstimateFeeRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. def finalizePsbt(): SingleResponseRequestBuilder[FinalizePsbtRequest, FinalizePsbtResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer finalizePsbt(walletrpc.FinalizePsbtRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  14. def fundPsbt(): SingleResponseRequestBuilder[FundPsbtRequest, FundPsbtResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer fundPsbt(walletrpc.FundPsbtRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def importAccount(): SingleResponseRequestBuilder[ImportAccountRequest, ImportAccountResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer importAccount(walletrpc.ImportAccountRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  18. def importPublicKey(): SingleResponseRequestBuilder[ImportPublicKeyRequest, ImportPublicKeyResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer importPublicKey(walletrpc.ImportPublicKeyRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def labelTransaction(): SingleResponseRequestBuilder[LabelTransactionRequest, LabelTransactionResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer labelTransaction(walletrpc.LabelTransactionRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  21. def leaseOutput(): SingleResponseRequestBuilder[LeaseOutputRequest, LeaseOutputResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer leaseOutput(walletrpc.LeaseOutputRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  22. def listAccounts(): SingleResponseRequestBuilder[ListAccountsRequest, ListAccountsResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer listAccounts(walletrpc.ListAccountsRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  23. def listLeases(): SingleResponseRequestBuilder[ListLeasesRequest, ListLeasesResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer listLeases(walletrpc.ListLeasesRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  24. def listSweeps(): SingleResponseRequestBuilder[ListSweepsRequest, ListSweepsResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer listSweeps(walletrpc.ListSweepsRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  25. def listUnspent(): SingleResponseRequestBuilder[ListUnspentRequest, ListUnspentResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer listUnspent(walletrpc.ListUnspentRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def nextAddr(): SingleResponseRequestBuilder[AddrRequest, AddrResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer nextAddr(walletrpc.AddrRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def pendingSweeps(): SingleResponseRequestBuilder[PendingSweepsRequest, PendingSweepsResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer pendingSweeps(walletrpc.PendingSweepsRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  31. def publishTransaction(): SingleResponseRequestBuilder[Transaction, PublishResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer publishTransaction(walletrpc.Transaction) if possible.

    Definition Classes
    WalletKitClientPowerApi
  32. def releaseOutput(): SingleResponseRequestBuilder[ReleaseOutputRequest, ReleaseOutputResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer releaseOutput(walletrpc.ReleaseOutputRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  33. def sendOutputs(): SingleResponseRequestBuilder[SendOutputsRequest, SendOutputsResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer sendOutputs(walletrpc.SendOutputsRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  34. def signPsbt(): SingleResponseRequestBuilder[SignPsbtRequest, SignPsbtResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer signPsbt(walletrpc.SignPsbtRequest) if possible.

    Definition Classes
    WalletKitClientPowerApi
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AkkaGrpcClient

Inherited from WalletKit

Inherited from AnyRef

Inherited from Any

Ungrouped