LN Sync

Methods for synchronizing metadata about Lightning Network nodes, channels, and
payments.

Methods

$3

Confirm that a peer will accept a channel open

{
capacity:
[cooperative_close_address]:
[give_tokens]: // Defaults to zero
[is_private]: // Defaults to false
lnd:
[min_htlc_mtokens]:
[partner_csv_delay]:
partner_public_key:
}

@returns via cbk or Promise
{
is_accepted:
}

$3

Ask to get a chain fee rate

{
ask:
lnd:
}

@returns via cbk or Promise
{
tokens_per_vbyte:
}

$3

Assemble an unsigned PSBT with funding from multiple parties

{
capacity:
proposed: [{
[change]:
[funding]: []
utxos: [{
[non_witness_utxo]:
transaction_id:
transaction_vout:
witness_utxo: {
script_pub:
tokens:
}
}]
}]
rate:
}

@returns via cbk or Promise
{
psbt:
}

$3

Broadcast a chain transaction until it gets confirmed in a block

{
[description]:
lnd:
logger:
transaction:
}

@returns via cbk or Promise
{
transaction_confirmed_in_block:
}

$3

Connect a peer

{
id:
lnd:
[sockets]: []
}

@returns via cbk or Promise

$3

Find a confirmed on-chain output

{
lnd:
[min_confirmations]:
output_script:
start_height:
timeout_ms:
tokens:
}

@returns via cbk or Promise
{
confirmation_height:
is_coinbase:
transaction_id:
transaction_vout:
}

$3

Find a public key given a query

{
[channels]: [{
partner_public_key:
}]
lnd:
[query]:
}

@returns via cbk or Promise
{
[public_key]:
}

$3

Format tokens for display

{
is_monochrome:
tokens:
}

@returns
{
display:
}

$3

Get all invoices

{
[confirmed_after]:
[created_after]:
lnd:
}

@returns via cbk or Promise
{
invoices: [{
[chain_address]:
cltv_delta:
[confirmed_at]:
created_at:
description:
[description_hash]:
expires_at:
features: [{
bit:
is_known:
is_required:
type:
}]
id:
[is_canceled]:
is_confirmed:
[is_held]:
is_private:
[is_push]:
payments: [{
[confirmed_at]:
created_at:
created_height:
in_channel:
is_canceled:
is_confirmed:
is_held:
messages: [{
type:
value:
}]
mtokens:
[pending_index]:
tokens:
[total_mtokens]:
}]
received:
received_mtokens:
[request]:
secret:
tokens:
}]
}

$3

Get a funded transaction

{
ask:
[chain_fee_tokens_per_vbyte]:
[is_external]:
lnd: Authenticated LND API Object>
logger:
outputs: [{
address:
tokens:
}]
}

@returns via cbk or Promise
{
id:
[inputs]: [{
[lock_expires_at]:
[lock_id]:
transaction_id:
transaction_vout:
}]
[psbt]:
transaction:
}

$3

Get the channel available liquidity

A request function is required when min_node_score is specified

{
[is_outbound]:
[is_top]:
lnd:
[min_node_score]:
[max_fee_rate]:
[request]:
[with]: []
}

@returns via cbk
{
tokens: []
}

$3

Get network name for lnd

{
lnd:
}

@returns via cbk or Promise
{
[bitcoinjs]:
network:
}

$3

Get the alias of a node, ignoring errors

{
id:
lnd:
}

@returns via cbk or Promise
{
alias:
id:
}

$3

Get a detailed balance that categorizes balance of tokens on the node

{
[is_confirmed]:
lnd:
}

@returns via cbk or Promise
{
[closing_balance]:
[conflicted_pending]:
[invalid_pending]:
[offchain_balance]:
[offchain_pending]:
[onchain_confirmed]:
[onchain_pending]:
[onchain_vbytes]:
[utxos_count]:
}

$3

Find the max amount that can be used for funding outputs given inputs

{
addresses: []
fee_tokens_per_vbyte:
inputs: [{
tokens:
transaction_id:
transaction_vout:
}]
lnd:
}

@returns via cbk or Promise
{
fee_tokens_per_vbyte:
max_tokens:
}

$3

Get payments

{
[after]:
lnd:
}

@returns via cbk or Promise
{
payments: [{
attempts: [{
[failure]: {
code:
[details]: {
[channel]:
[height]:
[index]:
[mtokens]:
[policy]: {
base_fee_mtokens:
cltv_delta:
fee_rate:
[is_disabled]:
max_htlc_mtokens:
min_htlc_mtokens:
updated_at:
}
[timeout_height]:
[update]: {
chain:
channel_flags:
extra_opaque_data:
message_flags:
signature:
}
}
message:
}
[index]:
is_confirmed:
is_failed:
is_pending:
route: {
fee:
fee_mtokens:
hops: [{
channel:
channel_capacity:
fee:
fee_mtokens:
forward:
forward_mtokens:
[public_key]:
[timeout]:
}]
mtokens:
[payment]:
timeout:
tokens:
[total_mtokens]:
}
}]
created_at:
destination:
fee:
fee_mtokens:
hops: []
id:
[index]:
is_confirmed:
is_outgoing:
mtokens:
[request]:
safe_fee:
safe_tokens:
secret:
tokens:
}]
}

$3

Get the rundown on liquidity with a specific peer

{
lnd:
public_key:
[settled]:
}

@returns via cbk or Promise
{
alias:
inbound:
inbound_pending:
outbound:
outbound_pending:
}

$3

Get payments that were rebalances

{
after:
lnds: []
}

@returns via cbk or Promise
{
payments: [{
attempts: [{
[failure]: {
code:
[details]: {
[channel]:
[height]:
[index]:
[mtokens]:
[policy]: {
base_fee_mtokens:
cltv_delta:
fee_rate:
[is_disabled]:
max_htlc_mtokens:
min_htlc_mtokens:
updated_at:
}
[timeout_height]:
[update]: {
chain:
channel_flags:
extra_opaque_data:
message_flags:
signature:
}
}
message:
}
[index]:
[confirmed_at]:
is_confirmed:
is_failed:
is_pending:
route: {
fee:
fee_mtokens:
hops: [{
channel:
channel_capacity:
fee:
fee_mtokens:
forward:
forward_mtokens:
[public_key]:
[timeout]:
}]
mtokens:
[payment]:
timeout:
tokens:
[total_mtokens]:
}
}]
confirmed_at:
created_at:
destination:
fee:
fee_mtokens:
hops: []
id:
[index]:
is_confirmed:
is_outgoing:
mtokens:
[request]:
safe_fee:
safe_tokens:
secret:
tokens:
}]
}

$3

Get scored nodes

{
network:
request:
}

@returns via cbk or Promise
{
nodes: [{
public_key:
score:
}]
}

$3

Get LND internal record associated with a transaction id

{
[chain_transactions]: [{
[block_id]:
[confirmation_count]:
[confirmation_height]:
created_at:
[description]:
[fee]:
id:
is_confirmed:
is_outgoing:
output_addresses: [