XImportMissionControl

XImportMissionControl is an experimental API that imports the state provided to the internal mission control's state, using all results which are more recent than our existing values. These values will only be imported in-memory, and will not be persisted across restarts.

Source: routerrpc/router.proto

gRPC

rpc XImportMissionControl (XImportMissionControlRequest) returns (XImportMissionControlResponse);

REST

HTTP Method	Path
POST	/v2/router/x/importhistory

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', 'routerrpc/router.proto'], loaderOptions);
const routerrpc = grpc.loadPackageDefinition(packageDefinition).routerrpc;
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 routerrpc.Router(GRPC_HOST, creds);
let request = {
  pairs: <PairHistory>,
  force: <bool>,
};
client.xImportMissionControl(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the routerrpc/router.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import router_pb2 as routerrpc, router_pb2_grpc as routerstub

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 = routerstub.RouterStub(channel)
request = routerrpc.XImportMissionControlRequest(
  pairs=<PairHistory>,
  force=<bool>,
)
response = stub.XImportMissionControl(request)
print(response)
# {
# }

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 = {
  pairs: <array>, // <PairHistory> 
  force: <boolean>, // <bool> 
};
let options = {
  url: `https://${REST_HOST}/v2/router/x/importhistory`,
  // 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:
//  {
//  }

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/router/x/importhistory'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'pairs': <PairHistory>,
  'force': <bool>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
# }

Shell

# There is no CLI command for this RPC

Messages

routerrpc.XImportMissionControlRequest

Source: routerrpc/router.proto

Field	gRPC Type	REST Type	REST Placement
pairs Node pair-level mission control state to be imported.	PairHistory[]	array	body
force Whether to force override MC pair history. Note that even with force override the failure pair is imported before the success pair and both still clamp existing failure/success amounts.	bool	boolean	body

routerrpc.XImportMissionControlResponse

Source: routerrpc/router.proto

note

This response has no parameters.

Nested Messages

routerrpc.PairHistory

Field	gRPC Type	REST Type
node_from The source node pubkey of the pair.	bytes	string
node_to The destination node pubkey of the pair.	bytes	string
history	PairData	object

routerrpc.PairData

Field	gRPC Type	REST Type
fail_time Time of last failure.	int64	string
fail_amt_sat Lowest amount that failed to forward rounded to whole sats. This may be set to zero if the failure is independent of amount.	int64	string
fail_amt_msat Lowest amount that failed to forward in millisats. This may be set to zero if the failure is independent of amount.	int64	string
success_time Time of last success.	int64	string
success_amt_sat Highest amount that we could successfully forward rounded to whole sats.	int64	string
success_amt_msat Highest amount that we could successfully forward in millisats.	int64	string