Skip to main content

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 MethodPath
GET /v1/pool/lease_durations

Code Samples

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>,
// }

Messages

poolrpc.LeaseDurationRequest

Source: poolrpc/trader.proto

note

This request has no parameters.

poolrpc.LeaseDurationResponse

Source: poolrpc/trader.proto

FieldgRPC TypeREST Type
lease_durationsdeprecated
LeaseDurationsEntry[]object
lease_duration_buckets
LeaseDurationBucketsEntry[]object

Nested Messages

poolrpc.LeaseDurationResponse.LeaseDurationBucketsEntry

FieldgRPC TypeREST Type
key
uint32unknown
value
DurationBucketStateunknown

poolrpc.LeaseDurationResponse.LeaseDurationsEntry

FieldgRPC TypeREST Type
key
uint32unknown
value
boolunknown

Enums

poolrpc.DurationBucketState

NameNumber
NO_MARKET
0
MARKET_CLOSED
1
ACCEPTING_ORDERS
2
MARKET_OPEN
3