From d21cda21d01be35bc37b11de43516fd93e93a778 Mon Sep 17 00:00:00 2001 From: Denis Angell Date: Tue, 6 Jun 2023 12:53:43 +0000 Subject: [PATCH] !fixup --- components/Navigation.tsx | 2 +- xrpl-hooks-docs/md/hooks-account-buf-len.md | 2 +- xrpl-hooks-docs/md/hooks-account-conv-buf-len.md | 2 +- xrpl-hooks-docs/md/hooks-account-conv-pure.md | 2 +- xrpl-hooks-docs/md/hooks-array-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-burden-prereq.md | 2 +- xrpl-hooks-docs/md/hooks-control-string-arg.md | 2 +- xrpl-hooks-docs/md/hooks-detail-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-detail-prereq.md | 4 ++-- xrpl-hooks-docs/md/hooks-emit-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-emit-prereq.md | 4 ++-- xrpl-hooks-docs/md/hooks-entry-point-recursion.md | 2 +- xrpl-hooks-docs/md/hooks-entry-points-neg.md | 2 +- xrpl-hooks-docs/md/hooks-entry-points.md | 4 ++-- xrpl-hooks-docs/md/hooks-fee-prereq.md | 4 ++-- xrpl-hooks-docs/md/hooks-field-add-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-field-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-field-del-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-float-arith-pure.md | 4 ++-- xrpl-hooks-docs/md/hooks-float-compare-pure.md | 4 ++-- xrpl-hooks-docs/md/hooks-float-int-pure.md | 4 ++-- xrpl-hooks-docs/md/hooks-float-manip-pure.md | 4 ++-- xrpl-hooks-docs/md/hooks-float-one-pure.md | 4 ++-- xrpl-hooks-docs/md/hooks-float-pure.md | 4 ++-- xrpl-hooks-docs/md/hooks-guard-call-non-const.md | 2 +- xrpl-hooks-docs/md/hooks-guard-called.md | 4 ++-- xrpl-hooks-docs/md/hooks-guard-in-for.md | 2 +- xrpl-hooks-docs/md/hooks-guard-in-while.md | 2 +- xrpl-hooks-docs/md/hooks-hash-buf-len.md | 2 +- xrpl-hooks-docs/md/hooks-keylet-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-param-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-param-set-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md | 2 +- xrpl-hooks-docs/md/hooks-raddr-conv-pure.md | 2 +- xrpl-hooks-docs/md/hooks-reserve-limit.md | 4 ++-- xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md | 2 +- xrpl-hooks-docs/md/hooks-slot-hash-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-slot-keylet-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-slot-limit.md | 4 ++-- xrpl-hooks-docs/md/hooks-slot-sub-limit.md | 4 ++-- xrpl-hooks-docs/md/hooks-slot-type-limit.md | 4 ++-- xrpl-hooks-docs/md/hooks-state-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md | 2 +- xrpl-hooks-docs/md/hooks-transaction-slot-limit.md | 4 ++-- xrpl-hooks-docs/md/hooks-trivial-cbak.md | 4 ++-- xrpl-hooks-docs/md/hooks-validate-buf-len.md | 4 ++-- xrpl-hooks-docs/md/hooks-verify-buf-len.md | 2 +- 47 files changed, 77 insertions(+), 77 deletions(-) diff --git a/components/Navigation.tsx b/components/Navigation.tsx index 8fabde9..617a9d9 100644 --- a/components/Navigation.tsx +++ b/components/Navigation.tsx @@ -231,7 +231,7 @@ const Navigation = () => { as="a" rel="noreferrer noopener" target="_blank" - href="https://xrpl-hooks.readme.io//docs" + href="https://xrpl-hooks.readme.io/docs" > Hooks documentation diff --git a/xrpl-hooks-docs/md/hooks-account-buf-len.md b/xrpl-hooks-docs/md/hooks-account-buf-len.md index 56e39ed..e7d3ec7 100644 --- a/xrpl-hooks-docs/md/hooks-account-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-account-buf-len.md @@ -1,5 +1,5 @@ # hooks-account-buf-len -Function [hook_account](https://xrpl-hooks.readme.io//reference/hook_account) has fixed-size account ID output. +Function [hook_account](https://xrpl-hooks.readme.io/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). 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 2851ef7..82a9ad5 100644 --- a/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-account-conv-buf-len.md @@ -1,5 +1,5 @@ # hooks-account-conv-buf-len -Function [util_raddr](https://xrpl-hooks.readme.io//reference/util_raddr) has fixed-size account ID input. +Function [util_raddr](https://xrpl-hooks.readme.io/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). diff --git a/xrpl-hooks-docs/md/hooks-account-conv-pure.md b/xrpl-hooks-docs/md/hooks-account-conv-pure.md index 54e30f7..732b0e9 100644 --- a/xrpl-hooks-docs/md/hooks-account-conv-pure.md +++ b/xrpl-hooks-docs/md/hooks-account-conv-pure.md @@ -1,5 +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](https://xrpl-hooks.readme.io//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. +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/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). diff --git a/xrpl-hooks-docs/md/hooks-array-buf-len.md b/xrpl-hooks-docs/md/hooks-array-buf-len.md index 70313b2..2dac847 100644 --- a/xrpl-hooks-docs/md/hooks-array-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-array-buf-len.md @@ -1,7 +1,7 @@ # hooks-array-buf-len -Hook API [sto_subarray](https://xrpl-hooks.readme.io//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. +Hook API [sto_subarray](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/serialized-objects) +[Read more](https://xrpl-hooks.readme.io/docs/serialized-objects) diff --git a/xrpl-hooks-docs/md/hooks-burden-prereq.md b/xrpl-hooks-docs/md/hooks-burden-prereq.md index 96d2fc0..cca78d5 100644 --- a/xrpl-hooks-docs/md/hooks-burden-prereq.md +++ b/xrpl-hooks-docs/md/hooks-burden-prereq.md @@ -1,3 +1,3 @@ # hooks-burden-prereq -Hook API [etxn_burden](https://xrpl-hooks.readme.io//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//reference/etxn_reserve). +Hook API [etxn_burden](https://xrpl-hooks.readme.io/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/reference/etxn_reserve). diff --git a/xrpl-hooks-docs/md/hooks-control-string-arg.md b/xrpl-hooks-docs/md/hooks-control-string-arg.md index 6db80fa..33052b8 100644 --- a/xrpl-hooks-docs/md/hooks-control-string-arg.md +++ b/xrpl-hooks-docs/md/hooks-control-string-arg.md @@ -1,5 +1,5 @@ # hooks-control-string-arg -Functions [accept](https://xrpl-hooks.readme.io//reference/accept) and [rollback](https://xrpl-hooks.readme.io//reference/rollback) take an optional string buffer stored outside the hook as its result message. This is useful for debugging but takes up space. +Functions [accept](https://xrpl-hooks.readme.io/reference/accept) and [rollback](https://xrpl-hooks.readme.io/reference/rollback) take an optional string buffer stored outside the hook as its result message. This is useful for debugging but takes up space. For a release version, this check warns about constant strings passed to `accept` and `rollback`. diff --git a/xrpl-hooks-docs/md/hooks-detail-buf-len.md b/xrpl-hooks-docs/md/hooks-detail-buf-len.md index 56e1abe..05377e6 100644 --- a/xrpl-hooks-docs/md/hooks-detail-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-detail-buf-len.md @@ -1,7 +1,7 @@ # hooks-detail-buf-len -Function [etxn_details](https://xrpl-hooks.readme.io//reference/etxn_details) has fixed-size sfEmitDetails output. +Function [etxn_details](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions) +[Read more](https://xrpl-hooks.readme.io/docs/emitted-transactions) diff --git a/xrpl-hooks-docs/md/hooks-detail-prereq.md b/xrpl-hooks-docs/md/hooks-detail-prereq.md index 0bbfdeb..2b1600f 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](https://xrpl-hooks.readme.io//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//reference/etxn_reserve). +Hook API [etxn_details](https://xrpl-hooks.readme.io/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/reference/etxn_reserve). -[Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions) +[Read more](https://xrpl-hooks.readme.io/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 056a656..6f3d28e 100644 --- a/xrpl-hooks-docs/md/hooks-emit-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-emit-buf-len.md @@ -1,7 +1,7 @@ # hooks-emit-buf-len -Function [emit](https://xrpl-hooks.readme.io//reference/emit) has fixed-size transaction hash output. +Function [emit](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions) +[Read more](https://xrpl-hooks.readme.io/docs/emitted-transactions) diff --git a/xrpl-hooks-docs/md/hooks-emit-prereq.md b/xrpl-hooks-docs/md/hooks-emit-prereq.md index 8d81cc3..58fd0ad 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](https://xrpl-hooks.readme.io//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//reference/etxn_reserve). +Before emitting a transaction using [emit](https://xrpl-hooks.readme.io/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/reference/etxn_reserve). -[Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions) +[Read more](https://xrpl-hooks.readme.io/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 c1a6915..3207439 100644 --- a/xrpl-hooks-docs/md/hooks-entry-point-recursion.md +++ b/xrpl-hooks-docs/md/hooks-entry-point-recursion.md @@ -2,4 +2,4 @@ Recursive calls are disallowed in the implementation of hook entry points. -[Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding#no-recursion) +[Read more](https://xrpl-hooks.readme.io/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 51fb439..3bfd592 100644 --- a/xrpl-hooks-docs/md/hooks-entry-points-neg.md +++ b/xrpl-hooks-docs/md/hooks-entry-points-neg.md @@ -2,4 +2,4 @@ Shows error on function definitions with unexpected (that is, neither `hook` nor `cbak`) names. -[Read more](https://xrpl-hooks.readme.io//docs/compiling-hooks#constraints) +[Read more](https://xrpl-hooks.readme.io/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 078a6ee..0a33512 100644 --- a/xrpl-hooks-docs/md/hooks-entry-points.md +++ b/xrpl-hooks-docs/md/hooks-entry-points.md @@ -1,7 +1,7 @@ # hooks-entry-points -A Hook always implements and exports a [hook](https://xrpl-hooks.readme.io//reference/hook) function. +A Hook always implements and exports a [hook](https://xrpl-hooks.readme.io/reference/hook) function. This check shows error on translation units that do not have it. -[Read more](https://xrpl-hooks.readme.io//docs/compiling-hooks) +[Read more](https://xrpl-hooks.readme.io/docs/compiling-hooks) diff --git a/xrpl-hooks-docs/md/hooks-fee-prereq.md b/xrpl-hooks-docs/md/hooks-fee-prereq.md index 4b5e3f4..7741019 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](https://xrpl-hooks.readme.io//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//reference/etxn_reserve). +Hook API [etxn_fee_base](https://xrpl-hooks.readme.io/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/reference/etxn_reserve). -[Read more](https://xrpl-hooks.readme.io//docs/hook-fees) +[Read more](https://xrpl-hooks.readme.io/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 d85063c..6d37538 100644 --- a/xrpl-hooks-docs/md/hooks-field-add-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-field-add-buf-len.md @@ -1,7 +1,7 @@ # hooks-field-add-buf-len -Emplacing a new field into STObject by calling [sto_emplace](https://xrpl-hooks.readme.io//reference/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/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). -[Read more](https://xrpl-hooks.readme.io//docs/serialized-objects) +[Read more](https://xrpl-hooks.readme.io/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 d21385e..9bbe80b 100644 --- a/xrpl-hooks-docs/md/hooks-field-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-field-buf-len.md @@ -1,7 +1,7 @@ # hooks-field-buf-len -Hook API [sto_subfield](https://xrpl-hooks.readme.io//reference/sto_subfield) requires non-empty input buffer. +Hook API [sto_subfield](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/serialized-objects) +[Read more](https://xrpl-hooks.readme.io/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 06ec1fb..f3b64f7 100644 --- a/xrpl-hooks-docs/md/hooks-field-del-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-field-del-buf-len.md @@ -1,7 +1,7 @@ # hooks-field-del-buf-len -Erasing a field from STObject by calling [sto_erase](https://xrpl-hooks.readme.io//reference/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/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). -[Read more](https://xrpl-hooks.readme.io//docs/serialized-objects) +[Read more](https://xrpl-hooks.readme.io/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 2696aa0..749db54 100644 --- a/xrpl-hooks-docs/md/hooks-float-arith-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-arith-pure.md @@ -1,8 +1,8 @@ # hooks-float-arith-pure -Hooks can compute floating-point values in XFL format by calling functions [float_multiply](https://xrpl-hooks.readme.io//reference/float_multiply), [float_mulratio](https://xrpl-hooks.readme.io//reference/float_mulratio), [float_negate](https://xrpl-hooks.readme.io//reference/float_negate), [float_sum](https://xrpl-hooks.readme.io//reference/float_sum), [float_invert](https://xrpl-hooks.readme.io//reference/float_invert) and [float_divide](https://xrpl-hooks.readme.io//reference/float_divide) and access their constituent parts by calling [float_exponent](https://xrpl-hooks.readme.io//reference/float_exponent), [float_mantissa](https://xrpl-hooks.readme.io//reference/float_mantissa) and [float_sign](https://xrpl-hooks.readme.io//reference/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/reference/float_multiply), [float_mulratio](https://xrpl-hooks.readme.io/reference/float_mulratio), [float_negate](https://xrpl-hooks.readme.io/reference/float_negate), [float_sum](https://xrpl-hooks.readme.io/reference/float_sum), [float_invert](https://xrpl-hooks.readme.io/reference/float_invert) and [float_divide](https://xrpl-hooks.readme.io/reference/float_divide) and access their constituent parts by calling [float_exponent](https://xrpl-hooks.readme.io/reference/float_exponent), [float_mantissa](https://xrpl-hooks.readme.io/reference/float_mantissa) and [float_sign](https://xrpl-hooks.readme.io/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//docs/floating-point-numbers-xfl) +[Read more](https://xrpl-hooks.readme.io/docs/floating-point-numbers-xfl) diff --git a/xrpl-hooks-docs/md/hooks-float-compare-pure.md b/xrpl-hooks-docs/md/hooks-float-compare-pure.md index b41ef1a..a80dfcf 100644 --- a/xrpl-hooks-docs/md/hooks-float-compare-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-compare-pure.md @@ -1,7 +1,7 @@ # hooks-float-compare-pure -Hooks can compare floating-point values in XFL format by calling the [float_compare](https://xrpl-hooks.readme.io//reference/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/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). -[Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl) +[Read more](https://xrpl-hooks.readme.io/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 2fd52d1..38f0135 100644 --- a/xrpl-hooks-docs/md/hooks-float-int-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-int-pure.md @@ -1,7 +1,7 @@ # hooks-float-int-pure -Hooks can convert floating-point values in XFL format to integers by calling the [float_int](https://xrpl-hooks.readme.io//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. +Hooks can convert floating-point values in XFL format to integers by calling the [float_int](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl) +[Read more](https://xrpl-hooks.readme.io/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 9be2cf6..f5b7661 100644 --- a/xrpl-hooks-docs/md/hooks-float-manip-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-manip-pure.md @@ -1,7 +1,7 @@ # hooks-float-manip-pure -Hooks can directly manipulate floating-point values in XFL format by calling functions [float_exponent_set](https://xrpl-hooks.readme.io//reference/float_exponent_set), [float_mantissa_set](https://xrpl-hooks.readme.io//reference/float_mantissa_set) and [float_sign_set](https://xrpl-hooks.readme.io//reference/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/reference/float_exponent_set), [float_mantissa_set](https://xrpl-hooks.readme.io/reference/float_mantissa_set) and [float_sign_set](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl) +[Read more](https://xrpl-hooks.readme.io/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 ec9c14a..1d5664f 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](https://xrpl-hooks.readme.io//reference/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/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//docs/floating-point-numbers-xfl) +[Read more](https://xrpl-hooks.readme.io/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 c22d717..d64593d 100644 --- a/xrpl-hooks-docs/md/hooks-float-pure.md +++ b/xrpl-hooks-docs/md/hooks-float-pure.md @@ -1,7 +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](https://xrpl-hooks.readme.io//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. +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/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. -[Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl) +[Read more](https://xrpl-hooks.readme.io/docs/floating-point-numbers-xfl) diff --git a/xrpl-hooks-docs/md/hooks-guard-call-non-const.md b/xrpl-hooks-docs/md/hooks-guard-call-non-const.md index 43c8ce8..e116af4 100644 --- a/xrpl-hooks-docs/md/hooks-guard-call-non-const.md +++ b/xrpl-hooks-docs/md/hooks-guard-call-non-const.md @@ -3,4 +3,4 @@ Only compile-time constants can be used as an argument in loop GUARD call. This check warns if a non compile-time constant is used. It also checks whether a compile-time constant is used as a first argument of `_g()` call and whether it is a unique value. If not - it warns. -[Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding) +[Read more](https://xrpl-hooks.readme.io/docs/loops-and-guarding) diff --git a/xrpl-hooks-docs/md/hooks-guard-called.md b/xrpl-hooks-docs/md/hooks-guard-called.md index ce61101..6bb68a7 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](https://xrpl-hooks.readme.io//docs/loops-and-guarding#the-guard-function) and use it at least once. +Every hook needs to import the guard function [_g](https://xrpl-hooks.readme.io/docs/loops-and-guarding#the-guard-function) and use it at least once. -[Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding) +[Read more](https://xrpl-hooks.readme.io/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 2a7f177..f3a9351 100644 --- a/xrpl-hooks-docs/md/hooks-guard-in-for.md +++ b/xrpl-hooks-docs/md/hooks-guard-in-for.md @@ -32,4 +32,4 @@ for(int i = 0; GUARD(3), i < 3; ++i) { This check will warn if the GUARD call is missing and also it will propose a GUARD value based on the for loop initial value, the increment and loop condition. -[Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding) +[Read more](https://xrpl-hooks.readme.io/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 4a8ba33..df40a20 100644 --- a/xrpl-hooks-docs/md/hooks-guard-in-while.md +++ b/xrpl-hooks-docs/md/hooks-guard-in-while.md @@ -11,4 +11,4 @@ Like for loops, while loops must have a guard in their condition: ```
-[Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding) +[Read more](https://xrpl-hooks.readme.io/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 c34f6c6..04e36d6 100644 --- a/xrpl-hooks-docs/md/hooks-hash-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-hash-buf-len.md @@ -1,5 +1,5 @@ # hooks-hash-buf-len -Functions [util_sha512h](https://xrpl-hooks.readme.io//reference/util_sha512h), [hook_hash](https://xrpl-hooks.readme.io//reference/hook_hash), [ledger_last_hash](https://xrpl-hooks.readme.io//reference/ledger_last_hash), [etxn_nonce](https://xrpl-hooks.readme.io//reference/etxn_nonce) and [ledger_nonce](https://xrpl-hooks.readme.io//reference/ledger_nonce) have fixed-size hash output. +Functions [util_sha512h](https://xrpl-hooks.readme.io/reference/util_sha512h), [hook_hash](https://xrpl-hooks.readme.io/reference/hook_hash), [ledger_last_hash](https://xrpl-hooks.readme.io/reference/ledger_last_hash), [etxn_nonce](https://xrpl-hooks.readme.io/reference/etxn_nonce) and [ledger_nonce](https://xrpl-hooks.readme.io/reference/ledger_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). diff --git a/xrpl-hooks-docs/md/hooks-keylet-buf-len.md b/xrpl-hooks-docs/md/hooks-keylet-buf-len.md index a04c3ca..2bf145c 100644 --- a/xrpl-hooks-docs/md/hooks-keylet-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-keylet-buf-len.md @@ -1,7 +1,7 @@ # hooks-keylet-buf-len -Computing a ripple keylet by calling [util_keylet](https://xrpl-hooks.readme.io//reference/util_keylet) requires valid parameters dependent on the keylet type. +Computing a ripple keylet by calling [util_keylet](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets) +[Read more](https://xrpl-hooks.readme.io/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-param-buf-len.md b/xrpl-hooks-docs/md/hooks-param-buf-len.md index 12f5ac6..f7bcf26 100644 --- a/xrpl-hooks-docs/md/hooks-param-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-param-buf-len.md @@ -1,7 +1,7 @@ # hooks-param-buf-len -Function [hook_param](https://xrpl-hooks.readme.io//reference/hook_param) expects a limited-length name input and produces fixed-size value output. +Function [hook_param](https://xrpl-hooks.readme.io/reference/hook_param) expects a limited-length name input and produces fixed-size value output. This check warns about invalid sizes of input and output buffers (if they're specified by constants - variable parameters are ignored). -[Read more](https://xrpl-hooks.readme.io//docs/parameters) +[Read more](https://xrpl-hooks.readme.io/docs/parameters) diff --git a/xrpl-hooks-docs/md/hooks-param-set-buf-len.md b/xrpl-hooks-docs/md/hooks-param-set-buf-len.md index 0ed7ece..ca25b79 100644 --- a/xrpl-hooks-docs/md/hooks-param-set-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-param-set-buf-len.md @@ -1,7 +1,7 @@ # hooks-param-set-buf-len -Function [hook_param_set](https://xrpl-hooks.readme.io//reference/hook_param_set) expects limited-length name, fixed-length hash and limited-length value inputs. +Function [hook_param_set](https://xrpl-hooks.readme.io/reference/hook_param_set) expects limited-length name, fixed-length hash and limited-length value inputs. This check warns about invalid sizes of input buffers (if they're specified by constants - variable parameters are ignored). -[Read more](https://xrpl-hooks.readme.io//docs/parameters) +[Read more](https://xrpl-hooks.readme.io/docs/parameters) 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 adc0aa4..ab61f86 100644 --- a/xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md @@ -1,5 +1,5 @@ # hooks-raddr-conv-buf-len -Hook API [util_accid](https://xrpl-hooks.readme.io//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. +Hook API [util_accid](https://xrpl-hooks.readme.io/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). diff --git a/xrpl-hooks-docs/md/hooks-raddr-conv-pure.md b/xrpl-hooks-docs/md/hooks-raddr-conv-pure.md index ae1f8a8..1a5df3d 100644 --- a/xrpl-hooks-docs/md/hooks-raddr-conv-pure.md +++ b/xrpl-hooks-docs/md/hooks-raddr-conv-pure.md @@ -1,5 +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](https://xrpl-hooks.readme.io//reference/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/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). diff --git a/xrpl-hooks-docs/md/hooks-reserve-limit.md b/xrpl-hooks-docs/md/hooks-reserve-limit.md index d138808..f24ffe0 100644 --- a/xrpl-hooks-docs/md/hooks-reserve-limit.md +++ b/xrpl-hooks-docs/md/hooks-reserve-limit.md @@ -1,7 +1,7 @@ # hooks-reserve-limit -Hook API [etxn_reserve](https://xrpl-hooks.readme.io//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. +Hook API [etxn_reserve](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions) +[Read more](https://xrpl-hooks.readme.io/docs/emitted-transactions) diff --git a/xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md b/xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md index d367655..4f97c52 100644 --- a/xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md @@ -1,5 +1,5 @@ # hooks-skip-hash-buf-len -Function [hook_skip](https://xrpl-hooks.readme.io//reference/hook_skip) has fixed-size canonical hash input. +Function [hook_skip](https://xrpl-hooks.readme.io/reference/hook_skip) has fixed-size canonical hash input. This check warns about invalid size of its input buffer (if it's specified by a constant - variable parameter is ignored). 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 21f458e..46e7d78 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](https://xrpl-hooks.readme.io//reference/slot_id) has fixed-size canonical hash output. +Function [slot_id](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets) +[Read more](https://xrpl-hooks.readme.io/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 439a16a..7a17c6e 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](https://xrpl-hooks.readme.io//reference/slot_set) has structured keylet input. +Function [slot_set](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets) +[Read more](https://xrpl-hooks.readme.io/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 53e4520..16687b7 100644 --- a/xrpl-hooks-docs/md/hooks-slot-limit.md +++ b/xrpl-hooks-docs/md/hooks-slot-limit.md @@ -1,7 +1,7 @@ # hooks-slot-limit -Hook APIs [slot](https://xrpl-hooks.readme.io//reference/slot), [slot_count](https://xrpl-hooks.readme.io//reference/slot_count), [slot_clear](https://xrpl-hooks.readme.io//reference/slot_clear), [slot_size](https://xrpl-hooks.readme.io//reference/slot_size), [slot_float](https://xrpl-hooks.readme.io//reference/slot_float) and [trace_slot](https://xrpl-hooks.readme.io//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. +Hook APIs [slot](https://xrpl-hooks.readme.io/reference/slot), [slot_count](https://xrpl-hooks.readme.io/reference/slot_count), [slot_clear](https://xrpl-hooks.readme.io/reference/slot_clear), [slot_size](https://xrpl-hooks.readme.io/reference/slot_size), [slot_float](https://xrpl-hooks.readme.io/reference/slot_float) and [trace_slot](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets) +[Read more](https://xrpl-hooks.readme.io/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 14a157b..ce33d90 100644 --- a/xrpl-hooks-docs/md/hooks-slot-sub-limit.md +++ b/xrpl-hooks-docs/md/hooks-slot-sub-limit.md @@ -1,7 +1,7 @@ # hooks-slot-sub-limit -Hook APIs [slot_subarray](https://xrpl-hooks.readme.io//reference/slot_subarray) and [slot_subfield](https://xrpl-hooks.readme.io//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. +Hook APIs [slot_subarray](https://xrpl-hooks.readme.io/reference/slot_subarray) and [slot_subfield](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets) +[Read more](https://xrpl-hooks.readme.io/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 de97688..b6c0785 100644 --- a/xrpl-hooks-docs/md/hooks-slot-type-limit.md +++ b/xrpl-hooks-docs/md/hooks-slot-type-limit.md @@ -1,7 +1,7 @@ # hooks-slot-type-limit -Hook API [slot_type](https://xrpl-hooks.readme.io//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. +Hook API [slot_type](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets) +[Read more](https://xrpl-hooks.readme.io/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 54e2186..5d61c99 100644 --- a/xrpl-hooks-docs/md/hooks-state-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-state-buf-len.md @@ -1,7 +1,7 @@ # hooks-state-buf-len -Functions [state](https://xrpl-hooks.readme.io//reference/state) and [state_set](https://xrpl-hooks.readme.io//reference/state_set) accept fixed-size Hook State key. +Functions [state](https://xrpl-hooks.readme.io/reference/state) and [state_set](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/state-management) +[Read more](https://xrpl-hooks.readme.io/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 20074bf..34c3e45 100644 --- a/xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md @@ -1,5 +1,5 @@ # hooks-transaction-hash-buf-len -Function [otxn_id](https://xrpl-hooks.readme.io//reference/otxn_id) has fixed-size canonical hash output. +Function [otxn_id](https://xrpl-hooks.readme.io/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). diff --git a/xrpl-hooks-docs/md/hooks-transaction-slot-limit.md b/xrpl-hooks-docs/md/hooks-transaction-slot-limit.md index af212e3..6ad51a0 100644 --- a/xrpl-hooks-docs/md/hooks-transaction-slot-limit.md +++ b/xrpl-hooks-docs/md/hooks-transaction-slot-limit.md @@ -1,7 +1,7 @@ # hooks-transaction-slot-limit -Function [otxn_slot](https://xrpl-hooks.readme.io//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. +Function [otxn_slot](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets) +[Read more](https://xrpl-hooks.readme.io/docs/slots-and-keylets) diff --git a/xrpl-hooks-docs/md/hooks-trivial-cbak.md b/xrpl-hooks-docs/md/hooks-trivial-cbak.md index d9b8acc..8e3b054 100644 --- a/xrpl-hooks-docs/md/hooks-trivial-cbak.md +++ b/xrpl-hooks-docs/md/hooks-trivial-cbak.md @@ -1,7 +1,7 @@ # hooks-trivial-cbak -A Hook may implement and export a [cbak](https://xrpl-hooks.readme.io//reference/cbak) function. +A Hook may implement and export a [cbak](https://xrpl-hooks.readme.io/reference/cbak) function. But the function is optional, and defining it so that it doesn't do anything besides returning a constant value is unnecessary (except for some debugging scenarios) and just increases the hook size. This check warns about such implementations. -[Read more](https://xrpl-hooks.readme.io//docs/compiling-hooks) +[Read more](https://xrpl-hooks.readme.io/docs/compiling-hooks) diff --git a/xrpl-hooks-docs/md/hooks-validate-buf-len.md b/xrpl-hooks-docs/md/hooks-validate-buf-len.md index 591897a..a6aa4c0 100644 --- a/xrpl-hooks-docs/md/hooks-validate-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-validate-buf-len.md @@ -1,7 +1,7 @@ # hooks-validate-buf-len -Hook API [sto_validate](https://xrpl-hooks.readme.io//reference/sto_validate) requires non-empty input buffer. +Hook API [sto_validate](https://xrpl-hooks.readme.io/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). -[Read more](https://xrpl-hooks.readme.io//docs/serialized-objects) +[Read more](https://xrpl-hooks.readme.io/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 9a7c020..8590b94 100644 --- a/xrpl-hooks-docs/md/hooks-verify-buf-len.md +++ b/xrpl-hooks-docs/md/hooks-verify-buf-len.md @@ -1,5 +1,5 @@ # hooks-verify-buf-len -Verifying a cryptographic signature by calling [util_verify](https://xrpl-hooks.readme.io//reference/util_verify) requires valid public key & data signature. +Verifying a cryptographic signature by calling [util_verify](https://xrpl-hooks.readme.io/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).