QueryAddrs

QueryAddrs queries the set of Taproot Asset addresses stored in the database.

Source: taprootassets.proto

gRPC

rpc QueryAddrs (QueryAddrRequest) returns (QueryAddrResponse);

REST

HTTP Method	Path
GET	/v1/taproot-assets/addrs

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('taprootassets.proto', loaderOptions);
const taprpc = grpc.loadPackageDefinition(packageDefinition).taprpc;
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 taprpc.TaprootAssets(GRPC_HOST, creds);
let request = {
  created_after: <int64>,
  created_before: <int64>,
  limit: <int32>,
  offset: <int32>,
};
client.queryAddrs(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "addrs": <Addr>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the taprootassets.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import taprootassets_pb2 as taprpc, taprootassets_pb2_grpc as taprootassetsstub

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 = taprootassetsstub.TaprootAssetsStub(channel)
request = taprpc.QueryAddrRequest(
  created_after=<int64>,
  created_before=<int64>,
  limit=<int32>,
  offset=<int32>,
)
response = stub.QueryAddrs(request)
print(response)
# {
#    "addrs": <Addr>,
# }

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/addrs`,
  // 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:
//  {
//    "addrs": <array>, // <Addr> 
//  }

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/addrs'
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())
# {
#    "addrs": <Addr>,
# }

Shell

$ tapcli addrs query --help

NAME:
   tapcli addrs query - Query for the set of created addresses

USAGE:
   tapcli addrs query [command options] [arguments...]

DESCRIPTION:
   Query for the set of created addresses, supports pagination

OPTIONS:
   --created_after value   a duration short hand (-1h, 2d, 2w, etc)
   --created_before value  a duration short hand (-2h, 3d, 2w, etc)
   --limit value           the max number of addrs to returned (default: 0)
   --offset value          the number of addrs to skip before returning the first addr (default: 0)
   

Messages

taprpc.QueryAddrRequest

Source: taprootassets.proto

Field	gRPC Type	REST Type	REST Placement
created_after If set, then only addresses created after this Unix timestamp will be returned.	int64	string	query
created_before If set, then only addresses created before this Unix timestamp will be returned.	int64	string	query
limit The max number of addresses that should be returned.	int32	integer	query
offset The offset from the addresses that should be returned.	int32	integer	query

taprpc.QueryAddrResponse

Source: taprootassets.proto

Field	gRPC Type	REST Type
addrs	Addr[]	array

Nested Messages

taprpc.Addr

Field	gRPC Type	REST Type
encoded The bech32 encoded Taproot Asset address.	string	string
asset_id The asset ID that uniquely identifies the asset.	bytes	string
asset_type The type of the asset.	AssetType	string
amount The total amount of the asset stored in this Taproot Asset UTXO.	uint64	string
group_key The group key of the asset (if it exists)	bytes	string
script_key The specific script key the asset must commit to in order to transfer ownership to the creator of the address.	bytes	string
internal_key The internal key used for the on-chain output.	bytes	string
tapscript_sibling The optional serialized tapscript sibling preimage to use for the receiving asset. This is usually empty as it is only needed when there should be an additional script path in the Taproot tree alongside the Taproot Asset commitment of the asset.	bytes	string
taproot_output_key The tweaked internal key that commits to the asset and represents the on-chain output key the Bitcoin transaction must send to in order to transfer assets described in this address.	bytes	string
proof_courier_addr The address of the proof courier service used in proof transfer.	string	string
asset_version The asset version of the address.	AssetVersion	string

Enums

taprpc.AssetType

Name	Number
NORMAL Indicates that an asset is capable of being split/merged, with each of the units being fungible, even across a key asset ID boundary (assuming the key group is the same).	0
COLLECTIBLE Indicates that an asset is a collectible, meaning that each of the other items under the same key group are not fully fungible with each other. Collectibles also cannot be split or merged.	1

taprpc.AssetVersion

Name	Number
ASSET_VERSION_V0 ASSET_VERSION_V0 is the default asset version. This version will include the witness vector in the leaf for a tap commitment.	0
ASSET_VERSION_V1 ASSET_VERSION_V1 is the asset version that leaves out the witness vector from the MS-SMT leaf encoding.	1