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);

REST

HTTP Method	Path
POST	/v1/taproot-assets/rfq/portfoliopilot/resolve

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 = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
const TLS_PATH = 'TAPROOT-ASSETS_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>,
//  }

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 = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
TLS_PATH = 'TAPROOT-ASSETS_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>,
# }

REST

Javascript

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

const REST_HOST = 'localhost:8089'
const MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'

let requestBody = {
  buy_request: <object>, // <BuyRequest> 
  sell_request: <object>, // <SellRequest> 
};
let options = {
  url: `https://${REST_HOST}/v1/taproot-assets/rfq/portfoliopilot/resolve`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
  form: JSON.stringify(requestBody),
}
request.post(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "accept": <object>, // <AssetRate> 
//    "reject": <object>, // <RejectErr> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8089'
MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
TLS_PATH = 'TAPROOT-ASSETS_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/taproot-assets/rfq/portfoliopilot/resolve'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'buy_request': <BuyRequest>,
  'sell_request': <SellRequest>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "accept": <AssetRate>,
#    "reject": <RejectErr>,
# }

Shell

# There is no CLI command for this RPC

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	object	body
sell_request sell_request is a request to sell the subject asset.	SellRequest	object	body

portfoliopilotrpc.ResolveRequestResponse

Source: portfoliopilotrpc/portfolio_pilot.proto

Field	gRPC Type	REST Type
accept accept is the accepted asset rate for the request.	AssetRate	object
reject reject is the rejection reason for the request.	RejectErr	object

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	object
expiry_timestamp expiry_timestamp is the Unix timestamp in seconds after which the rate is no longer valid.	uint64	string

portfoliopilotrpc.AssetSpecifier

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

portfoliopilotrpc.BuyRequest

Field	gRPC Type	REST Type
asset_specifier asset_specifier is the subject asset.	AssetSpecifier	object
asset_max_amount asset_max_amount is the maximum amount of the asset that the peer must be willing to offer.	uint64	string
asset_rate_hint asset_rate_hint is an optional suggested asset rate for the request.	AssetRate	object
price_oracle_metadata price_oracle_metadata is optional metadata for pricing decisions.	string	string
peer_id peer_id is the 33-byte public key of the counterparty peer.	bytes	string

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	string
scale The scale is the component that determines how many decimal places the coefficient should be divided by to obtain the fractional value.	uint32	integer

portfoliopilotrpc.RejectErr

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

portfoliopilotrpc.SellRequest

Field	gRPC Type	REST Type
asset_specifier asset_specifier is the subject asset.	AssetSpecifier	object
payment_max_amount payment_max_amount is the maximum msat amount that the peer must agree to pay.	uint64	string
asset_rate_hint asset_rate_hint is an optional suggested asset rate for the request.	AssetRate	object
price_oracle_metadata price_oracle_metadata is optional metadata for pricing decisions.	string	string
peer_id peer_id is the 33-byte public key of the counterparty peer.	bytes	string

Enums

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