kosmos/lndhub
8
0
Fork 0
Code Issues Pull Requests Releases Activity

Unified .md style

Browse Source 
There were some tabs and broken Indentations which I corrected and converted to spaces.
This commit is contained in:
MG-ng 2021-09-28 20:11:05 +02:00 committed by Overtorment
parent 6047383747
commit a184872b02
1 changed files with 45 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
doc/Send-requirements.md
View File

@ -422,23 +422,23 @@ Response:
"fee": 0, // int, in cents of percent, i.e. 100 for 1%, 50 for 0.5%, 1 for 0.01% "fee": 0, // int, in cents of percent, i.e. 100 for 1%, 50 for 0.5%, 1 for 0.01%
"identity_pubkey": "...", //string, lnd node identity pubkey "identity_pubkey": "...", //string, lnd node identity pubkey
"alias": "...", //string, lnd node alias "alias": "...", //string, lnd node alias
"num_pending_channels": 0, //int "num_pending_channels": 0, //int
"num_active_channels": 3, //int "num_active_channels": 3, //int
"num_peers": 6, //int "num_peers": 6, //int
"block_height": 542389, //int "block_height": 542389, //int
"block_hash": "...", //string "block_hash": "...", //string
"synced_to_chain": true, //bool "synced_to_chain": true, //bool
"testnet": false, "testnet": false,
"chains": [ "chains": [
"bitcoin" //string, available chans to operate by lnd "bitcoin" //string, available chans to operate by lnd
], ],
"uris": [ "uris": [
"...", //string, uris of lnd node "...", //string, uris of lnd node
], ],
"best_header_timestamp": "...", //string, unixtime "best_header_timestamp": "...", //string, unixtime
"version": "..." // string, lnd version "version": "..." // string, lnd version
} }
## GET /getinvoice ## GET /getinvoice
@ -448,24 +448,26 @@ Returns fees user pays for payments, status of the system, etc.
Request: Request:
{ {
"amt": "...", //string "amt": "...", //string
"memo":"...", //string "memo":"...", //string
"receipt":"...", //string, not mandatory parameter "receipt":"...", //string, not mandatory parameter
"preimage": "...", //string, not mandatory parameter "preimage": "...", //string, not mandatory parameter
"fallbackAddr": "...", //string, not mandatory parameter "fallbackAddr": "...", //string, not mandatory parameter
"expiry": "...", //string, not mandatory parameter "expiry": "...", //string, not mandatory parameter
"private": "..." //string, not mandatory parameter "private": "..." //string, not mandatory parameter
} }
Response: Response:
{ {
"r_hash": "...", //string, "r_hash": "...", //string,
"pay_req": "...", //string, a bare-bones invoice for a payment within the Lightning Network "pay_req": "...", //string, a bare-bones invoice for a payment within the Lightning Network
"add_index": ... //int, The “add” index of this invoice. Each newly created invoice will "add_index": ... //int, The “add” index of this invoice. Each newly created invoice will
// increment this index making it monotonically increasing. // increment this index making it monotonically increasing.
// Callers to the SubscribeInvoices call can use this to instantly // Callers to the SubscribeInvoices call can use this to instantly
// get notified of all added invoices with an add_index greater than this one. // get notified of all added invoices with an add_index greater than this one.
} }
## GET /getuserinvoices ## GET /getuserinvoices
Returns fees user pays for payments, status of the system, etc. Returns fees user pays for payments, status of the system, etc.
@ -475,26 +477,28 @@ Request:
none none
Response: Response:
{
"r_hash": "...", //string {
"payment_request": "...", //string "r_hash": "...", //string
"add_index": "...", //string "payment_request": "...", //string
"description": "...", //string "add_index": "...", //string
"amt": ... , //int "description": "...", //string
"ispaid": ... //bool "amt": ... , //int
} "ispaid": ... //bool
}
# Data structures # Data structures
## Transaction object ## Transaction object
{ {
"type": "...", // string, type of txs. Types: "type": "...", // string, type of txs. Types:
// bitcoind_internal_tx - moves to user btc address or account // bitcoind_internal_tx - moves to user btc address or account
// bitcoind_tx - received by address or account // bitcoind_tx - received by address or account
// paid_invoice - user paid someone's invoice // paid_invoice - user paid someone's invoice
// sent_coins - user sent coins by lnd to someone's btc account // sent_coins - user sent coins by lnd to someone's btc account
// received_invoice_payments - user received payments by invoice // received_invoice_payments - user received payments by invoice
"txid": "...", // string, internal tx id. not related to onchain transaction id "txid": "...", // string, internal tx id. not related to onchain transaction id
"amt": 666, // satoshi, int "amt": 666, // satoshi, int
"fee": 11, // satoshi, int "fee": 11, // satoshi, int
"timestamp": 1234567, // int, unixtime "timestamp": 1234567, // int, unixtime