AbandonSwap

AbandonSwap allows the client to abandon a swap.

Source: looprpc/client.proto

gRPC

rpc AbandonSwap (AbandonSwapRequest) returns (AbandonSwapResponse);

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 = {
  id: <bytes>,
  i_know_what_i_am_doing: <bool>,
};
client.abandonSwap(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//  }

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.AbandonSwapRequest(
  id=<bytes>,
  i_know_what_i_am_doing=<bool>,
)
response = stub.AbandonSwap(request)
print(response)
# {
# }

Shell

$ loop abandonswap --help

NAME:
   loop abandonswap - abandon a swap with a given swap hash

USAGE:
   loop abandonswap [command options] ID

DESCRIPTION:
   This command overrides the database and abandons a swap with a given swap hash.

!!! This command might potentially lead to loss of funds if it is applied to swaps that are still waiting for pending user funds. Before executing this command make sure that no funds are locked by the swap.

OPTIONS:
   --i_know_what_i_am_doing  Specify this flag if you made sure that you read and understood the following consequence of applying this command.
   

Messages

looprpc.AbandonSwapRequest

Source: looprpc/client.proto

Field	gRPC Type	REST Type	REST Placement
id The swap identifier which currently is the hash that locks the HTLCs. When using REST, this field must be encoded as URL safe base64.	bytes	unknown	unknown
i_know_what_i_am_doing A flag that tries to ensure that the client understands that they are risking loss of funds by abandoning a swap. This could happen if an abandoned swap would wait on a timeout sweep by the client.	bool	unknown	unknown

looprpc.AbandonSwapResponse

Source: looprpc/client.proto

note

This response has no parameters.