Skip to content

Commit

Permalink
Fix README.md errors reported from twine check command
Browse files Browse the repository at this point in the history
  • Loading branch information
Artemios Tomaras committed Jun 10, 2019
1 parent 91bd870 commit 8fd242c
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,7 @@ Usage
3. Create an appropriate event receiver

::
# inside myapp.event_receivers

from django_ethereum_events.chainevents import AbstractEventReceiver

class CustomEventReceiver(AbsractEventReceiver):
Expand All @@ -117,9 +116,9 @@ Usage
You can also set the optional ``ETHEREUM_LOGS_BATCH_SIZE`` setting which limits the maximum amount of the blocks that can be read at a time from the celery task.


*****
******************************
More about the event receivers
*****
******************************

It is advisable that the code inside the custom event receiver to be simple since it is run synchronously while the ``event_listener`` task is running. If that is not the case, pass the argument ``decoded_event`` to a celery task of your own:

Expand All @@ -137,16 +136,16 @@ a new instance of the ``django_ethereum_events.models.FailedEventLog`` containin
The event listener does **not** attempt to rerun ``FailedEventLogs``. That is up to the client implementation.


*****
****************************
Resetting the internal state
*****
****************************
Blocks are processed only once. The last block processed is stored in the ``.models.Daemon`` entry.

To reset the number of blocks processed, run the ``reset_block_daemon`` command optionally specifying the block number (-b, --block) to reset to (defaults to zero). If you reset it to zero, the next time the ``event_listener`` is fired, it will start processing blocks from the genesis block.

The ``Daemon`` entry can also be changed from the django admin backend.

*****
***************************
Proof-of-Authority Networks
*****
***************************
To use this package on **Rinkeby** or any other private network that uses the Proof-of-Authority consensus engine (also named clique), set the optional ``ETHEREUM_GETH_POA`` setting to ``True``.

0 comments on commit 8fd242c

Please sign in to comment.