Skip to main content

GetMissionControlConfig

GetMissionControlConfig returns mission control's current config.

Source: routerrpc/router.proto

gRPC

rpc GetMissionControlConfig (GetMissionControlConfigRequest) returns (GetMissionControlConfigResponse);

REST

HTTP MethodPath
GET /v2/router/mccfg

Code Samples

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 = {};
client.getMissionControlConfig(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "config": <MissionControlConfig>,
// }

Messages

routerrpc.GetMissionControlConfigRequest

Source: routerrpc/router.proto

note

This request has no parameters.

routerrpc.GetMissionControlConfigResponse

Source: routerrpc/router.proto

FieldgRPC TypeREST Type
config
MissionControlConfigobject

Nested Messages

routerrpc.AprioriParameters

FieldgRPC TypeREST Type
half_life_seconds
uint64string
hop_probability
doublenumber
weight
doublenumber
capacity_fraction
doublenumber

routerrpc.BimodalParameters

FieldgRPC TypeREST Type
node_weight
doublenumber
scale_msat
uint64string
decay_time
uint64string

routerrpc.MissionControlConfig

FieldgRPC TypeREST Type
half_life_secondsdeprecated
uint64string
hop_probabilitydeprecated
floatnumber
weightdeprecated
floatnumber
maximum_payment_results
uint32integer
minimum_failure_relax_interval
uint64string
model
ProbabilityModelstring
apriori
AprioriParametersobject
bimodal
BimodalParametersobject

Enums

routerrpc.MissionControlConfig.ProbabilityModel

NameNumber
APRIORI
0
BIMODAL
1