Transaction Streaming Endpoints

Detailed platform gRPC endpoint reference

📘

gRPC Overview

Please refer to the gRPC Overview for details regarding running the examples shown below, encoding/decoding the request/response data, and clients available for several languages.

Endpoint Details

subscribeToTransactionsWithProofs

Returns: streams the requested transaction information
Parameters:

Name	Type	Required	Description
bloom_filter.v_data	Bytes	Yes	The filter itself is simply a bit field of arbitrary byte-aligned size. The maximum size is 36,000 bytes
bloom_filter.n_hash_funcs	Integer	Yes	The number of hash functions to use in this filter. The maximum value allowed in this field is 50
bloom_filter.n_tweak	Integer	Yes	A random value to add to the seed value in the hash function used by the bloom filter
bloom_filter.n_flags	Integer	Yes	A set of flags that control how matched items are added to the filter
----------
One of the following:
from_block_hash	Bytes	No	Return records beginning with the block hash provided
from_block_height	Integer	No	Return records beginning with the block height provided
----------
count	Integer	No	Number of blocks to sync. If set to 0 syncing is continuously sends new data as well (default: 0)
send_transaction_hashes *	Boolean	No

Example Request and Response

Request (gRPCurl)

grpcurl -proto protos/transactions_filter_stream.proto -plaintext \
  -d '{
  "from_block_height": 1,
  "count": 1,
  "bloom_filter": {
    "n_hash_funcs": 11,
    "v_data": "",
    "n_tweak": 0,
    "n_flags": 0
  }
}' \
  seed.evonet.networks.dash.org:3010 \
  org.dash.platform.dapi.v0.TransactionsFilterStream/subscribeToTransactionsWithProofs

Response

{
  "rawTransactions": {
    "transactions": [
      "AQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP////8RUQ9kZXZuZXQtZXZvbmV0LTT/////AQDyBSoBAAAAAWoAAAAA"
    ]
  }
}
{
  "rawMerkleBlock": "BAAAAC498j7sXNaobt1QlTkCjiw6PcBTFeso8rqkMhjKCAAAD0Oosr0gDJvAxHZ2Y+4dtsmO+XenCUNNoIX0W06eoW26loBU//9/IAAAAAABAAAAAQ9DqLK9IAybwMR2dmPuHbbJjvl3pwlDTaCF9FtOnqFtAQE="
}

Code Reference

Implementation details related to the information on this page can be found in:

• The DAPI repository lib/grpcServer/handlers/tx-filter-stream folder
• The DAPI-gRPC repository protos folder