GetChanInfo

GetChanInfo returns the latest authenticated network announcement for the given channel identified by its channel ID: an 8-byte integer which uniquely identifies the location of transaction's funding output within the blockchain.

Source: lightning.proto

gRPC

rpc GetChanInfo (ChanInfoRequest) returns (ChannelEdge);

REST

HTTP Method	Path
GET	/v1/graph/edge/{chan_id}

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', loaderOptions);
const lnrpc = grpc.loadPackageDefinition(packageDefinition).lnrpc;
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 lnrpc.Lightning(GRPC_HOST, creds);
let request = {
  chan_id: <uint64>,
  chan_point: <string>,
};
client.getChanInfo(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "channel_id": <uint64>,
//    "chan_point": <string>,
//    "last_update": <uint32>,
//    "node1_pub": <string>,
//    "node2_pub": <string>,
//    "capacity": <int64>,
//    "node1_policy": <RoutingPolicy>,
//    "node2_policy": <RoutingPolicy>,
//    "custom_records": <CustomRecordsEntry>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the lightning.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import lightning_pb2 as lnrpc, lightning_pb2_grpc as lightningstub

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 = lightningstub.LightningStub(channel)
request = lnrpc.ChanInfoRequest(
  chan_id=<uint64>,
  chan_point=<string>,
)
response = stub.GetChanInfo(request)
print(response)
# {
#    "channel_id": <uint64>,
#    "chan_point": <string>,
#    "last_update": <uint32>,
#    "node1_pub": <string>,
#    "node2_pub": <string>,
#    "capacity": <int64>,
#    "node1_policy": <RoutingPolicy>,
#    "node2_policy": <RoutingPolicy>,
#    "custom_records": <CustomRecordsEntry>,
# }

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 options = {
  url: `https://${REST_HOST}/v1/graph/edge/{chan_id}`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "channel_id": <string>, // <uint64> 
//    "chan_point": <string>, // <string> 
//    "last_update": <integer>, // <uint32> 
//    "node1_pub": <string>, // <string> 
//    "node2_pub": <string>, // <string> 
//    "capacity": <string>, // <int64> 
//    "node1_policy": <object>, // <RoutingPolicy> 
//    "node2_policy": <object>, // <RoutingPolicy> 
//    "custom_records": <object>, // <CustomRecordsEntry> 
//  }

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}/v1/graph/edge/{chan_id}'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "channel_id": <uint64>,
#    "chan_point": <string>,
#    "last_update": <uint32>,
#    "node1_pub": <string>,
#    "node2_pub": <string>,
#    "capacity": <int64>,
#    "node1_policy": <RoutingPolicy>,
#    "node2_policy": <RoutingPolicy>,
#    "custom_records": <CustomRecordsEntry>,
# }

Shell

$ lncli getchaninfo --help

NAME:
   lncli getchaninfo - Get the state of a channel.

USAGE:
   lncli getchaninfo [command options] chan_id

CATEGORY:
   Graph

DESCRIPTION:
   Prints out the latest authenticated state for a particular channel

OPTIONS:
   --chan_id value     The 8-byte compact channel ID to query for. If this is set the chan_point param is ignored. (default: 0)
   --chan_point value  The channel point in format txid:index. If the chan_id param is set this param is ignored.
   

Messages

lnrpc.ChanInfoRequest

Source: lightning.proto

Field	gRPC Type	REST Type	REST Placement
chan_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	path
chan_point The channel point of the channel in format funding_txid:output_index. If chan_id is specified, this field is ignored.	string	string	query

lnrpc.ChannelEdge

Source: lightning.proto

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

Nested Messages

lnrpc.ChannelEdge.CustomRecordsEntry

Field	gRPC Type	REST Type
key	uint64	unknown
value	bytes	unknown

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
inbound_fee_base_msat	int32	integer
inbound_fee_rate_milli_msat	int32	integer

lnrpc.RoutingPolicy.CustomRecordsEntry

Field	gRPC Type	REST Type
key	uint64	unknown
value	bytes	unknown