GRPC Documentation - SubtreeValidationAPI

Table of Contents

• subtreevalidation_api.proto

  • CheckBlockSubtreesRequest
  • CheckBlockSubtreesResponse
  • CheckSubtreeFromBlockRequest
  • CheckSubtreeFromBlockResponse
  • EmptyMessage

  • HealthResponse

  • SubtreeValidationAPI

• Scalar Value Types

Top

subtreevalidation_api.proto

SubtreeValidationAPI provides gRPC services for validating blockchain subtrees. The service exposes endpoints for health monitoring and subtree validation operations.

CheckBlockSubtreesRequest

Defines the input parameters for checking subtrees in a block.

swagger:model CheckBlockSubtreesRequest

Field	Type	Label	Description
block	bytes		Block containing the subtrees to be checked
base_url	string		Endpoint for retrieving missing transaction data

CheckBlockSubtreesResponse

Contains the validation results for subtrees in a block.

swagger:model CheckBlockSubtreesResponse

Field	Type	Label	Description
blessed	bool		Indicates if all subtrees in the block pass validation

CheckSubtreeFromBlockRequest

Defines the input parameters for subtree validation.

swagger:model CheckSubtreeFromBlockRequest

Field	Type	Label	Description
hash	bytes		Merkle root hash of the subtree requiring validation
base_url	string		Endpoint for retrieving missing transaction data
block_height	uint32		Blockchain height where the subtree is located
block_hash	bytes		Uniquely identifies the block containing the subtree
previous_block_hash	bytes		Identifies the block preceding the current block

CheckSubtreeFromBlockResponse

Contains the validation result for a subtree check.

swagger:model CheckSubtreeFromBlockResponse

Field	Type	Label	Description
blessed	bool		Indicates if the subtree passes all validation criteria

EmptyMessage

Represents an empty message structure used for health check requests.

swagger:model EmptyMessage

HealthResponse

Encapsulates the service health status information.

swagger:model HealthResponse

Field	Type	Label	Description
ok	bool		Indicates if the service is operating normally
details	string		Provides additional context about the service health status
timestamp	google.protobuf.Timestamp		Records when the health check was performed

SubtreeValidationAPI

Provides gRPC services for validating blockchain subtrees. The service exposes endpoints for health monitoring and subtree validation operations.

Method Name	Request Type	Response Type	Description
HealthGRPC	EmptyMessage	HealthResponse	Checks the service's health status. It takes an empty request message and returns a response indicating the service's health.
CheckSubtreeFromBlock	CheckSubtreeFromBlockRequest	CheckSubtreeFromBlockResponse	Validates a subtree within a specified block in the blockchain. It takes a request containing the subtree's merkle root hash and block details, returning a response indicating the subtree's validity status.
CheckBlockSubtrees	CheckBlockSubtreesRequest	CheckBlockSubtreesResponse	Validates all subtrees within a block. Takes a request containing the block data and returns validation results for all subtrees.

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)

---