GetLsatTokens

danger

This RPC is deprecated and will be removed in a future version.

Deprecated: use GetL402Tokens. This API is provided to maintain backward compatibility with gRPC clients (e.g. loop listauth, Terminal Web, RTL). Type LsatToken used by GetLsatTokens in the past was renamed to L402Token, but this does not affect binary encoding, so we can use type L402Token here.

Source: looprpc/client.proto

gRPC

rpc GetLsatTokens (TokensRequest) returns (TokensResponse);

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:11010'
const MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
const TLS_PATH = 'LOOP_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('looprpc/client.proto', loaderOptions);
const looprpc = grpc.loadPackageDefinition(packageDefinition).looprpc;
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 looprpc.SwapClient(GRPC_HOST, creds);
let request = {};
client.getLsatTokens(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "tokens": <L402Token>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the looprpc/client.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import client_pb2 as looprpc, client_pb2_grpc as clientstub

GRPC_HOST = 'localhost:11010'
MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
TLS_PATH = 'LOOP_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 = clientstub.SwapClientStub(channel)
request = looprpc.TokensRequest()
response = stub.GetLsatTokens(request)
print(response)
# {
#    "tokens": <L402Token>,
# }

Shell

# There is no CLI command for this RPC

Messages

looprpc.TokensRequest

Source: looprpc/client.proto

note

This request has no parameters.

looprpc.TokensResponse

Source: looprpc/client.proto

Field	gRPC Type	REST Type
tokens List of all tokens the daemon knows of, including old/expired tokens.	L402Token[]	array

Nested Messages

looprpc.L402Token

Field	gRPC Type	REST Type
base_macaroon The base macaroon that was baked by the auth server.	bytes	string
payment_hash The payment hash of the payment that was paid to obtain the token.	bytes	string
payment_preimage The preimage of the payment hash, knowledge of this is proof that the payment has been paid. If the preimage is set to all zeros, this means the payment is still pending and the token is not yet fully valid.	bytes	string
amount_paid_msat The amount of millisatoshis that was paid to get the token.	int64	string
routing_fee_paid_msat The amount of millisatoshis paid in routing fee to pay for the token.	int64	string
time_created The creation time of the token as UNIX timestamp in seconds.	int64	string
expired Indicates whether the token is expired or still valid.	bool	boolean
storage_name Identifying attribute of this token in the store. Currently represents the file name of the token where it's stored on the file system.	string	string
id The l402 ID of the token.	string	string