QuoteOrder

QuoteOrder calculates the premium, execution fees and max batch fee rate for an order based on the given order parameters.

Source: poolrpc/trader.proto

gRPC

rpc QuoteOrder (QuoteOrderRequest) returns (QuoteOrderResponse);

REST

HTTP Method	Path
POST	/v1/pool/orders/quote

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 = {
  amt: <uint64>,
  rate_fixed: <uint32>,
  lease_duration_blocks: <uint32>,
  max_batch_fee_rate_sat_per_kw: <uint64>,
  min_units_match: <uint32>,
};
client.quoteOrder(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "total_premium_sat": <uint64>,
//    "rate_per_block": <double>,
//    "rate_percent": <double>,
//    "total_execution_fee_sat": <uint64>,
//    "worst_case_chain_fee_sat": <uint64>,
//  }

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.QuoteOrderRequest(
  amt=<uint64>,
  rate_fixed=<uint32>,
  lease_duration_blocks=<uint32>,
  max_batch_fee_rate_sat_per_kw=<uint64>,
  min_units_match=<uint32>,
)
response = stub.QuoteOrder(request)
print(response)
# {
#    "total_premium_sat": <uint64>,
#    "rate_per_block": <double>,
#    "rate_percent": <double>,
#    "total_execution_fee_sat": <uint64>,
#    "worst_case_chain_fee_sat": <uint64>,
# }

REST

Javascript

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

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

let requestBody = {
  amt: <string>, // <uint64> 
  rate_fixed: <integer>, // <uint32> 
  lease_duration_blocks: <integer>, // <uint32> 
  max_batch_fee_rate_sat_per_kw: <string>, // <uint64> 
  min_units_match: <integer>, // <uint32> 
};
let options = {
  url: `https://${REST_HOST}/v1/pool/orders/quote`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
  form: JSON.stringify(requestBody),
}
request.post(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "total_premium_sat": <string>, // <uint64> 
//    "rate_per_block": <number>, // <double> 
//    "rate_percent": <number>, // <double> 
//    "total_execution_fee_sat": <string>, // <uint64> 
//    "worst_case_chain_fee_sat": <string>, // <uint64> 
//  }

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/orders/quote'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'amt': <uint64>,
  'rate_fixed': <uint32>,
  'lease_duration_blocks': <uint32>,
  'max_batch_fee_rate_sat_per_kw': <uint64>,
  'min_units_match': <uint32>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "total_premium_sat": <uint64>,
#    "rate_per_block": <double>,
#    "rate_percent": <double>,
#    "total_execution_fee_sat": <uint64>,
#    "worst_case_chain_fee_sat": <uint64>,
# }

Shell

# There is no CLI command for this RPC

Messages

poolrpc.QuoteOrderRequest

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type	REST Placement
amt Order amount in satoshis.	uint64	string	body
rate_fixed Fixed order rate in parts per billion.	uint32	integer	body
lease_duration_blocks Required number of blocks that a channel opened as a result of this bid should be kept open.	uint32	integer	body
max_batch_fee_rate_sat_per_kw Maximum fee rate the trader is willing to pay for the batch transaction, expressed in satoshis per 1000 weight units (sat/KW).	uint64	string	body
min_units_match The minimum number of order units that must be matched per order pair.	uint32	integer	body

poolrpc.QuoteOrderResponse

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type
total_premium_sat The total order premium in satoshis for filling the entire order. This represents the interest amount paid to the maker by the taker excluding any execution or chain fees.	uint64	string
rate_per_block The fixed order rate expressed as a fraction instead of parts per billion.	double	number
rate_percent The fixed order rate expressed as a percentage instead of parts per billion.	double	number
total_execution_fee_sat The total execution fee in satoshis that needs to be paid to the auctioneer for executing the entire order.	uint64	string
worst_case_chain_fee_sat The worst case chain fees that need to be paid if fee rates spike up to the max_batch_fee_rate_sat_per_kw value specified in the request. This value is highly dependent on the min_units_match parameter as well since the calculation assumes chain fees for the chain footprint of opening amt/min_units_match channels (hence worst case calculation).	uint64	string