GRPC Documentation - PropagationAPI

propagation_api.proto

Package propagation_api provides gRPC services for Bitcoin SV transaction propagation. It handles individual and batch transaction processing, health checks, and debugging capabilities for the BSV network.

EmptyMessage

Represents an empty request or response. Used when no additional data needs to be transmitted.

swagger:model EmptyMessage

BatchTransactionItem

Represents a single transaction item in a batch request with trace context support.

Field	Type	Label	Description
tx	bytes		Raw transaction bytes to process
trace_context	map		Serialized OpenTelemetry trace context as key-value pairs for proper span propagation

GetRequest

Represents a request to retrieve a transaction by its ID.

swagger:model GetRequest

Field	Type	Label	Description
txid	bytes		Transaction ID in bytes

GetResponse

Contains the retrieved transaction data.

swagger:model GetResponse

Field	Type	Label	Description
tx	bytes		Raw transaction bytes

HealthResponse

Provides information about the service's health status.

swagger:model HealthResponse

Field	Type	Description
ok	bool	Indicates whether the service is healthy
details	string	Provides additional information about the health status
timestamp	google.protobuf.Timestamp	Indicates when the health check was performed

ProcessTransactionBatchRequest

Represents a request to process multiple transactions in a batch.

swagger:model ProcessTransactionBatchRequest

Field	Type	Label	Description
items	BatchTransactionItem	repeated	Array of transaction items to process, each containing transaction bytes and trace context

ProcessTransactionBatchResponse

Contains the results of batch transaction processing.

swagger:model ProcessTransactionBatchResponse

Field	Type	Label	Description
errors	errors.TError	repeated	Error messages for each transaction in the batch. Empty string indicates success for that transaction.

ProcessTransactionRequest

Represents a request to process a single transaction.

swagger:model ProcessTransactionRequest

Field	Type	Label	Description
tx	bytes		Raw transaction bytes to process

PropagationAPI

Method Name	Request Type	Response Type	Description
HealthGRPC	EmptyMessage	HealthResponse	Checks the health status of the propagation service and its dependencies. Returns a HealthResponse containing the service status and details.
ProcessTransaction	ProcessTransactionRequest	EmptyMessage	Processes a single BSV transaction. The transaction must be provided in raw byte format and must be extended. Coinbase transactions are not allowed.
ProcessTransactionBatch	ProcessTransactionBatchRequest	ProcessTransactionBatchResponse	Processes multiple transactions in a single request. This is more efficient than processing transactions individually when dealing with large numbers of transactions.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)