ListSidecars

ListSidecars lists all sidecar tickets currently in the local database. This includes tickets offered by our node as well as tickets that our node is the recipient of. Optionally a ticket ID can be provided to filter the tickets.

Source: poolrpc/trader.proto

gRPC

rpc ListSidecars (ListSidecarsRequest) returns (ListSidecarsResponse);

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:12010'
const MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'
const TLS_PATH = 'POOL_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('poolrpc/trader.proto', loaderOptions);
const poolrpc = grpc.loadPackageDefinition(packageDefinition).poolrpc;
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 poolrpc.Trader(GRPC_HOST, creds);
let request = {
  sidecar_id: <bytes>,
};
client.listSidecars(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "tickets": <DecodedSidecarTicket>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the poolrpc/trader.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import trader_pb2 as poolrpc, trader_pb2_grpc as traderstub

GRPC_HOST = 'localhost:12010'
MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'
TLS_PATH = 'POOL_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 = traderstub.TraderStub(channel)
request = poolrpc.ListSidecarsRequest(
  sidecar_id=<bytes>,
)
response = stub.ListSidecars(request)
print(response)
# {
#    "tickets": <DecodedSidecarTicket>,
# }

Shell

$ pool sidecar list --help

NAME:
   pool sidecar list - list all sidecar tickets

USAGE:
   pool sidecar list [arguments...]

Messages

poolrpc.ListSidecarsRequest

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type	REST Placement
sidecar_id The optional sidecar ID to filter for. If set, the result should either be a single ticket or no ticket in most cases. But because the ID is just 8 bytes and is randomly generated, there could be collisions, especially since tickets can also be crafted by a malicious party and given to any node. That's why the offer's public key is also used as an identifying element since that cannot easily be forged without also producing a valid signature. So an attacker cannot overwrite a ticket a node offered by themselves offering a ticket with the same ID and tricking the victim into registering that. Long story sort, there could be multiple tickets with the same ID but different offer public keys, which is why those keys should be checked as well.	bytes	unknown	unknown

poolrpc.ListSidecarsResponse

Source: poolrpc/trader.proto

Field	gRPC Type	REST Type
tickets	DecodedSidecarTicket[]	array

Nested Messages

poolrpc.DecodedSidecarTicket

Field	gRPC Type	REST Type
id The unique, pseudorandom identifier of the ticket.	bytes	string
version The version of the ticket encoding format.	uint32	integer
state The state of the ticket.	string	string
offer_capacity The offered channel capacity in satoshis.	uint64	string
offer_push_amount The offered push amount in satoshis.	uint64	string
offer_lease_duration_blocks The offered lease duration in blocks.	uint32	integer
offer_sign_pubkey The public key the offer was signed with.	bytes	string
offer_signature The signature over the offer's digest.	bytes	string
offer_auto Whether the offer was created with the automatic order creation flag.	bool	boolean
recipient_node_pubkey The recipient node's public identity key.	bytes	string
recipient_multisig_pubkey The recipient node's channel multisig public key to be used for the sidecar channel.	bytes	string
recipient_multisig_pubkey_index The index used when deriving the above multisig pubkey.	uint32	integer
order_bid_nonce The nonce of the bid order created for this sidecar ticket.	bytes	string
order_signature The signature over the order's digest, signed with the private key that corresponds to the offer_sign_pubkey.	bytes	string
execution_pending_channel_id The pending channel ID of the sidecar channel during the execution phase.	bytes	string
encoded_ticket The original, base58 encoded ticket.	string	string
offer_unannounced_channel If true, the channel acceptor for this ticket will expect an unannounced channel.	bool	boolean
offer_zero_conf_channel If true, the channel acceptor for this ticket will expect a zero conf channel.	bool	boolean