ListBalances
ListBalances lists asset balances
Source: taprootassets.proto
gRPC
rpc ListBalances (ListBalancesRequest) returns (ListBalancesResponse);
REST
HTTP Method | Path |
---|---|
GET | /v1/taproot-assets/assets/balance |
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: <bool>,
group_key: <bool>,
asset_filter: <bytes>,
group_key_filter: <bytes>,
include_leased: <bool>,
};
client.listBalances(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "asset_balances": <AssetBalancesEntry>,
// "asset_group_balances": <AssetGroupBalancesEntry>,
// }
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.ListBalancesRequest(
asset_id=<bool>,
group_key=<bool>,
asset_filter=<bytes>,
group_key_filter=<bytes>,
include_leased=<bool>,
)
response = stub.ListBalances(request)
print(response)
# {
# "asset_balances": <AssetBalancesEntry>,
# "asset_group_balances": <AssetGroupBalancesEntry>,
# }
- 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/balance`,
// 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:
// {
// "asset_balances": <object>, // <AssetBalancesEntry>
// "asset_group_balances": <object>, // <AssetGroupBalancesEntry>
// }
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/balance'
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())
# {
# "asset_balances": <AssetBalancesEntry>,
# "asset_group_balances": <AssetGroupBalancesEntry>,
# }
$ tapcli assets balance --help
NAME:
tapcli assets balance - list asset balances
USAGE:
tapcli assets balance [command options] [arguments...]
DESCRIPTION:
list balances for all assets or a selected asset
OPTIONS:
--by_group Group asset balances by group key
--include_leased Include leased assets in balances
--asset_id value A specific asset ID to run the balance query against
--group_key value A specific asset group key to run the balance query against. Must be used together with --by_group
Messages
taprpc.ListBalancesRequest
Source: taprootassets.proto
Field | gRPC Type | REST Type | REST Placement |
---|---|---|---|
asset_id | bool | boolean | query |
group_key | bool | boolean | query |
asset_filter | bytes | string | query |
group_key_filter | bytes | string | query |
include_leased | bool | boolean | query |
taprpc.ListBalancesResponse
Source: taprootassets.proto
Field | gRPC Type | REST Type |
---|---|---|
asset_balances | AssetBalancesEntry[] | object |
asset_group_balances | AssetGroupBalancesEntry[] | object |
Nested Messages
taprpc.AssetBalance
Field | gRPC Type | REST Type |
---|---|---|
asset_genesis | GenesisInfo | object |
balance | uint64 | string |
taprpc.AssetGroupBalance
Field | gRPC Type | REST Type |
---|---|---|
group_key | bytes | string |
balance | uint64 | 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.ListBalancesResponse.AssetBalancesEntry
Field | gRPC Type | REST Type |
---|---|---|
key | string | unknown |
value | AssetBalance | unknown |
taprpc.ListBalancesResponse.AssetGroupBalancesEntry
Field | gRPC Type | REST Type |
---|---|---|
key | string | unknown |
value | AssetGroupBalance | unknown |
Enums
taprpc.AssetType
Name | Number |
---|---|
NORMAL | 0 |
COLLECTIBLE | 1 |