InstantOut

InstantOut initiates an instant out swap with the given parameters.

Source: looprpc/client.proto

gRPC

rpc InstantOut (InstantOutRequest) returns (InstantOutResponse);

REST

HTTP Method	Path
POST	/v1/instantout

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/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 = {
  reservation_ids: <bytes>,
  outgoing_chan_set: <uint64>,
  dest_addr: <string>,
};
client.instantOut(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "instant_out_hash": <bytes>,
//    "sweep_tx_id": <string>,
//    "state": <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/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.InstantOutRequest(
  reservation_ids=<bytes>,
  outgoing_chan_set=<uint64>,
  dest_addr=<string>,
)
response = stub.InstantOut(request)
print(response)
# {
#    "instant_out_hash": <bytes>,
#    "sweep_tx_id": <string>,
#    "state": <string>,
# }

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 = {
  reservation_ids: <array>, // <bytes> (base64 encoded)
  outgoing_chan_set: <array>, // <uint64> 
  dest_addr: <string>, // <string> 
};
let options = {
  url: `https://${REST_HOST}/v1/instantout`,
  // 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:
//  {
//    "instant_out_hash": <string>, // <bytes> 
//    "sweep_tx_id": <string>, // <string> 
//    "state": <string>, // <string> 
//  }

Python

import base64, codecs, json, requests

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

url = f'https://{REST_HOST}/v1/instantout'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'reservation_ids': base64.b64encode(<bytes>),
  'outgoing_chan_set': <uint64>,
  'dest_addr': <string>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "instant_out_hash": <bytes>,
#    "sweep_tx_id": <string>,
#    "state": <string>,
# }

Shell

$ loop instantout --help

NAME:
   loop instantout - perform an instant off-chain to on-chain swap (looping out)

USAGE:
   loop instantout [options]

DESCRIPTION:
   
     Attempts to instantly loop out into the backing lnd's wallet. The amount
     will be chosen via the cli.
     

OPTIONS:
   --channel string  the comma-separated list of short channel IDs of the channels to loop out
   --addr string     the optional address that the looped out funds should be sent to, if let blank the funds will go to lnd's wallet
   --help, -h        show help

GLOBAL OPTIONS:
   --rpcserver string           loopd daemon address host:port (default: "localhost:11010") [$LOOPCLI_RPCSERVER]
   --network string, -n string  the network loop is running on e.g. mainnet, testnet, etc. (default: "mainnet") [$LOOPCLI_NETWORK]
   --loopdir string             path to loop's base directory (default: "/home/runner/.loop") [$LOOPCLI_LOOPDIR]
   --tlscertpath string         path to loop's TLS certificate (default: "/home/runner/.loop/mainnet/tls.cert") [$LOOPCLI_TLSCERTPATH]
   --macaroonpath string        path to macaroon file (default: "/home/runner/.loop/mainnet/loop.macaroon") [$LOOPCLI_MACAROONPATH]

Messages

looprpc.InstantOutRequest

Source: looprpc/client.proto

Field	gRPC Type	REST Type	REST Placement
reservation_ids The reservations to use for the swap.	bytes[]	array	body
outgoing_chan_set A restriction on the channel set that may be used to loop out. The actual channel(s) that will be used are selected based on the lowest routing fee for the swap payment to the server.	uint64[]	array	body
dest_addr An optional address to sweep the onchain funds to. If not set, the funds will be swept to the wallet's internal address.	string	string	body

looprpc.InstantOutResponse

Source: looprpc/client.proto

Field	gRPC Type	REST Type
instant_out_hash The hash of the swap preimage.	bytes	string
sweep_tx_id The transaction id of the sweep transaction.	string	string
state The state of the swap.	string	string