Node.js

2min
Connect to a Voltage Node using Node.js
Firsrt, install the gRPC requirements for Node.js
Text
npm install --save @grpc/grpc-js
npm install --save @grpc/grpc-js
﻿
Next, you can use this script to make a getinfo call to your node!
Node.js
const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');
const loaderOptions = {
    keepCase: true,
    longs: String,
    enums: String,
    defaults: true,
    oneofs: true
};
const packageDefinition = protoLoader.loadSync('lightning.proto', loaderOptions);


async function main() {
    process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA'

    let m = fs.readFileSync('~/.lnd/admin.macaroon');
    let macaroon = m.toString('hex');

    // build meta data credentials
    let metadata = new grpc.Metadata()
    metadata.add('macaroon', macaroon)
    let macaroonCreds = grpc.credentials.createFromMetadataGenerator((_args, callback) => {
        callback(null, metadata);
    });

    // build ssl credentials without needing to pass in the cert
    const sslCreds = grpc.credentials.createSsl();

    // combine the cert credentials and the macaroon auth credentials
    // such that every call is properly encrypted and authenticated
    let credentials = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);

    // Pass the crendentials when creating a channel
    let lnrpcDescriptor = grpc.loadPackageDefinition(packageDefinition);
    let lnrpc = lnrpcDescriptor.lnrpc;
    let client = new lnrpc.Lightning('node-name.m.voltageapp.io:10009', credentials);

    client.getInfo({}, (err, response) => {
        if (err) {
            console.log('Error: ' + err);
        }
        console.log('GetInfo:', response);
    });
}
const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');
const loaderOptions = {
    keepCase: true,
    longs: String,
    enums: String,
    defaults: true,
    oneofs: true
};
const packageDefinition = protoLoader.loadSync('lightning.proto', loaderOptions);


async function main() {
    process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA'

    let m = fs.readFileSync('~/.lnd/admin.macaroon');
    let macaroon = m.toString('hex');

    // build meta data credentials
    let metadata = new grpc.Metadata()
    metadata.add('macaroon', macaroon)
    let macaroonCreds = grpc.credentials.createFromMetadataGenerator((_args, callback) => {
        callback(null, metadata);
    });

    // build ssl credentials without needing to pass in the cert
    const sslCreds = grpc.credentials.createSsl();

    // combine the cert credentials and the macaroon auth credentials
    // such that every call is properly encrypted and authenticated
    let credentials = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);

    // Pass the crendentials when creating a channel
    let lnrpcDescriptor = grpc.loadPackageDefinition(packageDefinition);
    let lnrpc = lnrpcDescriptor.lnrpc;
    let client = new lnrpc.Lightning('node-name.m.voltageapp.io:10009', credentials);

    client.getInfo({}, (err, response) => {
        if (err) {
            console.log('Error: ' + err);
        }
        console.log('GetInfo:', response);
    });
}
﻿
See more examples below:
﻿GRPC API Examples﻿﻿
﻿REST API Examples﻿﻿
﻿
Updated 17 May 2024
Did this page help you?
Connect to Your Node
LNBits