Skip to main content

AddHoldInvoice

AddHoldInvoice creates a hold invoice. It ties the invoice to the hash supplied in the request.

Source: invoicesrpc/invoices.proto

gRPC

rpc AddHoldInvoice (AddHoldInvoiceRequest) returns (AddHoldInvoiceResp);

REST

HTTP MethodPath
POST /v2/invoices/hodl

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', 'invoicesrpc/invoices.proto'], loaderOptions);
const invoicesrpc = grpc.loadPackageDefinition(packageDefinition).invoicesrpc;
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 invoicesrpc.Invoices(GRPC_HOST, creds);
let request = {
memo: <string>,
hash: <bytes>,
value: <int64>,
value_msat: <int64>,
description_hash: <bytes>,
expiry: <int64>,
fallback_addr: <string>,
cltv_expiry: <uint64>,
route_hints: <RouteHint>,
private: <bool>,
};
client.addHoldInvoice(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "payment_request": <string>,
// "add_index": <uint64>,
// "payment_addr": <bytes>,
// }

Messages

invoicesrpc.AddHoldInvoiceRequest

Source: invoicesrpc/invoices.proto

FieldgRPC TypeREST TypeREST Placement
memo
stringstringbody
hash
bytesstringbody
value
int64stringbody
value_msat
int64stringbody
description_hash
bytesstringbody
expiry
int64stringbody
fallback_addr
stringstringbody
cltv_expiry
uint64stringbody
route_hints
RouteHint[]arraybody
private
boolbooleanbody

invoicesrpc.AddHoldInvoiceResp

Source: invoicesrpc/invoices.proto

FieldgRPC TypeREST Type
payment_request
stringstring
add_index
uint64string
payment_addr
bytesstring

Nested Messages

lnrpc.HopHint

FieldgRPC TypeREST Type
node_id
stringstring
chan_id
uint64string
fee_base_msat
uint32integer
fee_proportional_millionths
uint32integer
cltv_expiry_delta
uint32integer

lnrpc.RouteHint

FieldgRPC TypeREST Type
hop_hints
HopHint[]array