The callback function of your hook

Concepts

Behaviour

  • cbak is a user defined function called by xrpld in order to inform your hook about the status of a previously emitted transaction
  • State changes and further emit calls can be made from cbak but it cannot rollback a transaction.
  • When cbak is executed the emitted transaction to which the callback relates is now the originating transaction.

Definition

int64_t cbak (
    uint32_t what
)

Example

int64_t cbak(uint32_t what)
{
    return 0;
}

Parameters

Name

Type

Description

what

uint32_t

if 0:

  • the emittted transaction to which this callback relates was successfully accepted into a ledger.

If 1

  • the emitted transaction to which the callback relates was NOT successfully accepted into a ledger before it expired.

Return Code

Type

Description

int64_t

An arbitrary return code you wish to return from your hook. This will be present in the metadata of the originating transaction.