Skip to main content

AssetLeafKeys

AssetLeafKeys queries for the set of Universe keys associated with a given asset_id or group_key. Each key takes the form: (outpoint, script_key), where outpoint is an outpoint in the Bitcoin blockchain that anchors a valid Taproot Asset commitment, and script_key is the script_key of the asset within the Taproot Asset commitment for the given asset_id or group_key.

Source: universerpc/universe.proto

gRPC

rpc AssetLeafKeys (AssetLeafKeysRequest) returns (AssetLeafKeyResponse);

REST

HTTP MethodPath
GET /v1/taproot-assets/universe/keys/asset-id/{id.asset_id_str}

Code Samples

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('universerpc/universe.proto', loaderOptions);
const universerpc = grpc.loadPackageDefinition(packageDefinition).universerpc;
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 universerpc.Universe(GRPC_HOST, creds);
let request = {
id: <ID>,
offset: <int32>,
limit: <int32>,
direction: <SortDirection>,
};
client.assetLeafKeys(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "asset_keys": <AssetKey>,
// }

Messages

universerpc.AssetLeafKeysRequest

Source: universerpc/universe.proto

FieldgRPC TypeREST TypeREST Placement
id
IDobjectmixed
offset
int32integerquery
limit
int32integerquery
direction
SortDirectionobjectquery

universerpc.AssetLeafKeyResponse

Source: universerpc/universe.proto

FieldgRPC TypeREST Type
asset_keys
AssetKey[]array

Nested Messages

universerpc.AssetKey

FieldgRPC TypeREST Type
op_str
stringstring
op
Outpointobject
script_key_bytes
bytesstring
script_key_str
stringstring

universerpc.ID

FieldgRPC TypeREST Type
asset_id
bytesstring
asset_id_str
stringstring
group_key
bytesstring
group_key_str
stringstring
proof_type
ProofTypestring

universerpc.Outpoint

FieldgRPC TypeREST Type
hash_str
stringstring
index
int32integer

Enums

universerpc.ProofType

NameNumber
PROOF_TYPE_UNSPECIFIED
0
PROOF_TYPE_ISSUANCE
1
PROOF_TYPE_TRANSFER
2

universerpc.SortDirection

NameNumber
SORT_DIRECTION_ASC
0
SORT_DIRECTION_DESC
1