ListPayments

ListPayments is a wrapper around lnd's lnrpc.ListPayments method that only returns payments that involve at least one Taproot Asset. The full lnd payment is returned along with the decoded asset amounts that the payment's HTLCs carry, so that callers don't need to parse the custom channel data themselves. All request fields behave the same way as they do for lnd's lnrpc.ListPayments RPC method.

Source: tapchannelrpc/tapchannel.proto

gRPC

rpc ListPayments (ListPaymentsRequest) returns (ListPaymentsResponse);

REST

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

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 = 'TAPD_DIR/data/regtest/admin.macaroon'
const TLS_PATH = 'TAPD_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 = {
  request: <ListPaymentsRequest>,
};
client.listPayments(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "payments": <AssetPayment>,
//    "first_index_offset": <uint64>,
//    "last_index_offset": <uint64>,
//  }

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 = 'TAPD_DIR/data/regtest/admin.macaroon'
TLS_PATH = 'TAPD_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.ListPaymentsRequest(
  request=<ListPaymentsRequest>,
)
response = stub.ListPayments(request)
print(response)
# {
#    "payments": <AssetPayment>,
#    "first_index_offset": <uint64>,
#    "last_index_offset": <uint64>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightninglabs/taproot-assets
# Also requires: https://github.com/lightningnetwork/lnd
GRPC_HOST=localhost:10029
TAPD_DIR=~/.tapd
TAPD_SOURCE=path/to/taproot-assets
LND_SOURCE=path/to/lnd
NETWORK=mainnet
MACAROON_PATH="$TAPD_DIR/data/$NETWORK/admin.macaroon"
TLS_PATH="$TAPD_DIR/tls.cert"

grpcurl \
    -import-path $TAPD_SOURCE/taprpc/ \
    -import-path $LND_SOURCE/lnrpc \
    -proto tapchannelrpc/tapchannel.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "request": <ListPaymentsRequest> }' \
    $GRPC_HOST \
    tapchannelrpc.TaprootAssetChannels/ListPayments

REST

Javascript

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

const REST_HOST = 'localhost:8089'
const MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'

let requestBody = {
  request: <object>, // <ListPaymentsRequest> 
};
let options = {
  url: `https://${REST_HOST}/v1/taproot-assets/channels/payments`,
  // 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:
//  {
//    "payments": <array>, // <AssetPayment> 
//    "first_index_offset": <string>, // <uint64> 
//    "last_index_offset": <string>, // <uint64> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8089'
MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'
TLS_PATH = 'TAPD_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/taproot-assets/channels/payments'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'request': <ListPaymentsRequest>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "payments": <AssetPayment>,
#    "first_index_offset": <uint64>,
#    "last_index_offset": <uint64>,
# }

curl

REST_HOST=localhost:8089
TAPD_DIR=~/.tapd
NETWORK=mainnet
MACAROON_PATH="$TAPD_DIR/data/$NETWORK/admin.macaroon"
TLS_PATH="$TAPD_DIR/tls.cert"

curl -X POST \
    --cacert $TLS_PATH \
    -H "Grpc-Metadata-macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "request": <ListPaymentsRequest> }' \
    https://$REST_HOST/v1/taproot-assets/channels/payments

Messages

tapchannelrpc.ListPaymentsRequest

Source: tapchannelrpc/tapchannel.proto

Field	gRPC Type	REST Type	REST Placement
request The standard lnd payment listing request. All fields behave the same way as they do for lnd's lnrpc.ListPayments RPC method (see the API docs at https://lightning.engineering/api-docs/api/lnd/lightning/list-payments for more details). Pagination is performed by lnd over all payments; the returned set is then filtered down to only those that involve assets, so a page may contain fewer asset payments than the requested maximum.	ListPaymentsRequest	object	body

tapchannelrpc.ListPaymentsResponse

Source: tapchannelrpc/tapchannel.proto

Field	gRPC Type	REST Type
payments The list of asset payments that matched the request.	AssetPayment[]	array
first_index_offset The index of the first item in the set of returned payments. This can be used to seek backwards, pagination style. Mirrors the value returned by lnd's lnrpc.ListPayments.	uint64	string
last_index_offset The index of the last item in the set of returned payments. This can be used to seek further, pagination style. Mirrors the value returned by lnd's lnrpc.ListPayments.	uint64	string

Nested Messages

tapchannelrpc.AssetAmount

Field	gRPC Type	REST Type
asset_id The asset ID (genesis ID of the tranche) the amount refers to.	bytes	string
amount The amount, expressed in units of the asset identified by asset_id.	uint64	string
group_key The tweaked group key the asset belongs to, in compressed form. Empty for assets that aren't part of a group, or whose group is unknown to this tapd instance. Populated so callers that work in terms of group keys (e.g. wallets backing a fungible group of tranches) don't need a separate lookup per result.	bytes	string

tapchannelrpc.AssetPayment

Field	gRPC Type	REST Type
payment The full lnd payment, including any custom channel data on its HTLCs.	Payment	object
asset_amounts The asset amounts carried by the payment, aggregated per asset ID across all non-failed HTLC attempts. Empty for payments that did not (yet) move any assets.	AssetAmount[]	array