ResolveRequest

ResolveRequest resolves a quote request by returning either an accepted asset rate or a rejection reason.

Source: portfoliopilotrpc/portfolio_pilot.proto

gRPC

rpc ResolveRequest (ResolveRequestRequest) returns (ResolveRequestResponse);

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:10029'
const MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'
const TLS_PATH = 'TAPD_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('portfoliopilotrpc/portfolio_pilot.proto', loaderOptions);
const portfoliopilotrpc = grpc.loadPackageDefinition(packageDefinition).portfoliopilotrpc;
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 portfoliopilotrpc.PortfolioPilot(GRPC_HOST, creds);
let request = {
  buy_request: <BuyRequest>,
  sell_request: <SellRequest>,
};
client.resolveRequest(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "accept": <AssetRate>,
//    "reject": <RejectErr>,
//    "accepted_max_amount": <uint64>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the portfoliopilotrpc/portfolio_pilot.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import portfolio_pilot_pb2 as portfoliopilotrpc, portfolio_pilot_pb2_grpc as portfolio_pilotstub

GRPC_HOST = 'localhost:10029'
MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'
TLS_PATH = 'TAPD_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 = portfolio_pilotstub.PortfolioPilotStub(channel)
request = portfoliopilotrpc.ResolveRequestRequest(
  buy_request=<BuyRequest>,
  sell_request=<SellRequest>,
)
response = stub.ResolveRequest(request)
print(response)
# {
#    "accept": <AssetRate>,
#    "reject": <RejectErr>,
#    "accepted_max_amount": <uint64>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightninglabs/taproot-assets
GRPC_HOST=localhost:10029
TAPD_DIR=~/.tapd
TAPD_SOURCE=path/to/taproot-assets
NETWORK=mainnet
MACAROON_PATH="$TAPD_DIR/data/$NETWORK/admin.macaroon"
TLS_PATH="$TAPD_DIR/tls.cert"

grpcurl \
    -import-path $TAPD_SOURCE/taprpc/ \
    -proto portfoliopilotrpc/portfolio_pilot.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "buy_request": <BuyRequest>, "sell_request": <SellRequest> }' \
    $GRPC_HOST \
    portfoliopilotrpc.PortfolioPilot/ResolveRequest

Messages

portfoliopilotrpc.ResolveRequestRequest

Source: portfoliopilotrpc/portfolio_pilot.proto

Field	gRPC Type	REST Type	REST Placement
buy_request buy_request is a request to buy the subject asset.	BuyRequest	unknown	unknown
sell_request sell_request is a request to sell the subject asset.	SellRequest	unknown	unknown

portfoliopilotrpc.ResolveRequestResponse

Source: portfoliopilotrpc/portfolio_pilot.proto

Field	gRPC Type	REST Type
accept accept is the accepted asset rate for the request.	AssetRate	unknown
reject reject is the rejection reason for the request.	RejectErr	unknown
accepted_max_amount accepted_max_amount is an optional fill quantity that caps the amount the responder is willing to accept. Only meaningful when accept is set; 0 means no fill cap (full request max). The unit depends on the request type: asset units for a buy request, msat for a sell request.	uint64	unknown

Nested Messages

portfoliopilotrpc.AssetRate

Field	gRPC Type	REST Type
rate rate is the asset to BTC conversion rate represented as a fixed-point number.	FixedPoint	unknown
expiry_timestamp expiry_timestamp is the Unix timestamp in seconds after which the rate is no longer valid.	uint64	unknown

portfoliopilotrpc.AssetSpecifier

Field	gRPC Type	REST Type
asset_id The 32-byte asset ID specified as raw bytes (gRPC only).	bytes	unknown
asset_id_str The 32-byte asset ID encoded as a hex string (use this for REST).	string	unknown
group_key The 32-byte asset group key specified as raw bytes (gRPC only).	bytes	unknown
group_key_str The 32-byte asset group key encoded as hex string (use this for REST).	string	unknown

portfoliopilotrpc.BuyRequest

Field	gRPC Type	REST Type
asset_specifier asset_specifier is the subject asset.	AssetSpecifier	unknown
asset_max_amount asset_max_amount is the maximum amount of the asset that the peer must be willing to offer.	uint64	unknown
asset_rate_hint asset_rate_hint is an optional suggested asset rate for the request.	AssetRate	unknown
price_oracle_metadata price_oracle_metadata is optional metadata for pricing decisions.	string	unknown
peer_id peer_id is the 33-byte public key of the counterparty peer.	bytes	unknown
asset_min_amount asset_min_amount is an optional minimum asset amount. A value of 0 means unset.	uint64	unknown
asset_rate_limit asset_rate_limit is an optional minimum acceptable rate (asset units per BTC).	FixedPoint	unknown
execution_policy execution_policy is the optional execution policy for this request.	ExecutionPolicy	unknown

portfoliopilotrpc.FixedPoint

Field	gRPC Type	REST Type
coefficient The coefficient is the fractional value scaled-up as an integer. This integer is represented as a string as it may be too large to fit in a uint64.	string	unknown
scale The scale is the component that determines how many decimal places the coefficient should be divided by to obtain the fractional value.	uint32	unknown

portfoliopilotrpc.RejectErr

Field	gRPC Type	REST Type
code code is the error code.	RejectCode	unknown
message message is a human-readable error message.	string	unknown

portfoliopilotrpc.SellRequest

Field	gRPC Type	REST Type
asset_specifier asset_specifier is the subject asset.	AssetSpecifier	unknown
payment_max_amount payment_max_amount is the maximum msat amount that the peer must agree to pay.	uint64	unknown
asset_rate_hint asset_rate_hint is an optional suggested asset rate for the request.	AssetRate	unknown
price_oracle_metadata price_oracle_metadata is optional metadata for pricing decisions.	string	unknown
peer_id peer_id is the 33-byte public key of the counterparty peer.	bytes	unknown
payment_min_amount payment_min_amount is an optional minimum msat amount. A value of 0 means unset.	uint64	unknown
asset_rate_limit asset_rate_limit is an optional maximum acceptable rate (asset units per BTC).	FixedPoint	unknown
execution_policy execution_policy is the optional execution policy for this request.	ExecutionPolicy	unknown

Enums

portfoliopilotrpc.ExecutionPolicy

Name	Number
EXECUTION_POLICY_IOC EXECUTION_POLICY_IOC (Immediate-Or-Cancel) accepts any partial fill. This is the default policy.	0
EXECUTION_POLICY_FOK EXECUTION_POLICY_FOK (Fill-Or-Kill) requires the accepted rate to satisfy the full requested amount.	1

portfoliopilotrpc.RejectCode

Name	Number
REJECT_CODE_UNSPECIFIED REJECT_CODE_UNSPECIFIED indicates an unspecified error.	0
REJECT_CODE_PRICE_ORACLE_UNAVAILABLE REJECT_CODE_PRICE_ORACLE_UNAVAILABLE indicates that pricing could not be provided due to an unavailable oracle.	1
REJECT_CODE_MIN_FILL_NOT_MET REJECT_CODE_MIN_FILL_NOT_MET indicates that the minimum fill constraint was not satisfiable at the accepted rate.	2
REJECT_CODE_PRICE_BOUND_MISS REJECT_CODE_PRICE_BOUND_MISS indicates that the accepted rate violated the requester's rate limit constraint.	3
REJECT_CODE_FOK_NOT_VIABLE REJECT_CODE_FOK_NOT_VIABLE indicates that the FOK execution policy could not be satisfied at the accepted rate.	4
REJECT_CODE_FILL_EXCEEDS_MAX REJECT_CODE_FILL_EXCEEDS_MAX indicates that the negotiated fill amount exceeds the requester's maximum.	5