started updating docs
This commit is contained in:
@@ -1,6 +1,5 @@
|
|||||||
# hooks-account-buf-len
|
# hooks-account-buf-len
|
||||||
|
|
||||||
Function `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
|
This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored).
|
||||||
specified by a constant - variable parameter is ignored).
|
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
# hooks-account-conv-buf-len
|
# hooks-account-conv-buf-len
|
||||||
|
|
||||||
Function `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
|
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).
|
||||||
parameter (if it's specified by a constant - variable parameter is
|
|
||||||
ignored).
|
|
||||||
|
|||||||
@@ -1,10 +1,5 @@
|
|||||||
# hooks-account-conv-pure
|
# hooks-account-conv-pure
|
||||||
|
|
||||||
Hooks identify accounts by the 20 byte account ID, which can be
|
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.
|
||||||
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.
|
|
||||||
|
|
||||||
This check warns about calls of `util_raddr` with constant input and
|
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).
|
||||||
proposes to add a tracing statement showing the computed value (so
|
|
||||||
that the user can use it to replace the call).
|
|
||||||
|
|||||||
@@ -1,9 +1,5 @@
|
|||||||
# hooks-array-buf-len
|
# hooks-array-buf-len
|
||||||
|
|
||||||
Hook API `sto_subarray` requires non-empty input buffer and takes a
|
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.
|
||||||
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
|
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).
|
||||||
index specified in calls to `sto_subarray` (if they're specified by
|
|
||||||
constants - variable parameters are ignored).
|
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
# hooks-burden-prereq
|
# hooks-burden-prereq
|
||||||
|
|
||||||
Hook API `etxn_burden` computes transaction burden, based on (i.a.)
|
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).
|
||||||
the number of reserved transactions, so a call to it must be preceded
|
|
||||||
by a call to `etxn_reserve`.
|
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
# hooks-detail-buf-len
|
# hooks-detail-buf-len
|
||||||
|
|
||||||
Function `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
|
This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored).
|
||||||
specified by a constant - variable parameter is ignored).
|
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
# hooks-detail-prereq
|
# hooks-detail-prereq
|
||||||
|
|
||||||
Hook API `etxn_details` serializes emit details, based on (i.a.) the
|
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).
|
||||||
number of reserved transactions, so a call to it must be preceded by a
|
|
||||||
call to `etxn_reserve`.
|
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
# hooks-emit-buf-len
|
# hooks-emit-buf-len
|
||||||
|
|
||||||
Function `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
|
This check warns about too-small size of its output buffer (if it's specified by a constant - variable parameter is ignored).
|
||||||
specified by a constant - variable parameter is ignored).
|
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
# hooks-emit-prereq
|
# hooks-emit-prereq
|
||||||
|
|
||||||
Before emitting a transaction using `emit` Hook API, a hook must set a
|
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).
|
||||||
maximal count of transactions it plans to emit, by calling
|
|
||||||
`etxn_reserve`.
|
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
# hooks-entry-point-recursion
|
# hooks-entry-point-recursion
|
||||||
|
|
||||||
Recursive calls are disallowed in the implementation of hook entry
|
Recursive calls are disallowed in the implementation of hook entry points.
|
||||||
points.
|
|
||||||
|
[Read more](https://xrpl-hooks.readme.io/docs/loops-and-guarding#no-recursion)
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
# hooks-entry-points-neg
|
# hooks-entry-points-neg
|
||||||
|
|
||||||
Shows error on function definitions with unexpected (that is, neither
|
Shows error on function definitions with unexpected (that is, neither `hook` nor `cbak`) names.
|
||||||
`hook` nor `cbak`) names.
|
|
||||||
|
[Read more](https://xrpl-hooks.readme.io/docs/compiling-hooks)
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
# hooks-entry-points
|
# hooks-entry-points
|
||||||
|
|
||||||
A Hook always implements and exports exactly two functions: `cbak` and
|
A Hook always implements and exports exactly two functions: [cbak](https://xrpl-hooks.readme.io/reference/cbak) and [hook](https://xrpl-hooks.readme.io/reference/hook).
|
||||||
`hook`.
|
|
||||||
|
|
||||||
This check shows error on translation units that do not have them.
|
This check shows error on translation units that do not have them.
|
||||||
|
|
||||||
|
[Read more](https://xrpl-hooks.readme.io/docs/compiling-hooks)
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
# hooks-fee-prereq
|
# hooks-fee-prereq
|
||||||
|
|
||||||
Hook API `etxn_fee_base` estimates a transaction fee, based on (i.a.)
|
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).
|
||||||
the number of reserved transactions, so a call to it must be preceded
|
|
||||||
by a call to `etxn_reserve`.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user