plugeth-utils/docs/types.rst

.. _types:

======================
Basic Types of Plugins
======================

While PluGeth has been designed to be versatile and customizable, when learning the project it can be helpful to think of plugins as being of four different archetypes.

.. contents:: :local:

RPC Methods
-----------

These plugins provide new json rpc methods to access several objects containing real time and historic data.


Subcommand
------------

A subcommand redifines the total behavior of Geth and could stand on its own. In contrast with the other plugin types which, in general, are meant to capture and manipulate information, a subcommand is meant to change to overall behavior of Geth. It may do this in order to capture information but the primary fuctionality is a modulation of geth behaviour.

Tracers
-------

Tracers rely on historic data recompiled after execution to give insight into a transaction.

Subscriptions
-------------

Subscriptions provide real time notification of data from the EVM as it processes transactions.

.. NOTE:: Plugins are not limited to a singular functionality and can be customized to operate as hybrids of the above. See `blockupdates`_ as an example.


.. _blockupdates: https://github.com/openrelayxyz/plugeth-plugins/tree/master/packages/blockupdates
re-committing entire project as well as todays changes 2021-09-23 19:11:56 +00:00			`.. _types:`

			`======================`
			`Basic Types of Plugins`
			`======================`

Update today, add hook writing guide 2021-10-15 20:27:20 +00:00			`While PluGeth has been designed to be versatile and customizable, when learning the project it can be helpful to think of plugins as being of four different archetypes.`
Moving Austin's work into most current version 2021-10-05 22:43:09 +00:00
			`.. contents:: :local:`

re-committing entire project as well as todays changes 2021-09-23 19:11:56 +00:00			`RPC Methods`
			`-----------`

Moving Austin's work into most current version 2021-10-05 22:43:09 +00:00			`These plugins provide new json rpc methods to access several objects containing real time and historic data.`
re-committing entire project as well as todays changes 2021-09-23 19:11:56 +00:00

			`Subcommand`
			`------------`

Update today, add hook writing guide 2021-10-15 20:27:20 +00:00			`A subcommand redifines the total behavior of Geth and could stand on its own. In contrast with the other plugin types which, in general, are meant to capture and manipulate information, a subcommand is meant to change to overall behavior of Geth. It may do this in order to capture information but the primary fuctionality is a modulation of geth behaviour.`
re-committing entire project as well as todays changes 2021-09-23 19:11:56 +00:00
			`Tracers`
			`-------`

Update today, add hook writing guide 2021-10-15 20:27:20 +00:00			`Tracers rely on historic data recompiled after execution to give insight into a transaction.`
re-committing entire project as well as todays changes 2021-09-23 19:11:56 +00:00
			`Subscriptions`
			`-------------`

Update today, add hook writing guide 2021-10-15 20:27:20 +00:00			`Subscriptions provide real time notification of data from the EVM as it processes transactions.`
Moving Austin's work into most current version 2021-10-05 22:43:09 +00:00
Update today, add hook writing guide 2021-10-15 20:27:20 +00:00			.. NOTE:: Plugins are not limited to a singular functionality and can be customized to operate as hybrids of the above. See `blockupdates`_ as an example.
Moving Austin's work into most current version 2021-10-05 22:43:09 +00:00
re-committing entire project as well as todays changes 2021-09-23 19:11:56 +00:00
Update today, add hook writing guide 2021-10-15 20:27:20 +00:00			`.. _blockupdates: https://github.com/openrelayxyz/plugeth-plugins/tree/master/packages/blockupdates`