IgnoreAssetOutPoint

IgnoreAssetOutPoint allows an asset issuer to mark a specific asset outpoint as ignored. An ignored outpoint will be included in the next universe supply commitment transaction that is published.

Source: universerpc/universe.proto

gRPC

rpc IgnoreAssetOutPoint (IgnoreAssetOutPointRequest) returns (IgnoreAssetOutPointResponse);

REST

HTTP Method	Path
POST	/v1/taproot-assets/universe/supply/ignore

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 = {
  asset_out_point: <AssetOutPoint>,
  amount: <uint64>,
};
client.ignoreAssetOutPoint(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "leaf_key": <bytes>,
//    "leaf": <MerkleSumNode>,
//  }

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.IgnoreAssetOutPointRequest(
  asset_out_point=<AssetOutPoint>,
  amount=<uint64>,
)
response = stub.IgnoreAssetOutPoint(request)
print(response)
# {
#    "leaf_key": <bytes>,
#    "leaf": <MerkleSumNode>,
# }

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 requestBody = {
  asset_out_point: <object>, // <AssetOutPoint> 
  amount: <string>, // <uint64> 
};
let options = {
  url: `https://${REST_HOST}/v1/taproot-assets/universe/supply/ignore`,
  // 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:
//  {
//    "leaf_key": <string>, // <bytes> 
//    "leaf": <object>, // <MerkleSumNode> 
//  }

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/ignore'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'asset_out_point': <AssetOutPoint>,
  'amount': <uint64>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "leaf_key": <bytes>,
#    "leaf": <MerkleSumNode>,
# }

Shell

# There is no CLI command for this RPC

Messages

universerpc.IgnoreAssetOutPointRequest

Source: universerpc/universe.proto

Field	gRPC Type	REST Type	REST Placement
asset_out_point The outpoint of the asset to ignore.	AssetOutPoint	object	body
amount The amount of asset units at the associated asset outpoint.	uint64	string	body

universerpc.IgnoreAssetOutPointResponse

Source: universerpc/universe.proto

Field	gRPC Type	REST Type
leaf_key The key identifying the signed ignore outpoint leaf in the ignore supply commitment subtree.	bytes	string
leaf The signed ignore outpoint leaf in the ignore supply commitment tree.	MerkleSumNode	object

Nested Messages

taprpc.AssetOutPoint

Field	gRPC Type	REST Type
anchor_out_point The outpoint of the asset anchor, represented as a string in the format "<txid>:<vout>". The <txid> is the transaction ID of the UTXO, hex-encoded and byte-reversed (i.e., the internal little-endian 32-byte value is reversed to big-endian hex format) to match standard Bitcoin RPC and UI conventions.	string	string
asset_id The asset ID of the asset anchored at the outpoint.	bytes	string
script_key The script key of the asset. This is the taproot output key that the asset is locked to.	bytes	string

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