QuoteAccount

QuoteAccount gets a fee quote to fund an account of the given size with the given confirmation target. If the connected lnd wallet doesn't have enough balance to fund an account of the requested size, an error is returned.

Source: poolrpc/trader.proto

gRPC

rpc QuoteAccount (QuoteAccountRequest) returns (QuoteAccountResponse);

REST

HTTP Method	Path
POST	/v1/pool/accounts/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/regtest/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 = {
  account_value: <uint64>,
  conf_target: <uint32>,
};
client.quoteAccount(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "miner_fee_rate_sat_per_kw": <uint64>,
//    "miner_fee_total": <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/regtest/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.QuoteAccountRequest(
  account_value=<uint64>,
  conf_target=<uint32>,
)
response = stub.QuoteAccount(request)
print(response)
# {
#    "miner_fee_rate_sat_per_kw": <uint64>,
#    "miner_fee_total": <uint64>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightninglabs/pool
GRPC_HOST=localhost:12010
POOL_DIR=~/.pool
POOL_SOURCE=path/to/pool
NETWORK=mainnet
MACAROON_PATH="$POOL_DIR/$NETWORK/pool.macaroon"
TLS_PATH="$POOL_DIR/$NETWORK/tls.cert"

grpcurl \
    -import-path $POOL_SOURCE \
    -proto poolrpc/trader.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "account_value": <uint64>, "conf_target": <uint32> }' \
    $GRPC_HOST \
    poolrpc.Trader/QuoteAccount

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 = {
  account_value: <string>, // <uint64> 
  conf_target: <integer>, // <uint32> 
};
let options = {
  url: `https://${REST_HOST}/v1/pool/accounts/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:
//  {
//    "miner_fee_rate_sat_per_kw": <string>, // <uint64> 
//    "miner_fee_total": <string>, // <uint64> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8281'
MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'
TLS_PATH = 'POOL_DIR/regtest/tls.cert'

url = f'https://{REST_HOST}/v1/pool/accounts/quote'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'account_value': <uint64>,
  'conf_target': <uint32>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "miner_fee_rate_sat_per_kw": <uint64>,
#    "miner_fee_total": <uint64>,
# }

curl

REST_HOST=localhost:8281
POOL_DIR=~/.pool
NETWORK=mainnet
MACAROON_PATH="$POOL_DIR/$NETWORK/pool.macaroon"
TLS_PATH="$POOL_DIR/$NETWORK/tls.cert"

curl -X POST \
    --cacert $TLS_PATH \
    -H "Grpc-Metadata-macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "account_value": <uint64>, "conf_target": <uint32> }' \
    https://$REST_HOST/v1/pool/accounts/quote

Messages

poolrpc.QuoteAccountRequest

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type	REST Placement
account_value	uint64	string	body
conf_target The target number of blocks that the transaction should be confirmed in.	uint32	integer	body

poolrpc.QuoteAccountResponse

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type
miner_fee_rate_sat_per_kw	uint64	string
miner_fee_total	uint64	string