Support for execution costs per Hook APIs [DO NOT MERGE]

.github/workflows/verify-generated-headers.yml

@@ -18,12 +18,23 @@ jobs:
             generator: bash ./hook/generate_sfcodes.sh
           - target: hook/tts.h
             generator: ./hook/generate_tts.sh
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
+    env:
+      CLANG_VERSION: 10
     name: ${{ matrix.target }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
+      - name: Download and install clang-format
+        run: |
+          sudo apt-get update -y
+          sudo apt-get install -y libtinfo5
+          curl -LO https://github.com/llvm/llvm-project/releases/download/llvmorg-10.0.1/clang+llvm-10.0.1-x86_64-linux-gnu-ubuntu-16.04.tar.xz
+          tar -xf clang+llvm-10.0.1-x86_64-linux-gnu-ubuntu-16.04.tar.xz
+          sudo mv clang+llvm-10.0.1-x86_64-linux-gnu-ubuntu-16.04 /opt/clang-10
+          sudo ln -s /opt/clang-10/bin/clang-format /usr/local/bin/clang-format-10
+
       - name: Verify ${{ matrix.target }}
         run: |
           set -euo pipefail

Builds/CMake/RippledCore.cmake

@@ -463,6 +463,7 @@ target_sources (rippled PRIVATE
   src/ripple/app/tx/impl/DepositPreauth.cpp
   src/ripple/app/tx/impl/Escrow.cpp
   src/ripple/app/tx/impl/GenesisMint.cpp
+  src/ripple/app/tx/impl/HookDefinitionUpdate.cpp
   src/ripple/app/tx/impl/Import.cpp
   src/ripple/app/tx/impl/InvariantCheck.cpp
   src/ripple/app/tx/impl/Invoke.cpp

cfg/xahaud-example.cfg

@@ -1502,6 +1502,15 @@
 #       Example:
 #           owner_reserve = 2000000      # 2 XAH
 #
+#   hook_gas_price = <uint32_t>
+#
+#       The gas price for hooks is used to calculate the execution fee for hooks.
+#
+#       If this parameter is unspecified, xahaud will use an internal
+#       default. Don't change this without understanding the consequences.
+#
+#       Example:
+#           hook_gas_price = 1000000
 #-------------------------------------------------------------------------------
 #
 # 9. Misc Settings

hook/extern.h

@@ -82,7 +82,7 @@ sto_erase(
     uint32_t field_id);
 
 extern int64_t
-etxn_burden(void);
+etxn_burden();
 
 extern int64_t
 etxn_details(uint32_t write_ptr, uint32_t write_len);
@@ -94,7 +94,7 @@ extern int64_t
 etxn_reserve(uint32_t count);
 
 extern int64_t
-etxn_generation(void);
+etxn_generation();
 
 extern int64_t
 etxn_nonce(uint32_t write_ptr, uint32_t write_len);
@@ -149,7 +149,7 @@ extern int64_t
 float_divide(int64_t float1, int64_t float2);
 
 extern int64_t
-float_one(void);
+float_one();
 
 extern int64_t
 float_mantissa(int64_t float1);
@@ -167,13 +167,13 @@ extern int64_t
 float_root(int64_t float1, uint32_t n);
 
 extern int64_t
-fee_base(void);
+fee_base();
 
 extern int64_t
-ledger_seq(void);
+ledger_seq();
 
 extern int64_t
-ledger_last_time(void);
+ledger_last_time();
 
 extern int64_t
 ledger_last_hash(uint32_t write_ptr, uint32_t write_len);
@@ -213,13 +213,13 @@ hook_param(
     uint32_t read_len);
 
 extern int64_t
-hook_again(void);
+hook_again();
 
 extern int64_t
 hook_skip(uint32_t read_ptr, uint32_t read_len, uint32_t flags);
 
 extern int64_t
-hook_pos(void);
+hook_pos();
 
 extern int64_t
 slot(uint32_t write_ptr, uint32_t write_len, uint32_t slot);
@@ -299,19 +299,19 @@ extern int64_t
 trace_float(uint32_t read_ptr, uint32_t read_len, int64_t float1);
 
 extern int64_t
-otxn_burden(void);
+otxn_burden();
 
 extern int64_t
 otxn_field(uint32_t write_ptr, uint32_t write_len, uint32_t field_id);
 
 extern int64_t
-otxn_generation(void);
+otxn_generation();
 
 extern int64_t
 otxn_id(uint32_t write_ptr, uint32_t write_len, uint32_t flags);
 
 extern int64_t
-otxn_type(void);
+otxn_type();
 
 extern int64_t
 otxn_slot(uint32_t slot_no);

hook/generate_extern.sh

@@ -4,7 +4,7 @@ set -eu
 SCRIPT_DIR=$(dirname "$0")
 SCRIPT_DIR=$(cd "$SCRIPT_DIR" && pwd)
 
-APPLY_HOOK="$SCRIPT_DIR/../src/ripple/app/hook/applyHook.h"
+APPLY_HOOK="$SCRIPT_DIR/../src/ripple/app/hook/hook_api.macro"
 
 {
     echo '// For documentation please see: https://xrpl-hooks.readme.io/reference/'
@@ -19,127 +19,36 @@ APPLY_HOOK="$SCRIPT_DIR/../src/ripple/app/hook/applyHook.h"
             return s;
         }
 
-        function emit(ret, name, argc, argt, argn) {
-            attr = (name == "_g") ? " __attribute__((noduplicate))" : "";
-            if (!first)
-                printf("\n");
-            first = 0;
-            printf("extern %s%s\n", ret, attr);
-            if (argc == 0) {
-                printf("%s(void);\n", name);
-                return;
-            }
-            if (argc <= 3) {
-                line = argt[1] " " argn[1];
-                for (i = 2; i <= argc; ++i)
-                    line = line ", " argt[i] " " argn[i];
-                printf("%s(%s);\n", name, line);
-                return;
-            }
-            printf("%s(\n", name);
-            for (i = 1; i <= argc; ++i) {
-                sep = (i < argc) ? "," : ");";
-                printf("    %s %s%s\n", argt[i], argn[i], sep);
-            }
-        }
-
-        function process(buffer, kind,    payload, parts, n, i, arg, tokens, argc, argt, argn) {
-            if (kind == "func")
-                sub(/^DECLARE_HOOK_FUNCTION[[:space:]]*\(/, "", buffer);
-            else
-                sub(/^DECLARE_HOOK_FUNCNARG[[:space:]]*\(/, "", buffer);
-            buffer = trim(buffer);
-            sub(/\)[[:space:]]*$/, "", buffer);
-            n = split(buffer, parts, ",");
-            for (i = 1; i <= n; ++i)
-                parts[i] = trim(parts[i]);
-            ret = parts[1];
-            name = parts[2];
-            argc = 0;
-            delete argt;
-            delete argn;
-            for (i = 3; i <= n; ++i) {
-                arg = parts[i];
-                if (arg == "")
-                    continue;
-                split(arg, tokens, /[[:space:]]+/);
-                if (length(tokens) < 2)
-                    continue;
-                ++argc;
-                argt[argc] = tokens[1];
-                argn[argc] = tokens[2];
-            }
-            emit(ret, name, argc, argt, argn);
-        }
-
-        BEGIN {
-            first = 1;
-            in_block = 0;
-            in_macro = 0;
-        }
-
         {
             line = $0;
-            if (in_block) {
-                if (line ~ /\*\//) {
-                    sub(/.*\*\//, "", line);
-                    in_block = 0;
-                }
-                else
-                    next;
-            }
-            while (line ~ /\/\*/) {
-                if (line ~ /\/\*.*\*\//) {
-                    gsub(/\/\*.*\*\//, "", line);
-                }
-                else {
-                    sub(/\/\*.*/, "", line);
-                    in_block = 1;
-                    break;
-                }
-            }
-            sub(/\/\/.*$/, "", line);
-            line = trim(line);
-            if (line == "")
-                next;
-
-            if (!in_macro && line ~ /^DECLARE_HOOK_FUNCTION\(/) {
-                buffer = line;
-                kind = "func";
-                if (line ~ /\);[[:space:]]*$/) {
-                    sub(/\);[[:space:]]*$/, "", buffer);
-                    process(buffer, kind);
-                }
-                else
-                    in_macro = 1;
+
+            # Skip block comments
+            if (line ~ /\/\*/) {
                 next;
             }
-            if (!in_macro && line ~ /^DECLARE_HOOK_FUNCNARG\(/) {
-                buffer = line;
-                kind = "narg";
-                if (line ~ /\);[[:space:]]*$/) {
-                    sub(/\);[[:space:]]*$/, "", buffer);
-                    process(buffer, kind);
-                }
-                else
-                    in_macro = 1;
-                next;
-            }
-            if (in_macro) {
-                buffer = buffer " " line;
-                if (line ~ /\);[[:space:]]*$/) {
-                    sub(/\);[[:space:]]*$/, "", buffer);
-                    process(buffer, kind);
-                    in_macro = 0;
+
+            # Look for comment lines that start with // and contain function signature
+            if (line ~ /^[[:space:]]*\/\/[[:space:]]*[a-zA-Z_][a-zA-Z0-9_]*[[:space:]]+[a-zA-Z_][a-zA-Z0-9_]*[[:space:]]*\(/) {
+                # Remove leading // and trim
+                sub(/^[[:space:]]*\/\/[[:space:]]*/, "", line);
+                line = trim(line);
+
+                # Check if function name is "_g" to add attribute
+                if (line ~ /[[:space:]]+_g[[:space:]]*\(/) {
+                    # Insert __attribute__((noduplicate)) before _g
+                    sub(/[[:space:]]+_g/, " __attribute__((noduplicate)) _g", line);
                 }
+
+                # printf("\n");
+
+                printf("extern %s\n\n", line);
             }
         }
-
-        END {
-            printf("\n");
-        }
     ' "$APPLY_HOOK"
 
     echo '#define HOOK_EXTERN'
     echo '#endif  // HOOK_EXTERN'
-}
+} | (
+    cd "$SCRIPT_DIR/.."
+    clang-format --style=file -
+)

hook/sfcodes.h

@@ -63,6 +63,7 @@
 #define sfEmitGeneration ((2U << 16U) + 46U)
 #define sfLockCount ((2U << 16U) + 49U)
 #define sfFirstNFTokenSequence ((2U << 16U) + 50U)
+#define sfHookGasPrice ((2U << 16U) + 92U)
 #define sfStartTime ((2U << 16U) + 93U)
 #define sfRepeatCount ((2U << 16U) + 94U)
 #define sfDelaySeconds ((2U << 16U) + 95U)
@@ -87,6 +88,8 @@
 #define sfHookInstructionCount ((3U << 16U) + 17U)
 #define sfHookReturnCode ((3U << 16U) + 18U)
 #define sfReferenceCount ((3U << 16U) + 19U)
+#define sfHookCallbackCost ((3U << 16U) + 95U)
+#define sfHookCost ((3U << 16U) + 96U)
 #define sfTouchCount ((3U << 16U) + 97U)
 #define sfAccountIndex ((3U << 16U) + 98U)
 #define sfAccountCount ((3U << 16U) + 99U)

hook/tts.h

@@ -34,6 +34,7 @@
 #define ttURITOKEN_BUY 47
 #define ttURITOKEN_CREATE_SELL_OFFER 48
 #define ttURITOKEN_CANCEL_SELL_OFFER 49
+#define ttHOOK_DEFINITION_UPDATE 91
 #define ttCRON 92
 #define ttCRON_SET 93
 #define ttREMARKS_SET 94