Quiesce

Quiesce instructs a channel to initiate the quiescence (stfu) protocol. This RPC is for testing purposes only. The commit that adds it will be removed once interop is confirmed.

Source: devrpc/dev.proto

gRPC

rpc Quiesce (QuiescenceRequest) returns (QuiescenceResponse);

REST

HTTP Method	Path
POST	/v2/dev/quiesce

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10009'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
const TLS_PATH = 'LND_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync(['lightning.proto', 'devrpc/dev.proto'], loaderOptions);
const devrpc = grpc.loadPackageDefinition(packageDefinition).devrpc;
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 devrpc.Dev(GRPC_HOST, creds);
let request = {
  chan_id: <ChannelPoint>,
};
client.quiesce(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "initiator": <bool>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the devrpc/dev.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import dev_pb2 as devrpc, dev_pb2_grpc as devstub

GRPC_HOST = 'localhost:10009'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_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 = devstub.DevStub(channel)
request = devrpc.QuiescenceRequest(
  chan_id=<ChannelPoint>,
)
response = stub.Quiesce(request)
print(response)
# {
#    "initiator": <bool>,
# }

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8080'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'

let requestBody = {
  chan_id: <object>, // <ChannelPoint> 
};
let options = {
  url: `https://${REST_HOST}/v2/dev/quiesce`,
  // 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:
//  {
//    "initiator": <boolean>, // <bool> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8080'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

url = f'https://{REST_HOST}/v2/dev/quiesce'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'chan_id': <ChannelPoint>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "initiator": <bool>,
# }

Shell

# There is no CLI command for this RPC

Messages

devrpc.QuiescenceRequest

Source: devrpc/dev.proto

Field	gRPC Type	REST Type	REST Placement
chan_id The channel point of the channel we wish to quiesce	ChannelPoint	object	body

devrpc.QuiescenceResponse

Source: devrpc/dev.proto

Field	gRPC Type	REST Type
initiator Indicates whether or not we hold the initiator role or not once the negotiation completes	bool	boolean

Nested Messages

lnrpc.ChannelPoint

Field	gRPC Type	REST Type
funding_txid_bytes Txid of the funding transaction. When using REST, this field must be encoded as base64.	bytes	string
funding_txid_str Hex-encoded string representing the byte-reversed hash of the funding transaction.	string	string
output_index The index of the output of the funding transaction	uint32	integer