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
- REST
- Shell
- Javascript
- Python
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>,
// }
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>,
# }
- Javascript
- Python
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>
// }
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>,
# }
$ 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 | int64 | string | query |
created_before | int64 | string | query |
limit | int32 | integer | query |
offset | 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 | string | string |
asset_id | bytes | string |
asset_type | AssetType | string |
amount | uint64 | string |
group_key | bytes | string |
script_key | bytes | string |
internal_key | bytes | string |
tapscript_sibling | bytes | string |
taproot_output_key | bytes | string |
proof_courier_addr | string | string |
asset_version | AssetVersion | string |
address_version | AddrVersion | string |
Enums
taprpc.AddrVersion
Name | Number |
---|---|
ADDR_VERSION_UNSPECIFIED | 0 |
ADDR_VERSION_V0 | 1 |
ADDR_VERSION_V1 | 2 |
taprpc.AssetType
Name | Number |
---|---|
NORMAL | 0 |
COLLECTIBLE | 1 |
taprpc.AssetVersion
Name | Number |
---|---|
ASSET_VERSION_V0 | 0 |
ASSET_VERSION_V1 | 1 |