QueryRateTick

QueryRateTick queries the rate tick for a given transaction type, subject asset, and payment asset. The rate tick is the exchange rate between the subject asset and the payment asset.

Source: priceoraclerpc/price_oracle.proto

gRPC

rpc QueryRateTick (QueryRateTickRequest) returns (QueryRateTickResponse);

REST

HTTP Method	Path
GET	/v1/taproot-assets/rfq/priceoracle/ratetick

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('priceoraclerpc/price_oracle.proto', loaderOptions);
const priceoraclerpc = grpc.loadPackageDefinition(packageDefinition).priceoraclerpc;
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 priceoraclerpc.PriceOracle(GRPC_HOST, creds);
let request = {
  transaction_type: <TransactionType>,
  subject_asset: <AssetSpecifier>,
  subject_asset_max_amount: <uint64>,
  payment_asset: <AssetSpecifier>,
  rate_tick_hint: <RateTick>,
};
client.queryRateTick(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "success": <QueryRateTickSuccessResponse>,
//    "error": <QueryRateTickErrResponse>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the priceoraclerpc/price_oracle.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import price_oracle_pb2 as priceoraclerpc, price_oracle_pb2_grpc as price_oraclestub

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 = price_oraclestub.PriceOracleStub(channel)
request = priceoraclerpc.QueryRateTickRequest(
  transaction_type=<TransactionType>,
  subject_asset=<AssetSpecifier>,
  subject_asset_max_amount=<uint64>,
  payment_asset=<AssetSpecifier>,
  rate_tick_hint=<RateTick>,
)
response = stub.QueryRateTick(request)
print(response)
# {
#    "success": <QueryRateTickSuccessResponse>,
#    "error": <QueryRateTickErrResponse>,
# }

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 options = {
  url: `https://${REST_HOST}/v1/taproot-assets/rfq/priceoracle/ratetick`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "success": <object>, // <QueryRateTickSuccessResponse> 
//    "error": <object>, // <QueryRateTickErrResponse> 
//  }

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/priceoracle/ratetick'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "success": <QueryRateTickSuccessResponse>,
#    "error": <QueryRateTickErrResponse>,
# }

Shell

# There is no CLI command for this RPC

Messages

priceoraclerpc.QueryRateTickRequest

Source: priceoraclerpc/price_oracle.proto

Field	gRPC Type	REST Type	REST Placement
transaction_type transaction_type indicates whether the transaction is a purchase or a sale. Nested REST Parameters transaction_type: string in query	TransactionType	object	query
subject_asset subject_asset is the asset to be priced for purchase or sale. Nested REST Parameters subject_asset.asset_id: string in query subject_asset.group_key: string in query subject_asset.group_key_str: string in query subject_asset.asset_id_str: string in query	AssetSpecifier	object	query
subject_asset_max_amount subject_asset_max_amount is the maximum amount of the subject asset that could be involved in the transaction.	uint64	string	query
payment_asset payment_asset is the asset used for purchasing or receiving from a sale. NOTE: An asset ID of all zeros indicates that the payment asset is BTC. In this case, the rate tick will be given as milli-satoshi per asset unit Nested REST Parameters payment_asset.asset_id_str: string in query payment_asset.group_key_str: string in query payment_asset.group_key: string in query payment_asset.asset_id: string in query	AssetSpecifier	object	query
rate_tick_hint rate_tick_hint is an optional suggested rate tick for the transaction, used to provide guidance on expected pricing. Nested REST Parameters rate_tick_hint.expiry_timestamp: string in query rate_tick_hint.rate: string in query	RateTick	object	query

priceoraclerpc.QueryRateTickResponse

Source: priceoraclerpc/price_oracle.proto

Field	gRPC Type	REST Type
success success is the successful response to the rate tick query.	QueryRateTickSuccessResponse	object
error error is the error response to the rate tick query.	QueryRateTickErrResponse	object

Nested Messages

priceoraclerpc.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

priceoraclerpc.QueryRateTickErrResponse

Field	gRPC Type	REST Type
message error is the error message.	string	string
code code is the error code.	uint32	integer

priceoraclerpc.QueryRateTickSuccessResponse

Field	gRPC Type	REST Type
rate_tick rate_tick is the rate tick for the transaction.	RateTick	object

priceoraclerpc.RateTick

Field	gRPC Type	REST Type
rate rate is the exchange rate between the subject asset and the payment asset.	uint64	string
expiry_timestamp expiry_timestamp is the Unix timestamp in seconds after which the rate tick is no longer valid.	uint64	string

Enums

priceoraclerpc.TransactionType

Name	Number
PURCHASE PURCHASE indicates a purchase transaction.	0
SALE SALE indicates a sale transaction.	1