StaticAddressLoopIn

loop:static StaticAddressLoopIn initiates a static address loop-in swap.

Source: looprpc/client.proto

gRPC

rpc StaticAddressLoopIn (StaticAddressLoopInRequest) returns (StaticAddressLoopInResponse);

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 = {
  outpoints: <string>,
  max_swap_fee_satoshis: <int64>,
  last_hop: <bytes>,
  label: <string>,
  initiator: <string>,
  route_hints: <RouteHint>,
  private: <bool>,
  payment_timeout_seconds: <uint32>,
};
client.staticAddressLoopIn(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "swap_hash": <bytes>,
//    "state": <string>,
//    "amount": <uint64>,
//    "htlc_cltv": <int32>,
//    "quoted_swap_fee_satoshis": <int64>,
//    "max_swap_fee_satoshis": <int64>,
//    "initiation_height": <uint32>,
//    "protocol_version": <string>,
//    "label": <string>,
//    "initiator": <string>,
//    "payment_timeout_seconds": <uint32>,
//  }

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.StaticAddressLoopInRequest(
  outpoints=<string>,
  max_swap_fee_satoshis=<int64>,
  last_hop=<bytes>,
  label=<string>,
  initiator=<string>,
  route_hints=<RouteHint>,
  private=<bool>,
  payment_timeout_seconds=<uint32>,
)
response = stub.StaticAddressLoopIn(request)
print(response)
# {
#    "swap_hash": <bytes>,
#    "state": <string>,
#    "amount": <uint64>,
#    "htlc_cltv": <int32>,
#    "quoted_swap_fee_satoshis": <int64>,
#    "max_swap_fee_satoshis": <int64>,
#    "initiation_height": <uint32>,
#    "protocol_version": <string>,
#    "label": <string>,
#    "initiator": <string>,
#    "payment_timeout_seconds": <uint32>,
# }

Shell

# There is no CLI command for this RPC

Messages

looprpc.StaticAddressLoopInRequest

Source: looprpc/client.proto

Field	gRPC Type	REST Type	REST Placement
outpoints The outpoints of the deposits to loop-in.	string[]	unknown	unknown
max_swap_fee_satoshis Maximum satoshis we are willing to pay the server for the swap. This value is not disclosed in the swap initiation call, but if the server asks for a higher fee, we abort the swap. Typically this value is taken from the response of the GetQuote call.	int64	unknown	unknown
last_hop Optionally the client can specify the last hop pubkey when requesting a loop-in quote. This is useful to get better off-chain routing fee from the server.	bytes	unknown	unknown
label An optional label for this swap. This field is limited to 500 characters and may not be one of the reserved values in loop/labels Reserved list.	string	unknown	unknown
initiator An optional identification string that will be appended to the user agent string sent to the server to give information about the usage of loop. This initiator part is meant for user interfaces to add their name to give the full picture of the binary used (loopd, LiT) and the method used for triggering the swap (loop CLI, autolooper, LiT UI, other 3rd party UI).	string	unknown	unknown
route_hints Optional route hints to reach the destination through private channels.	RouteHint[]	unknown	unknown
private Private indicates whether the destination node should be considered private. In which case, loop will generate hop hints to assist with probing and payment.	bool	unknown	unknown
payment_timeout_seconds The swap payment timeout allows the user to specify an upper limit for the amount of time the server is allowed to take to fulfill the off-chain swap payment. If the timeout is reached the swap will be aborted on the server side and the client can retry the swap with different parameters.	uint32	unknown	unknown

looprpc.StaticAddressLoopInResponse

Source: looprpc/client.proto

Field	gRPC Type	REST Type
swap_hash The swap hash that identifies this swap.	bytes	string
state The state the swap is in.	string	string
amount The amount of the swap.	uint64	string
htlc_cltv The htlc cltv expiry height of the swap.	int32	integer
quoted_swap_fee_satoshis The quoted swap fee in satoshis.	int64	string
max_swap_fee_satoshis The maximum total swap fee the client is willing to pay for the swap.	int64	string
initiation_height The block height at which the swap was initiated.	uint32	integer
protocol_version The static address protocol version.	string	string
label An optional label for this swap.	string	string
initiator An optional identification string that will be appended to the user agent string sent to the server to give information about the usage of loop. This initiator part is meant for user interfaces to add their name to give the full picture of the binary used (loopd, LiT) and the method used for triggering the swap (loop CLI, autolooper, LiT UI, other 3rd party UI).	string	string
payment_timeout_seconds The swap payment timeout allows the user to specify an upper limit for the amount of time the server is allowed to take to fulfill the off-chain swap payment. If the timeout is reached the swap will be aborted on the server side and the client can retry the swap with different parameters.	uint32	integer