SubscribeReceiveAssetEventNtfns

SubscribeReceiveAssetEventNtfns registers a subscription to the event notification stream which relates to the asset receive process.

Source: tapdevrpc/tapdev.proto

gRPC

info

This is a server-streaming RPC

rpc SubscribeReceiveAssetEventNtfns (SubscribeReceiveAssetEventNtfnsRequest) returns (stream ReceiveAssetEvent);

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('tapdevrpc/tapdev.proto', loaderOptions);
const tapdevrpc = grpc.loadPackageDefinition(packageDefinition).tapdevrpc;
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 tapdevrpc.TapDev(GRPC_HOST, creds);
let request = {};
let call = client.subscribeReceiveAssetEventNtfns(request);
call.on('data', function(response) {
  // A response was received from the server.
  console.log(response);
});
call.on('status', function(status) {
  // The current status of the stream.
});
call.on('end', function() {
  // The server has closed the stream.
});
// Console output:
//  {
//    "proof_transfer_backoff_wait_event": <ProofTransferBackoffWaitEvent>,
//    "asset_receive_complete_event": <AssetReceiveCompleteEvent>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the tapdevrpc/tapdev.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import tapdev_pb2 as tapdevrpc, tapdev_pb2_grpc as tapdevstub

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 = tapdevstub.TapDevStub(channel)
request = tapdevrpc.SubscribeReceiveAssetEventNtfnsRequest()
for response in stub.SubscribeReceiveAssetEventNtfns(request):
  print(response)
# {
#    "proof_transfer_backoff_wait_event": <ProofTransferBackoffWaitEvent>,
#    "asset_receive_complete_event": <AssetReceiveCompleteEvent>,
# }

Shell

# There is no CLI command for this RPC

Messages

tapdevrpc.SubscribeReceiveAssetEventNtfnsRequest

Source: tapdevrpc/tapdev.proto

note

This request has no parameters.

tapdevrpc.ReceiveAssetEvent

Source: tapdevrpc/tapdev.proto

Field	gRPC Type	REST Type
proof_transfer_backoff_wait_event An event which indicates that the proof transfer backoff wait period will start imminently.	ProofTransferBackoffWaitEvent	object
asset_receive_complete_event An event which indicates that an asset receive process has finished.	AssetReceiveCompleteEvent	object

Nested Messages

tapdevrpc.AssetReceiveCompleteEvent

Field	gRPC Type	REST Type
timestamp Event creation timestamp.	int64	string
address The address that received the asset.	Addr	object
outpoint The outpoint of the transaction that was used to receive the asset.	string	string

tapdevrpc.ProofTransferBackoffWaitEvent

Field	gRPC Type	REST Type
timestamp Transfer attempt timestamp (microseconds).	int64	string
backoff Backoff is the active backoff wait duration.	int64	string
tries_counter Tries counter is the number of tries we've made so far during the course of the current backoff procedure to deliver the proof to the receiver.	int64	string
transfer_type The type of proof transfer attempt.	ProofTransferType	string

taprpc.Addr

Field	gRPC Type	REST Type
encoded The bech32 encoded Taproot Asset address.	string	string
asset_id The asset ID that uniquely identifies the asset.	bytes	string
asset_type The type of the asset.	AssetType	string
amount The total amount of the asset stored in this Taproot Asset UTXO.	uint64	string
group_key The group key of the asset (if it exists)	bytes	string
script_key The specific script key the asset must commit to in order to transfer ownership to the creator of the address.	bytes	string
internal_key The internal key used for the on-chain output.	bytes	string
tapscript_sibling The optional serialized tapscript sibling preimage to use for the receiving asset. This is usually empty as it is only needed when there should be an additional script path in the Taproot tree alongside the Taproot Asset commitment of the asset.	bytes	string
taproot_output_key The tweaked internal key that commits to the asset and represents the on-chain output key the Bitcoin transaction must send to in order to transfer assets described in this address.	bytes	string
proof_courier_addr The address of the proof courier service used in proof transfer.	string	string
asset_version The asset version of the address.	AssetVersion	string
address_version The version of the address.	AddrVersion	string

Enums

tapdevrpc.ProofTransferType

Name	Number
PROOF_TRANSFER_TYPE_SEND This value indicates that the proof transfer attempt is a delivery to the transfer counterparty.	0
PROOF_TRANSFER_TYPE_RECEIVE This value indicates that the proof transfer attempt is a receive from the transfer counterparty.	1

taprpc.AddrVersion

Name	Number
ADDR_VERSION_UNSPECIFIED ADDR_VERSION_UNSPECIFIED is the default value for an address version in an RPC message. It is unmarshalled to the latest address version.	0
ADDR_VERSION_V0 ADDR_VERSION_V0 is the initial address version.	1
ADDR_VERSION_V1 ADDR_VERSION_V1 is the address version that uses V2 Taproot Asset commitments.	2

taprpc.AssetType

Name	Number
NORMAL Indicates that an asset is capable of being split/merged, with each of the units being fungible, even across a key asset ID boundary (assuming the key group is the same).	0
COLLECTIBLE Indicates that an asset is a collectible, meaning that each of the other items under the same key group are not fully fungible with each other. Collectibles also cannot be split or merged.	1

taprpc.AssetVersion

Name	Number
ASSET_VERSION_V0 ASSET_VERSION_V0 is the default asset version. This version will include the witness vector in the leaf for a tap commitment.	0
ASSET_VERSION_V1 ASSET_VERSION_V1 is the asset version that leaves out the witness vector from the MS-SMT leaf encoding.	1