ImportGraph

ImportGraph imports a ChannelGraph into the graph database. Should only be used for development.

Source: devrpc/dev.proto

gRPC

rpc ImportGraph (ChannelGraph) returns (ImportGraphResponse);

REST

HTTP Method	Path
POST	/v2/dev/importgraph

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10009'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
const TLS_PATH = 'LND_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync(['lightning.proto', 'devrpc/dev.proto'], loaderOptions);
const devrpc = grpc.loadPackageDefinition(packageDefinition).devrpc;
process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA';
const tlsCert = fs.readFileSync(TLS_PATH);
const sslCreds = grpc.credentials.createSsl(tlsCert);
const macaroon = fs.readFileSync(MACAROON_PATH).toString('hex');
const macaroonCreds = grpc.credentials.createFromMetadataGenerator(function(args, callback) {
  let metadata = new grpc.Metadata();
  metadata.add('macaroon', macaroon);
  callback(null, metadata);
});
let creds = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);
let client = new devrpc.Dev(GRPC_HOST, creds);
let request = {
  nodes: <LightningNode>,
  edges: <ChannelEdge>,
};
client.importGraph(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the devrpc/dev.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import dev_pb2 as devrpc, dev_pb2_grpc as devstub

GRPC_HOST = 'localhost:10009'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

# create macaroon credentials
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
def metadata_callback(context, callback):
  callback([('macaroon', macaroon)], None)
auth_creds = grpc.metadata_call_credentials(metadata_callback)
# create SSL credentials
os.environ['GRPC_SSL_CIPHER_SUITES'] = 'HIGH+ECDSA'
cert = open(TLS_PATH, 'rb').read()
ssl_creds = grpc.ssl_channel_credentials(cert)
# combine macaroon and SSL credentials
combined_creds = grpc.composite_channel_credentials(ssl_creds, auth_creds)
# make the request
channel = grpc.secure_channel(GRPC_HOST, combined_creds)
stub = devstub.DevStub(channel)
request = devrpc.ChannelGraph(
  nodes=<LightningNode>,
  edges=<ChannelEdge>,
)
response = stub.ImportGraph(request)
print(response)
# {
# }

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8080'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'

let requestBody = {
  nodes: <array>, // <LightningNode> 
  edges: <array>, // <ChannelEdge> 
};
let options = {
  url: `https://${REST_HOST}/v2/dev/importgraph`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
  form: JSON.stringify(requestBody),
}
request.post(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8080'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

url = f'https://{REST_HOST}/v2/dev/importgraph'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'nodes': <LightningNode>,
  'edges': <ChannelEdge>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
# }

Shell

# There is no CLI command for this RPC

Messages

lnrpc.ChannelGraph

Source: lightning.proto

Field	gRPC Type	REST Type	REST Placement
nodes The list of LightningNodes in this channel graph	LightningNode[]	array	body
edges The list of ChannelEdges in this channel graph	ChannelEdge[]	array	body

devrpc.ImportGraphResponse

Source: devrpc/dev.proto

note

This response has no parameters.

Nested Messages

lnrpc.LightningNode

Field	gRPC Type	REST Type
last_update	uint32	integer
pub_key	string	string
alias	string	string
addresses	NodeAddress[]	array
color	string	string
features	FeaturesEntry[]	object
custom_records Custom node announcement tlv records.	CustomRecordsEntry[]	object

lnrpc.NodeAddress

Field	gRPC Type	REST Type
network	string	string
addr	string	string

lnrpc.LightningNode.FeaturesEntry

Field	gRPC Type	REST Type
key	uint32	unknown
value	Feature	unknown

lnrpc.Feature

Field	gRPC Type	REST Type
name	string	string
is_required	bool	boolean
is_known	bool	boolean

lnrpc.LightningNode.CustomRecordsEntry

Field	gRPC Type	REST Type
key	uint64	unknown
value	bytes	unknown

lnrpc.ChannelEdge

Field	gRPC Type	REST Type
channel_id The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.	uint64	string
chan_point	string	string
last_update	uint32	integer
node1_pub	string	string
node2_pub	string	string
capacity	int64	string
node1_policy	RoutingPolicy	object
node2_policy	RoutingPolicy	object
custom_records Custom channel announcement tlv records.	CustomRecordsEntry[]	object

lnrpc.RoutingPolicy

Field	gRPC Type	REST Type
time_lock_delta	uint32	integer
min_htlc	int64	string
fee_base_msat	int64	string
fee_rate_milli_msat	int64	string
disabled	bool	boolean
max_htlc_msat	uint64	string
last_update	uint32	integer
custom_records Custom channel update tlv records.	CustomRecordsEntry[]	object

lnrpc.RoutingPolicy.CustomRecordsEntry

Field	gRPC Type	REST Type
key	uint64	unknown
value	bytes	unknown

lnrpc.ChannelEdge.CustomRecordsEntry

Field	gRPC Type	REST Type
key	uint64	unknown
value	bytes	unknown