MarketInfo

Source: auctioneerrpc/auctioneer.proto

gRPC

rpc MarketInfo (MarketInfoRequest) returns (MarketInfoResponse);

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('auctioneerrpc/auctioneer.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.ChannelAuctioneer(GRPC_HOST, creds);
let request = {};
client.marketInfo(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "markets": <MarketsEntry>,
//  }

Python

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

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 = auctioneerstub.ChannelAuctioneerStub(channel)
request = poolrpc.MarketInfoRequest()
response = stub.MarketInfo(request)
print(response)
# {
#    "markets": <MarketsEntry>,
# }

Shell

# There is no CLI command for this RPC

Messages

poolrpc.MarketInfoRequest

Source: auctioneerrpc/auctioneer.proto

note

This request has no parameters.

poolrpc.MarketInfoResponse

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type
markets A map of all markets identified by their lease duration and the current set of statistics.	MarketsEntry[]	unknown

Nested Messages

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.MarketInfoResponse.MarketsEntry

Field	gRPC Type	REST Type
key	uint32	unknown
value	MarketInfo	unknown

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