DecodeProof
DecodeProof attempts to decode a given proof file into human readable format.
Source: taprootassets.proto
gRPC
rpc DecodeProof (DecodeProofRequest) returns (DecodeProofResponse);
REST
HTTP Method | Path |
---|---|
POST | /v1/taproot-assets/proofs/decode |
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 = {
raw_proof: <bytes>,
proof_at_depth: <uint32>,
with_prev_witnesses: <bool>,
with_meta_reveal: <bool>,
};
client.decodeProof(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "decoded_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.DecodeProofRequest(
raw_proof=<bytes>,
proof_at_depth=<uint32>,
with_prev_witnesses=<bool>,
with_meta_reveal=<bool>,
)
response = stub.DecodeProof(request)
print(response)
# {
# "decoded_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 = {
raw_proof: <string>, // <bytes> (base64 encoded)
proof_at_depth: <integer>, // <uint32>
with_prev_witnesses: <boolean>, // <bool>
with_meta_reveal: <boolean>, // <bool>
};
let options = {
url: `https://${REST_HOST}/v1/taproot-assets/proofs/decode`,
// 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:
// {
// "decoded_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/proofs/decode'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
'raw_proof': base64.b64encode(<bytes>),
'proof_at_depth': <uint32>,
'with_prev_witnesses': <bool>,
'with_meta_reveal': <bool>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
# "decoded_proof": <DecodedProof>,
# }
$ tapcli proofs decode --help
NAME:
tapcli proofs decode - decode a Taproot Asset proof
USAGE:
tapcli proofs decode [command options] [arguments...]
DESCRIPTION:
Decode a taproot asset proof that contains the full provenance of an
asset into human readable format. Such a proof proves the existence
of an asset, but does not prove that the creator of the proof can
actually also spend the asset. To verify ownership, use the
"verifyownership" command with a separate ownership proof.
OPTIONS:
--proof_file value the path to the proof file on disk; use the dash character (-) to read from stdin instead
--proof_at_depth value the index depth of the decoded proof to fetch with 0 being the latest proof (default: 0)
--latest_proof if true, previous witnesses will be returned
--meta_reveal if true, will attempt to reveal the meta data associated with the proof
Messages
taprpc.DecodeProofRequest
Source: taprootassets.proto
Field | gRPC Type | REST Type | REST Placement |
---|---|---|---|
raw_proof | bytes | string | body |
proof_at_depth | uint32 | integer | body |
with_prev_witnesses | bool | boolean | body |
with_meta_reveal | bool | boolean | body |
taprpc.DecodeProofResponse
Source: taprootassets.proto
Field | gRPC Type | REST Type |
---|---|---|
decoded_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.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 |
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 |