Skip to main content

SubscribeCustomMessages

SubscribeCustomMessages subscribes to a stream of incoming custom peer messages.

Source: lightning.proto

gRPC

info

This is a server-streaming RPC

rpc SubscribeCustomMessages (SubscribeCustomMessagesRequest) returns (stream CustomMessage);

REST

HTTP MethodPath
GET /v1/custommessage/subscribe

Code Samples

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 = {};
let call = client.subscribeCustomMessages(request);
call.on('data', function(response) {
// A response was received from the server.
console.log(response);
});
call.on('status', function(status) {
// The current status of the stream.
});
call.on('end', function() {
// The server has closed the stream.
});
// Console output:
// {
// "peer": <bytes>,
// "type": <uint32>,
// "data": <bytes>,
// }

Messages

lnrpc.SubscribeCustomMessagesRequest

Source: lightning.proto

note

This request has no parameters.

lnrpc.CustomMessage

Source: lightning.proto

FieldgRPC TypeREST Type
peer
bytesstring
type
uint32integer
data
bytesstring