InitAccount

Source: auctioneerrpc/auctioneer.proto

gRPC

rpc InitAccount (ServerInitAccountRequest) returns (ServerInitAccountResponse);

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_point: <OutPoint>,
  account_script: <bytes>,
  account_value: <uint64>,
  account_expiry: <uint32>,
  trader_key: <bytes>,
  user_agent: <string>,
  version: <uint32>,
};
client.initAccount(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//  }

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.ServerInitAccountRequest(
  account_point=<OutPoint>,
  account_script=<bytes>,
  account_value=<uint64>,
  account_expiry=<uint32>,
  trader_key=<bytes>,
  user_agent=<string>,
  version=<uint32>,
)
response = stub.InitAccount(request)
print(response)
# {
# }

Shell

# There is no CLI command for this RPC

Messages

poolrpc.ServerInitAccountRequest

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type	REST Placement
account_point Transaction output of the account. Has to be unspent and be a P2WSH of the account script below. The amount must also exactly correspond to the account value below.	OutPoint	unknown	unknown
account_script The script used to create the account point. For version 1 (Taproot enabled) accounts this represents the 32-byte (x-only) Taproot public key with the combined MuSig2 key of the auctioneer's key and the trader's key with the expiry script path applied as a single tapscript leaf.	bytes	unknown	unknown
account_value The value of the account in satoshis. Must match the amount of the account_point output.	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
user_agent The user agent string that identifies the software running on the user's side. This can be changed in the user's client software but it SHOULD conform to the following pattern and use less than 256 characters: Agent-Name/semver-version(/additional-info) Examples: poold/v0.4.2-beta/commit=3b635821,initiator=pool-cli litd/v0.4.0-alpha/commit=326d754,initiator=lit-ui	string	unknown	unknown
version The account version. Must be set to 0 for legacy (non-taproot) accounts.	uint32	unknown	unknown

poolrpc.ServerInitAccountResponse

Source: auctioneerrpc/auctioneer.proto

note

This response has no parameters.

Nested Messages

poolrpc.OutPoint

Field	gRPC Type	REST Type
txid Raw bytes representing the transaction id.	bytes	string
output_index The index of the output on the transaction.	uint32	integer