hook

Concepts

Compiling Hooks

Behaviour

• hook is a user defined function called by xahaud in order to fire your hook.
• Your hook function calls either accept or reject to pass or reject the originating transaction.
• If execution reaches the end of the function it is implicitly an accept.

Definition

C

int64_t hook (
    uint32_t reserved
)

JavaScript

type Hook = (reserved: number) => number

Example

C

int64_t hook(uint32_t reserved)
{
  return 0;
}

JavaScript

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

Parameters

C

Name	Type	Description
reserved	uint32_t	Reserved for future use.

JavaScript

Name	Type	Description
reserved	number	Reserved for future use.

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.