StaticOpenChannel

loop:static openchannel StaticOpenChannel opens a channel funded by selected static address deposits.

Source: looprpc/client.proto

gRPC

rpc StaticOpenChannel (StaticOpenChannelRequest) returns (StaticOpenChannelResponse);

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 = {
  open_channel_request: <OpenChannelRequest>,
};
client.staticOpenChannel(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "channel_open_outpoint": <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.StaticOpenChannelRequest(
  open_channel_request=<OpenChannelRequest>,
)
response = stub.StaticOpenChannel(request)
print(response)
# {
#    "channel_open_outpoint": <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 '{ "open_channel_request": <OpenChannelRequest> }' \
    $GRPC_HOST \
    looprpc.SwapClient/StaticOpenChannel

Messages

looprpc.StaticOpenChannelRequest

Source: looprpc/client.proto

Field	gRPC Type	REST Type	REST Placement
open_channel_request Wrap lnd's request so Loop can extend this RPC with Loop-specific fields without diverging from the upstream API surface.	OpenChannelRequest	unknown	unknown

looprpc.StaticOpenChannelResponse

Source: looprpc/client.proto

Field	gRPC Type	REST Type
channel_open_outpoint The outpoint of the channel opening transaction in the format "txid:output_index".	string	string