@transia/hooks-toolkit

The Hooks Toolkit (Typescript)

Global Prerequsits

$ npm i -g js2wasm-cli

Compile Hooks

Run this command to locally compile an XRPL Hook source file (inside ./contracts) from .c to .wasm code:

$ yarn run build:hooks

Here is what each command does in the background:

• wasmcc - compiles a Hook source file (C code) to WebAssembly (WASM) code. For example, ./contracts/base.c compiles to ./build/base.wasm
• wasm-opt - optimizes the WASM code ./build/base.wasm
• hook-cleaner - cleans it by removing unnecessary additional exports
• guard_checker - this checks if any guard violation has occurred in the Hooks code before submitting it in SetHook transaction. For more information, visit this link
• Converts the compiled WASM to hexadecimal characters then submits it as payload in a SetHook transaction

You can also build a single hook with;

$ yarn run build:hook contracts/toolbox/base.ts build

Debug the test env

tail -f xahau/log/debug.log | grep HookTrace

Test the Hook Library

Run Unit tests

$ yarn run test:unit

Before you can run the integration tests you must have a standalone rippled server running.

• Full env with explorer:

• • $ xrpld-netgen up:standalone --version=2024.5.30-HEAD+900

• Docker standalone only:

• • $ docker run -p 5005:5005 -p 6006:6006 -it transia/xahaud:latest

Run Integration tests

$ yarn run test:integration

Run single Integration test

$ yarn run test:integration test/integration/toolbox/base.test.ts

Adding a new Hook

• Add the hook.c file into the contracts directory
• Build the hooks $ yarn run build:hooks
• Copy the hook base.test.ts template into the correct folder. (audited/toolbox)
• Test the hook using: $ yarn run test:integration test/integration/audited/myHook.test.ts