ListAutopilotFeatures

ListAutopilotFeatures fetches all the features supported by the Autopilot server along with the rules that we need to support in order to subscribe to those features.

Source: lit-autopilot.proto

gRPC

rpc ListAutopilotFeatures (ListAutopilotFeaturesRequest) returns (ListAutopilotFeaturesResponse);

REST

HTTP Method	Path
GET	/v1/autopilot/features

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:8443'
const MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
const TLS_PATH = 'LIT_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('lit-autopilot.proto', loaderOptions);
const litrpc = grpc.loadPackageDefinition(packageDefinition).litrpc;
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 litrpc.Autopilot(GRPC_HOST, creds);
let request = {};
client.listAutopilotFeatures(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "features": <FeaturesEntry>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the lit-autopilot.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import lit-autopilot_pb2 as litrpc, lit-autopilot_pb2_grpc as lit-autopilotstub

GRPC_HOST = 'localhost:8443'
MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
TLS_PATH = 'LIT_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 = lit-autopilotstub.AutopilotStub(channel)
request = litrpc.ListAutopilotFeaturesRequest()
response = stub.ListAutopilotFeatures(request)
print(response)
# {
#    "features": <FeaturesEntry>,
# }

REST

Javascript

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

const REST_HOST = 'localhost:8443'
const MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'

let options = {
  url: `https://${REST_HOST}/v1/autopilot/features`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "features": <object>, // <FeaturesEntry> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8443'
MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
TLS_PATH = 'LIT_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/autopilot/features'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "features": <FeaturesEntry>,
# }

Shell

$ litcli autopilot features --help

NAME:
   litcli autopilot features - List available Autopilot features.

USAGE:
   litcli autopilot features [arguments...]

DESCRIPTION:
   List available Autopilot features.

Messages

litrpc.ListAutopilotFeaturesRequest

Source: lit-autopilot.proto

note

This request has no parameters.

litrpc.ListAutopilotFeaturesResponse

Source: lit-autopilot.proto

Field	gRPC Type	REST Type
features A map of feature names to Feature objects describing the feature.	FeaturesEntry[]	object

Nested Messages

litrpc.ChannelPolicyBounds

Field	gRPC Type	REST Type
min_base_msat The minimum base fee in msat that the autopilot can set for a channel.	uint64	string
max_base_msat The maximum base fee in msat that the autopilot can set for a channel.	uint64	string
min_rate_ppm The minimum ppm fee in msat that the autopilot can set for a channel.	uint32	integer
max_rate_ppm The maximum ppm fee in msat that the autopilot can set for a channel.	uint32	integer
min_cltv_delta The minimum cltv delta that the autopilot may set for a channel.	uint32	integer
max_cltv_delta The maximum cltv delta that the autopilot may set for a channel.	uint32	integer
min_htlc_msat The minimum htlc msat that the autopilot may set for a channel.	uint64	string
max_htlc_msat The maximum htlc msat that the autopilot may set for a channel.	uint64	string

litrpc.ChannelRestrict

Field	gRPC Type	REST Type
channel_ids A list of channel IDs that the Autopilot should not perform any actions on.	uint64[]	array

litrpc.Feature

Field	gRPC Type	REST Type
name Name is the name of the Autopilot feature.	string	string
description A human readable description of what the feature offers.	string	string
rules A map of rules that make sense for this feature. Each rule is accompanied with appropriate default values for the feature along with minimum and maximum values for the rules.	RulesEntry[]	object
permissions_list A list of URI permissions required by the feature.	Permissions[]	array
requires_upgrade A boolean indicating if the user would need to upgrade their Litd version in order to subscribe to the Autopilot feature. This will be true if the feature rules set contains a rule that Litd is unaware of.	bool	boolean
default_config The JSON-marshaled representation of a feature's default configuration.	string	string
privacy_flags This feature may require relaxed privacy obfuscation that can be enabled with these flags.	uint64	string

litrpc.Feature.RulesEntry

Field	gRPC Type	REST Type
key	string	unknown
value	RuleValues	unknown

litrpc.HistoryLimit

Field	gRPC Type	REST Type
start_time The absolute unix timestamp in seconds before which no information should be shared. This should only be set if duration is not set.	uint64	string
duration The maximum relative duration in seconds that a request is allowed to query for. This should only be set if start_time is not set.	uint64	string

litrpc.ListAutopilotFeaturesResponse.FeaturesEntry

Field	gRPC Type	REST Type
key	string	unknown
value	Feature	unknown

litrpc.MacaroonPermission

Field	gRPC Type	REST Type
entity The entity a permission grants access to. If a entity is set to the "uri" keyword then the action entry should be one of the special cases described in the comment for action.	string	string
action The action that is granted. If entity is set to "uri", then action must be set to either: - a particular URI to which access should be granted. - a URI regex, in which case access will be granted to each URI that matches the regex. - the "readonly" keyword. This will result in the access being granted to all read-only endpoints.	string	string

litrpc.OffChainBudget

Field	gRPC Type	REST Type
max_amt_msat The maximum amount that can be spent off-chain excluding fees.	uint64	string
max_fees_msat The maximum amount that can be spent off-chain on fees.	uint64	string

litrpc.OnChainBudget

Field	gRPC Type	REST Type
absolute_amt_sats The maximum amount that can be spent on-chain including fees.	uint64	string
max_sat_per_v_byte The maximum amount that can be spent on-chain in fees.	uint64	string

litrpc.PeerRestrict

Field	gRPC Type	REST Type
peer_ids A list of peer IDs that the Autopilot should not perform any actions on.	string[]	array

litrpc.Permissions

Field	gRPC Type	REST Type
method The URI in question.	string	string
operations A list of the permissions required for this method.	MacaroonPermission[]	array

litrpc.Rate

Field	gRPC Type	REST Type
iterations The number of times a call is allowed in num_hours number of hours.	uint32	integer
num_hours The number of hours in which the iterations count takes place over.	uint32	integer

litrpc.RateLimit

Field	gRPC Type	REST Type
read_limit The rate limit for read-only calls.	Rate	object
write_limit The rate limit for write/execution calls.	Rate	object

litrpc.RuleValue

Field	gRPC Type	REST Type
rate_limit	RateLimit	object
chan_policy_bounds	ChannelPolicyBounds	object
history_limit	HistoryLimit	object
off_chain_budget	OffChainBudget	object
on_chain_budget	OnChainBudget	object
send_to_self	SendToSelf	object
channel_restrict	ChannelRestrict	object
peer_restrict	PeerRestrict	object

litrpc.RuleValues

Field	gRPC Type	REST Type
known Whether or not the users version of Litd is aware of this rule.	bool	boolean
defaults The default values for the rule that the Autopilot server recommends for the associated feature.	RuleValue	object
min_value The minimum sane value for this rule for the associated feature.	RuleValue	object
max_value The maximum sane value for this rule for the associated feature.	RuleValue	object

litrpc.SendToSelf

note

This response has no parameters.