FetchSupplyLeaves

FetchSupplyLeaves fetches the supply leaves for a specific asset group within a specified block height range. The leaves include issuance, burn, and ignore leaves, which represent the supply changes for the asset group.

Source: universerpc/universe.proto

gRPC

rpc FetchSupplyLeaves (FetchSupplyLeavesRequest) returns (FetchSupplyLeavesResponse);

REST

HTTP Method	Path
GET	/v1/taproot-assets/universe/supply/leaves/{group_key_str}

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('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 = {
  group_key_bytes: <bytes>,
  group_key_str: <string>,
  block_height_start: <uint32>,
  block_height_end: <uint32>,
};
client.fetchSupplyLeaves(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "issuance_leaves": <SupplyLeafEntry>,
//    "burn_leaves": <SupplyLeafEntry>,
//    "ignore_leaves": <SupplyLeafEntry>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the universerpc/universe.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import universe_pb2 as universerpc, universe_pb2_grpc as universestub

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 = universestub.UniverseStub(channel)
request = universerpc.FetchSupplyLeavesRequest(
  group_key_bytes=<bytes>,
  group_key_str=<string>,
  block_height_start=<uint32>,
  block_height_end=<uint32>,
)
response = stub.FetchSupplyLeaves(request)
print(response)
# {
#    "issuance_leaves": <SupplyLeafEntry>,
#    "burn_leaves": <SupplyLeafEntry>,
#    "ignore_leaves": <SupplyLeafEntry>,
# }

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/universe/supply/leaves/{group_key_str}`,
  // 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:
//  {
//    "issuance_leaves": <array>, // <SupplyLeafEntry> 
//    "burn_leaves": <array>, // <SupplyLeafEntry> 
//    "ignore_leaves": <array>, // <SupplyLeafEntry> 
//  }

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/universe/supply/leaves/{group_key_str}'
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())
# {
#    "issuance_leaves": <SupplyLeafEntry>,
#    "burn_leaves": <SupplyLeafEntry>,
#    "ignore_leaves": <SupplyLeafEntry>,
# }

Shell

# There is no CLI command for this RPC

Messages

universerpc.FetchSupplyLeavesRequest

Source: universerpc/universe.proto

Field	gRPC Type	REST Type	REST Placement
group_key_bytes The 32-byte asset group key specified as raw bytes (gRPC only).	bytes	string	query
group_key_str The 32-byte asset group key encoded as hex string (use this for REST).	string	string	path
block_height_start The start block height for the range of supply leaves to fetch.	uint32	integer	query
block_height_end The end block height for the range of supply leaves to fetch.	uint32	integer	query

universerpc.FetchSupplyLeavesResponse

Source: universerpc/universe.proto

Field	gRPC Type	REST Type
issuance_leaves	SupplyLeafEntry[]	array
burn_leaves	SupplyLeafEntry[]	array
ignore_leaves	SupplyLeafEntry[]	array

Nested Messages

universerpc.MerkleSumNode

Field	gRPC Type	REST Type
root_hash The MS-SMT root hash for the branch node.	bytes	string
root_sum The root sum of the branch node. This is hashed to create the root_hash along with the left and right siblings. This value represents the total known supply of the asset.	int64	string

universerpc.Outpoint

Field	gRPC Type	REST Type
hash_str The output as a hex encoded (and reversed!) string.	string	string
index The index of the output.	int32	integer

universerpc.SupplyLeafEntry

Field	gRPC Type	REST Type
leaf_key The key that identifies the supply leaf in the supply commitment subtree.	SupplyLeafKey	object
leaf_node The merkle sum node representing the supply leaf in the supply commitment subtree.	MerkleSumNode	object
block_height The block height at which the supply leaf was created.	uint32	integer
raw_leaf The raw serialized bytes of the supply leaf.	bytes	string

universerpc.SupplyLeafKey

Field	gRPC Type	REST Type
outpoint The outpoint associated with the supply leaf.	Outpoint	object
script_key The script key of the supply leaf. This is the script key of the asset point.	bytes	string
asset_id The asset ID associated with the supply leaf. This is only set for ignore type supply leaves.	bytes	string