LeaseDurations

LeaseDurations returns the current set of valid lease duration in the market as is, and also information w.r.t if the market is currently active.

Source: poolrpc/trader.proto

gRPC

rpc LeaseDurations (LeaseDurationRequest) returns (LeaseDurationResponse);

REST

HTTP Method	Path
GET	/v1/pool/lease_durations

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.leaseDurations(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "lease_durations": <LeaseDurationsEntry>,
//    "lease_duration_buckets": <LeaseDurationBucketsEntry>,
//  }

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.LeaseDurationRequest()
response = stub.LeaseDurations(request)
print(response)
# {
#    "lease_durations": <LeaseDurationsEntry>,
#    "lease_duration_buckets": <LeaseDurationBucketsEntry>,
# }

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/lease_durations`,
  // 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:
//  {
//    "lease_durations": <object>, // <LeaseDurationsEntry> 
//    "lease_duration_buckets": <object>, // <LeaseDurationBucketsEntry> 
//  }

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/lease_durations'
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())
# {
#    "lease_durations": <LeaseDurationsEntry>,
#    "lease_duration_buckets": <LeaseDurationBucketsEntry>,
# }

Shell

$ pool auction leasedurations --help

NAME:
   pool auction leasedurations - returns the current active set of accepted lease durations for orders

USAGE:
   pool auction leasedurations [arguments...]

Messages

poolrpc.LeaseDurationRequest

Source: poolrpc/trader.proto

note

This request has no parameters.

poolrpc.LeaseDurationResponse

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type
lease_durationsdeprecated Deprecated, use lease_duration_buckets.	LeaseDurationsEntry[]	object
lease_duration_buckets The set of lease durations the market is currently accepting and the state the duration buckets currently are in.	LeaseDurationBucketsEntry[]	object

Nested Messages

poolrpc.LeaseDurationResponse.LeaseDurationBucketsEntry

Field	gRPC Type	REST Type
key	uint32	unknown
value	DurationBucketState	unknown

poolrpc.LeaseDurationResponse.LeaseDurationsEntry

Field	gRPC Type	REST Type
key	uint32	unknown
value	bool	unknown

Enums

poolrpc.DurationBucketState

Name	Number
NO_MARKET NO_MARKET indicates that this bucket doesn't actually exist, in that no market is present for this market.	0
MARKET_CLOSED MARKET_CLOSED indicates that this market exists, but that it isn't currently running.	1
ACCEPTING_ORDERS ACCEPTING_ORDERS indicates that we're accepting orders for this bucket, but not yet clearing for this duration.	2
MARKET_OPEN MARKET_OPEN indicates that we're accepting orders, and fully clearing the market for this duration.	3