package walletrpc
Get desktop application:
View/edit binary Protocol Buffers messages
service WalletKit
walletkit.proto:12WalletKit is a service that gives access to the core functionalities of the daemon's wallet.
rpc ListUnspent (, )
walletkit.proto:19ListUnspent 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.
message
walletkit.proto:312int32 min_confs = 1
The minimum number of confirmations to be included.
int32 max_confs = 2
The maximum number of confirmations to be included.
string account = 3
An optional filter to only include outputs belonging to an account.
bool unconfirmed_only = 4
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)
message
walletkit.proto:331repeated utxos = 1
A list of utxos satisfying the specified number of confirmations.
rpc LeaseOutput (, )
walletkit.proto:28LeaseOutput 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`.
message
walletkit.proto:336bytes id = 1
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.
optional outpoint = 2
The identifying outpoint of the output being leased.
uint64 expiration_seconds = 3
The time in seconds before the lock expires. If set to zero, the default lock duration is used.
message
walletkit.proto:351uint64 expiration = 1
The absolute expiration of the output lease represented as a unix timestamp.
rpc ReleaseOutput (, )
walletkit.proto:35ReleaseOutput 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.
message
walletkit.proto:358bytes id = 1
The unique ID that was used to lock the output.
optional outpoint = 2
The identifying outpoint of the output being released.
message
walletkit.proto:366(message has no fields)
rpc ListLeases (, )
walletkit.proto:40ListLeases lists all currently locked utxos.
message
walletkit.proto:1239(message has no fields)
message
walletkit.proto:1242repeated locked_utxos = 1
The list of currently leased utxos.
rpc DeriveNextKey (, )
walletkit.proto:47DeriveNextKey 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.
message
walletkit.proto:369int32 key_finger_print = 1
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.
int32 key_family = 2
The target key family to derive a key from. In other contexts, this is known as the "account".
rpc DeriveKey (, )
walletkit.proto:53DeriveKey attempts to derive an arbitrary key specified by the passed KeyLocator.
rpc NextAddr (, )
walletkit.proto:58NextAddr returns the next unused address within the wallet.
message
walletkit.proto:384string account = 1
The name of the account to retrieve the next address of. If empty, the default wallet account is used.
AddressType type = 2
The type of address to derive.
bool change = 3
Whether a change address should be derived.
message
walletkit.proto:401string addr = 1
The address encoded using a bech32 format.
rpc ListAccounts (, )
walletkit.proto:65ListAccounts 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.
message
walletkit.proto:505string name = 1
An optional filter to only return accounts matching this name.
AddressType address_type = 2
An optional filter to only return accounts matching this address type.
message
walletkit.proto:513repeated accounts = 1
rpc RequiredReserve (, )
walletkit.proto:72RequiredReserve returns the minimum amount of satoshis that should be kept in the wallet in order to fee bump anchor channels if necessary. The value scales with the number of public anchor channels but is capped at a maximum.
message
walletkit.proto:517uint32 additional_public_channels = 1
The number of additional channels the user would like to open.
message
walletkit.proto:522int64 required_reserve = 1
The amount of reserve required.
rpc ListAddresses (, )
walletkit.proto:80ListAddresses retrieves all the addresses along with their balance. An account name filter can be provided to filter through all of the wallet accounts and return the addresses of only those matching.
message
walletkit.proto:527string account_name = 1
An optional filter to only return addresses matching this account.
bool show_custom_accounts = 2
An optional flag to return LND's custom accounts (Purpose=1017) public key along with other addresses.
message
walletkit.proto:536repeated account_with_addresses = 1
A list of all the accounts and their addresses.
SignMessageWithAddr returns the compact signature (base64 encoded) created with the private key of the provided address. This requires the address to be solely based on a public key lock (no scripts). Obviously the internal lnd wallet has to possess the private key of the address otherwise an error is returned. This method aims to provide full compatibility with the bitcoin-core and btcd implementation. Bitcoin-core's algorithm is not specified in a BIP and only applicable for legacy addresses. This method enhances the signing for additional address types: P2WKH, NP2WKH, P2TR. For P2TR addresses this represents a special case. ECDSA is used to create a compact signature which makes the public key of the signature recoverable.
message
walletkit.proto:541bytes msg = 1
The message to be signed. When using REST, this field must be encoded as base64.
string addr = 2
The address which will be used to look up the private key and sign the corresponding message.
message
walletkit.proto:551string signature = 1
The compact ECDSA signature for the given message encoded in base64.
VerifyMessageWithAddr returns the validity and the recovered public key of the provided compact signature (base64 encoded). The verification is twofold. First the validity of the signature itself is checked and then it is verified that the recovered public key of the signature equals the public key of the provided address. There is no dependence on the private key of the address therefore also external addresses are allowed to verify signatures. Supported address types are P2PKH, P2WKH, NP2WKH, P2TR. This method is the counterpart of the related signing method (SignMessageWithAddr) and aims to provide full compatibility to bitcoin-core's implementation. Although bitcoin-core/btcd only provide this functionality for legacy addresses this function enhances it to the address types: P2PKH, P2WKH, NP2WKH, P2TR. The verification for P2TR addresses is a special case and requires the ECDSA compact signature to compare the reovered public key to the internal taproot key. The compact ECDSA signature format was used because there are still no known compact signature schemes for schnorr signatures.
message
walletkit.proto:556bytes msg = 1
The message to be signed. When using REST, this field must be encoded as base64.
string signature = 2
The compact ECDSA signature to be verified over the given message ecoded in base64.
string addr = 3
The address which will be used to look up the public key and verify the the signature.
message
walletkit.proto:570bool valid = 1
Whether the signature was valid over the given message.
bytes pubkey = 2
The pubkey recovered from the signature.
rpc ImportAccount (, )
walletkit.proto:148ImportAccount 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.
message
walletkit.proto:578string name = 1
A name to identify the account with.
string extended_public_key = 2
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'.
bytes master_key_fingerprint = 3
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 address_type = 4
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.
bool dry_run = 5
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.
message
walletkit.proto:613optional account = 1
The details of the imported account.
repeated string dry_run_external_addrs = 2
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.
repeated string dry_run_internal_addrs = 3
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.
rpc ImportPublicKey (, )
walletkit.proto:161ImportPublicKey imports a public key as watch-only into the wallet. The public key is converted into a simple address of the given type and that address script is watched on chain. For Taproot keys, this will only watch the BIP-0086 style output script. Use ImportTapscript for more advanced key spend or script spend outputs. 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.
message
walletkit.proto:632bytes public_key = 1
A compressed public key represented as raw bytes.
AddressType address_type = 2
The type of address that will be generated from the public key.
message
walletkit.proto:639(message has no fields)
rpc ImportTapscript (, )
walletkit.proto:177ImportTapscript imports a Taproot script and internal key and adds the resulting Taproot output key as a watch-only output script into the wallet. For BIP-0086 style Taproot keys (no root hash commitment and no script spend path) use ImportPublicKey. 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. NOTE: Taproot keys imported through this RPC currently _cannot_ be used for funding PSBTs. Only tracking the balance and UTXOs is currently supported.
message
walletkit.proto:642bytes internal_public_key = 1
The internal public key, serialized as 32-byte x-only public key.
oneof script
full_tree = 2
The full script tree with all individual leaves is known and the root hash can be constructed from the full tree directly.
partial_reveal = 3
Only a single script leaf is known. To construct the root hash, the full inclusion proof must also be provided.
bytes root_hash_only = 4
Only the root hash of the Taproot script tree (or other form of Taproot commitment) is known.
bool full_key_only = 5
Only the final, tweaked Taproot key is known and no additional information about the internal key or type of tweak that was used to derive it. When this is set, the wallet treats the key in internal_public_key as the Taproot key directly. This can be useful for tracking arbitrary Taproot outputs without the goal of ever being able to spend from them through the internal wallet.
message
walletkit.proto:705string p2tr_address = 1
The resulting pay-to-Taproot address that represents the imported internal key with the script committed to it.
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.
message
walletkit.proto:713bytes tx_hex = 1
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.
string label = 2
An optional label to save with the transaction. Limited to 500 characters.
message
walletkit.proto:726string publish_error = 1
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
rpc SendOutputs (, )
walletkit.proto:193SendOutputs 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.
message
walletkit.proto:737int64 sat_per_kw = 1
The number of satoshis per kilo weight that should be used when crafting this transaction.
repeated outputs = 2
A slice of the outputs that should be created in the transaction produced.
string label = 3
An optional label for the transaction, limited to 500 characters.
int32 min_confs = 4
The minimum number of confirmations each one of your outputs used for the transaction must satisfy.
bool spend_unconfirmed = 5
Whether unconfirmed outputs should be used as inputs for the transaction.
message
walletkit.proto:759bytes raw_tx = 1
The serialized transaction sent out on the network.
rpc EstimateFee (, )
walletkit.proto:200EstimateFee 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.
message
walletkit.proto:766int32 conf_target = 1
The number of confirmations to shoot for when estimating the fee.
message
walletkit.proto:772int64 sat_per_kw = 1
The amount of satoshis per kw that should be used in order to reach the confirmation target in the request.
rpc PendingSweeps (, )
walletkit.proto:212PendingSweeps 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.
message
walletkit.proto:991(message has no fields)
message
walletkit.proto:994repeated pending_sweeps = 1
The set of outputs currently being swept by lnd's central batching engine.
rpc BumpFee (, )
walletkit.proto:241BumpFee 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.
message
walletkit.proto:1001optional outpoint = 1
The input we're attempting to bump the fee of.
uint32 target_conf = 2
The target number of blocks that the input should be spent within.
uint32 sat_per_byte = 3
Deprecated, use sat_per_vbyte. The fee rate, expressed in sat/vbyte, that should be used to spend the input with.
bool force = 4
Whether this input must be force-swept. This means that it is swept even if it has a negative yield.
uint64 sat_per_vbyte = 5
The fee rate, expressed in sat/vbyte, that should be used to spend the input with.
message
walletkit.proto:1028(message has no fields)
rpc ListSweeps (, )
walletkit.proto:248ListSweeps 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.
message
walletkit.proto:1031bool verbose = 1
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.
message
walletkit.proto:1040oneof sweeps
transaction_details = 1
transaction_ids = 2
rpc LabelTransaction (, )
walletkit.proto:256LabelTransaction 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.
message
walletkit.proto:1056bytes txid = 1
The txid of the transaction to label. Note: When using gRPC, the bytes must be in little-endian (reverse) order.
string label = 2
The label to add to the transaction, limited to 500 characters.
bool overwrite = 3
Whether to overwrite the existing label, if it is present.
message
walletkit.proto:1068(message has no fields)
rpc FundPsbt (, )
walletkit.proto:279FundPsbt 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.
message
walletkit.proto:1088oneof template
bytes psbt = 1
Use an existing PSBT packet as the template for the funded PSBT. The packet must contain at least one non-dust output. If one or more inputs are specified, no coin selection is performed. In that case 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 specified fee rate. A change output is added to the PSBT if necessary.
raw = 2
Use the outputs and optional inputs from this raw template.
oneof fees
uint32 target_conf = 3
The target number of blocks that the transaction should be confirmed in.
uint64 sat_per_vbyte = 4
The fee rate, expressed in sat/vbyte, that should be used to spend the input with.
string account = 5
The name of the account to fund the PSBT with. If empty, the default wallet account is used.
int32 min_confs = 6
The minimum number of confirmations each one of your outputs used for the transaction must satisfy.
bool spend_unconfirmed = 7
Whether unconfirmed outputs should be used as inputs for the transaction.
ChangeAddressType change_type = 8
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.
message
walletkit.proto:1140bytes funded_psbt = 1
The funded but not yet signed PSBT packet.
int32 change_output_index = 2
The index of the added change output or -1 if no change was left over.
repeated locked_utxos = 3
The list of lock leases that were acquired for the inputs in the funded PSBT packet.
rpc SignPsbt (, )
walletkit.proto:294SignPsbt 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.
message
walletkit.proto:1201bytes funded_psbt = 1
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.
message
walletkit.proto:1209bytes signed_psbt = 1
The signed transaction in PSBT format.
repeated uint32 signed_inputs = 2
The indices of signed inputs.
rpc FinalizePsbt (, )
walletkit.proto:309FinalizePsbt 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.
message
walletkit.proto:1217bytes funded_psbt = 1
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.
string account = 5
The name of the account to finalize the PSBT with. If empty, the default wallet account is used.
message
walletkit.proto:1231bytes signed_psbt = 1
The fully signed and finalized transaction in PSBT format.
bytes raw_final_tx = 2
The fully signed and finalized transaction in the raw wire format.
message
walletkit.proto:415Used in: ,
string name = 1
The name used to identify the account.
AddressType address_type = 2
The type of addresses the account supports.
string extended_public_key = 3
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.
bytes master_key_fingerprint = 4
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.
string derivation_path = 5
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.
uint32 external_key_count = 6
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.
uint32 internal_key_count = 7
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.
bool watch_only = 8
Whether the wallet stores private keys for the account.
message
walletkit.proto:482Used in:
string name = 1
The name used to identify the account.
AddressType address_type = 2
The type of addresses the account supports.
string derivation_path = 3
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.
repeated addresses = 4
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.
message
walletkit.proto:462Used in:
string address = 1
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).
bool is_internal = 2
Denotes if the address is a change address.
int64 balance = 3
The balance of the address.
Used in: , , , , ,
UNKNOWN = 0
WITNESS_PUBKEY_HASH = 1
NESTED_WITNESS_PUBKEY_HASH = 2
HYBRID_NESTED_WITNESS_PUBKEY_HASH = 3
TAPROOT_PUBKEY = 4
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.
Used in:
CHANGE_ADDRESS_TYPE_UNSPECIFIED = 0
CHANGE_ADDRESS_TYPE_UNSPECIFIED indicates that no change address type is provided. We will then use P2WPKH address type for change (BIP0084 key scope).
CHANGE_ADDRESS_TYPE_P2TR = 1
CHANGE_ADDRESS_TYPE_P2TR indicates to use P2TR address for change output (BIP0086 key scope).
message
walletkit.proto:1041Used in:
repeated string transaction_ids = 1
Reversed, hex-encoded string representing the transaction ids of the sweeps that our node has broadcast. Note that these transactions may not have confirmed yet, we record sweeps on broadcast, not confirmation.
message
walletkit.proto:940Used in:
optional outpoint = 1
The outpoint of the output we're attempting to sweep.
WitnessType witness_type = 2
The witness type of the output we're attempting to sweep.
uint32 amount_sat = 3
The value of the output we're attempting to sweep.
uint32 sat_per_byte = 4
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.
uint32 broadcast_attempts = 5
The number of broadcast attempts we've made to sweep the output.
uint32 next_broadcast_height = 6
The next height of the chain at which we'll attempt to broadcast the sweep transaction of the output.
uint32 requested_conf_target = 8
The requested confirmation target for this output.
uint32 requested_sat_per_byte = 9
Deprecated, use requested_sat_per_vbyte. The requested fee rate, expressed in sat/vbyte, for this output.
uint64 sat_per_vbyte = 10
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.
uint64 requested_sat_per_vbyte = 11
The requested fee rate, expressed in sat/vbyte, for this output.
bool force = 7
Whether this input must be force-swept. This means that it is swept even if it has a negative yield.
message
walletkit.proto:686Used in: ,
uint32 leaf_version = 1
The leaf version. Should be 0xc0 (192) in case of a SegWit v1 script.
bytes script = 2
The script of the tap leaf.
message
walletkit.proto:679Used in:
repeated all_leaves = 1
The complete, ordered list of all tap leaves of the tree.
message
walletkit.proto:694Used in:
optional revealed_leaf = 1
The tap leaf that is known and will be revealed.
bytes full_inclusion_proof = 2
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.
message
walletkit.proto:1158Used in:
repeated inputs = 1
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.
map<string, uint64> outputs = 2
A map of all addresses and the amounts to send to in the funded PSBT.
message
walletkit.proto:1176Used in: ,
bytes id = 1
A 32 byte random ID that identifies the lease.
optional outpoint = 2
The identifying outpoint of the output being leased.
uint64 expiration = 3
The absolute expiration of the output lease represented as a unix timestamp.
bytes pk_script = 4
The public key script of the leased output.
uint64 value = 5
The value of the leased output in satoshis.
Used in:
UNKNOWN_WITNESS = 0
COMMITMENT_TIME_LOCK = 1
A witness that allows us to spend the output of a commitment transaction after a relative lock-time lockout.
COMMITMENT_NO_DELAY = 2
A witness that allows us to spend a settled no-delay output immediately on a counterparty's commitment transaction.
COMMITMENT_REVOKE = 3
A witness that allows us to sweep the settled output of a malicious counterparty's who broadcasts a revoked commitment transaction.
HTLC_OFFERED_REVOKE = 4
A witness that allows us to sweep an HTLC which we offered to the remote party in the case that they broadcast a revoked commitment state.
HTLC_ACCEPTED_REVOKE = 5
A witness that allows us to sweep an HTLC output sent to us in the case that the remote party broadcasts a revoked commitment state.
HTLC_OFFERED_TIMEOUT_SECOND_LEVEL = 6
A witness that allows us to sweep an HTLC output that we extended to a party, but was never fulfilled. This HTLC output isn't directly on the commitment transaction, but is the result of a confirmed second-level HTLC transaction. As a result, we can only spend this after a CSV delay.
HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL = 7
A witness that allows us to sweep an HTLC output that was offered to us, and for which we have a payment preimage. This HTLC output isn't directly on our commitment transaction, but is the result of confirmed second-level HTLC transaction. As a result, we can only spend this after a CSV delay.
HTLC_OFFERED_REMOTE_TIMEOUT = 8
A witness that allows us to sweep an HTLC that we offered to the remote party which lies in the commitment transaction of the remote party. We can spend this output after the absolute CLTV timeout of the HTLC as passed.
HTLC_ACCEPTED_REMOTE_SUCCESS = 9
A witness that allows us to sweep an HTLC that was offered to us by the remote party. We use this witness in the case that the remote party goes to chain, and we know the pre-image to the HTLC. We can sweep this without any additional timeout.
HTLC_SECOND_LEVEL_REVOKE = 10
A witness that allows us to sweep an HTLC from the remote party's commitment transaction in the case that the broadcast a revoked commitment, but then also immediately attempt to go to the second level to claim the HTLC.
WITNESS_KEY_HASH = 11
A witness type that allows us to spend a regular p2wkh output that's sent to an output which is under complete control of the backing wallet.
NESTED_WITNESS_KEY_HASH = 12
A witness type that allows us to sweep an output that sends to a nested P2SH script that pays to a key solely under our control.
COMMITMENT_ANCHOR = 13
A witness type that allows us to spend our anchor on the commitment transaction.
COMMITMENT_NO_DELAY_TWEAKLESS = 14
A witness type that is similar to the COMMITMENT_NO_DELAY type, but it omits the tweak that randomizes the key we need to spend with a channel peer supplied set of randomness.
COMMITMENT_TO_REMOTE_CONFIRMED = 15
A witness type that allows us to spend our output on the counterparty's commitment transaction after a confirmation.
HTLC_OFFERED_TIMEOUT_SECOND_LEVEL_INPUT_CONFIRMED = 16
A witness type that allows us to sweep an HTLC output that we extended to a party, but was never fulfilled. This _is_ the HTLC output directly on our commitment transaction, and the input to the second-level HTLC timeout transaction. It can only be spent after CLTV expiry, and commitment confirmation.
HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL_INPUT_CONFIRMED = 17
A witness type that allows us to sweep an HTLC output that was offered to us, and for which we have a payment preimage. This _is_ the HTLC output directly on our commitment transaction, and the input to the second-level HTLC success transaction. It can only be spent after the commitment has confirmed.
LEASE_COMMITMENT_TIME_LOCK = 18
A witness type that allows us to spend our output on our local commitment transaction after a relative and absolute lock-time lockout as part of the script enforced lease commitment type.
LEASE_COMMITMENT_TO_REMOTE_CONFIRMED = 19
A witness type that allows us to spend our output on the counterparty's commitment transaction after a confirmation and absolute locktime as part of the script enforced lease commitment type.
LEASE_HTLC_OFFERED_TIMEOUT_SECOND_LEVEL = 20
A witness type that allows us to sweep an HTLC output that we extended to a party, but was never fulfilled. This HTLC output isn't directly on the commitment transaction, but is the result of a confirmed second-level HTLC transaction. As a result, we can only spend this after a CSV delay and CLTV locktime as part of the script enforced lease commitment type.
LEASE_HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL = 21
A witness type that allows us to sweep an HTLC output that was offered to us, and for which we have a payment preimage. This HTLC output isn't directly on our commitment transaction, but is the result of confirmed second-level HTLC transaction. As a result, we can only spend this after a CSV delay and CLTV locktime as part of the script enforced lease commitment type.
TAPROOT_PUB_KEY_SPEND = 22
A witness type that allows us to spend a regular p2tr output that's sent to an output which is under complete control of the backing wallet.