Skip to main content

WithdrawAccount

WithdrawAccount splits off parts of the account balance into the specified outputs while recreating the account with a reduced balance.

Source: poolrpc/trader.proto

gRPC

rpc WithdrawAccount (WithdrawAccountRequest) returns (WithdrawAccountResponse);

REST

HTTP MethodPath
POST /v1/pool/accounts/withdraw

Code Samples

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>,
outputs: <Output>,
fee_rate_sat_per_kw: <uint64>,
absolute_expiry: <uint32>,
relative_expiry: <uint32>,
new_version: <AccountVersion>,
};
client.withdrawAccount(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "account": <Account>,
// "withdraw_txid": <bytes>,
// }

Messages

poolrpc.WithdrawAccountRequest

Source: poolrpc/trader.proto

FieldgRPC TypeREST TypeREST Placement
trader_key
bytesstringbody
outputs
Output[]arraybody
fee_rate_sat_per_kw
uint64stringbody
absolute_expiry
uint32integerbody
relative_expiry
uint32integerbody
new_version
AccountVersionstringbody

poolrpc.WithdrawAccountResponse

Source: poolrpc/trader.proto

FieldgRPC TypeREST Type
account
Accountobject
withdraw_txid
bytesstring

Nested Messages

poolrpc.Account

FieldgRPC TypeREST Type
trader_key
bytesstring
outpoint
OutPointobject
value
uint64string
available_balance
uint64string
expiration_height
uint32integer
state
AccountStatestring
latest_txid
bytesstring
version
AccountVersionstring

poolrpc.OutPoint

FieldgRPC TypeREST Type
txid
bytesstring
output_index
uint32integer

poolrpc.Output

FieldgRPC TypeREST Type
value_sat
uint64string
address
stringstring

Enums

poolrpc.AccountState

NameNumber
PENDING_OPEN
0
PENDING_UPDATE
1
OPEN
2
EXPIRED
3
PENDING_CLOSED
4
CLOSED
5
RECOVERY_FAILED
6
PENDING_BATCH
7

poolrpc.AccountVersion

NameNumber
ACCOUNT_VERSION_LND_DEPENDENT
0
ACCOUNT_VERSION_LEGACY
1
ACCOUNT_VERSION_TAPROOT
2
ACCOUNT_VERSION_TAPROOT_V2
3