ReserveAccount

Source: auctioneerrpc/auctioneer.proto

gRPC

rpc ReserveAccount (ReserveAccountRequest) returns (ReserveAccountResponse);

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 = {
  account_value: <uint64>,
  account_expiry: <uint32>,
  trader_key: <bytes>,
  version: <uint32>,
};
client.reserveAccount(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "auctioneer_key": <bytes>,
//    "initial_batch_key": <bytes>,
//  }

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.ReserveAccountRequest(
  account_value=<uint64>,
  account_expiry=<uint32>,
  trader_key=<bytes>,
  version=<uint32>,
)
response = stub.ReserveAccount(request)
print(response)
# {
#    "auctioneer_key": <bytes>,
#    "initial_batch_key": <bytes>,
# }

Shell

# There is no CLI command for this RPC

Messages

poolrpc.ReserveAccountRequest

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type	REST Placement
account_value The desired value of the account in satoshis.	uint64	unknown	unknown
account_expiry The block height at which the account should expire.	uint32	unknown	unknown
trader_key The trader's account key.	bytes	unknown	unknown
version The account version. Must be set to 0 for legacy (non-taproot) accounts.	uint32	unknown	unknown

poolrpc.ReserveAccountResponse

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type
auctioneer_key The base key of the auctioneer. This key should be tweaked with the trader's per-batch tweaked key to obtain the corresponding per-batch tweaked auctioneer key. Or, in case of the version 1, Taproot enabled account, the trader and auctioneer key will be combined into a MuSig2 combined key that is static throughout the lifetime of the account. The on-chain uniqueness of the generated output will be ensured by the merkle root hash that is applied as a tweak to the MuSig2 combined internal key. The merkle root hash is either the hash of the timeout script path (which uses the trader key tweaked with the per-batch key) directly or the root of a tree with one leaf that is the timeout script path and a leaf that is a Taro commitment (which is a root hash by itself).	bytes	unknown
initial_batch_key The initial per-batch key to be used for the account. For every cleared batch that the account participates in, this key will be incremented by the base point of its curve, resulting in a new key for both the trader and auctioneer in every batch.	bytes	unknown