Merge remote-tracking branch 'origin/master' into lash/local-dev-improve
This commit is contained in:
nolash
commit
858bbdb69a
@ -10,7 +10,7 @@ version = (
|
||||
0,
|
||||
12,
|
||||
4,
|
||||
'alpha.13',
|
||||
'alpha.14',
|
||||
)
|
||||
|
||||
version_object = semver.VersionInfo(
|
||||
|
||||
@ -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 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
|
||||
|
||||
|
||||
@ -14,5 +14,6 @@ Released 2021 under GPL3
|
||||
@c
|
||||
@contents
|
||||
|
||||
@include index.texi
|
||||
@include content.texi
|
||||
@include appendix.texi
|
||||
|
||||
|
||||
3
apps/cic-eth/doc/texinfo/appendix.texi
Normal file
3
apps/cic-eth/doc/texinfo/appendix.texi
Normal file
@ -0,0 +1,3 @@
|
||||
@include admin.texi
|
||||
@include chains.texi
|
||||
@include transfertypes.texi
|
||||
@ -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,6 +1,6 @@
|
||||
@node cic-eth
|
||||
@top cic-eth
|
||||
|
||||
@include intro.texi
|
||||
@include dependencies.texi
|
||||
@include configuration.texi
|
||||
@include system.texi
|
||||
@ -9,6 +9,3 @@
|
||||
@include incoming.texi
|
||||
@include services.texi
|
||||
@include tools.texi
|
||||
@include admin.texi
|
||||
@include chains.texi
|
||||
@include transfertypes.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,9 +1,8 @@
|
||||
@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.
|
||||
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.
|
||||
|
||||
There are two API classes, @var{Api} and @var{AdminApi}. The former is described later in this section, the latter described in @ref{cic-eth system maintenance,the Admin API appendix}.
|
||||
There are two API classes, @var{Api} and @var{AdminApi}. The former is described later in this section, the latter described in @ref{cic-eth-appendix-system-maintenance,the Admin API appendix}.
|
||||
|
||||
|
||||
@subsection Interface
|
||||
|
||||
@ -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
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
celery==4.4.7
|
||||
chainlib-eth>=0.0.10a15,<0.1.0
|
||||
chainlib-eth>=0.0.10a16,<0.1.0
|
||||
semver==2.13.0
|
||||
crypto-dev-signer>=0.4.15rc2,<0.5.0
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# standard imports
|
||||
import semver
|
||||
|
||||
version = (0, 3, 1, 'alpha.5')
|
||||
version = (0, 3, 1, 'alpha.6')
|
||||
|
||||
version_object = semver.VersionInfo(
|
||||
major=version[0],
|
||||
|
||||
@ -6,7 +6,7 @@ celery==4.4.7
|
||||
cffi==1.14.6
|
||||
cic-eth~=0.12.5a1
|
||||
cic-notify~=0.4.0a11
|
||||
cic-types~=0.2.0a6
|
||||
cic-types~=0.2.1a2
|
||||
confini>=0.3.6rc4,<0.5.0
|
||||
phonenumbers==8.12.12
|
||||
psycopg2==2.8.6
|
||||
|
||||
Loading…
Reference in New Issue
Block a user