OrderState

Source: auctioneerrpc/auctioneer.proto

gRPC

rpc OrderState (ServerOrderStateRequest) returns (ServerOrderStateResponse);

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('auctioneerrpc/auctioneer.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.ChannelAuctioneer(GRPC_HOST, creds);
let request = {
  order_nonce: <bytes>,
};
client.orderState(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "state": <OrderState>,
//    "units_unfulfilled": <uint32>,
//  }

Python

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

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 = auctioneerstub.ChannelAuctioneerStub(channel)
request = poolrpc.ServerOrderStateRequest(
  order_nonce=<bytes>,
)
response = stub.OrderState(request)
print(response)
# {
#    "state": <OrderState>,
#    "units_unfulfilled": <uint32>,
# }

Shell

# There is no CLI command for this RPC

Messages

poolrpc.ServerOrderStateRequest

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type	REST Placement
order_nonce	bytes	unknown	unknown

poolrpc.ServerOrderStateResponse

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type
state The state the order currently is in.	OrderState	unknown
units_unfulfilled The number of currently unfilled units of this order. This will be equal to the total amount of units until the order has reached the state PARTIAL_FILL or EXECUTED.	uint32	unknown

Enums

poolrpc.OrderState

Name	Number
ORDER_SUBMITTED	0
ORDER_CLEARED	1
ORDER_PARTIALLY_FILLED	2
ORDER_EXECUTED	3
ORDER_CANCELED	4
ORDER_EXPIRED	5
ORDER_FAILED	6