"summary":"NextAddr returns the next unused address within the wallet.",
"operationId":"NextAddr",
"responses":{
"200":{
"description":"A successful response.",
"schema":{
"$ref":"#/definitions/walletrpcAddrResponse"
}
},
"default":{
"description":"An unexpected error response",
"schema":{
"$ref":"#/definitions/runtimeError"
}
}
},
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"$ref":"#/definitions/walletrpcAddrRequest"
}
}
],
"tags":[
"WalletKit"
]
}
},
"/v2/wallet/bumpfee":{
"post":{
"summary":"BumpFee bumps the fee of an arbitrary input within a transaction. This RPC\ntakes a different approach than bitcoind's bumpfee command. lnd has a\ncentral batching engine in which inputs with similar fee rates are batched\ntogether to save on transaction fees. Due to this, we cannot rely on\nbumping the fee on a specific transaction, since transactions can change at\nany point with the addition of new inputs. The list of inputs that\ncurrently exist within lnd's central batching engine can be retrieved\nthrough the PendingSweeps RPC.",
"description":"When bumping the fee of an input that currently exists within lnd's central\nbatching engine, a higher fee transaction will be created that replaces the\nlower fee transaction through the Replace-By-Fee (RBF) policy. If it\n\nThis RPC also serves useful when wanting to perform a Child-Pays-For-Parent\n(CPFP), where the child transaction pays for its parent's fee. This can be\ndone by specifying an outpoint within the low fee transaction that is under\nthe control of the wallet.\n\nThe fee preference can be expressed either as a specific fee rate or a delta\nof blocks in which the output should be swept on-chain within. If a fee\npreference is not explicitly specified, then an error is returned.\n\nNote that this RPC currently doesn't perform any validation checks on the\nfee preference being provided. For now, the responsibility of ensuring that\nthe new fee preference is sufficient is delegated to the user.",
"operationId":"BumpFee",
"responses":{
"200":{
"description":"A successful response.",
"schema":{
"$ref":"#/definitions/walletrpcBumpFeeResponse"
}
},
"default":{
"description":"An unexpected error response",
"schema":{
"$ref":"#/definitions/runtimeError"
}
}
},
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"$ref":"#/definitions/walletrpcBumpFeeRequest"
}
}
],
"tags":[
"WalletKit"
]
}
},
"/v2/wallet/estimatefee/{conf_target}":{
"get":{
"summary":"EstimateFee attempts to query the internal fee estimator of the wallet to\ndetermine the fee (in sat/kw) to attach to a transaction in order to\nachieve the confirmation target.",
"description":"The number of confirmations to shoot for when estimating the fee.",
"in":"path",
"required":true,
"type":"integer",
"format":"int32"
}
],
"tags":[
"WalletKit"
]
}
},
"/v2/wallet/key":{
"post":{
"summary":"DeriveKey attempts to derive an arbitrary key specified by the passed\nKeyLocator.",
"operationId":"DeriveKey",
"responses":{
"200":{
"description":"A successful response.",
"schema":{
"$ref":"#/definitions/signrpcKeyDescriptor"
}
},
"default":{
"description":"An unexpected error response",
"schema":{
"$ref":"#/definitions/runtimeError"
}
}
},
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"$ref":"#/definitions/signrpcKeyLocator"
}
}
],
"tags":[
"WalletKit"
]
}
},
"/v2/wallet/key/next":{
"post":{
"summary":"DeriveNextKey attempts to derive the *next* key within the key family\n(account in BIP43) specified. This method should return the next external\nchild within this branch.",
"summary":"FinalizePsbt expects a partial transaction with all inputs and outputs fully\ndeclared and tries to sign all inputs that belong to the wallet. Lnd must be\nthe last signer of the transaction. That means, if there are any unsigned\nnon-witness inputs or inputs without UTXO information attached or inputs\nwithout witness data that do not belong to lnd's wallet, this method will\nfail. If no error is returned, the PSBT is ready to be extracted and the\nfinal TX within to be broadcast.",
"description":"NOTE: This method does NOT publish the transaction once finalized. It is the\ncaller's responsibility to either publish the transaction on success or\nunlock/release any locked UTXOs in case of an error in this method.",
"summary":"FundPsbt creates a fully populated PSBT that contains enough inputs to fund\nthe outputs specified in the template. There are two ways of specifying a\ntemplate: Either by passing in a PSBT with at least one output declared or\nby passing in a raw TxTemplate message.",
"description":"If there are no inputs specified in the template, coin selection is\nperformed automatically. If the template does contain any inputs, it is\nassumed that full coin selection happened externally and no additional\ninputs are added. If the specified inputs aren't enough to fund the outputs\nwith the given fee rate, an error is returned.\n\nAfter either selecting or verifying the inputs, all input UTXOs are locked\nwith an internal app ID.\n\nNOTE: If this method returns without an error, it is the caller's\nresponsibility to either spend the locked UTXOs (by finalizing and then\npublishing the transaction) or to unlock/release the locked UTXOs in case of\nan error on the caller's side.",
"summary":"SendOutputs is similar to the existing sendmany call in Bitcoind, and\nallows the caller to create a transaction that sends to several outputs at\nonce. This is ideal when wanting to batch create a set of transactions.",
"summary":"ListSweeps returns a list of the sweep transactions our node has produced.\nNote that these sweeps may not be confirmed yet, as we record sweeps on\nbroadcast, not confirmation.",
"description":"Retrieve the full sweep transaction details. If false, only the sweep txids\nwill be returned. Note that some sweeps that LND publishes will have been\nreplaced-by-fee, so will not be included in this output.",
"summary":"PendingSweeps returns lists of on-chain outputs that lnd is currently\nattempting to sweep within its central batching engine. Outputs with similar\nfee rates are batched together in order to sweep them within a single\ntransaction.",
"description":"NOTE: Some of the fields within PendingSweepsRequest are not guaranteed to\nremain supported. This is an advanced API that depends on the internals of\nthe UtxoSweeper, so things may change.",
"summary":"PublishTransaction attempts to publish the passed transaction to the\nnetwork. Once this returns without an error, the wallet will continually\nattempt to re-broadcast the transaction on start up, until it enters the\nchain.",
"operationId":"PublishTransaction",
"responses":{
"200":{
"description":"A successful response.",
"schema":{
"$ref":"#/definitions/walletrpcPublishResponse"
}
},
"default":{
"description":"An unexpected error response",
"schema":{
"$ref":"#/definitions/runtimeError"
}
}
},
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"$ref":"#/definitions/walletrpcTransaction"
}
}
],
"tags":[
"WalletKit"
]
}
},
"/v2/wallet/tx/label":{
"post":{
"summary":"LabelTransaction adds a label to a transaction. If the transaction already\nhas a label the call will fail unless the overwrite bool is set. This will\noverwrite the exiting transaction label. Labels must not be empty, and\ncannot exceed 500 characters.",
"summary":"ListUnspent returns a list of all utxos spendable by the wallet with a\nnumber of confirmations between the specified minimum and maximum.",
"summary":"LeaseOutput locks an output to the given ID, preventing it from being\navailable for any future coin selection attempts. The absolute time of the\nlock's expiration is returned. The expiration of the lock can be extended by\nsuccessive invocations of this RPC. Outputs can be unlocked before their\nexpiration through `ReleaseOutput`.",
"summary":"ReleaseOutput unlocks an output, allowing it to be available for coin\nselection if it remains unspent. The ID should match the one used to\noriginally lock the output.",
"description":"Reversed, hex-encoded string representing the transaction ids of the\nsweeps that our node has broadcast. Note that these transactions may\nnot have confirmed yet, we record sweeps on broadcast, not confirmation."
"description":"A PSBT that should be signed and finalized. The PSBT must contain all\nrequired inputs, outputs, UTXO data and partial signatures of all other\nsigners."
}
}
},
"walletrpcFinalizePsbtResponse":{
"type":"object",
"properties":{
"signed_psbt":{
"type":"string",
"format":"byte",
"description":"The fully signed and finalized transaction in PSBT format."
},
"raw_final_tx":{
"type":"string",
"format":"byte",
"description":"The fully signed and finalized transaction in the raw wire format."
}
}
},
"walletrpcFundPsbtRequest":{
"type":"object",
"properties":{
"psbt":{
"type":"string",
"format":"byte",
"description":"Use an existing PSBT packet as the template for the funded PSBT.\n\nThe packet must contain at least one non-dust output. If one or more\ninputs are specified, no coin selection is performed. In that case every\ninput must be an UTXO known to the wallet that has not been locked\nbefore. The sum of all inputs must be sufficiently greater than the sum\nof all outputs to pay a miner fee with the specified fee rate. A change\noutput is added to the PSBT if necessary."
},
"raw":{
"$ref":"#/definitions/walletrpcTxTemplate",
"description":"Use the outputs and optional inputs from this raw template."
},
"target_conf":{
"type":"integer",
"format":"int64",
"description":"The target number of blocks that the transaction should be confirmed in."
},
"sat_per_vbyte":{
"type":"integer",
"format":"int64",
"description":"The fee rate, expressed in sat/vbyte, that should be used to spend the\ninput with."
}
}
},
"walletrpcFundPsbtResponse":{
"type":"object",
"properties":{
"funded_psbt":{
"type":"string",
"format":"byte",
"description":"The funded but not yet signed PSBT packet."
},
"change_output_index":{
"type":"integer",
"format":"int32",
"description":"The index of the added change output or -1 if no change was left over."
},
"locked_utxos":{
"type":"array",
"items":{
"$ref":"#/definitions/walletrpcUtxoLease"
},
"description":"The list of lock leases that were acquired for the inputs in the funded PSBT\npacket."
"description":"Is the key finger print of the root pubkey that this request is targeting.\nThis allows the WalletKit to possibly serve out keys for multiple HD chains\nvia public derivation."
},
"key_family":{
"type":"integer",
"format":"int32",
"description":"The target key family to derive a key from. In other contexts, this is\nknown as the \"account\"."
}
}
},
"walletrpcLabelTransactionRequest":{
"type":"object",
"properties":{
"txid":{
"type":"string",
"format":"byte",
"description":"The txid of the transaction to label."
},
"label":{
"type":"string",
"description":"The label to add to the transaction, limited to 500 characters."
},
"overwrite":{
"type":"boolean",
"format":"boolean",
"description":"Whether to overwrite the existing label, if it is present."
"description":"An ID of 32 random bytes that must be unique for each distinct application\nusing this RPC which will be used to bound the output lease to."
},
"outpoint":{
"$ref":"#/definitions/lnrpcOutPoint",
"description":"The identifying outpoint of the output being leased."
"description":"The outpoint of the output we're attempting to sweep."
},
"witness_type":{
"$ref":"#/definitions/walletrpcWitnessType",
"description":"The witness type of the output we're attempting to sweep."
},
"amount_sat":{
"type":"integer",
"format":"int64",
"description":"The value of the output we're attempting to sweep."
},
"sat_per_byte":{
"type":"integer",
"format":"int64",
"description":"The fee rate we'll use to sweep the output. The fee rate is only determined\nonce a sweeping transaction for the output is created, so it's possible for\nthis to be 0 before this."
},
"broadcast_attempts":{
"type":"integer",
"format":"int64",
"description":"The number of broadcast attempts we've made to sweep the output."
},
"next_broadcast_height":{
"type":"integer",
"format":"int64",
"description":"The next height of the chain at which we'll attempt to broadcast the\nsweep transaction of the output."
},
"requested_conf_target":{
"type":"integer",
"format":"int64",
"description":"The requested confirmation target for this output."
},
"requested_sat_per_byte":{
"type":"integer",
"format":"int64",
"description":"The requested fee rate, expressed in sat/byte, for this output."
},
"force":{
"type":"boolean",
"format":"boolean",
"description":"Whether this input must be force-swept. This means that it is swept even\nif it has a negative yield."
}
}
},
"walletrpcPendingSweepsResponse":{
"type":"object",
"properties":{
"pending_sweeps":{
"type":"array",
"items":{
"$ref":"#/definitions/walletrpcPendingSweep"
},
"description":"The set of outputs currently being swept by lnd's central batching engine."
}
}
},
"walletrpcPublishResponse":{
"type":"object",
"properties":{
"publish_error":{
"type":"string",
"description":"If blank, then no error occurred and the transaction was successfully\npublished. If not the empty string, then a string representation of the\nbroadcast error.\n\nTODO(roasbeef): map to a proper enum type"
"description":"An optional list of inputs to use. Every input must be an UTXO known to the\nwallet that has not been locked before. The sum of all inputs must be\nsufficiently greater than the sum of all outputs to pay a miner fee with the\nfee rate specified in the parent message.\n\nIf no inputs are specified, coin selection will be performed instead and\ninputs of sufficient value will be added to the resulting PSBT."
},
"outputs":{
"type":"object",
"additionalProperties":{
"type":"string",
"format":"uint64"
},
"description":"A map of all addresses and the amounts to send to in the funded PSBT."
}
}
},
"walletrpcUtxoLease":{
"type":"object",
"properties":{
"id":{
"type":"string",
"format":"byte",
"description":"A 32 byte random ID that identifies the lease."
},
"outpoint":{
"$ref":"#/definitions/lnrpcOutPoint",
"description":"The identifying outpoint of the output being leased."
},
"expiration":{
"type":"string",
"format":"uint64",
"description":"The absolute expiration of the output lease represented as a unix timestamp."
"description":" - COMMITMENT_TIME_LOCK: A witness that allows us to spend the output of a commitment transaction\nafter a relative lock-time lockout.\n - COMMITMENT_NO_DELAY: A witness that allows us to spend a settled no-delay output immediately on a\ncounterparty's commitment transaction.\n - COMMITMENT_REVOKE: A witness that allows us to sweep the settled output of a malicious\ncounterparty's who broadcasts a revoked commitment transaction.\n - HTLC_OFFERED_REVOKE: A witness that allows us to sweep an HTLC which we offered to the remote\nparty in the case that they broadcast a revoked commitment state.\n - HTLC_ACCEPTED_REVOKE: A witness that allows us to sweep an HTLC output sent to us in the case that\nthe remote party broadcasts a revoked commitment state.\n - HTLC_OFFERED_TIMEOUT_SECOND_LEVEL: A witness that allows us to sweep an HTLC output that we extended to a\nparty, but was never fulfilled. This HTLC output isn't directly on the\ncommitment transaction, but is the result of a confirmed second-level HTLC\ntransaction. As a result, we can only spend this after a CSV delay.\n - HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL: A witness that allows us to sweep an HTLC output that was offered to us, and\nfor which we have a payment preimage. This HTLC output isn't directly on our\ncommitment transaction, but is the result of confirmed second-level HTLC\ntransaction. As a result, we can only spend this after a CSV delay.\n - HTLC_OFFERED_REMOTE_TIMEOUT: A witness that allows us to sweep an HTLC that we offered to the remote\nparty which lies in the commitment transaction of the remote party. We can\nspend this output after the absolute CLTV timeout of the HTLC as passed.\n - HTLC_ACCEPTED_REMOTE_SUCCESS: A witness that allows us to sweep an HTLC that was offered to us by the\nremote party. We use this witness in the case that the remote party goes to\nchain, and we know the pre-image to the HTLC. We can sweep this without any\nadditional timeout.\n - HTLC_SECOND_LEVEL_REVOKE: A witness that allows us to sweep an HTLC from the remote party's commitment\ntransaction in the case that the broadcast a revoked commitment, but then\nalso immediately attempt to go to the second level to claim the HTLC.\n - WITNESS_KEY_HASH: A witness type that allows us to spend a regular p2wkh output that's sent to\nan output which is under complete control of the backing wallet.\n - NESTED_WITNESS_KEY_HASH: A witness type that allows us to sweep an output that sends to a nested P2SH\nscript that pays to a key solely under our control.\n - COMMITMENT_ANCHOR: A witness type that allows us to spend our anchor on the commitment\ntransaction."
