Skip to main content

ListBurns

ListBurns lists the asset burns that this wallet has performed. These assets are not recoverable in any way. Filters may be applied to return more specific results.

Source: taprootassets.proto

gRPC

rpc ListBurns (ListBurnsRequest) returns (ListBurnsResponse);

REST

HTTP MethodPath
GET /v1/taproot-assets/burns

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('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 = {
asset_id: <bytes>,
tweaked_group_key: <bytes>,
anchor_txid: <bytes>,
};
client.listBurns(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "burns": <AssetBurn>,
// }

Messages

taprpc.ListBurnsRequest

Source: taprootassets.proto

FieldgRPC TypeREST TypeREST Placement
asset_id
bytesstringquery
tweaked_group_key
bytesstringquery
anchor_txid
bytesstringquery

taprpc.ListBurnsResponse

Source: taprootassets.proto

FieldgRPC TypeREST Type
burns
AssetBurn[]array

Nested Messages

taprpc.AssetBurn

FieldgRPC TypeREST Type
note
stringstring
asset_id
bytesstring
tweaked_group_key
bytesstring
amount
uint64string
anchor_txid
bytesstring