BurnAsset
BurnAsset burns the given number of units of a given asset by sending them to a provably un-spendable script key. Burning means irrevocably destroying a certain number of assets, reducing the total supply of the asset. Because burning is such a destructive and non-reversible operation, some specific values need to be set in the request to avoid accidental burns.
Source: taprootassets.proto
gRPC
rpc BurnAsset (BurnAssetRequest) returns (BurnAssetResponse);
REST
HTTP Method | Path |
---|---|
POST | /v1/taproot-assets/burn |
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>,
asset_id_str: <string>,
amount_to_burn: <uint64>,
confirmation_text: <string>,
note: <string>,
};
client.burnAsset(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "burn_transfer": <AssetTransfer>,
// "burn_proof": <DecodedProof>,
// }
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.BurnAssetRequest(
asset_id=<bytes>,
asset_id_str=<string>,
amount_to_burn=<uint64>,
confirmation_text=<string>,
note=<string>,
)
response = stub.BurnAsset(request)
print(response)
# {
# "burn_transfer": <AssetTransfer>,
# "burn_proof": <DecodedProof>,
# }
- 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 requestBody = {
asset_id: <string>, // <bytes> (base64 encoded)
asset_id_str: <string>, // <string>
amount_to_burn: <string>, // <uint64>
confirmation_text: <string>, // <string>
note: <string>, // <string>
};
let options = {
url: `https://${REST_HOST}/v1/taproot-assets/burn`,
// Work-around for self-signed certificates.
rejectUnauthorized: false,
json: true,
headers: {
'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
},
form: JSON.stringify(requestBody),
}
request.post(options, function(error, response, body) {
console.log(body);
});
// Console output:
// {
// "burn_transfer": <object>, // <AssetTransfer>
// "burn_proof": <object>, // <DecodedProof>
// }
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/burn'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
'asset_id': base64.b64encode(<bytes>),
'asset_id_str': <string>,
'amount_to_burn': <uint64>,
'confirmation_text': <string>,
'note': <string>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
# "burn_transfer": <AssetTransfer>,
# "burn_proof": <DecodedProof>,
# }
$ tapcli assets burn --help
NAME:
tapcli assets burn - burn a number of asset units
USAGE:
tapcli assets burn [command options] [arguments...]
DESCRIPTION:
Burn (destroy, remove from circulation) a number of asset units in a
provable way. The returned burn proof is cryptographic evidence that the
assets can no longer be spent and that the supply has been reduced by
the specified amount.
To avoid a dangling BTC output, not all assets within a commitment can
be burned completely, there always must be a change output (either with
a change amount or another asset that resides in the same commitment).
OPTIONS:
--asset_id value the asset ID to burn units from
--amount value the amount of units to burn/destroy (default: 0)
--override_confirmation_destroy_assets if set, the confirmation prompt will be skipped and the assets are burned/destroyed immediately
Messages
taprpc.BurnAssetRequest
Source: taprootassets.proto
Field | gRPC Type | REST Type | REST Placement |
---|---|---|---|
asset_id | bytes | string | body |
asset_id_str | string | string | body |
amount_to_burn | uint64 | string | body |
confirmation_text | string | string | body |
note | string | string | body |
taprpc.BurnAssetResponse
Source: taprootassets.proto
Field | gRPC Type | REST Type |
---|---|---|
burn_transfer | AssetTransfer | object |
burn_proof | DecodedProof | object |
Nested Messages
taprpc.AnchorInfo
Field | gRPC Type | REST Type |
---|---|---|
anchor_tx | bytes | string |
anchor_block_hash | string | string |
anchor_outpoint | string | string |
internal_key | bytes | string |
merkle_root | bytes | string |
tapscript_sibling | bytes | string |
block_height | uint32 | integer |
taprpc.Asset
Field | gRPC Type | REST Type |
---|---|---|
version | AssetVersion | string |
asset_genesis | GenesisInfo | object |
amount | uint64 | string |
lock_time | int32 | integer |
relative_lock_time | int32 | integer |
script_version | int32 | integer |
script_key | bytes | string |
script_key_is_local | bool | boolean |
asset_group | AssetGroup | object |
chain_anchor | AnchorInfo | object |
prev_witnesses | PrevWitness[] | array |
is_spent | bool | boolean |
lease_owner | bytes | string |
lease_expiry | int64 | string |
is_burn | bool | boolean |
script_key_declared_known | bool | boolean |
script_key_has_script_path | bool | boolean |
decimal_display | DecimalDisplay | object |
taprpc.AssetGroup
Field | gRPC Type | REST Type |
---|---|---|
raw_group_key | bytes | string |
tweaked_group_key | bytes | string |
asset_witness | bytes | string |
tapscript_root | bytes | string |
taprpc.AssetMeta
Field | gRPC Type | REST Type |
---|---|---|
data | bytes | string |
type | AssetMetaType | string |
meta_hash | bytes | string |
taprpc.AssetTransfer
Field | gRPC Type | REST Type |
---|---|---|
transfer_timestamp | int64 | string |
anchor_tx_hash | bytes | string |
anchor_tx_height_hint | uint32 | integer |
anchor_tx_chain_fees | int64 | string |
inputs | TransferInput[] | array |
outputs | TransferOutput[] | array |
anchor_tx_block_hash | ChainHash | object |
taprpc.ChainHash
Field | gRPC Type | REST Type |
---|---|---|
hash | bytes | string |
hash_str | string | string |
taprpc.DecimalDisplay
Field | gRPC Type | REST Type |
---|---|---|
decimal_display | uint32 | integer |
taprpc.DecodedProof
Field | gRPC Type | REST Type |
---|---|---|
proof_at_depth | uint32 | integer |
number_of_proofs | uint32 | integer |
asset | Asset | object |
meta_reveal | AssetMeta | object |
tx_merkle_proof | bytes | string |
inclusion_proof | bytes | string |
exclusion_proofs | bytes[] | array |
split_root_proof | bytes | string |
num_additional_inputs | uint32 | integer |
challenge_witness | bytes[] | array |
is_burn | bool | boolean |
genesis_reveal | GenesisReveal | object |
group_key_reveal | GroupKeyReveal | object |
alt_leaves | bytes | string |
taprpc.GenesisInfo
Field | gRPC Type | REST Type |
---|---|---|
genesis_point | string | string |
name | string | string |
meta_hash | bytes | string |
asset_id | bytes | string |
asset_type | AssetType | string |
output_index | uint32 | integer |
taprpc.GenesisReveal
Field | gRPC Type | REST Type |
---|---|---|
genesis_base_reveal | GenesisInfo | object |
taprpc.GroupKeyReveal
Field | gRPC Type | REST Type |
---|---|---|
raw_group_key | bytes | string |
tapscript_root | bytes | string |
taprpc.PrevInputAsset
Field | gRPC Type | REST Type |
---|---|---|
anchor_point | string | string |
asset_id | bytes | string |
script_key | bytes | string |
amount | uint64 | string |
taprpc.PrevWitness
Field | gRPC Type | REST Type |
---|---|---|
prev_id | PrevInputAsset | object |
tx_witness | bytes[] | array |
split_commitment | SplitCommitment | object |
taprpc.SplitCommitment
Field | gRPC Type | REST Type |
---|---|---|
root_asset | Asset | object |
taprpc.TransferInput
Field | gRPC Type | REST Type |
---|---|---|
anchor_point | string | string |
asset_id | bytes | string |
script_key | bytes | string |
amount | uint64 | string |
taprpc.TransferOutput
Field | gRPC Type | REST Type |
---|---|---|
anchor | TransferOutputAnchor | object |
script_key | bytes | string |
script_key_is_local | bool | boolean |
amount | uint64 | string |
new_proof_blob | bytes | string |
split_commit_root_hash | bytes | string |
output_type | OutputType | string |
asset_version | AssetVersion | string |
lock_time | uint64 | string |
relative_lock_time | uint64 | string |
proof_delivery_status | ProofDeliveryStatus | string |
taprpc.TransferOutputAnchor
Field | gRPC Type | REST Type |
---|---|---|
outpoint | string | string |
value | int64 | string |
internal_key | bytes | string |
taproot_asset_root | bytes | string |
merkle_root | bytes | string |
tapscript_sibling | bytes | string |
num_passive_assets | uint32 | integer |
Enums
taprpc.AssetMetaType
Name | Number |
---|---|
META_TYPE_OPAQUE | 0 |
META_TYPE_JSON | 1 |
taprpc.AssetType
Name | Number |
---|---|
NORMAL | 0 |
COLLECTIBLE | 1 |
taprpc.AssetVersion
Name | Number |
---|---|
ASSET_VERSION_V0 | 0 |
ASSET_VERSION_V1 | 1 |
taprpc.OutputType
Name | Number |
---|---|
OUTPUT_TYPE_SIMPLE | 0 |
OUTPUT_TYPE_SPLIT_ROOT | 1 |
taprpc.ProofDeliveryStatus
Name | Number |
---|---|
PROOF_DELIVERY_STATUS_NOT_APPLICABLE | 0 |
PROOF_DELIVERY_STATUS_COMPLETE | 1 |
PROOF_DELIVERY_STATUS_PENDING | 2 |