Terms

Source: auctioneerrpc/auctioneer.proto

gRPC

rpc Terms (TermsRequest) returns (TermsResponse);

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.terms(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "max_account_value": <uint64>,
//    "max_order_duration_blocks": <uint32>,
//    "execution_fee": <ExecutionFee>,
//    "lease_durations": <LeaseDurationsEntry>,
//    "next_batch_conf_target": <uint32>,
//    "next_batch_fee_rate_sat_per_kw": <uint64>,
//    "next_batch_clear_timestamp": <uint64>,
//    "lease_duration_buckets": <LeaseDurationBucketsEntry>,
//    "auto_renew_extension_blocks": <uint32>,
//  }

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.TermsRequest()
response = stub.Terms(request)
print(response)
# {
#    "max_account_value": <uint64>,
#    "max_order_duration_blocks": <uint32>,
#    "execution_fee": <ExecutionFee>,
#    "lease_durations": <LeaseDurationsEntry>,
#    "next_batch_conf_target": <uint32>,
#    "next_batch_fee_rate_sat_per_kw": <uint64>,
#    "next_batch_clear_timestamp": <uint64>,
#    "lease_duration_buckets": <LeaseDurationBucketsEntry>,
#    "auto_renew_extension_blocks": <uint32>,
# }

Shell

# There is no CLI command for this RPC

Messages

poolrpc.TermsRequest

Source: auctioneerrpc/auctioneer.proto

note

This request has no parameters.

poolrpc.TermsResponse

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type
max_account_value The maximum account size in satoshis currently allowed by the auctioneer.	uint64	unknown
max_order_duration_blocksdeprecated Deprecated, use explicit order duration from lease_duration_buckets.	uint32	unknown
execution_fee The execution fee charged per matched order.	ExecutionFee	unknown
lease_durationsdeprecated Deprecated, use lease_duration_buckets.	LeaseDurationsEntry[]	unknown
next_batch_conf_target The confirmation target to use for fee estimation of the next batch.	uint32	unknown
next_batch_fee_rate_sat_per_kw The fee rate, in satoshis per kiloweight, estimated to use for the next batch.	uint64	unknown
next_batch_clear_timestamp The absolute unix timestamp at which the auctioneer will attempt to clear the next batch.	uint64	unknown
lease_duration_buckets The set of lease durations the market is currently accepting and the state the duration buckets currently are in.	LeaseDurationBucketsEntry[]	unknown
auto_renew_extension_blocks The value used by the auctioneer to determine if an account expiry height needs to be extended after participating in a batch and for how long.	uint32	unknown

Nested Messages

poolrpc.ExecutionFee

Field	gRPC Type	REST Type
base_fee The base fee in satoshis charged per order, regardless of the matched size.	uint64	string
fee_rate The fee rate in parts per million.	uint64	string

poolrpc.TermsResponse.LeaseDurationBucketsEntry

Field	gRPC Type	REST Type
key	uint32	unknown
value	DurationBucketState	unknown

poolrpc.TermsResponse.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