Initial commit of pre caridnal documentation updates.

This commit is contained in:
philip-morlier 2022-02-09 12:46:40 -08:00
parent 393e2167a2
commit 60db12bbe7
4 changed files with 47 additions and 1 deletions

View File

@ -62,4 +62,5 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ['_static']
master_doc = 'index'

41
docs/existing.rst Normal file
View File

@ -0,0 +1,41 @@
.. _existing:
================
Existing Pluings
================
The isSynced plugin was designed as an extention of the ``eth_syncing`` available on statdard Geth. ``plugeth_isSynced`` was desinged to return a status object such that a status report could be given as to the current state of the node as opposed to ``eth_syncing`` which returns the status object only if the node is actively syncing and a simple false if frozen or fully synced.
Usage
======
As with all ``rpc`` methods, isSynced is available by ``curl`` or the `javascript console`_.
From the command line:
``{"method": "plugeth_isSynced", "params": []}``
``Lookup(name string, validate func(interface{}) bool) []interface{}``
Returns a list of values from plugins identified by ``name``, which match the
provided ``validate`` predicate. For example:
.. code-block:: go
pl.Lookup("Version", func(item interface{}) bool {
_, ok := item.(int)
return ok
})
Would return a list of ``int`` objects named ``Version`` in any loaded plugins.
This can enable Plugins to interact with each other, accessing values and
functions implemented in other plugins.
GetFeed
=======
``GetFeed() Feed``
.. _javascript console: https://geth.ethereum.org/docs/interface/javascript-console

View File

@ -43,6 +43,7 @@ Table of Contents
:maxdepth: 1
:caption: Reference
existing
system_req
version
api

View File

@ -11,6 +11,9 @@ While PluGeth has been designed to be versatile and customizable, when learning
RPC Methods
-----------
this is a big ole test
These plugins provide new json rpc methods to access several objects containing real time and historic data.