Skip to main content

DecodePayReq

DecodePayReq takes an encoded payment request string and attempts to decode it, returning a full description of the conditions encoded within the payment request.

Source: lightning.proto

gRPC

rpc DecodePayReq (PayReqString) returns (PayReq);

REST

HTTP MethodPath
GET /v1/payreq/{pay_req}

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 = {
pay_req: <string>,
};
client.decodePayReq(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "destination": <string>,
// "payment_hash": <string>,
// "num_satoshis": <int64>,
// "timestamp": <int64>,
// "expiry": <int64>,
// "description": <string>,
// "description_hash": <string>,
// "fallback_addr": <string>,
// "cltv_expiry": <int64>,
// "route_hints": <RouteHint>,
// "payment_addr": <bytes>,
// "num_msat": <int64>,
// "features": <FeaturesEntry>,
// }

Messages

lnrpc.PayReqString

Source: lightning.proto

FieldgRPC TypeREST TypeREST Placement
pay_req
stringstringpath

lnrpc.PayReq

Source: lightning.proto

FieldgRPC TypeREST Type
destination
stringstring
payment_hash
stringstring
num_satoshis
int64string
timestamp
int64string
expiry
int64string
description
stringstring
description_hash
stringstring
fallback_addr
stringstring
cltv_expiry
int64string
route_hints
RouteHint[]array
payment_addr
bytesstring
num_msat
int64string
features
FeaturesEntry[]object

Nested Messages

lnrpc.RouteHint

FieldgRPC TypeREST Type
hop_hints
HopHint[]array

lnrpc.HopHint

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

lnrpc.PayReq.FeaturesEntry

FieldgRPC TypeREST Type
key
uint32unknown
value
Featureunknown

lnrpc.Feature

FieldgRPC TypeREST Type
name
stringstring
is_required
boolboolean
is_known
boolboolean