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 Method | Path |
---|---|
GET | /v1/taproot-assets/burns |
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 = {
asset_id: <bytes>,
tweaked_group_key: <bytes>,
anchor_txid: <bytes>,
};
client.listBurns(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "burns": <AssetBurn>,
// }
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.ListBurnsRequest(
asset_id=<bytes>,
tweaked_group_key=<bytes>,
anchor_txid=<bytes>,
)
response = stub.ListBurns(request)
print(response)
# {
# "burns": <AssetBurn>,
# }
- 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/burns`,
// 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:
// {
// "burns": <array>, // <AssetBurn>
// }
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/burns'
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())
# {
# "burns": <AssetBurn>,
# }
$ tapcli assets listburns --help
NAME:
tapcli assets listburns - list burnt assets
USAGE:
tapcli assets listburns [command options] [arguments...]
DESCRIPTION:
List assets that have been burned by this daemon. These are assets that
have been destroyed and are no longer spendable.
Some filters may be used to return more specific results.
OPTIONS:
--asset_id value the asset ID of the burnt asset
--group_key value the group key of the burnt asset
--anchor_txid value the txid of the transaction the burn was anchored to
Messages
taprpc.ListBurnsRequest
Source: taprootassets.proto
Field | gRPC Type | REST Type | REST Placement |
---|---|---|---|
asset_id | bytes | string | query |
tweaked_group_key | bytes | string | query |
anchor_txid | bytes | string | query |
taprpc.ListBurnsResponse
Source: taprootassets.proto
Field | gRPC Type | REST Type |
---|---|---|
burns | AssetBurn[] | array |
Nested Messages
taprpc.AssetBurn
Field | gRPC Type | REST Type |
---|---|---|
note | string | string |
asset_id | bytes | string |
tweaked_group_key | bytes | string |
amount | uint64 | string |
anchor_txid | bytes | string |