GetInfo

GetInfo returns general information about the state of the Pool trader daemon.

Source: poolrpc/trader.proto

gRPC

rpc GetInfo (GetInfoRequest) returns (GetInfoResponse);

REST

HTTP Method	Path
GET	/v1/pool/info

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:12010'
const MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'
const TLS_PATH = 'POOL_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('poolrpc/trader.proto', loaderOptions);
const poolrpc = grpc.loadPackageDefinition(packageDefinition).poolrpc;
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 poolrpc.Trader(GRPC_HOST, creds);
let request = {};
client.getInfo(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "version": <string>,
//    "accounts_total": <uint32>,
//    "accounts_active": <uint32>,
//    "accounts_active_expired": <uint32>,
//    "accounts_archived": <uint32>,
//    "orders_total": <uint32>,
//    "orders_active": <uint32>,
//    "orders_archived": <uint32>,
//    "current_block_height": <uint32>,
//    "batches_involved": <uint32>,
//    "node_rating": <NodeRating>,
//    "lsat_tokens": <uint32>,
//    "subscribed_to_auctioneer": <bool>,
//    "new_nodes_only": <bool>,
//    "market_info": <MarketInfoEntry>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the poolrpc/trader.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import trader_pb2 as poolrpc, trader_pb2_grpc as traderstub

GRPC_HOST = 'localhost:12010'
MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'
TLS_PATH = 'POOL_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 = traderstub.TraderStub(channel)
request = poolrpc.GetInfoRequest()
response = stub.GetInfo(request)
print(response)
# {
#    "version": <string>,
#    "accounts_total": <uint32>,
#    "accounts_active": <uint32>,
#    "accounts_active_expired": <uint32>,
#    "accounts_archived": <uint32>,
#    "orders_total": <uint32>,
#    "orders_active": <uint32>,
#    "orders_archived": <uint32>,
#    "current_block_height": <uint32>,
#    "batches_involved": <uint32>,
#    "node_rating": <NodeRating>,
#    "lsat_tokens": <uint32>,
#    "subscribed_to_auctioneer": <bool>,
#    "new_nodes_only": <bool>,
#    "market_info": <MarketInfoEntry>,
# }

REST

Javascript

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

const REST_HOST = 'localhost:8281'
const MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'

let options = {
  url: `https://${REST_HOST}/v1/pool/info`,
  // 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:
//  {
//    "version": <string>, // <string> 
//    "accounts_total": <integer>, // <uint32> 
//    "accounts_active": <integer>, // <uint32> 
//    "accounts_active_expired": <integer>, // <uint32> 
//    "accounts_archived": <integer>, // <uint32> 
//    "orders_total": <integer>, // <uint32> 
//    "orders_active": <integer>, // <uint32> 
//    "orders_archived": <integer>, // <uint32> 
//    "current_block_height": <integer>, // <uint32> 
//    "batches_involved": <integer>, // <uint32> 
//    "node_rating": <object>, // <NodeRating> 
//    "lsat_tokens": <integer>, // <uint32> 
//    "subscribed_to_auctioneer": <boolean>, // <bool> 
//    "new_nodes_only": <boolean>, // <bool> 
//    "market_info": <object>, // <MarketInfoEntry> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8281'
MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'
TLS_PATH = 'POOL_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/pool/info'
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())
# {
#    "version": <string>,
#    "accounts_total": <uint32>,
#    "accounts_active": <uint32>,
#    "accounts_active_expired": <uint32>,
#    "accounts_archived": <uint32>,
#    "orders_total": <uint32>,
#    "orders_active": <uint32>,
#    "orders_archived": <uint32>,
#    "current_block_height": <uint32>,
#    "batches_involved": <uint32>,
#    "node_rating": <NodeRating>,
#    "lsat_tokens": <uint32>,
#    "subscribed_to_auctioneer": <bool>,
#    "new_nodes_only": <bool>,
#    "market_info": <MarketInfoEntry>,
# }

Shell

$ pool getinfo --help

NAME:
   pool getinfo - show info about the daemon's current state

USAGE:
   pool getinfo [arguments...]

DESCRIPTION:
   Displays basic info about the current state of the Pool trader daemon

Messages

poolrpc.GetInfoRequest

Source: poolrpc/trader.proto

note

This request has no parameters.

poolrpc.GetInfoResponse

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type
version The version of the Pool daemon that is running.	string	string
accounts_total The total number of accounts in the local database.	uint32	integer
accounts_active The total number of accounts that are in an active, non-archived state, including expired accounts.	uint32	integer
accounts_active_expired The total number of accounts that are active but have expired.	uint32	integer
accounts_archived The total number of accounts that are in an archived/closed state.	uint32	integer
orders_total The total number of orders in the local database.	uint32	integer
orders_active The total number of active/pending orders that are still waiting for execution.	uint32	integer
orders_archived The total number of orders that have been archived.	uint32	integer
current_block_height The current block height as seen by the connected lnd node.	uint32	integer
batches_involved The number of batches an account of this node was ever involved in.	uint32	integer
node_rating Our lnd node's rating as judged by the auctioneer server.	NodeRating	object
lsat_tokens The number of available LSAT tokens.	uint32	integer
subscribed_to_auctioneer Indicates whether there is an active subscription connection to the auctioneer. This will never be true if there is no active account. If there are active accounts, this value represents the network connection status to the auctioneer server.	bool	boolean
new_nodes_only Indicates whether the global `--newnodesonly` command line flag or `newnodesonly=true` configuration parameter was set on the Pool trader daemon.	bool	boolean
market_info A map of all markets identified by their lease duration and the current set of statistics such as number of open orders and total units of open interest.	MarketInfoEntry[]	object

Nested Messages

poolrpc.GetInfoResponse.MarketInfoEntry

Field	gRPC Type	REST Type
key	uint32	unknown
value	MarketInfo	unknown

poolrpc.MarketInfo

Field	gRPC Type	REST Type
num_asks The number of open/pending ask orders per node tier.	TierValue[]	array
num_bids The number of open/pending bid orders per node tier.	TierValue[]	array
ask_open_interest_units The total number of open/unmatched units in open/pending ask orders per node tier.	TierValue[]	array
bid_open_interest_units The total number of open/unmatched units in open/pending bid orders per node tier.	TierValue[]	array

poolrpc.MarketInfo.TierValue

Field	gRPC Type	REST Type
tier	NodeTier	unknown
value	uint32	unknown

poolrpc.NodeRating

Field	gRPC Type	REST Type
node_pubkey The pubkey for the node these ratings belong to.	bytes	string
node_tier The tier of the target node.	NodeTier	string

Enums

poolrpc.NodeTier

Name	Number
TIER_DEFAULT The default node tier. This value will be determined at run-time by the current order version.	0
TIER_0 Tier 0, bid with this tier are opting out of the smaller "higher quality" pool of nodes to match their bids. Nodes in this tier are considered to have "no rating".	1
TIER_1 Tier 1, the "base" node tier. Nodes in this tier are shown to have a higher degree of up time and route-ability compared to the rest of the nodes in the network. This is the current default node tier when submitting bid orders.	2