CreateOffer

CreateOffer creates a new BOLT 12 offer. The offer is persisted in the offer store and the encoded offer string (lno1...) is returned. The node must run with --protocol.bolt12-offers.

Source: devrpc/dev.proto

gRPC

rpc CreateOffer (CreateOfferRequest) returns (CreateOfferResponse);

REST

HTTP Method	Path
POST	/v2/dev/createoffer

Code Samples

gRPC

Javascript

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', 'devrpc/dev.proto'], loaderOptions);
const devrpc = grpc.loadPackageDefinition(packageDefinition).devrpc;
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 devrpc.Dev(GRPC_HOST, creds);
let request = {
  description: <string>,
  amount_msat: <uint64>,
  absolute_expiry: <uint64>,
  quantity_max: <uint64>,
};
client.createOffer(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "offer": <string>,
//    "offer_hash": <bytes>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the devrpc/dev.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import dev_pb2 as devrpc, dev_pb2_grpc as devstub

GRPC_HOST = 'localhost:10009'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/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 = devstub.DevStub(channel)
request = devrpc.CreateOfferRequest(
  description=<string>,
  amount_msat=<uint64>,
  absolute_expiry=<uint64>,
  quantity_max=<uint64>,
)
response = stub.CreateOffer(request)
print(response)
# {
#    "offer": <string>,
#    "offer_hash": <bytes>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightningnetwork/lnd
GRPC_HOST=localhost:10009
LND_DIR=~/.lnd
LND_SOURCE=path/to/lnd
NETWORK=mainnet
MACAROON_PATH="$LND_DIR/data/chain/bitcoin/$NETWORK/admin.macaroon"
TLS_PATH="$LND_DIR/tls.cert"

grpcurl \
    -import-path $LND_SOURCE/lnrpc/ \
    -proto devrpc/dev.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "description": <string>, "amount_msat": <uint64>, "absolute_expiry": <uint64>, "quantity_max": <uint64> }' \
    $GRPC_HOST \
    devrpc.Dev/CreateOffer

REST

Javascript

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

const REST_HOST = 'localhost:8080'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'

let requestBody = {
  description: <string>, // <string> 
  amount_msat: <string>, // <uint64> 
  absolute_expiry: <string>, // <uint64> 
  quantity_max: <string>, // <uint64> 
};
let options = {
  url: `https://${REST_HOST}/v2/dev/createoffer`,
  // 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:
//  {
//    "offer": <string>, // <string> 
//    "offer_hash": <string>, // <bytes> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8080'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

url = f'https://{REST_HOST}/v2/dev/createoffer'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'description': <string>,
  'amount_msat': <uint64>,
  'absolute_expiry': <uint64>,
  'quantity_max': <uint64>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "offer": <string>,
#    "offer_hash": <bytes>,
# }

curl

REST_HOST=localhost:8080
LND_DIR=~/.lnd
NETWORK=mainnet
MACAROON_PATH="$LND_DIR/data/chain/bitcoin/$NETWORK/admin.macaroon"
TLS_PATH="$LND_DIR/tls.cert"

curl -X POST \
    --cacert $TLS_PATH \
    -H "Grpc-Metadata-macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "description": <string>, "amount_msat": <uint64>, "absolute_expiry": <uint64>, "quantity_max": <uint64> }' \
    https://$REST_HOST/v2/dev/createoffer

Messages

devrpc.CreateOfferRequest

Source: devrpc/dev.proto

Field	gRPC Type	REST Type	REST Placement
description A UTF-8 description of the purpose of the payment. Required when amount_msat is set.	string	string	body
amount_msat The amount expected per item in millisatoshis. Zero or unset means the payer chooses the amount.	uint64	string	body
absolute_expiry Seconds since epoch after which the offer expires. Zero or unset means no expiry.	uint64	string	body
quantity_max Maximum number of items that can be requested in a single invoice. Zero means unlimited. If not set, quantity selection is not supported.	uint64	string	body

devrpc.CreateOfferResponse

Source: devrpc/dev.proto

Field	gRPC Type	REST Type
offer The bech32-encoded offer string (lno1...).	string	string
offer_hash The 32-byte offer hash: the SHA256 of the offer's TLV records.	bytes	string