GetChannelEvents

Get a list of channel events that occurred for a given channel.

Source: faraday.proto

gRPC

rpc GetChannelEvents (ChannelEventsRequest) returns (ChannelEventsResponse);

REST

HTTP Method	Path
POST	/v1/faraday/getchannelevents

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:8465'
const MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
const TLS_PATH = 'FARADAY_DIR/regtest/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('faraday.proto', loaderOptions);
const frdrpc = grpc.loadPackageDefinition(packageDefinition).frdrpc;
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 frdrpc.FaradayServer(GRPC_HOST, creds);
let request = {
  chan_point: <string>,
  start_time: <int64>,
  end_time: <int64>,
  max_events: <uint32>,
  last_id: <int64>,
};
client.getChannelEvents(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "events": <ChannelEvent>,
//    "last_id": <int64>,
//    "has_more": <bool>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the faraday.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import faraday_pb2 as frdrpc, faraday_pb2_grpc as faradaystub

GRPC_HOST = 'localhost:8465'
MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
TLS_PATH = 'FARADAY_DIR/regtest/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 = faradaystub.FaradayServerStub(channel)
request = frdrpc.ChannelEventsRequest(
  chan_point=<string>,
  start_time=<int64>,
  end_time=<int64>,
  max_events=<uint32>,
  last_id=<int64>,
)
response = stub.GetChannelEvents(request)
print(response)
# {
#    "events": <ChannelEvent>,
#    "last_id": <int64>,
#    "has_more": <bool>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightninglabs/faraday
GRPC_HOST=localhost:8465
FARADAY_DIR=~/.faraday
FARADAY_SOURCE=path/to/faraday
NETWORK=mainnet
MACAROON_PATH="$FARADAY_DIR/$NETWORK/faraday.macaroon"
TLS_PATH="$FARADAY_DIR/$NETWORK/tls.cert"

grpcurl \
    -import-path $FARADAY_SOURCE/frdrpc/ \
    -proto faraday.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "chan_point": <string>, "start_time": <int64>, "end_time": <int64>, "max_events": <uint32>, "last_id": <int64> }' \
    $GRPC_HOST \
    frdrpc.FaradayServer/GetChannelEvents

REST

Javascript

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

const REST_HOST = 'localhost:8082'
const MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'

let requestBody = {
  chan_point: <string>, // <string> 
  start_time: <string>, // <int64> 
  end_time: <string>, // <int64> 
  max_events: <integer>, // <uint32> 
  last_id: <string>, // <int64> 
};
let options = {
  url: `https://${REST_HOST}/v1/faraday/getchannelevents`,
  // 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:
//  {
//    "events": <array>, // <ChannelEvent> 
//    "last_id": <string>, // <int64> 
//    "has_more": <boolean>, // <bool> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8082'
MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
TLS_PATH = 'FARADAY_DIR/regtest/tls.cert'

url = f'https://{REST_HOST}/v1/faraday/getchannelevents'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'chan_point': <string>,
  'start_time': <int64>,
  'end_time': <int64>,
  'max_events': <uint32>,
  'last_id': <int64>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "events": <ChannelEvent>,
#    "last_id": <int64>,
#    "has_more": <bool>,
# }

curl

REST_HOST=localhost:8082
FARADAY_DIR=~/.faraday
NETWORK=mainnet
MACAROON_PATH="$FARADAY_DIR/$NETWORK/faraday.macaroon"
TLS_PATH="$FARADAY_DIR/$NETWORK/tls.cert"

curl -X POST \
    --cacert $TLS_PATH \
    -H "Grpc-Metadata-macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "chan_point": <string>, "start_time": <int64>, "end_time": <int64>, "max_events": <uint32>, "last_id": <int64> }' \
    https://$REST_HOST/v1/faraday/getchannelevents

Messages

frdrpc.ChannelEventsRequest

Source: faraday.proto

Field	gRPC Type	REST Type	REST Placement
chan_point The channel point of the channel to get events for, formatted txid:outpoint.	string	string	body
start_time Lower time bound, inclusive, as Unix seconds. Independent filter — does not need to advance between paginated calls. Zero means no lower bound.	int64	string	body
end_time Upper time bound, exclusive, as Unix seconds. Must be greater than or equal to start_time. Zero means "use the server's current time".	int64	string	body
max_events The maximum number of events to return. If zero, the server default is used. The server enforces a hard cap; values above the cap are clamped.	uint32	integer	body
last_id Pagination cursor: id of the last event from the previous response. Pass zero on the first call; for subsequent calls pass the response's last_id to resume past already-returned events.	int64	string	body

frdrpc.ChannelEventsResponse

Source: faraday.proto

Field	gRPC Type	REST Type
events The list of channel events.	ChannelEvent[]	array
last_id Id of the last event returned, suitable as the next request's last_id. Zero when events is empty.	int64	string
has_more True when the page filled to the requested limit and more events may be available; callers should keep paginating until this is false.	bool	boolean

Nested Messages

frdrpc.ChannelEvent

Field	gRPC Type	REST Type
timestamp The timestamp of the event, as Unix seconds.	int64	string
event_type The type of the event.	ChannelEventType	string
local_balance The channel's local balance at the time of the event in sat.	uint64	string
remote_balance The channel's remote balance at the time of the event in sat.	uint64	string
id Server-assigned monotonic identity. Echo this back as the next request's last_id when paginating.	int64	string

Enums

frdrpc.ChannelEventType

Name	Number
CHAN_EVENT_UNKNOWN An unknown event type.	0
CHAN_EVENT_ONLINE An online event.	1
CHAN_EVENT_OFFLINE An offline event.	2
CHAN_EVENT_UPDATE A channel balance update event.	3