mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
121 lines
3.8 KiB
Groff
Generated
121 lines
3.8 KiB
Groff
Generated
.TH "LIGHTNING-LISTTRANSACTIONS" "7" "" "" "lightning-listtransactions"
|
|
.SH NAME
|
|
lightning-listtransactions - Command to get the list of transactions that was stored in the wallet\.
|
|
.SH SYNOPSIS
|
|
|
|
\fBlisttransactions\fR
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBlisttransactions\fR command returns transactions tracked in the wallet\. This includes deposits, withdrawals and transactions related to channels\. A transaction may have multiple types, e\.g\., a transaction may both be a close and a deposit if it closes the channel and returns funds to the wallet\.
|
|
|
|
.SH EXAMPLE JSON REQUEST
|
|
.nf
|
|
.RS
|
|
{
|
|
"id": 82,
|
|
"method": "listtransactions",
|
|
"params": {}
|
|
}
|
|
.RE
|
|
|
|
.fi
|
|
.SH RETURN VALUE
|
|
|
|
On success, the command will return a list of transactions, each object represents a transaction, with the following details:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fIhash\fR: A string that rappresents the hash of transaction, which the caller can use to find it on the blockchain\.
|
|
.IP \[bu]
|
|
\fIrawtx\fR: A string that rappresents the hexadecimal dump of the transaction\.
|
|
.IP \[bu]
|
|
\fIblockheight\fR: An integer that rappresents the block height that contains the transaction on the blockchain\.
|
|
.IP \[bu]
|
|
\fItxindex\fR: An integer that rappresent the transaction index inside the block\.
|
|
.IP \[bu]
|
|
\fIlocktime\fR: An integer that rappresent the locktime\.
|
|
.IP \[bu]
|
|
\fIversion\fR: An integer that rappresent the version\.
|
|
.IP \[bu]
|
|
\fIinputs\fR: A list of spent transaction outputs, each spent transaction output is rappresented with an object with the following properties:.RS
|
|
.IP \[bu]
|
|
\fItxid\fR: A string that rappresent the hash of transaction\. This is the output index of the transaction output being spent\.
|
|
.IP \[bu]
|
|
\fIindex\fR: An integer that rappresent the index of transaction\.
|
|
.IP \[bu]
|
|
\fIsequence\fR: An integer that rappresent the sequence number\.
|
|
|
|
.RE
|
|
|
|
.IP \[bu]
|
|
\fIoutputs\fR: A list of transactions, each transaction is rappresented with an object with the following proprieties:.RS
|
|
.IP \[bu]
|
|
\fIindex\fR: An integer that rappresent the index of transaction\.
|
|
.IP \[bu]
|
|
\fIsatoshis\fR: A string that rappresent the amount in millisatoshi\.
|
|
.IP \[bu]
|
|
\fIscriptPubKey\fR: A string that contains the lock script in hexadecimal dump form\.
|
|
|
|
.RE
|
|
|
|
|
|
.RE
|
|
|
|
On failure, one of the following error codes may be returned:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
-32602: Error in given parameters\.
|
|
|
|
.RE
|
|
.SH EXAMPLE JSON RESPONSE
|
|
.nf
|
|
.RS
|
|
{
|
|
"transactions": [
|
|
{
|
|
"hash": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0",
|
|
"rawtx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000",
|
|
"blockheight": 0,
|
|
"txindex": 0,
|
|
"locktime": 0,
|
|
"version": 2,
|
|
"inputs": [
|
|
{
|
|
"txid": "804254330e02a4b53b1492efdfe207875940965fcd3a89e0a325fc5126913270",
|
|
"index": 1,
|
|
"sequence": 4294967295
|
|
},
|
|
{
|
|
"txid": "4ee2eafa9a9b9e900aad69b7d3e4d6a5851556b0680ac1caeb3886f7b4a429d2",
|
|
"index": 0,
|
|
"sequence": 4294967295
|
|
}
|
|
],
|
|
"outputs": [
|
|
{
|
|
"index": 0,
|
|
"satoshis": "88721000msat",
|
|
"scriptPubKey": "a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf87"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
.RE
|
|
|
|
.fi
|
|
.SH AUTHOR
|
|
|
|
Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-newaddr\fR(7), \fBlightning-listfunds\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|