ARCHIVE/xrpl-hooks-ide
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

change readme link

Browse Source
This commit is contained in:
Denis Angell
2023-06-06 12:28:19 +00:00
parent 3bb26d0c9b
commit 1cae0f161e
47 changed files with 78 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/Navigation.tsx
View File

@@ -231,7 +231,7 @@ const Navigation = () => {
as="a" as="a"
rel="noreferrer noopener" rel="noreferrer noopener"
target="_blank" target="_blank"
href="https://xrpl-hooks.readme.io/v2.0/docs" href="https://xrpl-hooks.readme.io//docs"
> >
<ArrowUpRight size="15px" /> Hooks documentation <ArrowUpRight size="15px" /> Hooks documentation
</Text> </Text>
@@ -352,7 +352,7 @@ const Navigation = () => {
</Button> </Button>
</Link> </Link>
</ButtonGroup> </ButtonGroup>
<Link href="https://xrpl-hooks.readme.io/v2.0" passHref> <Link href="https://xrpl-hooks.readme.io/" passHref>
<a target="_blank" rel="noreferrer noopener"> <a target="_blank" rel="noreferrer noopener">
<Button outline> <Button outline>
<BookOpen size="15px" /> <BookOpen size="15px" />

2
xrpl-hooks-docs/md/hooks-account-buf-len.md
View File

@@ -1,5 +1,5 @@
# hooks-account-buf-len # hooks-account-buf-len
Function [hook_account](https://xrpl-hooks.readme.io/v2.0/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). This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored).

2
xrpl-hooks-docs/md/hooks-account-conv-buf-len.md
View File

@@ -1,5 +1,5 @@
# hooks-account-conv-buf-len # hooks-account-conv-buf-len
Function [util_raddr](https://xrpl-hooks.readme.io/v2.0/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). 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).

2
xrpl-hooks-docs/md/hooks-account-conv-pure.md
View File

@@ -1,5 +1,5 @@
# hooks-account-conv-pure # 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/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. 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). 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).

4
xrpl-hooks-docs/md/hooks-array-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-array-buf-len # hooks-array-buf-len
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/serialized-objects)

2
xrpl-hooks-docs/md/hooks-burden-prereq.md
View File

@@ -1,3 +1,3 @@
# hooks-burden-prereq # hooks-burden-prereq
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). 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).

2
xrpl-hooks-docs/md/hooks-control-string-arg.md
View File

@@ -1,5 +1,5 @@
# hooks-control-string-arg # hooks-control-string-arg
Functions [accept](https://xrpl-hooks.readme.io/v2.0/reference/accept) and [rollback](https://xrpl-hooks.readme.io/v2.0/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`. For a release version, this check warns about constant strings passed to `accept` and `rollback`.

4
xrpl-hooks-docs/md/hooks-detail-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-detail-buf-len # hooks-detail-buf-len
Function [etxn_details](https://xrpl-hooks.readme.io/v2.0/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). 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) [Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions)

4
xrpl-hooks-docs/md/hooks-detail-prereq.md
View File

@@ -1,5 +1,5 @@
# hooks-detail-prereq # hooks-detail-prereq
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). 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/v2.0/docs/emitted-transactions) [Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions)

4
xrpl-hooks-docs/md/hooks-emit-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-emit-buf-len # hooks-emit-buf-len
Function [emit](https://xrpl-hooks.readme.io/v2.0/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). 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) [Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions)

4
xrpl-hooks-docs/md/hooks-emit-prereq.md
View File

@@ -1,5 +1,5 @@
# hooks-emit-prereq # hooks-emit-prereq
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). 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/v2.0/docs/emitted-transactions) [Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions)

2
xrpl-hooks-docs/md/hooks-entry-point-recursion.md
View File

@@ -2,4 +2,4 @@
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) [Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding#no-recursion)

2
xrpl-hooks-docs/md/hooks-entry-points-neg.md
View File

@@ -2,4 +2,4 @@
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) [Read more](https://xrpl-hooks.readme.io//docs/compiling-hooks#constraints)

4
xrpl-hooks-docs/md/hooks-entry-points.md
View File

@@ -1,7 +1,7 @@
# hooks-entry-points # hooks-entry-points
A Hook always implements and exports a [hook](https://xrpl-hooks.readme.io/v2.0/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. This check shows error on translation units that do not have it.
[Read more](https://xrpl-hooks.readme.io/v2.0/docs/compiling-hooks) [Read more](https://xrpl-hooks.readme.io//docs/compiling-hooks)

4
xrpl-hooks-docs/md/hooks-fee-prereq.md
View File

@@ -1,5 +1,5 @@
# hooks-fee-prereq # hooks-fee-prereq
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). 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/v2.0/docs/hook-fees) [Read more](https://xrpl-hooks.readme.io//docs/hook-fees)

4
xrpl-hooks-docs/md/hooks-field-add-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-field-add-buf-len # hooks-field-add-buf-len
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/serialized-objects)

4
xrpl-hooks-docs/md/hooks-field-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-field-buf-len # hooks-field-buf-len
Hook API [sto_subfield](https://xrpl-hooks.readme.io/v2.0/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). 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) [Read more](https://xrpl-hooks.readme.io//docs/serialized-objects)

4
xrpl-hooks-docs/md/hooks-field-del-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-field-del-buf-len # hooks-field-del-buf-len
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/serialized-objects)

4
xrpl-hooks-docs/md/hooks-float-arith-pure.md
View File

@@ -1,8 +1,8 @@
# hooks-float-arith-pure # hooks-float-arith-pure
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl)

4
xrpl-hooks-docs/md/hooks-float-compare-pure.md
View File

@@ -1,7 +1,7 @@
# hooks-float-compare-pure # hooks-float-compare-pure
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl)

4
xrpl-hooks-docs/md/hooks-float-int-pure.md
View File

@@ -1,7 +1,7 @@
# hooks-float-int-pure # 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/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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl)

4
xrpl-hooks-docs/md/hooks-float-manip-pure.md
View File

@@ -1,7 +1,7 @@
# hooks-float-manip-pure # 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/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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl)

4
xrpl-hooks-docs/md/hooks-float-one-pure.md
View File

@@ -1,5 +1,5 @@
# hooks-float-one-pure # hooks-float-one-pure
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. 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/v2.0/docs/floating-point-numbers-xfl) [Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl)

4
xrpl-hooks-docs/md/hooks-float-pure.md
View File

@@ -1,7 +1,7 @@
# hooks-float-pure # 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/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. 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. 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) [Read more](https://xrpl-hooks.readme.io//docs/floating-point-numbers-xfl)

2
xrpl-hooks-docs/md/hooks-guard-call-non-const.md
View File

@@ -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. 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. 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/v2.0/docs/loops-and-guarding) [Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding)

4
xrpl-hooks-docs/md/hooks-guard-called.md
View File

@@ -1,5 +1,5 @@
# hooks-guard-called # hooks-guard-called
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. 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/v2.0/docs/loops-and-guarding) [Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding)

2
xrpl-hooks-docs/md/hooks-guard-in-for.md
View File

@@ -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, 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. the increment and loop condition.
[Read more](https://xrpl-hooks.readme.io/v2.0/docs/loops-and-guarding) [Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding)

2
xrpl-hooks-docs/md/hooks-guard-in-while.md
View File

@@ -11,4 +11,4 @@ Like for loops, while loops must have a guard in their condition:
``` ```
<BR/> <BR/>
[Read more](https://xrpl-hooks.readme.io/v2.0/docs/loops-and-guarding) [Read more](https://xrpl-hooks.readme.io//docs/loops-and-guarding)

2
xrpl-hooks-docs/md/hooks-hash-buf-len.md
View File

@@ -1,5 +1,5 @@
# hooks-hash-buf-len # hooks-hash-buf-len
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), [etxn_nonce](https://xrpl-hooks.readme.io/v2.0/reference/etxn_nonce) and [ledger_nonce](https://xrpl-hooks.readme.io/v2.0/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). This check warns about too-small size of their output buffer (if it's specified by a constant - variable parameter is ignored).

4
xrpl-hooks-docs/md/hooks-keylet-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-keylet-buf-len # hooks-keylet-buf-len
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets)

4
xrpl-hooks-docs/md/hooks-param-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-param-buf-len # hooks-param-buf-len
Function [hook_param](https://xrpl-hooks.readme.io/v2.0/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). 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/v2.0/docs/parameters) [Read more](https://xrpl-hooks.readme.io//docs/parameters)

4
xrpl-hooks-docs/md/hooks-param-set-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-param-set-buf-len # hooks-param-set-buf-len
Function [hook_param_set](https://xrpl-hooks.readme.io/v2.0/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). 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/v2.0/docs/parameters) [Read more](https://xrpl-hooks.readme.io//docs/parameters)

2
xrpl-hooks-docs/md/hooks-raddr-conv-buf-len.md
View File

@@ -1,5 +1,5 @@
# hooks-raddr-conv-buf-len # hooks-raddr-conv-buf-len
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. 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). This check warns about invalid sizes of input and output parameters (if they're specified by constants - variable parameters are ignored).

2
xrpl-hooks-docs/md/hooks-raddr-conv-pure.md
View File

@@ -1,5 +1,5 @@
# hooks-raddr-conv-pure # 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/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. 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). 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).

4
xrpl-hooks-docs/md/hooks-reserve-limit.md
View File

@@ -1,7 +1,7 @@
# hooks-reserve-limit # hooks-reserve-limit
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/emitted-transactions)

2
xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md
View File

@@ -1,5 +1,5 @@
# hooks-skip-hash-buf-len # hooks-skip-hash-buf-len
Function [hook_skip](https://xrpl-hooks.readme.io/v2.0/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). This check warns about invalid size of its input buffer (if it's specified by a constant - variable parameter is ignored).

4
xrpl-hooks-docs/md/hooks-slot-hash-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-slot-hash-buf-len # hooks-slot-hash-buf-len
Function [slot_id](https://xrpl-hooks.readme.io/v2.0/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). 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) [Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets)

4
xrpl-hooks-docs/md/hooks-slot-keylet-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-slot-keylet-buf-len # hooks-slot-keylet-buf-len
Function [slot_set](https://xrpl-hooks.readme.io/v2.0/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). 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) [Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets)

4
xrpl-hooks-docs/md/hooks-slot-limit.md
View File

@@ -1,7 +1,7 @@
# hooks-slot-limit # hooks-slot-limit
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets)

4
xrpl-hooks-docs/md/hooks-slot-sub-limit.md
View File

@@ -1,7 +1,7 @@
# hooks-slot-sub-limit # hooks-slot-sub-limit
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets)

4
xrpl-hooks-docs/md/hooks-slot-type-limit.md
View File

@@ -1,7 +1,7 @@
# hooks-slot-type-limit # hooks-slot-type-limit
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets)

4
xrpl-hooks-docs/md/hooks-state-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-state-buf-len # hooks-state-buf-len
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/state-management)

2
xrpl-hooks-docs/md/hooks-transaction-hash-buf-len.md
View File

@@ -1,5 +1,5 @@
# hooks-transaction-hash-buf-len # hooks-transaction-hash-buf-len
Function [otxn_id](https://xrpl-hooks.readme.io/v2.0/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). This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored).

4
xrpl-hooks-docs/md/hooks-transaction-slot-limit.md
View File

@@ -1,7 +1,7 @@
# hooks-transaction-slot-limit # hooks-transaction-slot-limit
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. 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). 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) [Read more](https://xrpl-hooks.readme.io//docs/slots-and-keylets)

4
xrpl-hooks-docs/md/hooks-trivial-cbak.md
View File

@@ -1,7 +1,7 @@
# hooks-trivial-cbak # hooks-trivial-cbak
A Hook may implement and export a [cbak](https://xrpl-hooks.readme.io/v2.0/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. 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/v2.0/docs/compiling-hooks) [Read more](https://xrpl-hooks.readme.io//docs/compiling-hooks)

4
xrpl-hooks-docs/md/hooks-validate-buf-len.md
View File

@@ -1,7 +1,7 @@
# hooks-validate-buf-len # hooks-validate-buf-len
Hook API [sto_validate](https://xrpl-hooks.readme.io/v2.0/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). 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) [Read more](https://xrpl-hooks.readme.io//docs/serialized-objects)

2
xrpl-hooks-docs/md/hooks-verify-buf-len.md
View File

@@ -1,5 +1,5 @@
# hooks-verify-buf-len # hooks-verify-buf-len
Verifying a cryptographic signature by calling [util_verify](https://xrpl-hooks.readme.io/v2.0/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). 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).