Skip to main content

CancelOrder

CancelOrder cancels an active order with the auction server to remove it from future matching.

Source: poolrpc/trader.proto

gRPC

rpc CancelOrder (CancelOrderRequest) returns (CancelOrderResponse);

REST

HTTP MethodPath
DELETE /v1/pool/orders/{order_nonce}

Code Samples

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 = {
order_nonce: <bytes>,
};
client.cancelOrder(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// }

Messages

poolrpc.CancelOrderRequest

Source: poolrpc/trader.proto

FieldgRPC TypeREST TypeREST Placement
order_nonce
bytesstringpath

poolrpc.CancelOrderResponse

Source: poolrpc/trader.proto

note

This response has no parameters.