sto_validate

Concepts

Serialized Objects

Behaviour

C

• Parse an STObject pointed to by read_ptr
• Return 1 if the serialization is valid, 0 otherwise.

JavaScript

• The blob (e.g. serialized transaction) is provided to be validated.
• Returns number 1 if the STObject is valid, 0 if it isn’t, or an error code if validation fails.

Definition

C

int64_t sto_validate (
    uint32_t read_ptr,
    uint32_t read_len
);

JavaScript

function sto_validate(blob: ByteArray | HexString): ErrorCode | number

Example

C

int64_t result =
  sto_validate(tx_out, sizeof(tx_out));

if (tx_len <= 0)
    rollback("Invalid STO.", 12, 1);

JavaScript

const result = sto_validate(tx_out)

if (result <= 0)
    rollback("Invalid STO.", 1)

Parameters

C

Name	Type	Description
read_ptr	uint32_t	The buffer to read the source STObject from
read_len	uint32_t	The Length of the source object

JavaScript

Name	Type	Description
blob	ByteArray | HexString	The blob (e.g. serialized transaction) to be validated.

Return Code

C

Type	Description
int64_t	1 if the STObject pointed to by read_ptr is a valid STObject. 0 if it isn’t. If negative, an error: OUT_OF_BOUNDS - pointers/lengths specified outside of hook memory.

JavaScript

Type	Description
ErrorCode | number	Returns number 1 if the STObject is valid, 0 if it isn’t, or an error code if validation fails.