orb.cln.cln_rest module

class orb.cln.cln_rest.ClnREST(tls_certificate, server, macaroon, port)

Bases: ClnBase

batch_open(pubkeys, amounts, sat_per_vbyte)

https://lightning.readthedocs.io/lightning-multifundchannel.7.html The multifundchannel RPC command opens multiple payment channels with nodes by committing a single funding transaction to the blockchain that is shared by all channels.

close_channel(id: str, unilateral_timeout: int = 172800, dest: str = '', fee_negotiation_step: str = '50%')

connect(id)

lncli: connect ConnectPeer attempts to establish a connection to a remote peer. This is at the networking level, and is used for communication between nodes. This is distinct from establishing a channel with a peer.

decode_payment_request(payment_request)

Conversion Done.

fee_report()

property fqdn

generate_invoice(amount: int, memo: str = 'Orb invoice')

get_balance()

Conversion done.

get_channel_events()

get_channels()

Conversion Done

get_forwarding_history(index_offset=0, num_max_events=100)

get_htlc_events()

get_info()

Conversion done

get_invoice_events()

get_node_alias(pub_key)

get_node_info(pubkey: str)

Conversion done.

get_own_pubkey()

get_policy_from(channel_id)

Conversion done

get_policy_to(channel_id)

Conversion done

list_channel(shortchannelid: str)

Conversion done.

list_invoices()

list_payments(index_offset=0, max_payments=100)

list_peers()

Return list of peers

listsendpays_cached()

local_remote_bal()

Conversion done.

new_address()

Conversion done.

open_channel(node_pubkey_string: str, amount_sat: int, sat_per_vbyte: float)

Conversion done.

router_send(pub_key, amount, payment_request, last_hop_pubkey, outgoing_chan_id, fee_limit_msat, payment_request_raw)

SendPaymentV2 attempts to route a payment described by the passed PaymentRequest to the final destination. The call returns a stream of payment updates.

Does not allow for self-payment.

rpc(method: str, **kwargs)

send_coins(addr: str, satoshi: int, sat_per_vbyte: int, send_all: bool = False)

send_payment(payment_request, route)

set_channel_fee(channel, *args, **kwargs)

Conversion done.

sign_message(msg)

orb.cln.cln_rest.encode_pk(PK)