Skip to content

API Reference

This section collects the detailed Hook API docs by function group.

Groups

  • Control — core flow control, hook identity, parameters, and rollback.
  • Transaction — read information from the originating transaction.
  • State — read and write persistent hook state.
  • Slot — work with slot handles and slot contents.
  • Ledger — inspect ledger values and keylets.
  • Emit — reserve, prepare, and emit transactions.
  • Float — XFL arithmetic and conversions.
  • Utility — address conversion, keylet derivation, verification helpers.
  • STO — serialized-object inspection and editing.
  • Trace — debug tracing helpers.

Start here

If you want a broad conceptual introduction first, read Overview.