write_ptr

uint32_t

Pointer to the buffer receiving the sfEmitDetails record

write_len

uint32_t

Length of the buffer

int64_t

The number of bytes written. If negative, an error: OUT_OF_BOUNDS - pointers/lengths specified outside of hook memory. TOO_SMALL - Buffer isn't large enough to receive record PREREQUISITE_NOT_MET - The hook failed to call etxn_reserve(n) first FEE_TOO_LARGE - The burden would be too high for the network to allow. INTERNAL_ERROR - A generic error in which rippled had trouble generating the required field.

int64_t

The generation an emitted transaction will need in order to be successfully passed to emit()

read_ptr

uint32_t

Pointer to the buffer containing the serialized transaction you intend to emit. The fee field is required but ignored (you may use zero). Use the output of this function to populate the fee field correctly.

read_len

uint32_t

The length of the tx blob.

int64_t

The smallest number of drops that an emitted txn would need to be accepted. If negative, an error: OUT_OF_BOUNDS - The provided buffer is not validly within the hook memory. PREREQUISITE_NOT_MET - etxn_reserve has not been called first. INVALID_TXN - The provided buffer did not contain a valid serialized transaction. (Deserialization failed, or a required field was missing.)

count

uint32_t

The largest number of transactions this hook might emit during the course of one execution.

int64_t

The maximum number of emitted transactions this hook may emit. This will always be the same as the count parameter or an error as below. If negative, an error: ALREADY_SET - The hook already called this function earlier. TOO_BIG - The specified number of emitted transactions is too large.