refactor: Make texinfo docs buildable with makeinfo <6.0
This commit is contained in:
Louis Holbrook
parent
8250b15d32
commit
e3acc1757a
|
|
@ -1,4 +1,3 @@
|
|||
@node cic-eth-accounts
|
||||
@section Accounts
|
||||
|
||||
Accounts are private keys in the signer component keyed by "addresses," a one-way transformation of a public key. Data can be signed by using the account as identifier for corresponding RPC requests.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
@node cic-eth-appendix-system-maintenance
|
||||
@anchor{cic-eth-appendix-system-maintenance}
|
||||
@appendix Admin API
|
||||
|
||||
The admin API is still in an early stage of refinement. User friendliness can be considerably improved.
|
||||
|
|
@ -33,7 +33,7 @@ Get the current state of a lock
|
|||
|
||||
@appendixsection tag_account
|
||||
|
||||
Associate an identifier with an account address (@xref{cic-eth system accounts})
|
||||
Associate an identifier with an account address (@xref{cic-eth-system-accounts})
|
||||
|
||||
@appendixsection have_account
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
@node cic-eth-appendix-task-chains
|
||||
@anchor{cic-eth-appendix-task-chains}
|
||||
@appendix Task chains
|
||||
|
||||
TBC - explain here how to generate these chain diagrams
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
@node cic-eth configuration
|
||||
@section Configuration
|
||||
|
||||
Configuration parameters are grouped by configuration filename.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
@node cic-eth
|
||||
@top cic-eth
|
||||
|
||||
@include dependencies.texi
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
@node cic-eth-dependencies
|
||||
@section Dependencies
|
||||
|
||||
This application is written in Python 3.8. It is tightly coupled with @code{python-celery}, which provides the task worker ecosystem. It also uses @code{SQLAlchemy} which provides useful abstractions for persistent storage though SQL, and @code{alembic} for database schema migrations.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
@node cic-eth-incoming
|
||||
@anchor{cic-eth-incoming}
|
||||
@section Incoming transactions
|
||||
|
||||
All transactions in mined blocks will be passed to a selection of plugin filters to the @code{chainsyncer} component. Each of these filters are individual python module files in @code{cic_eth.runnable.daemons.filters}. This section describes their function.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
@node cic-eth-interacting
|
||||
@section Interacting with the system
|
||||
|
||||
The API to the @var{cic-eth} component is a proxy for executing @emph{chains of Celery tasks}. The tasks that compose individual chains are documented in @ref{cic-eth-appendix-task-chains,the Task Chain appendix}, which also describes a CLI tool that can generate graph representationso of them.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
@node cic-eth-outgoing
|
||||
@section Outgoing transactions
|
||||
|
||||
@strong{Important! A pre-requisite for proper functioning of the component is that no other agent is sending transactions to the network for any of the keys in the keystore.}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
@node cic-eth-services
|
||||
@section Services
|
||||
|
||||
There are four daemons that together orchestrate all of the aforementioned recipes. This section will provide a high level description of them.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
@node cic-eth system accounts
|
||||
@section System initialization
|
||||
|
||||
When the system starts for the first time, it is locked for any state change request other than account creation@footnote{Specifically, the @code{INIT}, @code{SEND} and @code{QUEUE} lock bits are set.}. These locks should be @emph{reset} once system initialization has been completed. Currently, system initialization only involves creating and tagging required system accounts, as specified below.
|
||||
|
||||
See @ref{cic-eth-locking,Locking} and @ref{cic-eth-tools-ctrl,ctrl in Tools} for details on locking.
|
||||
|
||||
@anchor{cic-eth-system-accounts}
|
||||
@subsection System accounts
|
||||
|
||||
Certain accounts in the system have special roles. These are defined by @emph{tagging} certain accounts addresses with well-known identifiers.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
@node cic-eth-tools
|
||||
@section Tools
|
||||
|
||||
A collection of CLI tools have been provided to help with diagnostics and other administrative tasks. These use the same configuration infrastructure as the daemons.
|
||||
|
|
@ -37,7 +36,7 @@ Execute a token transfer on behalf of a custodial account.
|
|||
|
||||
@subsection tag (cic-eth-tag)
|
||||
|
||||
Associate an account address with a string identifier. @xref{cic-eth system accounts}
|
||||
Associate an account address with a string identifier. @xref{cic-eth-system-accounts}
|
||||
|
||||
|
||||
@anchor{cic-eth-tools-ctrl}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
@node cic-eth-appendix-transaction-types
|
||||
@appendix Transfer types
|
||||
|
||||
@table @var
|
||||
|
|
|
|||
Loading…
Reference in New Issue