ServerStaticAddressLoopIn

ServerStaticAddressLoopIn initiates a static address loop-in swap. The server will respond with htlc details that the client can use to construct and sign the htlc tx.

Source: staticaddr.proto

gRPC

rpc ServerStaticAddressLoopIn (ServerStaticAddressLoopInRequest) returns (ServerStaticAddressLoopInResponse);

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('staticaddr.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.StaticAddressServer(GRPC_HOST, creds);
let request = {
  htlc_client_pub_key: <bytes>,
  swap_hash: <bytes>,
  deposit_outpoints: <string>,
  swap_invoice: <string>,
  last_hop: <bytes>,
  protocol_version: <StaticAddressProtocolVersion>,
  user_agent: <string>,
  payment_timeout_seconds: <uint32>,
};
client.serverStaticAddressLoopIn(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "htlc_server_pub_key": <bytes>,
//    "htlc_expiry": <int32>,
//    "standard_htlc_info": <ServerHtlcSigningInfo>,
//    "high_fee_htlc_info": <ServerHtlcSigningInfo>,
//    "extreme_fee_htlc_info": <ServerHtlcSigningInfo>,
//  }

Python

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

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 = staticaddrstub.StaticAddressServerStub(channel)
request = looprpc.ServerStaticAddressLoopInRequest(
  htlc_client_pub_key=<bytes>,
  swap_hash=<bytes>,
  deposit_outpoints=<string>,
  swap_invoice=<string>,
  last_hop=<bytes>,
  protocol_version=<StaticAddressProtocolVersion>,
  user_agent=<string>,
  payment_timeout_seconds=<uint32>,
)
response = stub.ServerStaticAddressLoopIn(request)
print(response)
# {
#    "htlc_server_pub_key": <bytes>,
#    "htlc_expiry": <int32>,
#    "standard_htlc_info": <ServerHtlcSigningInfo>,
#    "high_fee_htlc_info": <ServerHtlcSigningInfo>,
#    "extreme_fee_htlc_info": <ServerHtlcSigningInfo>,
# }

Shell

# There is no CLI command for this RPC

Messages

looprpc.ServerStaticAddressLoopInRequest

Source: staticaddr.proto

Field	gRPC Type	REST Type	REST Placement
htlc_client_pub_key The client's public key for the htlc output.	bytes	unknown	unknown
swap_hash The hashed swap invoice preimage of the swap.	bytes	unknown	unknown
deposit_outpoints The deposit outpoints the client wishes to loop in. They implicitly state the swap amount.	string[]	unknown	unknown
swap_invoice The swap invoice that the client wants the server to pay.	string	unknown	unknown
last_hop An optional last hop the client wants to receive the invoice payment from.	bytes	unknown	unknown
protocol_version The protocol version that the client adheres to.	StaticAddressProtocolVersion	unknown	unknown
user_agent The user agent string that identifies the software running on the user's side. This can be changed in the user's client software but it SHOULD conform to the following pattern: Agent-Name/semver-version(/additional-info) Examples: loopd/v0.10.0-beta/commit=3b635821 litd/v0.2.0-alpha/commit=326d754 loopd/v0.10.0-beta/commit=3b635823,initiator=easy-autoloop	string	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.ServerStaticAddressLoopInResponse

Source: staticaddr.proto

Field	gRPC Type	REST Type
htlc_server_pub_key The server's public key for the htlc output.	bytes	unknown
htlc_expiry The cltv expiry height for the htlc. This is the height at which the htlc will expire and the client is free to claim the funds back.	int32	unknown
standard_htlc_info The info the server used to generate the standard fee partial htlc tx sigs.	ServerHtlcSigningInfo	unknown
high_fee_htlc_info The info the server used to generate the high fee partial htlc tx sigs.	ServerHtlcSigningInfo	unknown
extreme_fee_htlc_info The info the server used to generate the extreme fee partial htlc tx sigs.	ServerHtlcSigningInfo	unknown

Nested Messages

looprpc.ServerHtlcSigningInfo

Field	gRPC Type	REST Type
nonces The nonces that the server used to generate the partial htlc tx sigs.	bytes[]	unknown
fee_rate The fee rate in sat/kw that the server wants to use for the htlc tx.	uint64	unknown

Enums

looprpc.StaticAddressProtocolVersion

Name	Number
V0 V0 is the initially released static address protocol version.	0