diff --git a/xrpl-hooks-docs/md/hooks-account-buf-len.md b/xrpl-hooks-docs/md/hooks-account-buf-len.md index ac3f7d8..e1761d2 100644 --- a/xrpl-hooks-docs/md/hooks-account-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-account-buf-len.md @@ -1,6 +1,5 @@ # hooks-account-buf-len -Function `hook_account` has fixed-size account ID output. +Function [hook_account](https://xrpl-hooks.readme.io/v2.0/reference/hook_account) has fixed-size account ID output. -This check warns about too-small size of its output buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored). diff --git a/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md b/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md index 835c6b0..0c705dd 100644 --- a/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md @@ -1,7 +1,5 @@ # hooks-account-conv-buf-len -Function `util_raddr` has fixed-size account ID input. +Function [util_raddr](https://xrpl-hooks.readme.io/v2.0/reference/util_raddr) has fixed-size account ID input. -This check warns unless the correct size is passed in the input size -parameter (if it's specified by a constant - variable parameter is -ignored). +This check warns unless the correct size is passed in the input size parameter (if it's specified by a constant - variable parameter is ignored). diff --git a/xrpl-hooks-docs/md/hooks-account-conv-pure.md b/xrpl-hooks-docs/md/hooks-account-conv-pure.md index a87cf9c..8203905 100644 --- a/xrpl-hooks-docs/md/hooks-account-conv-pure.md +++ b/xrpl-hooks-docs/md/hooks-account-conv-pure.md @@ -1,10 +1,5 @@ # hooks-account-conv-pure -Hooks identify accounts by the 20 byte account ID, which can be -converted to an raddr using the `util_raddr` function. If the account -ID never changes, a more efficient way to do this is precompute the -raddr from the account ID. +Hooks identify accounts by the 20 byte account ID, which can be converted to an raddr using the [util_raddr](https://xrpl-hooks.readme.io/v2.0/reference/util_raddr) function. If the account ID never changes, a more efficient way to do this is precompute the raddr from the account ID. -This check warns about calls of `util_raddr` with constant input and -proposes to add a tracing statement showing the computed value (so -that the user can use it to replace the call). +This check warns about calls of `util_raddr` with constant input and proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). diff --git a/xrpl-hooks-docs/md/hooks-array-buf-len.md b/xrpl-hooks-docs/md/hooks-array-buf-len.md index 4f1aaac..9e1ee55 100644 --- a/xrpl-hooks-docs/md/hooks-array-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-array-buf-len.md @@ -1,9 +1,7 @@ # hooks-array-buf-len -Hook API `sto_subarray` requires non-empty input buffer and takes a -parameter specifying the array index, whose value is limited - the -sought object cannot be found if the limit is exceeded. +Hook API [sto_subarray](https://xrpl-hooks.readme.io/v2.0/reference/sto_subarray) requires non-empty input buffer and takes a parameter specifying the array index, whose value is limited - the sought object cannot be found if the limit is exceeded. -This check warns about empty input as well as too-large values of the -index specified in calls to `sto_subarray` (if they're specified by -constants - variable parameters are ignored). +This check warns about empty input as well as too-large values of the index specified in calls to `sto_subarray` (if they're specified by constants - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/serialized-objects) diff --git a/xrpl-hooks-docs/md/hooks-burden-prereq.md b/xrpl-hooks-docs/md/hooks-burden-prereq.md index cc40a1f..e15e34d 100644 --- a/xrpl-hooks-docs/md/hooks-burden-prereq.md +++ b/xrpl-hooks-docs/md/hooks-burden-prereq.md @@ -1,5 +1,3 @@ # hooks-burden-prereq -Hook API `etxn_burden` computes transaction burden, based on (i.a.) -the number of reserved transactions, so a call to it must be preceded -by a call to `etxn_reserve`. +Hook API [etxn_burden](https://xrpl-hooks.readme.io/v2.0/reference/etxn_burden) computes transaction burden, based on (i.a.) the number of reserved transactions, so a call to it must be preceded by a call to [etxn_reserve](https://xrpl-hooks.readme.io/v2.0/reference/etxn_reserve). diff --git a/xrpl-hooks-docs/md/hooks-detail-buf-len.md b/xrpl-hooks-docs/md/hooks-detail-buf-len.md index 96563d7..c136508 100644 --- a/xrpl-hooks-docs/md/hooks-detail-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-detail-buf-len.md @@ -1,6 +1,7 @@ # hooks-detail-buf-len -Function `etxn_details` has fixed-size sfEmitDetails output. +Function [etxn_details](https://xrpl-hooks.readme.io/v2.0/reference/etxn_details) has fixed-size sfEmitDetails output. -This check warns about too-small size of its output buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/emitted-transactions) diff --git a/xrpl-hooks-docs/md/hooks-detail-prereq.md b/xrpl-hooks-docs/md/hooks-detail-prereq.md index a48917d..2a7379d 100644 --- a/xrpl-hooks-docs/md/hooks-detail-prereq.md +++ b/xrpl-hooks-docs/md/hooks-detail-prereq.md @@ -1,5 +1,5 @@ # hooks-detail-prereq -Hook API `etxn_details` serializes emit details, based on (i.a.) the -number of reserved transactions, so a call to it must be preceded by a -call to `etxn_reserve`. +Hook API [etxn_details](https://xrpl-hooks.readme.io/v2.0/reference/etxn_details) serializes emit details, based on (i.a.) the number of reserved transactions, so a call to it must be preceded by a call to [etxn_reserve](https://xrpl-hooks.readme.io/v2.0/reference/etxn_reserve). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/emitted-transactions) diff --git a/xrpl-hooks-docs/md/hooks-emit-buf-len.md b/xrpl-hooks-docs/md/hooks-emit-buf-len.md index 76f6d68..81cbc5f 100644 --- a/xrpl-hooks-docs/md/hooks-emit-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-emit-buf-len.md @@ -1,6 +1,7 @@ # hooks-emit-buf-len -Function `emit` has fixed-size transaction hash output. +Function [emit](https://xrpl-hooks.readme.io/v2.0/reference/emit) has fixed-size transaction hash output. -This check warns about too-small size of its output buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/emitted-transactions) diff --git a/xrpl-hooks-docs/md/hooks-emit-prereq.md b/xrpl-hooks-docs/md/hooks-emit-prereq.md index 2fbd561..0649523 100644 --- a/xrpl-hooks-docs/md/hooks-emit-prereq.md +++ b/xrpl-hooks-docs/md/hooks-emit-prereq.md @@ -1,5 +1,5 @@ # hooks-emit-prereq -Before emitting a transaction using `emit` Hook API, a hook must set a -maximal count of transactions it plans to emit, by calling -`etxn_reserve`. +Before emitting a transaction using [emit](https://xrpl-hooks.readme.io/v2.0/reference/emit) Hook API, a hook must set a maximal count of transactions it plans to emit, by calling [etxn_reserve](https://xrpl-hooks.readme.io/v2.0/reference/etxn_reserve). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/emitted-transactions) diff --git a/xrpl-hooks-docs/md/hooks-entry-point-recursion.md b/xrpl-hooks-docs/md/hooks-entry-point-recursion.md index e287894..5314d16 100644 --- a/xrpl-hooks-docs/md/hooks-entry-point-recursion.md +++ b/xrpl-hooks-docs/md/hooks-entry-point-recursion.md @@ -1,4 +1,5 @@ # hooks-entry-point-recursion -Recursive calls are disallowed in the implementation of hook entry -points. +Recursive calls are disallowed in the implementation of hook entry points. + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/loops-and-guarding#no-recursion) diff --git a/xrpl-hooks-docs/md/hooks-entry-points-neg.md b/xrpl-hooks-docs/md/hooks-entry-points-neg.md index faa03ad..6e6d2d7 100644 --- a/xrpl-hooks-docs/md/hooks-entry-points-neg.md +++ b/xrpl-hooks-docs/md/hooks-entry-points-neg.md @@ -1,4 +1,5 @@ # hooks-entry-points-neg -Shows error on function definitions with unexpected (that is, neither -`hook` nor `cbak`) names. +Shows error on function definitions with unexpected (that is, neither `hook` nor `cbak`) names. + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/compiling-hooks#constraints) diff --git a/xrpl-hooks-docs/md/hooks-entry-points.md b/xrpl-hooks-docs/md/hooks-entry-points.md index c0618dc..ff79f42 100644 --- a/xrpl-hooks-docs/md/hooks-entry-points.md +++ b/xrpl-hooks-docs/md/hooks-entry-points.md @@ -1,6 +1,7 @@ # hooks-entry-points -A Hook always implements and exports exactly two functions: `cbak` and -`hook`. +A Hook always implements and exports exactly two functions: [cbak](https://xrpl-hooks.readme.io/v2.0/reference/cbak) and [hook](https://xrpl-hooks.readme.io/v2.0/reference/hook). This check shows error on translation units that do not have them. + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/compiling-hooks) diff --git a/xrpl-hooks-docs/md/hooks-fee-prereq.md b/xrpl-hooks-docs/md/hooks-fee-prereq.md index c25f9e8..b018ec8 100644 --- a/xrpl-hooks-docs/md/hooks-fee-prereq.md +++ b/xrpl-hooks-docs/md/hooks-fee-prereq.md @@ -1,5 +1,5 @@ # hooks-fee-prereq -Hook API `etxn_fee_base` estimates a transaction fee, based on (i.a.) -the number of reserved transactions, so a call to it must be preceded -by a call to `etxn_reserve`. +Hook API [etxn_fee_base](https://xrpl-hooks.readme.io/v2.0/reference/etxn_fee_base) estimates a transaction fee, based on (i.a.) the number of reserved transactions, so a call to it must be preceded by a call to [etxn_reserve](https://xrpl-hooks.readme.io/v2.0/reference/etxn_reserve). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/hook-fees) diff --git a/xrpl-hooks-docs/md/hooks-field-add-buf-len.md b/xrpl-hooks-docs/md/hooks-field-add-buf-len.md index 688fe66..c820ad2 100644 --- a/xrpl-hooks-docs/md/hooks-field-add-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-field-add-buf-len.md @@ -1,9 +1,7 @@ # hooks-field-add-buf-len -Emplacing a new field into STObject by calling `sto_emplace` requires -enough space to serialize the new STObject into; the API also limits -sizes of the old object and field. +Emplacing a new field into STObject by calling [sto_emplace](https://xrpl-hooks.readme.io/v2.0/reference/sto_emplace) requires enough space to serialize the new STObject into; the API also limits sizes of the old object and field. -This check warns about insufficient output buffer space as well as -too-large values of the inputs in calls to `sto_emplace` (if they're -specified by constants - variable parameters are ignored). +This check warns about insufficient output buffer space as well as too-large values of the inputs in calls to `sto_emplace` (if they're specified by constants - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/serialized-objects) diff --git a/xrpl-hooks-docs/md/hooks-field-buf-len.md b/xrpl-hooks-docs/md/hooks-field-buf-len.md index 89f2f18..b48a7b7 100644 --- a/xrpl-hooks-docs/md/hooks-field-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-field-buf-len.md @@ -1,6 +1,7 @@ # hooks-field-buf-len -Hook API `sto_subfield` requires non-empty input buffer. +Hook API [sto_subfield](https://xrpl-hooks.readme.io/v2.0/reference/sto_subfield) requires non-empty input buffer. -This check warns about empty input in calls to `sto_subfield` (if it's -specified by a constant - variable parameter is ignored). +This check warns about empty input in calls to `sto_subfield` (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/serialized-objects) diff --git a/xrpl-hooks-docs/md/hooks-field-del-buf-len.md b/xrpl-hooks-docs/md/hooks-field-del-buf-len.md index b2dee0c..4d4e84b 100644 --- a/xrpl-hooks-docs/md/hooks-field-del-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-field-del-buf-len.md @@ -1,9 +1,7 @@ # hooks-field-del-buf-len -Erasing a field from STObject by calling `sto_erase` requires enough -space to serialize the new STObject into; the API also limits size of -the old object. +Erasing a field from STObject by calling [sto_erase](https://xrpl-hooks.readme.io/v2.0/reference/sto_erase) requires enough space to serialize the new STObject into; the API also limits size of the old object. -This check warns about insufficient output buffer space as well as -too-large value of the input STObject in calls to `sto_erase` (if -they're specified by constants - variable parameters are ignored). +This check warns about insufficient output buffer space as well as too-large value of the input STObject in calls to `sto_erase` (if they're specified by constants - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/serialized-objects) diff --git a/xrpl-hooks-docs/md/hooks-float-arith-pure.md b/xrpl-hooks-docs/md/hooks-float-arith-pure.md index d77ac4f..65aba23 100644 --- a/xrpl-hooks-docs/md/hooks-float-arith-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-arith-pure.md @@ -1,15 +1,8 @@ # hooks-float-arith-pure -Hooks can compute floating-point values in XFL format by calling -functions `float_multiply`, `float_mulratio`, `float_negate`, -`float_sum`, `float_invert` and `float_divide` and access their -constituent parts by calling `float_exponent`, `float_mantissa` and -`float_sign`. If the inputs of the computation never change, a more -efficient way to do this is to precompute it. +Hooks can compute floating-point values in XFL format by calling functions [float_multiply](https://xrpl-hooks.readme.io/v2.0/reference/float_multiply), [float_mulratio](https://xrpl-hooks.readme.io/v2.0/reference/float_mulratio), [float_negate](https://xrpl-hooks.readme.io/v2.0/reference/float_negate), [float_sum](https://xrpl-hooks.readme.io/v2.0/reference/float_sum), [float_invert](https://xrpl-hooks.readme.io/v2.0/reference/float_invert) and [float_divide](https://xrpl-hooks.readme.io/v2.0/reference/float_divide) and access their constituent parts by calling [float_exponent](https://xrpl-hooks.readme.io/v2.0/reference/float_exponent), [float_mantissa](https://xrpl-hooks.readme.io/v2.0/reference/float_mantissa) and [float_sign](https://xrpl-hooks.readme.io/v2.0/reference/float_sign). If the inputs of the computation never change, a more efficient way to do this is to precompute it. + +This check warns about calls of the aforementioned functions with constant inputs and in simple cases proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). It also checks that the divisor passed to `float_divide`, `float_mulratio` and `float_invert` is not 0 (if it's specified by a constant - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/floating-point-numbers-xfl) -This check warns about calls of the aforementioned functions with -constant inputs and in simple cases proposes to add a tracing -statement showing the computed value (so that the user can use it to -replace the call). It also checks that the divisor passed to -`float_divide`, `float_mulratio` and `float_invert` is not 0 (if it's -specified by a constant - variable parameters are ignored). diff --git a/xrpl-hooks-docs/md/hooks-float-compare-pure.md b/xrpl-hooks-docs/md/hooks-float-compare-pure.md index 20da0e9..2533709 100644 --- a/xrpl-hooks-docs/md/hooks-float-compare-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-compare-pure.md @@ -1,9 +1,7 @@ # hooks-float-compare-pure -Hooks can compare floating-point values in XFL format by calling the -`float_compare` function. If the inputs of the comparison never -change, its result is fixed and the function need not be called. +Hooks can compare floating-point values in XFL format by calling the [float_compare](https://xrpl-hooks.readme.io/v2.0/reference/float_compare) function. If the inputs of the comparison never change, its result is fixed and the function need not be called. -This check warns about calls of `float_compare` with constant inputs -as well as invalid values of the comparison mode parameter (if it's -specified by a constant - variable parameter is ignored). +This check warns about calls of `float_compare` with constant inputs as well as invalid values of the comparison mode parameter (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/floating-point-numbers-xfl) diff --git a/xrpl-hooks-docs/md/hooks-float-int-pure.md b/xrpl-hooks-docs/md/hooks-float-int-pure.md index 43c4935..25bf71f 100644 --- a/xrpl-hooks-docs/md/hooks-float-int-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-int-pure.md @@ -1,10 +1,7 @@ # hooks-float-int-pure -Hooks can convert floating-point values in XFL format to integers by -calling the `float_int` function. If the inputs of this function never -change, a more efficient way to do this is to precompute the integer -value. +Hooks can convert floating-point values in XFL format to integers by calling the [float_int](https://xrpl-hooks.readme.io/v2.0/reference/float_int) function. If the inputs of this function never change, a more efficient way to do this is to precompute the integer value. -This check warns about calls of `float_int` with constant inputs as -well as invalid values of the decimal places parameter (if it's -specified by a constant - variable parameter is ignored). +This check warns about calls of `float_int` with constant inputs as well as invalid values of the decimal places parameter (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/floating-point-numbers-xfl) diff --git a/xrpl-hooks-docs/md/hooks-float-manip-pure.md b/xrpl-hooks-docs/md/hooks-float-manip-pure.md index 631af28..9a355b4 100644 --- a/xrpl-hooks-docs/md/hooks-float-manip-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-manip-pure.md @@ -1,13 +1,7 @@ # hooks-float-manip-pure -Hooks can directly manipulate floating-point values in XFL format by -calling functions `float_exponent_set`, `float_mantissa_set` and -`float_sign_set`. If the inputs of the update never change, a more -efficient way to do this is to precompute it. +Hooks can directly manipulate floating-point values in XFL format by calling functions [float_exponent_set](https://xrpl-hooks.readme.io/v2.0/reference/float_exponent_set), [float_mantissa_set](https://xrpl-hooks.readme.io/v2.0/reference/float_mantissa_set) and [float_sign_set](https://xrpl-hooks.readme.io/v2.0/reference/float_sign_set). If the inputs of the update never change, a more efficient way to do this is to precompute it. -This check warns about calls of the aforementioned functions with -constant inputs and in simple cases proposes to add a tracing -statement showing the computed value (so that the user can use it to -replace the call). It also checks documented bounds of the second -parameter of these functions (if it's specified by a constant - -variable parameter is ignored). +This check warns about calls of the aforementioned functions with constant inputs and in simple cases proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). It also checks documented bounds of the second parameter of these functions (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/floating-point-numbers-xfl) diff --git a/xrpl-hooks-docs/md/hooks-float-one-pure.md b/xrpl-hooks-docs/md/hooks-float-one-pure.md index 31f5736..44ff48b 100644 --- a/xrpl-hooks-docs/md/hooks-float-one-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-one-pure.md @@ -1,5 +1,5 @@ # hooks-float-one-pure -Hooks can obtain XFL enclosing number 1 by calling the float_one -function. Since the number never changes, a more efficient way is to -use its precomputed value. +Hooks can obtain XFL enclosing number 1 by calling the [float_one](https://xrpl-hooks.readme.io/v2.0/reference/float_one) function. Since the number never changes, a more efficient way is to use its precomputed value. + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/floating-point-numbers-xfl) diff --git a/xrpl-hooks-docs/md/hooks-float-pure.md b/xrpl-hooks-docs/md/hooks-float-pure.md index 21372e7..b333d0f 100644 --- a/xrpl-hooks-docs/md/hooks-float-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-pure.md @@ -1,12 +1,7 @@ # hooks-float-pure -Hooks can use floating-point values in XFL format, creating them from -mantissa and exponent by calling the `float_set` function. If the -mantissa and exponent never change, a more efficient way to do this is -to precompute the floating-point value. +Hooks can use floating-point values in XFL format, creating them from mantissa and exponent by calling the [float_set](https://xrpl-hooks.readme.io/v2.0/reference/float_set) function. If the mantissa and exponent never change, a more efficient way to do this is to precompute the floating-point value. -This check warns about calls of `float_set` with constant inputs and -proposes to add a tracing statement showing the computed value (so -that the user can use it to replace the call). In the special case of -0 mantissa and 0 exponent ("canonical 0"), a replacement value of 0 is -proposed directly, with no need to trace it. +This check warns about calls of `float_set` with constant inputs and proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). In the special case of 0 mantissa and 0 exponent ("canonical 0"), a replacement value of 0 is proposed directly, with no need to trace it. + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/floating-point-numbers-xfl) diff --git a/xrpl-hooks-docs/md/hooks-guard-called.md b/xrpl-hooks-docs/md/hooks-guard-called.md index c5d21d8..50ae048 100644 --- a/xrpl-hooks-docs/md/hooks-guard-called.md +++ b/xrpl-hooks-docs/md/hooks-guard-called.md @@ -1,5 +1,5 @@ # hooks-guard-called -Every hook needs to import the guard function `_g` and use it at least once. +Every hook needs to import the guard function [_g](https://xrpl-hooks.readme.io/v2.0/docs/loops-and-guarding#the-guard-function) and use it at least once. -[Read documentation](https://xrpl-hooks.readme.io/docs/loops-and-guarding) +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/loops-and-guarding) diff --git a/xrpl-hooks-docs/md/hooks-guard-in-for.md b/xrpl-hooks-docs/md/hooks-guard-in-for.md index eb08042..ae0c0d4 100644 --- a/xrpl-hooks-docs/md/hooks-guard-in-for.md +++ b/xrpl-hooks-docs/md/hooks-guard-in-for.md @@ -1,6 +1,6 @@ # hooks-guard-in-for -Consider the following for-loop in C: +A guard is a marker that must be placed in your code at the top of each loop. Consider the following for-loop in C: ```c #define GUARD(maxiter) _g(__LINE__, (maxiter)+1) @@ -8,5 +8,7 @@ Consider the following for-loop in C: for (int i = 0; GUARD(3), i < 3; ++i) ``` -This is the only way to satisfy the guard rule when using a for-loop -in C. +
+This is the only way to satisfy the guard rule when using a for-loop in C. + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/loops-and-guarding) diff --git a/xrpl-hooks-docs/md/hooks-guard-in-while.md b/xrpl-hooks-docs/md/hooks-guard-in-while.md index 6e77156..5289cf2 100644 --- a/xrpl-hooks-docs/md/hooks-guard-in-while.md +++ b/xrpl-hooks-docs/md/hooks-guard-in-while.md @@ -9,3 +9,6 @@ Like for loops, while loops must have a guard in their condition: int i = 0; while (GUARD(3), i < 3) ``` + +
+[Read more](https://xrpl-hooks.readme.io/v2.0/docs/loops-and-guarding) diff --git a/xrpl-hooks-docs/md/hooks-hash-buf-len.md b/xrpl-hooks-docs/md/hooks-hash-buf-len.md index c0903f6..7bd1335 100644 --- a/xrpl-hooks-docs/md/hooks-hash-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-hash-buf-len.md @@ -1,7 +1,5 @@ # hooks-hash-buf-len -Functions `util_sha512h`, `hook_hash`, `ledger_last_hash` and `nonce` -have fixed-size hash output. +Functions [util_sha512h](https://xrpl-hooks.readme.io/v2.0/reference/util_sha512h), [hook_hash](https://xrpl-hooks.readme.io/v2.0/reference/hook_hash), [ledger_last_hash](https://xrpl-hooks.readme.io/v2.0/reference/ledger_last_hash) and [nonce](https://xrpl-hooks.readme.io/v2.0/reference/nonce) have fixed-size hash output. -This check warns about too-small size of their output buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-small size of their output buffer (if it's specified by a constant - variable parameter is ignored). diff --git a/xrpl-hooks-docs/md/hooks-keylet-buf-len.md b/xrpl-hooks-docs/md/hooks-keylet-buf-len.md index 2bc6a85..4f64835 100644 --- a/xrpl-hooks-docs/md/hooks-keylet-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-keylet-buf-len.md @@ -1,8 +1,7 @@ # hooks-keylet-buf-len -Computing a ripple keylet by calling `util_keylet` requires valid -parameters dependent on the keylet type. +Computing a ripple keylet by calling [util_keylet](https://xrpl-hooks.readme.io/v2.0/reference/util_keylet) requires valid parameters dependent on the keylet type. -This check does not fully parse these parameters, but warns about -invalid keylet type as well as buffer sizes that cannot be valid (if -they're specified by constants - variable parameters are ignored). +This check does not fully parse these parameters, but warns about invalid keylet type as well as buffer sizes that cannot be valid (if they're specified by constants - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md b/xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md index 478e25f..e82550a 100644 --- a/xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md @@ -1,8 +1,5 @@ # hooks-raddr-conv-buf-len -Hook API `util_accid` has upper limit on the length of its input -(because it expects it to be a raddr) and fixed-size account ID -output. +Hook API [util_accid](https://xrpl-hooks.readme.io/v2.0/reference/util_accid) has upper limit on the length of its input (because it expects it to be a raddr) and fixed-size account ID output. -This check warns about invalid sizes of input and output parameters -(if they're specified by constants - variable parameters are ignored). +This check warns about invalid sizes of input and output parameters (if they're specified by constants - variable parameters are ignored). diff --git a/xrpl-hooks-docs/md/hooks-raddr-conv-pure.md b/xrpl-hooks-docs/md/hooks-raddr-conv-pure.md index 6269782..051724a 100644 --- a/xrpl-hooks-docs/md/hooks-raddr-conv-pure.md +++ b/xrpl-hooks-docs/md/hooks-raddr-conv-pure.md @@ -1,10 +1,5 @@ # hooks-raddr-conv-pure -Hooks identify accounts by the 20 byte account ID, which can be -converted from a raddr using the `util_accid` function. If the raddr -never changes, a more efficient way to do this is precompute the -account-id from the raddr. +Hooks identify accounts by the 20 byte account ID, which can be converted from a raddr using the [util_accid](https://xrpl-hooks.readme.io/v2.0/reference/util_accid) function. If the raddr never changes, a more efficient way to do this is precompute the account-id from the raddr. -This check warns about calls of `util_accid` with constant input and -proposes to add a tracing statement showing the computed value (so -that the user can use it to replace the call). +This check warns about calls of `util_accid` with constant input and proposes to add a tracing statement showing the computed value (so that the user can use it to replace the call). diff --git a/xrpl-hooks-docs/md/hooks-reserve-limit.md b/xrpl-hooks-docs/md/hooks-reserve-limit.md index d418f12..ed8e8ab 100644 --- a/xrpl-hooks-docs/md/hooks-reserve-limit.md +++ b/xrpl-hooks-docs/md/hooks-reserve-limit.md @@ -1,9 +1,7 @@ # hooks-reserve-limit -Hook API `etxn_reserve` takes a parameter specifying the number of -transactions intended to emit from the calling hook. Value of this -parameter is limited, and the function fails if the limit is exceeded. +Hook API [etxn_reserve](https://xrpl-hooks.readme.io/v2.0/reference/etxn_reserve) takes a parameter specifying the number of transactions intended to emit from the calling hook. Value of this parameter is limited, and the function fails if the limit is exceeded. -This check warns about too-large values of the number of reserved -transactions (if they're specified by a constant - variable parameter -is ignored). +This check warns about too-large values of the number of reserved transactions (if they're specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/emitted-transactions) diff --git a/xrpl-hooks-docs/md/hooks-slot-hash-buf-len.md b/xrpl-hooks-docs/md/hooks-slot-hash-buf-len.md index 5306132..2c0fd94 100644 --- a/xrpl-hooks-docs/md/hooks-slot-hash-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-slot-hash-buf-len.md @@ -1,7 +1,7 @@ # hooks-slot-hash-buf-len -Function `slot_id` has fixed-size canonical hash output. +Function [slot_id](https://xrpl-hooks.readme.io/v2.0/reference/slot_id) has fixed-size canonical hash output. -This check warns about too-small size of its output buffer as well as -invalid values of the slot number parameter (if they're specified by -constants - variable parameters are ignored). +This check warns about too-small size of its output buffer as well as invalid values of the slot number parameter (if they're specified by constants - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-slot-keylet-buf-len.md b/xrpl-hooks-docs/md/hooks-slot-keylet-buf-len.md index 7455397..6b2a75f 100644 --- a/xrpl-hooks-docs/md/hooks-slot-keylet-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-slot-keylet-buf-len.md @@ -1,7 +1,7 @@ # hooks-slot-keylet-buf-len -Function `slot_set` has structured keylet input. +Function [slot_set](https://xrpl-hooks.readme.io/v2.0/reference/slot_set) has structured keylet input. -This check does not parse the input, but warns about its sizes that -cannot be valid as well as invalid values of the slot number parameter -(if they're specified by constants - variable parameters are ignored). +This check does not parse the input, but warns about its sizes that cannot be valid as well as invalid values of the slot number parameter (if they're specified by constants - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-slot-limit.md b/xrpl-hooks-docs/md/hooks-slot-limit.md index e47c497..b2a2d7d 100644 --- a/xrpl-hooks-docs/md/hooks-slot-limit.md +++ b/xrpl-hooks-docs/md/hooks-slot-limit.md @@ -1,9 +1,7 @@ # hooks-slot-limit -Hook APIs `slot`, `slot_count`, `slot_clear`, `slot_size`, -`slot_float` and `trace_slot` take a parameter specifying the accessed -slot number. Value of this parameter is limited, and the functions -fail if the limit is exceeded. +Hook APIs [slot](https://xrpl-hooks.readme.io/v2.0/reference/slot), [slot_count](https://xrpl-hooks.readme.io/v2.0/reference/slot_count), [slot_clear](https://xrpl-hooks.readme.io/v2.0/reference/slot_clear), [slot_size](https://xrpl-hooks.readme.io/v2.0/reference/slot_size), [slot_float](https://xrpl-hooks.readme.io/v2.0/reference/slot_float) and [trace_slot](https://xrpl-hooks.readme.io/v2.0/reference/trace_slot) take a parameter specifying the accessed slot number. Value of this parameter is limited, and the functions fail if the limit is exceeded. -This check warns about too-large values of the slot number (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-large values of the slot number (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-slot-sub-limit.md b/xrpl-hooks-docs/md/hooks-slot-sub-limit.md index 30b794b..944913a 100644 --- a/xrpl-hooks-docs/md/hooks-slot-sub-limit.md +++ b/xrpl-hooks-docs/md/hooks-slot-sub-limit.md @@ -1,8 +1,7 @@ # hooks-slot-sub-limit -Hook APIs `slot_subarray` and `slot_subfield` take parameters -specifying parent and child slot numbers. Values of these parameters -are limited, and the functions fail if the limit is exceeded. +Hook APIs [slot_subarray](https://xrpl-hooks.readme.io/v2.0/reference/slot_subarray) and [slot_subfield](https://xrpl-hooks.readme.io/v2.0/reference/slot_subfield) take parameters specifying parent and child slot numbers. Values of these parameters are limited, and the functions fail if the limit is exceeded. -This check warns about too-large values of the slot numbers (if -they're specified by a constant - variable parameters are ignored). +This check warns about too-large values of the slot numbers (if they're specified by a constant - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-slot-type-limit.md b/xrpl-hooks-docs/md/hooks-slot-type-limit.md index 44bc201..9786e30 100644 --- a/xrpl-hooks-docs/md/hooks-slot-type-limit.md +++ b/xrpl-hooks-docs/md/hooks-slot-type-limit.md @@ -1,9 +1,7 @@ # hooks-slot-type-limit -Hook API `slot_type` takes a parameter specifying the accessed slot -number. Value of this parameter is limited, and the function fails if -the limit is exceeded. +Hook API [slot_type](https://xrpl-hooks.readme.io/v2.0/reference/slot_type) takes a parameter specifying the accessed slot number. Value of this parameter is limited, and the function fails if the limit is exceeded. -This check warns about too-large values of the slot number as well as -invalid values of the flags parameter (if they're specified by -constants - variable parameters are ignored). +This check warns about too-large values of the slot number as well as invalid values of the flags parameter (if they're specified by constants - variable parameters are ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-state-buf-len.md b/xrpl-hooks-docs/md/hooks-state-buf-len.md index 7295138..8182d89 100644 --- a/xrpl-hooks-docs/md/hooks-state-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-state-buf-len.md @@ -1,6 +1,7 @@ # hooks-state-buf-len -Functions state and state_set accept fixed-size Hook State key. +Functions [state](https://xrpl-hooks.readme.io/v2.0/reference/state) and [state_set](https://xrpl-hooks.readme.io/v2.0/reference/state_set) accept fixed-size Hook State key. -This check warns about invalid size of its input buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about invalid size of its input buffer (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/state-management) diff --git a/xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md b/xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md index 04551aa..a71fb97 100644 --- a/xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md @@ -1,6 +1,5 @@ # hooks-transaction-hash-buf-len -Function `otxn_id` has fixed-size canonical hash output. +Function [otxn_id](https://xrpl-hooks.readme.io/v2.0/reference/otxn_id) has fixed-size canonical hash output. -This check warns about too-small size of its output buffer (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored). diff --git a/xrpl-hooks-docs/md/hooks-transaction-slot-limit.md b/xrpl-hooks-docs/md/hooks-transaction-slot-limit.md index 0d17d7a..746bfb8 100644 --- a/xrpl-hooks-docs/md/hooks-transaction-slot-limit.md +++ b/xrpl-hooks-docs/md/hooks-transaction-slot-limit.md @@ -1,8 +1,7 @@ # hooks-transaction-slot-limit -Function `otxn_slot` takes a parameter specifying the accessed slot -number. Value of this parameter is limited, and the function fails if -the limit is exceeded. +Function [otxn_slot](https://xrpl-hooks.readme.io/v2.0/reference/otxn_slot) takes a parameter specifying the accessed slot number. Value of this parameter is limited, and the function fails if the limit is exceeded. -This check warns about too-large values of the slot number (if it's -specified by a constant - variable parameter is ignored). +This check warns about too-large values of the slot number (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-validate-buf-len.md b/xrpl-hooks-docs/md/hooks-validate-buf-len.md index 85d4f49..bf4bd92 100644 --- a/xrpl-hooks-docs/md/hooks-validate-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-validate-buf-len.md @@ -1,6 +1,7 @@ # hooks-validate-buf-len -Hook API `sto_validate` requires non-empty input buffer. +Hook API [sto_validate](https://xrpl-hooks.readme.io/v2.0/reference/sto_validate) requires non-empty input buffer. -This check warns about empty input in calls to `sto_validate` (if it's -specified by a constant - variable parameter is ignored). +This check warns about empty input in calls to `sto_validate` (if it's specified by a constant - variable parameter is ignored). + +[Read more](https://xrpl-hooks.readme.io/v2.0/docs/serialized-objects) diff --git a/xrpl-hooks-docs/md/hooks-verify-buf-len.md b/xrpl-hooks-docs/md/hooks-verify-buf-len.md index ad4d03f..520965b 100644 --- a/xrpl-hooks-docs/md/hooks-verify-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-verify-buf-len.md @@ -1,8 +1,5 @@ # hooks-verify-buf-len -Verifying a cryptographic signature by calling `util_verify` requires -valid public key & data signature. +Verifying a cryptographic signature by calling [util_verify](https://xrpl-hooks.readme.io/v2.0/reference/util_verify) requires valid public key & data signature. -This check does not fully parse these parameters, but warns about -their sizes that cannot be valid (if they're specified by constants - -variable parameters are ignored). +This check does not fully parse these parameters, but warns about their sizes that cannot be valid (if they're specified by constants - variable parameters are ignored).