CloseAccount

CloseAccount closes an account and returns the funds locked in that account to the connected lnd node's wallet.

Source: poolrpc/trader.proto

gRPC

rpc CloseAccount (CloseAccountRequest) returns (CloseAccountResponse);

REST

HTTP Method	Path
DELETE	/v1/pool/accounts

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 = {
  trader_key: <bytes>,
  output_with_fee: <OutputWithFee>,
  outputs: <OutputsWithImplicitFee>,
};
client.closeAccount(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "close_txid": <bytes>,
//  }

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.CloseAccountRequest(
  trader_key=<bytes>,
  output_with_fee=<OutputWithFee>,
  outputs=<OutputsWithImplicitFee>,
)
response = stub.CloseAccount(request)
print(response)
# {
#    "close_txid": <bytes>,
# }

REST

Javascript

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

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

let options = {
  url: `https://${REST_HOST}/v1/pool/accounts`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.delete(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "close_txid": <string>, // <bytes> 
//  }

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/accounts'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.delete(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "close_txid": <bytes>,
# }

Shell

$ pool accounts close --help

NAME:
   pool accounts close - close an existing account

USAGE:
   pool accounts close [command options] trader_key sat_per_vbyte

DESCRIPTION:
   
  Close an existing account. An optional address can be provided which the
  funds of the account to close will be sent to, otherwise they are sent
  to an address under control of the connected lnd node.
  

OPTIONS:
   --trader_key value     the trader key associated with the account to close
   --sat_per_vbyte value  the fee rate expressed in sat/vbyte that should be used for the closing transaction (default: 0)
   --addr value           an optional address which the funds of the account to close will be sent to
   

Messages

poolrpc.CloseAccountRequest

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type	REST Placement
trader_key The trader key associated with the account that will be closed.	bytes	string	query
output_with_fee A single output/address to which the remaining funds of the account will be sent to at the specified fee. If an address is not specified, then the funds are sent to an address the backing lnd node controls. Nested REST Parameters output_with_fee.conf_target: integer in query output_with_fee.fee_rate_sat_per_kw: string in query output_with_fee.address: string in query	OutputWithFee	object	query
outputs The outputs to which the remaining funds of the account will be sent to. This should only be used when wanting to create two or more outputs, otherwise OutputWithFee should be used instead. The fee of the account's closing transaction is implicitly defined by the combined value of all outputs.	OutputsWithImplicitFee	object	unknown

poolrpc.CloseAccountResponse

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type
close_txid The hash of the closing transaction.	bytes	string

Nested Messages

poolrpc.Output

Field	gRPC Type	REST Type
value_sat The value, in satoshis, of the output.	uint64	string
address The address corresponding to the output.	string	string

poolrpc.OutputsWithImplicitFee

Field	gRPC Type	REST Type
outputs	Output[]	array

poolrpc.OutputWithFee

Field	gRPC Type	REST Type
address The address corresponding to the output.	string	string
conf_target The target number of blocks that the transaction should be confirmed in.	uint32	integer
fee_rate_sat_per_kw The fee rate, in satoshis per kw, to use for the withdrawal transaction.	uint64	string