ListAssets
ListAssets lists the set of assets owned by the target daemon.
Source: taprootassets.proto
gRPC
rpc ListAssets (ListAssetRequest) returns (ListAssetResponse);
REST
HTTP Method | Path |
---|---|
GET | /v1/taproot-assets/assets |
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 = {
with_witness: <bool>,
include_spent: <bool>,
include_leased: <bool>,
include_unconfirmed_mints: <bool>,
};
client.listAssets(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "assets": <Asset>,
// "unconfirmed_transfers": <uint64>,
// "unconfirmed_mints": <uint64>,
// }
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.ListAssetRequest(
with_witness=<bool>,
include_spent=<bool>,
include_leased=<bool>,
include_unconfirmed_mints=<bool>,
)
response = stub.ListAssets(request)
print(response)
# {
# "assets": <Asset>,
# "unconfirmed_transfers": <uint64>,
# "unconfirmed_mints": <uint64>,
# }
- 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/assets`,
// 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:
// {
// "assets": <array>, // <Asset>
// "unconfirmed_transfers": <string>, // <uint64>
// "unconfirmed_mints": <string>, // <uint64>
// }
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/assets'
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())
# {
# "assets": <Asset>,
# "unconfirmed_transfers": <uint64>,
# "unconfirmed_mints": <uint64>,
# }
$ tapcli assets list --help
NAME:
tapcli assets list - list all assets
USAGE:
tapcli assets list [command options] [arguments...]
DESCRIPTION:
list all pending and mined assets
OPTIONS:
--show_witness include the asset's witness data
--show_spent include fully spent assets in the list
--show_leased include leased assets in the list
--show_unconfirmed_mints include freshly minted and not yet confirmed assets in the list
Messages
taprpc.ListAssetRequest
Source: taprootassets.proto
Field | gRPC Type | REST Type | REST Placement |
---|---|---|---|
with_witness | bool | boolean | query |
include_spent | bool | boolean | query |
include_leased | bool | boolean | query |
include_unconfirmed_mints | bool | boolean | query |
taprpc.ListAssetResponse
Source: taprootassets.proto
Field | gRPC Type | REST Type |
---|---|---|
assets | Asset[] | array |
unconfirmed_transfers | uint64 | string |
unconfirmed_mints | uint64 | string |
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.DecimalDisplay
Field | gRPC Type | REST Type |
---|---|---|
decimal_display | uint32 | integer |
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.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 |
Enums
taprpc.AssetType
Name | Number |
---|---|
NORMAL | 0 |
COLLECTIBLE | 1 |
taprpc.AssetVersion
Name | Number |
---|---|
ASSET_VERSION_V0 | 0 |
ASSET_VERSION_V1 | 1 |