AddInvoice

AddInvoice is a wrapper around lnd's lnrpc.AddInvoice method with asset specific parameters. It allows RPC users to create invoices that correspond to the specified asset amount.

Source: tapchannelrpc/tapchannel.proto

gRPC

rpc AddInvoice (AddInvoiceRequest) returns (AddInvoiceResponse);

REST

HTTP Method	Path
POST	/v1/taproot-assets/channels/invoice

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10029'
const MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
const TLS_PATH = 'TAPROOT-ASSETS_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('tapchannelrpc/tapchannel.proto', loaderOptions);
const tapchannelrpc = grpc.loadPackageDefinition(packageDefinition).tapchannelrpc;
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 tapchannelrpc.TaprootAssetChannels(GRPC_HOST, creds);
let request = {
  asset_id: <bytes>,
  asset_amount: <uint64>,
  peer_pubkey: <bytes>,
  invoice_request: <Invoice>,
  hodl_invoice: <HodlInvoice>,
};
client.addInvoice(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "accepted_buy_quote": <PeerAcceptedBuyQuote>,
//    "invoice_result": <AddInvoiceResponse>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the tapchannelrpc/tapchannel.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import tapchannel_pb2 as tapchannelrpc, tapchannel_pb2_grpc as tapchannelstub

GRPC_HOST = 'localhost:10029'
MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
TLS_PATH = 'TAPROOT-ASSETS_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 = tapchannelstub.TaprootAssetChannelsStub(channel)
request = tapchannelrpc.AddInvoiceRequest(
  asset_id=<bytes>,
  asset_amount=<uint64>,
  peer_pubkey=<bytes>,
  invoice_request=<Invoice>,
  hodl_invoice=<HodlInvoice>,
)
response = stub.AddInvoice(request)
print(response)
# {
#    "accepted_buy_quote": <PeerAcceptedBuyQuote>,
#    "invoice_result": <AddInvoiceResponse>,
# }

REST

Javascript

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

const REST_HOST = 'localhost:8089'
const MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'

let requestBody = {
  asset_id: <string>, // <bytes> (base64 encoded)
  asset_amount: <string>, // <uint64> 
  peer_pubkey: <string>, // <bytes> (base64 encoded)
  invoice_request: <object>, // <Invoice> 
  hodl_invoice: <object>, // <HodlInvoice> 
};
let options = {
  url: `https://${REST_HOST}/v1/taproot-assets/channels/invoice`,
  // 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:
//  {
//    "accepted_buy_quote": <object>, // <PeerAcceptedBuyQuote> 
//    "invoice_result": <object>, // <AddInvoiceResponse> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8089'
MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
TLS_PATH = 'TAPROOT-ASSETS_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/taproot-assets/channels/invoice'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'asset_id': base64.b64encode(<bytes>),
  'asset_amount': <uint64>,
  'peer_pubkey': base64.b64encode(<bytes>),
  'invoice_request': <Invoice>,
  'hodl_invoice': <HodlInvoice>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "accepted_buy_quote": <PeerAcceptedBuyQuote>,
#    "invoice_result": <AddInvoiceResponse>,
# }

Shell

# There is no CLI command for this RPC

Messages

tapchannelrpc.AddInvoiceRequest

Source: tapchannelrpc/tapchannel.proto

Field	gRPC Type	REST Type	REST Placement
asset_id The asset ID to use for the invoice.	bytes	string	body
asset_amount The asset amount to receive.	uint64	string	body
peer_pubkey The node identity public key of the peer to ask for a quote for receiving assets and converting them from satoshis. This must be specified if there are multiple channels with the given asset ID.	bytes	string	body
invoice_request The full lnd invoice request to send. All fields (except for the value and the route hints) behave the same way as they do for lnd's lnrpc.AddInvoice RPC method (see the API docs at https://lightning.engineering/api-docs/api/lnd/lightning/add-invoice for more details). The value/value_msat fields will be overwritten by the satoshi (or milli-satoshi) equivalent of the asset amount, after negotiating a quote with a peer that supports the given asset ID.	Invoice	object	body
hodl_invoice If set, then this will make the invoice created a hodl invoice, which won't be settled automatically. Instead, users will need to use the invoicesrpc.SettleInvoice call to manually settle the invoice.	HodlInvoice	object	body

tapchannelrpc.AddInvoiceResponse

Source: tapchannelrpc/tapchannel.proto

Field	gRPC Type	REST Type
accepted_buy_quote The quote for the purchase of assets that was accepted by the peer.	PeerAcceptedBuyQuote	object
invoice_result The result of the invoice creation.	AddInvoiceResponse	object

Nested Messages

rfqrpc.FixedPoint

Field	gRPC Type	REST Type
coefficient The coefficient is the fractional value scaled-up as an integer. This integer is represented as a string as it may be too large to fit in a uint64.	string	string
scale The scale is the component that determines how many decimal places the coefficient should be divided by to obtain the fractional value.	uint32	integer

rfqrpc.PeerAcceptedBuyQuote

Field	gRPC Type	REST Type
peer Quote counterparty peer.	string	string
id The unique identifier of the quote request.	bytes	string
scid scid is the short channel ID of the channel over which the payment for the quote should be made.	uint64	string
asset_amount asset_amount is the amount of the subject asset.	uint64	string
ask_asset_rate ask_asset_rate is the asset to BTC conversion rate represented as a fixed-point number.	FixedPoint	object
expiry The unix timestamp in seconds after which the quote is no longer valid.	uint64	string

tapchannelrpc.HodlInvoice

Field	gRPC Type	REST Type
payment_hash	bytes	string