djwebdapp 0.6.8__tar.gz

djwebdapp-0.6.8/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Pyratzlabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

djwebdapp-0.6.8/MANIFEST.in

@@ -0,0 +1,2 @@
+include *.rst
+recursive-include src *.html *.css *.js *.py *.json

djwebdapp-0.6.8/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: djwebdapp
+Version: 0.6.8
+Home-page: https://yourlabs.io/oss/djwebdapp
+Author: James Pic
+Author-email: jamespic@gmail.com
+License: MIT
+Keywords: cli
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: django-model-utils
+Requires-Dist: djfernet>=0.8.1
+Requires-Dist: django-picklefield>=3.0.1
+Requires-Dist: networkx==2.8.8
+Requires-Dist: mnemonic
+Provides-Extra: test
+Requires-Dist: django; extra == "test"
+Requires-Dist: djangorestframework; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-django; extra == "test"
+Requires-Dist: web3<=6.20,>=6.7.0; extra == "test"
+Requires-Dist: eth-typing<5; extra == "test"
+Provides-Extra: ethereum
+Requires-Dist: web3<=6.20,>=6.7.0; extra == "ethereum"
+Requires-Dist: eth-typing<5; extra == "ethereum"
+Provides-Extra: tezos
+Requires-Dist: pytezos>3.4; extra == "tezos"
+Requires-Dist: pymich>=0.9.8; extra == "tezos"
+Provides-Extra: binary
+Requires-Dist: pysodium; extra == "binary"
+Requires-Dist: secp256k1; extra == "binary"
+Requires-Dist: fastecdsa; extra == "binary"
+Provides-Extra: all
+Requires-Dist: django; extra == "all"
+Requires-Dist: djangorestframework; extra == "all"
+Requires-Dist: pytest; extra == "all"
+Requires-Dist: pytest-cov; extra == "all"
+Requires-Dist: pytest-django; extra == "all"
+Requires-Dist: web3<=6.20,>=6.7.0; extra == "all"
+Requires-Dist: eth-typing<5; extra == "all"
+Requires-Dist: web3<=6.20,>=6.7.0; extra == "all"
+Requires-Dist: eth-typing<5; extra == "all"
+Requires-Dist: pytezos>3.4; extra == "all"
+Requires-Dist: pymich>=0.9.8; extra == "all"
+Requires-Dist: django; extra == "all"
+Requires-Dist: djangorestframework; extra == "all"
+Requires-Dist: pytest; extra == "all"
+Requires-Dist: pytest-cov; extra == "all"
+Requires-Dist: pytest-django; extra == "all"
+Requires-Dist: web3<=6.20,>=6.7.0; extra == "all"
+Requires-Dist: eth-typing<5; extra == "all"
+Requires-Dist: web3<=6.20,>=6.7.0; extra == "all"
+Requires-Dist: eth-typing<5; extra == "all"
+Requires-Dist: pytezos>3.4; extra == "all"
+Requires-Dist: pymich>=0.9.8; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+
+djWebdApp
+~~~~~~~~~
+
+`**Documentation**
+<https://djwebdapp.rtfd.io>`_
+
+Django is a great web application framework "for perfectionists with deadlines".
+
+A dApp is an app running on the blockchain: a smart contract on which users can
+call functions on.
+
+This module provides blockchain support for Django, for reading and/or writing
+the blockchain, with the following features usable independently:
+
+* blockchain indexer
+* private key vault
+* blockchain writer
+* blockchain data normalization
+* multiple blockchain support (tezos & ethereum so far)
+* inter-blockchain contract synchronisation
+* metamask authentication backend (TBA)
+
+In addition to these features, djWebdApp differenciates itself from indexers
+like dipdup because it is extensible: it's just a module you add to your Django
+project like any other Django App, in which you can add models, endpoints, and
+have an admin interface for free, and so on, benefiting from the `vast Django
+ecosystem of apps <https://djangopackages.org/>`_.
+
+Video demos
+===========
+
+- `Tezos tutorial demo
+  <https://www.youtube.com/watch?v=quSX-gJ6eow>`_
+- `Ethereum tutorial demo
+  <https://www.youtube.com/watch?v=oTjvnjB_8Tc>`_
+
+Getting started
+===============
+
+Django basics
+-------------
+
+If you are not familiar with the Django development framework, it is
+recommended you follow `their tutorial first
+<https://docs.djangoproject.com/en/4.0/intro/tutorial01/>`_, even though you
+can go through this tutorial copy/pasting your way.
+
+You may use the demo project or create your own and install djwebdapp there.
+
+Install
+-------
+
+To install djwebdapp with all optional dependencies::
+
+    pip install djwebdapp[all][binary]
+
+Don't use ``[binary]`` right there if you prefer to install compiled python
+packages from your system package manager.
+
+See setup.py's extra_requires for other possibilities.
+
+Demo project
+------------
+
+For this tutorial, we'll use the ``djwebdapp_demo`` project:
+
+.. code-block:: bash
+
+    git clone https://yourlabs.io/oss/djwebdapp.git
+    cd djwebdapp
+    pip install --editable .[all][binary]
+    ./manage.py migrate
+    ./manage.py shell
+
+.. _Local blockchains:
+
+Local blockchains
+-----------------
+
+Instead of using mainnets for development, we're going to use a local
+blockchains, so that we can work completely locally.
+
+We provide a ``docker-compose.yml`` in the root directory of this repository,
+run ``docker-compose up`` to start it.
+
+As some of us will also want to convert this to `GitLab-CI
+services <https://docs.gitlab.com/ee/ci/services/>`_\ , we'll refer to our services
+by hostname from now on, which is why we add the following to
+``/etc/hosts``::
+
+   127.0.0.1 tzlocal tzkt-api ethlocal
+
+You should then have:
+
+- a local ethereum HTTP RPC API on ``ethlocal:8545`` with a WebSocket on
+  ``ethlocal:30303``,
+- a local tezos sandbox on ``tzlocal:8732`` which autobakes every second,
+  useable like geth development mode.
+- a local tezos indexer to use the contract history download() function.
+
+See documentation for **Example contract deployment** in each blockchain
+specific documentation pages for more pointers.
+
+Custom project
+--------------
+
+Instead of the demo project, you can also create your own project, instead of
+the first step of cloning do:
+
+* run ``django-admin startproject your_project_name``
+* in ``your_project_name/your_project_name/settings.py``, add to
+  ``INSTALLED_APPS``: ``'djwebdapp', 'djwebdapp_tezos',
+  'djwebdapp_ethereum'``... See ``djwebdapp_demo/settings.py`` for other
+  INSTALLED_APPS you can use
+* proceed with the next steps ``migrate`, ``createsuperuser``, ``runserver``
+  ...
+
+Tutorial
+--------
+
+Read documentation `online
+<https://djwebdapp.rtfd.io>`_ or in the ``docs/`` directory.

djwebdapp-0.6.8/README.rst

@@ -0,0 +1,122 @@
+djWebdApp
+~~~~~~~~~
+
+`**Documentation**
+<https://djwebdapp.rtfd.io>`_
+
+Django is a great web application framework "for perfectionists with deadlines".
+
+A dApp is an app running on the blockchain: a smart contract on which users can
+call functions on.
+
+This module provides blockchain support for Django, for reading and/or writing
+the blockchain, with the following features usable independently:
+
+* blockchain indexer
+* private key vault
+* blockchain writer
+* blockchain data normalization
+* multiple blockchain support (tezos & ethereum so far)
+* inter-blockchain contract synchronisation
+* metamask authentication backend (TBA)
+
+In addition to these features, djWebdApp differenciates itself from indexers
+like dipdup because it is extensible: it's just a module you add to your Django
+project like any other Django App, in which you can add models, endpoints, and
+have an admin interface for free, and so on, benefiting from the `vast Django
+ecosystem of apps <https://djangopackages.org/>`_.
+
+Video demos
+===========
+
+- `Tezos tutorial demo
+  <https://www.youtube.com/watch?v=quSX-gJ6eow>`_
+- `Ethereum tutorial demo
+  <https://www.youtube.com/watch?v=oTjvnjB_8Tc>`_
+
+Getting started
+===============
+
+Django basics
+-------------
+
+If you are not familiar with the Django development framework, it is
+recommended you follow `their tutorial first
+<https://docs.djangoproject.com/en/4.0/intro/tutorial01/>`_, even though you
+can go through this tutorial copy/pasting your way.
+
+You may use the demo project or create your own and install djwebdapp there.
+
+Install
+-------
+
+To install djwebdapp with all optional dependencies::
+
+    pip install djwebdapp[all][binary]
+
+Don't use ``[binary]`` right there if you prefer to install compiled python
+packages from your system package manager.
+
+See setup.py's extra_requires for other possibilities.
+
+Demo project
+------------
+
+For this tutorial, we'll use the ``djwebdapp_demo`` project:
+
+.. code-block:: bash
+
+    git clone https://yourlabs.io/oss/djwebdapp.git
+    cd djwebdapp
+    pip install --editable .[all][binary]
+    ./manage.py migrate
+    ./manage.py shell
+
+.. _Local blockchains:
+
+Local blockchains
+-----------------
+
+Instead of using mainnets for development, we're going to use a local
+blockchains, so that we can work completely locally.
+
+We provide a ``docker-compose.yml`` in the root directory of this repository,
+run ``docker-compose up`` to start it.
+
+As some of us will also want to convert this to `GitLab-CI
+services <https://docs.gitlab.com/ee/ci/services/>`_\ , we'll refer to our services
+by hostname from now on, which is why we add the following to
+``/etc/hosts``::
+
+   127.0.0.1 tzlocal tzkt-api ethlocal
+
+You should then have:
+
+- a local ethereum HTTP RPC API on ``ethlocal:8545`` with a WebSocket on
+  ``ethlocal:30303``,
+- a local tezos sandbox on ``tzlocal:8732`` which autobakes every second,
+  useable like geth development mode.
+- a local tezos indexer to use the contract history download() function.
+
+See documentation for **Example contract deployment** in each blockchain
+specific documentation pages for more pointers.
+
+Custom project
+--------------
+
+Instead of the demo project, you can also create your own project, instead of
+the first step of cloning do:
+
+* run ``django-admin startproject your_project_name``
+* in ``your_project_name/your_project_name/settings.py``, add to
+  ``INSTALLED_APPS``: ``'djwebdapp', 'djwebdapp_tezos',
+  'djwebdapp_ethereum'``... See ``djwebdapp_demo/settings.py`` for other
+  INSTALLED_APPS you can use
+* proceed with the next steps ``migrate`, ``createsuperuser``, ``runserver``
+  ...
+
+Tutorial
+--------
+
+Read documentation `online
+<https://djwebdapp.rtfd.io>`_ or in the ``docs/`` directory.

djwebdapp-0.6.8/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

djwebdapp-0.6.8/setup.py

@@ -0,0 +1,58 @@
+from setuptools import setup, find_packages
+
+
+extras_require = dict(
+    test=[
+        'django',
+        'djangorestframework',
+        'pytest',
+        'pytest-cov',
+        'pytest-django',
+        'web3>=6.7.0,<=6.20',
+        'eth-typing<5',
+    ],
+    ethereum=[
+        #'web3>=6.7.0',  # no [dev] for persistent deployments
+        'web3>=6.7.0,<=6.20',
+        'eth-typing<5',
+    ],
+    tezos=[
+        'pytezos>3.4',
+        'pymich>=0.9.8',
+    ],
+    binary=[
+        'pysodium',
+        'secp256k1',
+        'fastecdsa',
+    ],
+)
+
+extras_require['all'] = []
+for name, deps in extras_require.items():
+    if name == 'binary':
+        continue
+    extras_require['all'] += deps
+
+
+setup(
+    name='djwebdapp',
+    version='0.6.8',
+    setup_requires='setupmeta',
+    packages=find_packages('src'),
+    package_dir={'': 'src'},
+    install_requires=[
+        'django-model-utils',
+        'djfernet>=0.8.1',
+        'django-picklefield>=3.0.1',
+        'networkx==2.8.8',
+        'mnemonic',
+    ],
+    extras_require=extras_require,
+    author='James Pic',
+    author_email='jamespic@gmail.com',
+    url='https://yourlabs.io/oss/djwebdapp',
+    include_package_data=True,
+    license='MIT',
+    keywords='cli',
+    python_requires='>=3.8',
+)

djwebdapp-0.6.8/src/djwebdapp/admin.py

@@ -0,0 +1,104 @@
+from django.contrib import admin
+
+from .models import Account, Blockchain, Node, Transaction
+
+
+@admin.register(Account)
+class AccountAdmin(admin.ModelAdmin):
+    search_fields = (
+        'name',
+        'description',
+        'address',
+        'owner__username',
+    )
+    list_display = (
+        'address',
+        'name',
+        'balance',
+        'blockchain',
+        'last_level',
+    )
+    list_filter = (
+        'blockchain',
+        'revealed',
+    )
+    readonly_fields = (
+        'revealed',
+        'counter',
+        'last_level',
+    )
+
+    def get_queryset(self, qs):
+        return super().get_queryset(qs).select_related('owner')
+
+
+@admin.register(Blockchain)
+class BlockchainAdmin(admin.ModelAdmin):
+    search_fields = (
+        'name',
+        'description',
+    )
+    list_display = (
+        'name',
+        'is_active',
+        'min_level',
+        'index_level',
+    )
+    list_filter = (
+        'is_active',
+    )
+
+
+@admin.register(Node)
+class NodeAdmin(admin.ModelAdmin):
+    search_fields = (
+        'name',
+    )
+    list_display = (
+        'endpoint',
+        'priority',
+        'is_active',
+    )
+    list_filter = (
+        'is_active',
+        'blockchain',
+    )
+
+
+@admin.register(Transaction)
+class TransactionAdmin(admin.ModelAdmin):
+    search_fields = (
+        'name',
+        'description',
+        'function',
+        'hash',
+        'sender__address',
+        'sender__owner__username',
+        'receiver__address',
+        'receiver__owner__username',
+    )
+    list_display = (
+        'kind',
+        'function',
+        'state',
+        'name',
+        'hash',
+        'address',
+    )
+    list_filter = (
+        'kind',
+        'state',
+        'blockchain',
+        'created_at',
+        'updated_at',
+    )
+    readonly_fields = (
+        'gas',
+        'gasprice',
+        'level',
+        'last_fail',
+        'history',
+        'kind',
+        'error',
+        'has_code',
+    )

djwebdapp-0.6.8/src/djwebdapp/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+from django.utils.module_loading import autodiscover_modules
+
+
+class DjwebdappConfig(AppConfig):
+    name = 'djwebdapp'
+
+    def ready(self):
+        autodiscover_modules('normalizers')

djwebdapp-0.6.8/src/djwebdapp/exceptions.py

@@ -0,0 +1,13 @@
+
+
+class BaseException(Exception):
+    """ Base exception class for all exceptions of this package. """
+    pass
+
+
+class PermanentError(BaseException):
+    """ Raised when a transaction can not be deployed. """
+
+
+class TemporaryError(BaseException):
+    """ Raised when a transaction has not been deployed. """

djwebdapp-0.6.8/src/djwebdapp/management/commands/history_download.py

@@ -0,0 +1,29 @@
+from django.core.management.base import BaseCommand
+
+from djwebdapp.models import Blockchain
+
+
+class Command(BaseCommand):
+    help = '''
+    Import a contract from tzkt.
+
+    Example usage:
+
+        ./manage.py history_download 'Tezos Mainnet' <address>
+    '''
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            'blockchain',
+            type=str,
+            help='Name of the blockchain to import into'
+        )
+        parser.add_argument(
+            'target',
+            type=str,
+            help='Id of the contract to import',
+        )
+
+    def handle(self, *args, **options):
+        blockchain = Blockchain.objects.get(name=options['blockchain'])
+        blockchain.provider.download(target=options['target'])

djwebdapp-0.6.8/src/djwebdapp/management/commands/index.py

@@ -0,0 +1,19 @@
+from django.core.management.base import BaseCommand
+
+from djwebdapp.models import Blockchain
+
+
+class Command(BaseCommand):
+    help = 'Synchronize external transactions'
+
+    def handle(self, *args, **options):
+        for blockchain in Blockchain.objects.filter(is_active=True):
+            try:
+                blockchain.provider.logger.info(f'Indexing {blockchain}')
+                blockchain.provider.index()
+            except:  # noqa
+                blockchain.provider.logger.exception(
+                    f'{blockchain}.provider.index() failure!'
+                )
+        else:
+            print('Found 0 blockchain to index! check is_active')

djwebdapp-0.6.8/src/djwebdapp/management/commands/normalize.py

@@ -0,0 +1,19 @@
+from django.core.management.base import BaseCommand
+
+from djwebdapp.models import Blockchain
+
+
+class Command(BaseCommand):
+    help = 'Normalize indexed transactions'
+
+    def handle(self, *args, **options):
+        for blockchain in Blockchain.objects.filter(is_active=True):
+            try:
+                blockchain.provider.logger.info(f'Normalizing {blockchain}')
+                blockchain.provider.normalize()
+            except:  # noqa
+                blockchain.provider.logger.exception(
+                    f'{blockchain}.normalize() failure!'
+                )
+        else:
+            print('Found 0 blockchain to normalize! check is_active')

djwebdapp-0.6.8/src/djwebdapp/management/commands/refresh_balances.py

@@ -0,0 +1,15 @@
+from django.core.management.base import BaseCommand
+
+from djwebdapp.models import Blockchain
+
+
+class Command(BaseCommand):
+    help = 'Synchronize balance'
+
+    def handle(self, *args, **options):
+        for blockchain in Blockchain.objects.all():
+            for address in blockchain.account_set.all():
+                try:
+                    address.refresh_balance()
+                except Exception as exception:
+                    blockchain.provider.logger.exception(exception)

djwebdapp-0.6.8/src/djwebdapp/management/commands/spool.py

@@ -0,0 +1,16 @@
+from django.core.management.base import BaseCommand
+
+from djwebdapp.models import Blockchain
+
+
+class Command(BaseCommand):
+    help = 'Synchronize external transactions'
+
+    def handle(self, *args, **options):
+        for blockchain in Blockchain.objects.filter(is_active=True):
+            try:
+                blockchain.provider.spool()
+            except:  # noqa
+                blockchain.provider.logger.exception(
+                    f'{blockchain}.provider.spool() failure!'
+                )