InsertSupplyCommit

InsertSupplyCommit inserts a supply commitment for a specific asset group. This includes the commitment details, supply leaves (issuance, burn, and ignore), and chain proof that proves the commitment has been mined.

Source: universerpc/universe.proto

gRPC

rpc InsertSupplyCommit (InsertSupplyCommitRequest) returns (InsertSupplyCommitResponse);

REST

HTTP Method	Path
POST	/v1/taproot-assets/universe/supply/{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>,
  chain_data: <SupplyCommitChainData>,
  spent_commitment_outpoint: <OutPoint>,
  issuance_leaves: <SupplyLeafEntry>,
  burn_leaves: <SupplyLeafEntry>,
  ignore_leaves: <SupplyLeafEntry>,
};
client.insertSupplyCommit(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//  }

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.InsertSupplyCommitRequest(
  group_key_bytes=<bytes>,
  group_key_str=<string>,
  chain_data=<SupplyCommitChainData>,
  spent_commitment_outpoint=<OutPoint>,
  issuance_leaves=<SupplyLeafEntry>,
  burn_leaves=<SupplyLeafEntry>,
  ignore_leaves=<SupplyLeafEntry>,
)
response = stub.InsertSupplyCommit(request)
print(response)
# {
# }

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 = {
  group_key_bytes: <unknown>, // <bytes> (base64 encoded)
  group_key_str: <string>, // <string> 
  chain_data: <object>, // <SupplyCommitChainData> 
  spent_commitment_outpoint: <object>, // <OutPoint> 
  issuance_leaves: <object>, // <SupplyLeafEntry> 
  burn_leaves: <object>, // <SupplyLeafEntry> 
  ignore_leaves: <object>, // <SupplyLeafEntry> 
};
let options = {
  url: `https://${REST_HOST}/v1/taproot-assets/universe/supply/{group_key_str}`,
  // 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:
//  {
//  }

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/{group_key_str}'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'group_key_bytes': base64.b64encode(<bytes>),
  'group_key_str': <string>,
  'chain_data': <SupplyCommitChainData>,
  'spent_commitment_outpoint': <OutPoint>,
  'issuance_leaves': <SupplyLeafEntry>,
  'burn_leaves': <SupplyLeafEntry>,
  'ignore_leaves': <SupplyLeafEntry>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
# }

Shell

# There is no CLI command for this RPC

Messages

universerpc.InsertSupplyCommitRequest

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	unknown	body
group_key_str The 32-byte asset group key encoded as hex string (use this for REST).	string	string	path
chain_data The supply commitment chain data that contains both the commitment and chain proof information.	SupplyCommitChainData	object	body
spent_commitment_outpoint The outpoint of the previous commitment that this new commitment is spending. This must be set unless this is the very first supply commitment of a grouped asset.	OutPoint	object	body
issuance_leaves The supply leaves that represent the supply changes for the asset group.	SupplyLeafEntry[]	object	body
burn_leaves	SupplyLeafEntry[]	object	body
ignore_leaves	SupplyLeafEntry[]	object	body

universerpc.InsertSupplyCommitResponse

Source: universerpc/universe.proto

note

This response has no parameters.

Nested Messages

taprpc.OutPoint

Field	gRPC Type	REST Type
txid Raw bytes representing the transaction id.	bytes	string
output_index The index of the output on the transaction.	uint32	integer

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.SupplyCommitChainData

Field	gRPC Type	REST Type
txn The raw transaction that created the root commitment.	bytes	string
tx_out_idx The index of the output in the transaction where the commitment resides.	uint32	integer
internal_key The internal key used to create the commitment output.	bytes	string
output_key The taproot output key used to create the commitment output.	bytes	string
supply_root_hash The root hash of the supply tree that contains the set of sub-commitments. The sum value of this tree is the outstanding supply value.	bytes	string
supply_root_sum The sum value of the supply root tree, representing the outstanding supply amount.	uint64	string
block_header The block header of the block that contains the supply commitment transaction.	bytes	string
block_hash The hash of the block that contains the commitment.	bytes	string
block_height The block height of the block that contains the supply commitment transaction.	uint32	integer
tx_block_merkle_proof The merkle proof that proves that the supply commitment transaction is included in the block.	bytes	string
tx_index The index of the supply commitment transaction in the block.	uint32	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