SubscribeSendAssetEventNtfns

SubscribeSendAssetEventNtfns registers a subscription to the event notification stream which relates to the asset sending process.

Source: tapdevrpc/tapdev.proto

gRPC

info

This is a server-streaming RPC

rpc SubscribeSendAssetEventNtfns (SubscribeSendAssetEventNtfnsRequest) returns (stream SendAssetEvent);

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 = 'TAPD_DIR/data/regtest/admin.macaroon'
const TLS_PATH = 'TAPD_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.subscribeSendAssetEventNtfns(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:
//  {
//    "execute_send_state_event": <ExecuteSendStateEvent>,
//    "proof_transfer_backoff_wait_event": <ProofTransferBackoffWaitEvent>,
//  }

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 = 'TAPD_DIR/data/regtest/admin.macaroon'
TLS_PATH = 'TAPD_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.SubscribeSendAssetEventNtfnsRequest()
for response in stub.SubscribeSendAssetEventNtfns(request):
  print(response)
# {
#    "execute_send_state_event": <ExecuteSendStateEvent>,
#    "proof_transfer_backoff_wait_event": <ProofTransferBackoffWaitEvent>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightninglabs/taproot-assets
GRPC_HOST=localhost:10029
TAPD_DIR=~/.tapd
TAPD_SOURCE=path/to/taproot-assets
NETWORK=mainnet
MACAROON_PATH="$TAPD_DIR/data/$NETWORK/admin.macaroon"
TLS_PATH="$TAPD_DIR/tls.cert"

grpcurl \
    -import-path $TAPD_SOURCE/taprpc/ \
    -proto tapdevrpc/tapdev.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    $GRPC_HOST \
    tapdevrpc.TapDev/SubscribeSendAssetEventNtfns

Messages

tapdevrpc.SubscribeSendAssetEventNtfnsRequest

Source: tapdevrpc/tapdev.proto

note

This request has no parameters.

tapdevrpc.SendAssetEvent

Source: tapdevrpc/tapdev.proto

Field	gRPC Type	REST Type
execute_send_state_event An event which indicates that a send state is about to be executed.	ExecuteSendStateEvent	object
proof_transfer_backoff_wait_event An event which indicates that the proof transfer backoff wait period will start imminently.	ProofTransferBackoffWaitEvent	object

Nested Messages

tapdevrpc.ExecuteSendStateEvent

Field	gRPC Type	REST Type
timestamp Execute timestamp (microseconds).	int64	string
send_state The send state that is about to be executed.	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

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