WithdrawDeposits

loop:static withdraw WithdrawDeposits withdraws a selection or all deposits of a static address.

Source: looprpc/client.proto

gRPC

rpc WithdrawDeposits (WithdrawDepositsRequest) returns (WithdrawDepositsResponse);

REST

HTTP Method	Path
POST	/v1/staticaddr/withdraw

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:11010'
const MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
const TLS_PATH = 'LOOP_DIR/regtest/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('looprpc/client.proto', loaderOptions);
const looprpc = grpc.loadPackageDefinition(packageDefinition).looprpc;
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 looprpc.SwapClient(GRPC_HOST, creds);
let request = {
  outpoints: <OutPoint>,
  all: <bool>,
  dest_addr: <string>,
  sat_per_vbyte: <int64>,
  amount: <int64>,
};
client.withdrawDeposits(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "withdrawal_tx_hash": <string>,
//    "address": <string>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the looprpc/client.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import client_pb2 as looprpc, client_pb2_grpc as clientstub

GRPC_HOST = 'localhost:11010'
MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
TLS_PATH = 'LOOP_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 = clientstub.SwapClientStub(channel)
request = looprpc.WithdrawDepositsRequest(
  outpoints=<OutPoint>,
  all=<bool>,
  dest_addr=<string>,
  sat_per_vbyte=<int64>,
  amount=<int64>,
)
response = stub.WithdrawDeposits(request)
print(response)
# {
#    "withdrawal_tx_hash": <string>,
#    "address": <string>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightninglabs/loop
# Also requires: https://github.com/lightningnetwork/lnd
GRPC_HOST=localhost:11010
LOOP_DIR=~/.loop
LOOP_SOURCE=path/to/loop
LND_SOURCE=path/to/lnd
NETWORK=mainnet
MACAROON_PATH="$LOOP_DIR/$NETWORK/loop.macaroon"
TLS_PATH="$LOOP_DIR/$NETWORK/tls.cert"

grpcurl \
    -import-path $LOOP_SOURCE \
    -import-path $LND_SOURCE \
    -proto looprpc/client.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "outpoints": <OutPoint>, "all": <bool>, "dest_addr": <string>, "sat_per_vbyte": <int64>, "amount": <int64> }' \
    $GRPC_HOST \
    looprpc.SwapClient/WithdrawDeposits

REST

Javascript

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

const REST_HOST = 'localhost:8081'
const MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'

let requestBody = {
  outpoints: <array>, // <OutPoint> 
  all: <boolean>, // <bool> 
  dest_addr: <string>, // <string> 
  sat_per_vbyte: <string>, // <int64> 
  amount: <string>, // <int64> 
};
let options = {
  url: `https://${REST_HOST}/v1/staticaddr/withdraw`,
  // 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:
//  {
//    "withdrawal_tx_hash": <string>, // <string> 
//    "address": <string>, // <string> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8081'
MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
TLS_PATH = 'LOOP_DIR/regtest/tls.cert'

url = f'https://{REST_HOST}/v1/staticaddr/withdraw'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'outpoints': <OutPoint>,
  'all': <bool>,
  'dest_addr': <string>,
  'sat_per_vbyte': <int64>,
  'amount': <int64>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "withdrawal_tx_hash": <string>,
#    "address": <string>,
# }

curl

REST_HOST=localhost:8081
LOOP_DIR=~/.loop
NETWORK=mainnet
MACAROON_PATH="$LOOP_DIR/$NETWORK/loop.macaroon"
TLS_PATH="$LOOP_DIR/$NETWORK/tls.cert"

curl -X POST \
    --cacert $TLS_PATH \
    -H "Grpc-Metadata-macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "outpoints": <OutPoint>, "all": <bool>, "dest_addr": <string>, "sat_per_vbyte": <int64>, "amount": <int64> }' \
    https://$REST_HOST/v1/staticaddr/withdraw

Messages

looprpc.WithdrawDepositsRequest

Source: looprpc/client.proto

Field	gRPC Type	REST Type	REST Placement
outpoints The outpoints of the deposits to withdraw.	OutPoint[]	array	body
all If set to true, all deposits will be withdrawn.	bool	boolean	body
dest_addr The address to withdraw the funds to.	string	string	body
sat_per_vbyte The fee rate in sat/vbyte to use for the withdrawal transaction.	int64	string	body
amount The amount in satoshis that should be withdrawn from the selected deposits. If there is change, it will be sent back to the static address. The fees for the transaction are taken from the change output. If the change is below the dust limit, there won't be a change output and the dust goes towards fees.	int64	string	body

looprpc.WithdrawDepositsResponse

Source: looprpc/client.proto

Field	gRPC Type	REST Type
withdrawal_tx_hash The transaction hash of the withdrawal transaction.	string	string
address The destination address of the withdrawal transaction.	string	string