AccountPayments

AccountPayments returns the detailed payment history for the given account.

Source: lit-accounts.proto

gRPC

rpc AccountPayments (AccountPaymentsRequest) returns (AccountPaymentsResponse);

REST

HTTP Method	Path
GET	/v1/accounts/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:8443'
const MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
const TLS_PATH = 'LIT_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('lit-accounts.proto', loaderOptions);
const litrpc = grpc.loadPackageDefinition(packageDefinition).litrpc;
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 litrpc.Accounts(GRPC_HOST, creds);
let request = {
  account: <AccountIdentifier>,
  max_payments: <uint64>,
  index_offset: <uint64>,
  count_total_payments: <bool>,
};
client.accountPayments(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "payments": <Payment>,
//    "first_index_offset": <uint64>,
//    "last_index_offset": <uint64>,
//    "total_num_payments": <uint64>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the lit-accounts.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import lit-accounts_pb2 as litrpc, lit-accounts_pb2_grpc as lit-accountsstub

GRPC_HOST = 'localhost:8443'
MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
TLS_PATH = 'LIT_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 = lit-accountsstub.AccountsStub(channel)
request = litrpc.AccountPaymentsRequest(
  account=<AccountIdentifier>,
  max_payments=<uint64>,
  index_offset=<uint64>,
  count_total_payments=<bool>,
)
response = stub.AccountPayments(request)
print(response)
# {
#    "payments": <Payment>,
#    "first_index_offset": <uint64>,
#    "last_index_offset": <uint64>,
#    "total_num_payments": <uint64>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightninglabs/lightning-terminal
GRPC_HOST=localhost:8443
LIT_DIR=~/.lit
LIT_SOURCE=path/to/lightning-terminal
NETWORK=mainnet
MACAROON_PATH="$LIT_DIR/$NETWORK/lit.macaroon"
TLS_PATH="$LIT_DIR/tls.cert"

grpcurl \
    -import-path $LIT_SOURCE/litrpc/ \
    -proto lit-accounts.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "account": <AccountIdentifier>, "max_payments": <uint64>, "index_offset": <uint64>, "count_total_payments": <bool> }' \
    $GRPC_HOST \
    litrpc.Accounts/AccountPayments

REST

Javascript

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

const REST_HOST = 'localhost:8443'
const MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'

let options = {
  url: `https://${REST_HOST}/v1/accounts/payments`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "payments": <array>, // <Payment> 
//    "first_index_offset": <string>, // <uint64> 
//    "last_index_offset": <string>, // <uint64> 
//    "total_num_payments": <string>, // <uint64> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8443'
MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
TLS_PATH = 'LIT_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/accounts/payments'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "payments": <Payment>,
#    "first_index_offset": <uint64>,
#    "last_index_offset": <uint64>,
#    "total_num_payments": <uint64>,
# }

curl

REST_HOST=localhost:8443
LIT_DIR=~/.lit
NETWORK=mainnet
MACAROON_PATH="$LIT_DIR/$NETWORK/lit.macaroon"
TLS_PATH="$LIT_DIR/tls.cert"

curl \
    --cacert $TLS_PATH \
    -H "Grpc-Metadata-macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    https://$REST_HOST/v1/accounts/payments

litcli

$ litcli accounts payments --help

NAME:
   litcli accounts payments - Show detailed payment history for a single off-chain account.

USAGE:
   litcli accounts payments [command options] [id | label]

DESCRIPTION:
   Returns the detailed payment history for an account by fetching their stored hashes and querying LND. The results are returned paginated and sorted in ascending lexicographical order of their payment hash.

OPTIONS:
   --id value              The ID of the account.
   --label value           (optional) The unique label of the account.
   --max_payments value    The maximum number of payments to return. The default value is 20 and the maximum is 50. (default: 20)
   --index_offset value    The row offset into the list of payments that will be used as the start of the query. (default: 0)
   --count_total_payments  If true, the total number of payments matching the query will be returned.
   

Messages

litrpc.AccountPaymentsRequest

Source: lit-accounts.proto

Field	gRPC Type	REST Type	REST Placement
account The identifier of the account to query payments for. Nested REST Parameters account.id: string in query account.label: string in query	AccountIdentifier	object	query
max_payments The maximum number of payments to return. If set to 0, it will default to 20. Capped at 50.	uint64	string	query
index_offset The row offset into the list of payments that will be used as the start of the query. The payments are returned in ascending lexicographical order of their payment hash.	uint64	string	query
count_total_payments If set, the total number of payments matching the query will be returned in the response.	bool	boolean	query

litrpc.AccountPaymentsResponse

Source: lit-accounts.proto

Field	gRPC Type	REST Type
payments The detailed payments associated with the account, sorted in ascending lexicographical order of their payment hash.	Payment[]	array
first_index_offset The row offset of the first payment returned.	uint64	string
last_index_offset The row offset of the last payment returned. This can be used as the index_offset in a subsequent query to paginate forwards.	uint64	string
total_num_payments The total number of payments matching the query (only set if count_total_payments was true in the request).	uint64	string

Nested Messages

litrpc.AccountIdentifier

Field	gRPC Type	REST Type
id The ID of the account.	string	string
label The label of the account.	string	string