DA Node API

Table of Contents

• Protocol Documentation

  • Table of Contents

  • signer.proto

    • BatchRetrieveReply

    • BatchRetrieveRequest

    • BatchSignReply

    • BatchSignRequest

    • RetrieveRequest

    • SignRequest

    • Slices

    • Signer

  • Scalar Value Types

Top

signer.proto

BatchRetrieveReply

Field	Type	Label	Description
encoded_slice	Slices	repeated	required encoded slices

BatchRetrieveRequest

Field	Type	Label	Description
requests	RetrieveRequest	repeated

BatchSignReply

Field	Type	Label	Description
signatures	bytes	repeated	signatures for requests

BatchSignRequest

Field	Type	Label	Description
requests	SignRequest	repeated

RetrieveRequest

Field	Type	Label	Description
epoch	uint64		epoch number of DASigners internal contract
quorum_id	uint64		quorum id of DASigners internal contract
storage_root	bytes		merkle root of data
row_indexes	uint32	repeated	required row indexes

SignRequest

Field	Type	Label	Description
epoch	uint64		epoch number of DASigners internal contract
quorum_id	uint64		quorum id of DASigners internal contract
erasure_commitment	bytes		erasure commitment generated by encoder
storage_root	bytes		merkle root of data
encoded_slice	bytes	repeated	encoded slices of data

Slices

Field	Type	Label	Description
encoded_slice	bytes	repeated

Signer

Method Name	Request Type	Response Type	Description
BatchSign	BatchSignRequest	BatchSignReply	This API accepts rows of encoded blobs to sign from clients. The node will verify the blobs existance in DAEntrance contract and validate the received rows.
BatchRetrieve	BatchRetrieveRequest	BatchRetrieveReply	This retrieves the requested encoded rows from the DA node database.

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)