cbak / Callback

The callback function of your hook

Concepts

• Compiling Hooks

Behaviour

• cbak is a user defined function called by xahaud 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

C

int64_t cbak (
    uint32_t what
)

Javascript

type Callback = (reserved: number) => number

Example

C

int64_t cbak(uint32_t reserved)
{
    return 0;
}

Javascript

const Callback = (reserved: number) => {
  return 0
}

Parameters

C

Name	Type	Description
reserved	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.

Javascript

Name	Type	Description
reserved	number	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

C

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.

Javascript

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