Merge "origin/master" into "philip/bump-test-coverage"

USSD Hardening and Cleanups

See merge request grassrootseconomics/cic-internal-integration!320

CODE_OF_CONDUCT.md

@@ -1,6 +1,4 @@
-# Code of Conduct
+# Contributor Covenant Code of Conduct
-
-By contributing toward this project you agree to the following code of conduct
 
 ## Our Pledge
 
@@ -16,21 +14,21 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-- Using welcoming and inclusive language
+* Using welcoming and inclusive language
-- Being respectful of differing viewpoints and experiences
+* Being respectful of differing viewpoints and experiences
-- Gracefully accepting constructive criticism
+* Gracefully accepting constructive criticism
-- Focusing on what is best for the community
+* Focusing on what is best for the community
-- Showing empathy towards other community members
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-- The use of sexualized language or imagery and unwelcome sexual attention or
+* The use of sexualized language or imagery and unwelcome sexual attention or
   advances
-- Trolling, insulting/derogatory comments, and personal or political attacks
+* Trolling, insulting/derogatory comments, and personal or political attacks
-- Public or private harassment
+* Public or private harassment
-- Publishing others' private information, such as a physical or electronic
+* Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
+* Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -57,7 +55,7 @@ a project may be further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at info@grassecon.org . All
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -77,8 +75,9 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
 
+
+
+
 ...Try to keep in mind the immortal
 words of Bill and Ted, "Be excellent to each other."
 
-These documents are licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) https://creativecommons.org/licenses/by-sa/4.0/
-And further any software Grassrotos Economics supports is under licenced under GNU GENERAL PUBLIC LICENSE Version 3 https://www.gnu.org/licenses/

CONTRIBUTING.md

@@ -1,66 +1,16 @@
-# Contribution Guidelines
+Hello and welcome to the CIC Stack repository. Targeted for use with the ethereum virtual machine and a ussd capable telecom provider. 
 
-**Karibu sana!** Hello and welcome to the Grassroots Economics [project](https://gitlab.com/grassrootseconomics). This guide will help you understand the overall
+__To request a change to the code please fork this repository and sumbit a merge request.__
-organization of the CIC project to get you started with contributing to the project. You'll be able to pick up issues, write code to fix them, and get your work reviewed and merged.
 
-## Table of Contents
+__If there is a Grassroots Economics Kanban Issue please include that in our MR it will help us track contributions. Karibu sana!__
 
-- [Prerequisites](#Prerequisites)
+__Visit the Development Kanban board here: https://gitlab.com/grassrootseconomics/cic-internal-integration/-/boards/2419764__
-- [Scope of contributions](#Scope-of-contributions)
-- [Issues](#Issues)
-  - [Bugs](#Bugs)
-  - [Good first issues](#Good-first-issues)
-- [Git guidelines](#Git-guidelines)
-- [Merge request processs](#Merge-request-processs)
-- [Environment setup](#Environment-setup)
-- [Code style](#Code-style)
-- [Building-and-testing](#Building-and-testing)
 
-## Prerequisites
+__Ask a question in our dev chat:__
 
-Before contributing to the CIC Stack, ensure you have:
+[Mattermost](https://chat.grassrootseconomics.net/cic/channels/dev)
 
-- Read and accepted to abide by the Code of Conduct
+[Discord](https://discord.gg/XWunwAsX)
-<!-- TODO: Add link to CoC -->
-- Read and accepted the Developers Certificate of Origin
-<!-- TODO: Add link to DCO -->
 
-## Scope of contributions
+[Matrix, IRC soon?]
 
-We generally welcome all sorts or contributions. No contribution is too small. We gladly accept contributions such as:
-
-- Documentation improvements including inline documentation or even minor typos
-- Answering questions in issue discussions and pull requests
-- Fixing known bugs on our issue tracker
-- Reporting unknown bugs
-<!-- TODO: Add resposible disclosure guidelines -->
-- Securty issues through responsible disclosure
-
-## Issues
-
-Use the existing issue template and issue tags to correctly catagorize and issue when creating issues. Make sure to search for duplicated before creating a new issue.
-
-### Bugs
-
-If a bug is encountered and you can reproduce it:
-
-- Define its priority with an issue tag
-- Describe the steps to reproduce it while providing the version of the bugged service/library and your environment setup
-
-### Good first issues
-
-These are pre-tagged issues which are friendly (low barrier to entry and clearly defined tasks) for new contributors to get aquinted to the project.
-
-## Git guideleines
-
-<!-- TODO: Review after finalzing branching or forking model -->
-
-## Merge request process
-
-<!-- TODO: Review after core_contrib -->
-
-## Environment setup
-
-## Code style
-
-## Building and testing

CONTRIBUTING_CORE.md

@@ -0,0 +1,117 @@
+# CORE TEAM CONTRIBUTION GUIDE
+
+# 1. Transparency
+
+1.1 Use work logs for reflection of work done, aswell as telling your peers about changes that may affect their own tasks
+
+1.2 A work log SHOULD be submitted after a "unit of work" is complete.
+
+1.2.1 A "unit of work" should not span more than one full day's worth of work.
+
+1.2.2 A "unit of work" should be small enough that the log entries give useful insight.
+
+1.3 Individual logs are reviewed in weekly meetings
+
+<!--1.4 Bullet point list of topics and one or more sub-points describing each item in short sentences, eg;
+
+```
+- Core
+	* fixed foo
+	* fixed bar
+- Frontend
+	* connected bar to baz
+
+```-->
+
+1.4 Work log format is defined in []()
+
+1.5 Link to issue/MR in bullet point where appropriate
+
+1.6 
+
+
+# 2. Code hygiene
+
+2.1 Keep function names and variable names short
+
+2.2 Keep code files, functions and test fixtures short
+
+2.3 The less magic the better. Recombinable and replaceable is king
+
+2.4 Group imports by `standard`, `external`, `local`, `test` - in that order
+
+2.5 Only auto-import when necessary, and always with a minimum of side-effects
+
+2.6 Use custom errors. Let them bubble up
+
+2.7 No logs in tight loops
+
+2.8 Keep executable main routine minimal. Pass variables (do not use globals) in main business logic function
+
+2.9 Test coverage MUST be kept higher than 90% after changes
+
+2.10 Docstrings. Always. Always!
+
+
+# 3. Versioning
+
+3.1 Use [Semantic Versioning](https://semver.org/)
+
+3.2 When merging code, explicit dependencies SHOULD NOT use pre-release version
+
+
+# 4. Issues
+
+4.1 Issue title should use [Convention Commit structure](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
+
+4.2 Issues need proper problem statement
+
+4.2.1. What is the current state
+
+4.2.2. If current state is not behaving as expected, what was the expected state
+
+4.2.3. What is the desired new state.
+
+4.3  Issues need proper resolution statement
+
+4.3.1. Bullet point list of short sentences describing practical steps to reach desired state
+		
+4.3.2. Builet point list of external resources informing the issue and resolution
+
+4.4 Tasks needs to be appropriately labelled using GROUP labels.
+
+
+# 5. Code submission
+
+5.1 A branch and new MR is always created BEFORE THE WORK STARTS
+
+5.2 An MR should solve ONE SINGLE PART of a problem
+
+5.3 Every MR should have at least ONE ISSUE associated with it. Ideally issue can be closed when MR is merged
+
+5.4 MRs should not be open for more than one week (during normal operation periods)
+
+5.5 MR should ideally not be longer than 400 lines of changes of logic
+
+5.6 MRs that MOVE or DELETE code should not CHANGE that same code in a single MR. Scope MOVEs and DELETEs in separate commits (or even better, separate MRs) for transparency
+
+
+# 6. Code reviews
+
+6.1 At least one peer review before merge
+
+6.2 If MR is too long, evaluate whether this affects the quality of the review negatively. If it does, expect to be asked to split it up
+
+6.3 Evaluate changes against associated issues' problem statement and proposed resolution steps. If there is a mismatch, either MR needs to change or issue needs to be amended accordingly
+
+6.4 Make sure all technical debt introduced by MR is documented in issues. Add them according to criteria in section ISSUES if not
+
+6.5 If CI is not working, reviewer MUST make sure code builds and runs
+
+6.6 Behave!
+
+6.6.1 Don't be a jerk
+
+6.6.2 Don't block needlessly
+
+6.6.3 Say please

README.md

@@ -1,24 +1,19 @@
-## Community Inclusion Currency Stack (CIC Stack)
+# Community Inclusion Currency Stack (CIC Stack) 
 
-A custodial wallet and blockchain bidirectional interface engine for community inclusion currencies. Check the [CIC Stack summary](https://docs.grassecon.org/software) page for more information.
+A custodial evm wallet for executing transactions via USSD
 
-### Contributing
+## Getting started 
 
-See our [contribution guidelines](https://docs.grassecon.org/community/contrib/) for more details on:
+This repo uses docker-compose and docker buildkit. Set the following environment variables to get started:
 
-- Environment setup
+```
-- Source Code Management (SCM) guidelines
+export COMPOSE_DOCKER_CLI_BUILD=1
-- Filing issues
+export DOCKER_BUILDKIT=1
+```
 
-#### Code of Conduct
+To get started see [./apps/contract-migration/README.md](./apps/contract-migration/README.md)
 
-This project is released with a [Code of Conduct](https://docs.grassecon.org/community/conduct/). By participating in this project you agree to abide by its terms.
+## Documentation 
 
-### Community
+[https://docs.grassecon.org/cic_stack/](https://docs.grassecon.org/cic_stack/)
 
-- [Mattermost](https://chat.grassrootseconomics.net/cic/channels/dev)
-- [Discord](https://discord.gg/ud32KMgH76)
-
-### License
-
-Licensed under [GNU AGPLv3](https://gitlab.com/grassrootseconomics/cic-internal-integration/-/blob/master/LICENSE).

apps/cic-cache/MANIFEST.in

@@ -1 +1 @@
-include *requirements.txt cic_cache/data/config/*
+include *requirements.txt cic_cache/data/config/* cic_cache/db/migrations/default/* cic_cache/db/migrations/default/versions/*

apps/cic-cache/cic_cache/data/config/cic.ini

@@ -1,4 +1,4 @@
 [cic]
 registry_address = 
 trust_address =
-health_modules = cic_eth.check.db,cic_eth.check.redis,cic_eth.check.signer,cic_eth.check.gas
+health_modules =

apps/cic-cache/cic_cache/data/config/database.ini

@@ -3,7 +3,8 @@ engine =
 driver =
 host =
 port =
-name = cic-cache
+#name = cic-cache
+prefix =
 user =
 password =
 debug = 0

apps/cic-cache/cic_cache/db/__init__.py

@@ -9,21 +9,26 @@ from .list import (
         tag_transaction,
         add_tag,
     )
+from cic_cache.db.models.base import SessionBase
 
 
 logg = logging.getLogger()
 
 
-def dsn_from_config(config):
+def dsn_from_config(config, name):
     scheme = config.get('DATABASE_ENGINE')
     if config.get('DATABASE_DRIVER') != None:
         scheme += '+{}'.format(config.get('DATABASE_DRIVER'))
 
+    database_name = name
+    if config.get('DATABASE_PREFIX'):
+        database_name = '{}_{}'.format(config.get('DATABASE_PREFIX'), database_name)
     dsn = ''
     if config.get('DATABASE_ENGINE') == 'sqlite':
+        SessionBase.poolable = False
         dsn = '{}:///{}'.format(
                 scheme,
-                config.get('DATABASE_NAME'),    
+                database_name,
             )
 
     else:
@@ -33,7 +38,7 @@ def dsn_from_config(config):
                 config.get('DATABASE_PASSWORD'),
                 config.get('DATABASE_HOST'),
                 config.get('DATABASE_PORT'),
-                config.get('DATABASE_NAME'),    
+                database_name,
             )
     logg.debug('parsed dsn from config: {}'.format(dsn))
     return dsn

apps/cic-cache/cic_cache/runnable/daemons/query.py

@@ -5,7 +5,11 @@ import re
 import base64
 
 # external imports
-from hexathon import add_0x
+from hexathon import (
+        add_0x,
+        strip_0x,
+        )
+from chainlib.encode import TxHexNormalizer
 
 # local imports
 from cic_cache.cache import (
@@ -16,27 +20,72 @@ from cic_cache.cache import (
 logg = logging.getLogger(__name__)
 #logg = logging.getLogger()
 
-re_transactions_all_bloom = r'/tx/(\d+)?/?(\d+)/?'
+re_transactions_all_bloom = r'/tx/?(\d+)?/?(\d+)?/?(\d+)?/?(\d+)?/?'
 re_transactions_account_bloom = r'/tx/user/((0x)?[a-fA-F0-9]+)(/(\d+)(/(\d+))?)?/?'
-re_transactions_all_data = r'/txa/(\d+)?/?(\d+)/?'
+re_transactions_all_data = r'/txa/?(\d+)?/?(\d+)?/?(\d+)?/?(\d+)?/?'
+re_transactions_account_data = r'/txa/user/((0x)?[a-fA-F0-9]+)(/(\d+)(/(\d+))?)?/?'
+re_default_limit = r'/defaultlimit/?'
 
 DEFAULT_LIMIT = 100
 
+tx_normalize = TxHexNormalizer()
+
+def parse_query_account(r):
+    address = strip_0x(r[1])
+    #address = tx_normalize.wallet_address(address)
+    limit = DEFAULT_LIMIT
+    g = r.groups()
+    if len(g) > 3:
+        limit = int(r[4])
+        if limit == 0:
+            limit = DEFAULT_LIMIT
+    offset = 0
+    if len(g) > 4:
+        offset = int(r[6])
+
+    logg.debug('account query is address {} offset {} limit {}'.format(address, offset, limit))
+
+    return (address, offset, limit,)
+
+
+# r is an re.Match
+def parse_query_any(r):
+    limit = DEFAULT_LIMIT
+    offset = 0
+    block_offset = None
+    block_end = None
+    if r.lastindex != None:
+        if r.lastindex > 0:
+            limit = int(r[1])
+        if r.lastindex > 1:
+            offset = int(r[2])
+        if r.lastindex > 2:
+            block_offset = int(r[3])
+        if r.lastindex > 3:
+            block_end = int(r[4])
+            if block_end < block_offset:
+                raise ValueError('cart before the horse, dude')
+
+    logg.debug('data query is offset {} limit {} block_offset {} block_end {}'.format(offset, limit, block_offset, block_end))
+
+    return (offset, limit, block_offset, block_end,)
+
+
+def process_default_limit(session, env):
+    r = re.match(re_default_limit, env.get('PATH_INFO'))
+    if not r:
+        return None
+
+    return ('application/json', str(DEFAULT_LIMIT).encode('utf-8'),)
+
 
 def process_transactions_account_bloom(session, env):
     r = re.match(re_transactions_account_bloom, env.get('PATH_INFO'))
     if not r:
         return None
+    logg.debug('match account bloom')
 
-    address = r[1]
+    (address, offset, limit,) = parse_query_account(r)
-    if r[2] == None:
-        address = add_0x(address)
-    offset = 0
-    if r.lastindex > 2:
-        offset = r[4]
-    limit = DEFAULT_LIMIT
-    if r.lastindex > 4:
-        limit = r[6]
 
     c = BloomCache(session)
     (lowest_block, highest_block, bloom_filter_block, bloom_filter_tx) = c.load_transactions_account(address, offset, limit)
@@ -59,13 +108,9 @@ def process_transactions_all_bloom(session, env):
     r = re.match(re_transactions_all_bloom, env.get('PATH_INFO'))
     if not r:
         return None
+    logg.debug('match all bloom')
 
-    offset = DEFAULT_LIMIT
+    (limit, offset, block_offset, block_end,) = parse_query_any(r)
-    if r.lastindex > 0:
-        offset = r[1]
-    limit = 0
-    if r.lastindex > 1:
-        limit = r[2]
 
     c = BloomCache(session)
     (lowest_block, highest_block, bloom_filter_block, bloom_filter_tx) = c.load_transactions(offset, limit)
@@ -88,17 +133,16 @@ def process_transactions_all_data(session, env):
     r = re.match(re_transactions_all_data, env.get('PATH_INFO'))
     if not r:
         return None
-    if env.get('HTTP_X_CIC_CACHE_MODE') != 'all':
+    #if env.get('HTTP_X_CIC_CACHE_MODE') != 'all':
-        return None
+    #    return None
+    logg.debug('match all data')
 
     logg.debug('got data request {}'.format(env))
-    block_offset = r[1]
+
-    block_end = r[2]
+    (offset, limit, block_offset, block_end) = parse_query_any(r)
-    if int(r[2]) < int(r[1]):
-        raise ValueError('cart before the horse, dude')
 
     c = DataCache(session)
-    (lowest_block, highest_block, tx_cache) = c.load_transactions_with_data(0, 0, block_offset, block_end, oldest=True) # oldest needs to be settable
+    (lowest_block, highest_block, tx_cache) = c.load_transactions_with_data(offset, limit, block_offset, block_end, oldest=True) # oldest needs to be settable
 
     for r in tx_cache:
         r['date_block'] = r['date_block'].timestamp()
@@ -113,3 +157,30 @@ def process_transactions_all_data(session, env):
     j = json.dumps(o)
 
     return ('application/json', j.encode('utf-8'),)
+
+
+def process_transactions_account_data(session, env):
+    r = re.match(re_transactions_account_data, env.get('PATH_INFO'))
+    if not r:
+        return None
+    logg.debug('match account data')
+    #if env.get('HTTP_X_CIC_CACHE_MODE') != 'all':
+    #    return None
+
+    (address, offset, limit,) = parse_query_account(r)
+
+    c = DataCache(session)
+    (lowest_block, highest_block, tx_cache) = c.load_transactions_account_with_data(address, offset, limit)
+
+    for r in tx_cache:
+        r['date_block'] = r['date_block'].timestamp()
+
+    o = {
+        'low': lowest_block,
+        'high': highest_block,
+        'data': tx_cache,
+    }
+
+    j = json.dumps(o)
+
+    return ('application/json', j.encode('utf-8'),)

apps/cic-cache/cic_cache/runnable/daemons/server.py

@@ -12,21 +12,20 @@ import cic_cache.cli
 from cic_cache.db import dsn_from_config
 from cic_cache.db.models.base import SessionBase
 from cic_cache.runnable.daemons.query import (
+        process_default_limit,
         process_transactions_account_bloom,
+        process_transactions_account_data,
         process_transactions_all_bloom,
         process_transactions_all_data,
         )
+import cic_cache.cli
 
 logging.basicConfig(level=logging.WARNING)
 logg = logging.getLogger()
 
-rootdir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
-dbdir = os.path.join(rootdir, 'cic_cache', 'db')
-migrationsdir = os.path.join(dbdir, 'migrations')
 
-# process args
+arg_flags = cic_cache.cli.argflag_std_read
-arg_flags = cic_cache.cli.argflag_std_base
+local_arg_flags = cic_cache.cli.argflag_local_sync | cic_cache.cli.argflag_local_task 
-local_arg_flags = cic_cache.cli.argflag_local_task
 argparser = cic_cache.cli.ArgumentParser(arg_flags)
 argparser.process_local_flags(local_arg_flags)
 args = argparser.parse_args()
@@ -35,7 +34,7 @@ args = argparser.parse_args()
 config = cic_cache.cli.Config.from_args(args, arg_flags, local_arg_flags)
 
 # connect to database
-dsn = dsn_from_config(config)
+dsn = dsn_from_config(config, 'cic_cache')
 SessionBase.connect(dsn, config.true('DATABASE_DEBUG'))
 
 
@@ -47,9 +46,11 @@ def application(env, start_response):
 
     session = SessionBase.create_session()
     for handler in [
+            process_transactions_account_data,
+            process_transactions_account_bloom,
             process_transactions_all_data,
             process_transactions_all_bloom,
-            process_transactions_account_bloom,
+            process_default_limit,
             ]:
         r = None
         try:

apps/cic-cache/cic_cache/runnable/daemons/tasker.py

@@ -3,6 +3,7 @@ import logging
 import os
 import sys
 import argparse
+import tempfile
 
 # third-party imports
 import celery
@@ -28,7 +29,7 @@ args = argparser.parse_args()
 config = cic_cache.cli.Config.from_args(args, arg_flags, local_arg_flags)
 
 # connect to database
-dsn = dsn_from_config(config)
+dsn = dsn_from_config(config, 'cic_cache')
 SessionBase.connect(dsn)
 
 # set up celery

apps/cic-cache/cic_cache/runnable/daemons/tracker.py

@@ -50,7 +50,7 @@ args = argparser.parse_args()
 config = cic_cache.cli.Config.from_args(args, arg_flags, local_arg_flags)
 
 # connect to database
-dsn = dsn_from_config(config)
+dsn = dsn_from_config(config, 'cic_cache')
 SessionBase.connect(dsn, debug=config.true('DATABASE_DEBUG'))
 
 # set up rpc

apps/cic-cache/cic_cache/version.py

@@ -5,7 +5,7 @@ version = (
         0,
         2,
         1,
-        'alpha.2',
+        'alpha.3',
         )
 
 version_object = semver.VersionInfo(

apps/cic-cache/config/celery.ini

@@ -1,3 +0,0 @@
-[celery]
-broker_url = redis:///
-result_url = redis:///

apps/cic-cache/config/cic.ini

@@ -1,3 +0,0 @@
-[cic]
-registry_address = 
-trust_address = 

apps/cic-cache/config/database.ini

@@ -1,9 +0,0 @@
-[database]
-NAME=cic_cache
-USER=postgres
-PASSWORD=
-HOST=localhost
-PORT=5432
-ENGINE=postgresql
-DRIVER=psycopg2
-DEBUG=0

apps/cic-cache/config/docker/celery.ini

@@ -1,3 +0,0 @@
-[celery]
-broker_url = redis://localhost:63379
-result_url = redis://localhost:63379

apps/cic-cache/config/docker/cic.ini

@@ -1,3 +0,0 @@
-[cic]
-registry_address =  
-trust_address = 0xEb3907eCad74a0013c259D5874AE7f22DcBcC95C

apps/cic-cache/config/docker/database.ini

@@ -1,9 +0,0 @@
-[database]
-NAME=cic_cache
-USER=grassroots
-PASSWORD=
-HOST=localhost
-PORT=63432
-ENGINE=postgresql
-DRIVER=psycopg2
-DEBUG=0

apps/cic-cache/config/docker/syncer.ini

@@ -1,4 +0,0 @@
-[syncer]
-loop_interval = 1
-offset = 0
-no_history = 0

apps/cic-cache/config/test/bancor.ini

@@ -1,2 +0,0 @@
-[bancor]
-dir =

apps/cic-cache/config/test/cic.ini

@@ -1,4 +1,3 @@
 [cic]
 registry_address = 
-chain_spec = 
 trust_address =

apps/cic-cache/config/test/database.ini

@@ -1,5 +1,5 @@
 [database]
-NAME=cic-cache-test
+PREFIX=cic-cache-test
 USER=postgres
 PASSWORD=
 HOST=localhost

apps/cic-cache/config/test/eth.ini

@@ -1,5 +0,0 @@
-[eth]
-#ws_provider = ws://localhost:8546
-#ttp_provider = http://localhost:8545
-provider = http://localhost:8545
-#chain_id = 

apps/cic-cache/doc/openapi/server.yml

@@ -1,4 +1,4 @@
-openapi: "3.0.3"
+openapi: "3.0.2"
 info:
   title: Grassroots Economics CIC Cache
   description: Cache of processed transaction data from Ethereum blockchain and worker queues
@@ -9,17 +9,34 @@ info:
     email: will@grassecon.org
   license:
     name: GPLv3
-  version: 0.1.0
+  version: 0.2.0
 
 paths:
-  /tx/{offset}/{limit}:
+  /defaultlimit:
-    description: Bloom filter for batch of latest transactions
+    summary: The default limit value of result sets.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve default limit
+      operationId: limit.default
+      responses:
+        200:
+          description: Limit query successful
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Limit"
+
+  /tx:
+    summary: Bloom filter for batch of latest transactions
+    description: Generate a bloom filter of the latest transactions in the cache. The number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
     get:
       tags:
         - transactions
       description:
         Retrieve transactions
-      operationId: tx.get
+      operationId: tx.get.latest
       responses:
         200:
           description: Transaction query successful.
@@ -29,27 +46,153 @@ paths:
                 $ref: "#/components/schemas/BlocksBloom"
 
 
-    parameters:
+  /tx/{limit}:
-    - name: offset
+    summary: Bloom filter for batch of latest transactions
-      in: path
+    description: Generate a bloom filter of the latest transactions in the cache. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
-      schema:
-        type: integer
-        format: int32
-    - name: limit
-      in: path
-      schema:
-        type: integer
-        format: int32
-
-
-  /tx/{address}/{offset}/{limit}:
-    description: Bloom filter for batch of latest transactions by account
     get:
       tags:
         - transactions
       description:
         Retrieve transactions
-      operationId: tx.get
+      operationId: tx.get.latest.limit
+      responses:
+        200:
+          description: Transaction query successful. Results are ordered from newest to oldest.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BlocksBloom"
+    parameters:
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /tx/{limit}/{offset}:
+    summary: Bloom filter for batch of latest transactions
+    description: Generate a bloom filter of the latest transactions in the cache. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: tx.get.latest.range
+      responses:
+        200:
+          description: Transaction query successful. Results are ordered from newest to oldest.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BlocksBloom"
+    parameters:
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /tx/{limit}/{offset}/{block_offset}:
+    summary: Bloom filter for batch of transactions since a particular block.
+    description: Generate a bloom filter of the latest transactions since a particular block in the cache. The block parameter is inclusive. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: tx.get.latest.range.block.offset
+      responses:
+        200:
+          description: Transaction query successful. Results are ordered from oldest to newest.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BlocksBloom"
+
+    parameters:
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: block_offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /tx/{limit}/{offset}/{block_offset}/{block_end}:
+    summary: Bloom filter for batch of transactions within a particular block range.
+    description: Generate a bloom filter of the latest transactions within a particular block range in the cache. The block parameters are inclusive. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: tx.get.latest.range.block.range
+      responses:
+        200:
+          description: Transaction query successful.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BlocksBloom"
+
+    parameters:
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: block_offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: block_end
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /tx/{address}:
+    summary: Bloom filter for batch of latest transactions by account.
+    description: Generate a bloom filter of the latest transactions where a specific account is the spender or beneficiary.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: tx.get.user
       responses:
         200:
           description: Transaction query successful. 
@@ -58,6 +201,30 @@ paths:
               schema:
                 $ref: "#/components/schemas/BlocksBloom"
 
+    parameters:
+    - name: address
+      in: path
+      required: true
+      schema:
+        type: string
+
+
+  /tx/{address}/{limit}:
+    summary: Bloom filter for batch of latest transactions by account.
+    description: Generate a bloom filter of the latest transactions where a specific account is the spender or beneficiary. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: tx.get.user.limit
+      responses:
+        200:
+          description: Transaction query successful. 
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BlocksBloom"
 
     parameters:
     - name: address
@@ -65,26 +232,317 @@ paths:
       required: true
       schema:
         type: string
-    - name: offset
-      in: path
-      schema:
-        type: integer
-        format: int32
     - name: limit
       in: path
+      required: true
       schema:
         type: integer
         format: int32
 
+
+  /tx/{address}/{limit}/{offset}:
+    summary: Bloom filter for batch of latest transactions by account
+    description: Generate a bloom filter of the latest transactions where a specific account is the spender or beneficiary. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: tx.get.user.range
+      responses:
+        200:
+          description: Transaction query successful. 
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BlocksBloom"
+
+    parameters:
+    - name: address
+      in: path
+      required: true
+      schema:
+        type: string
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /txa:
+    summary: Cached data for latest transactions.
+    description: Return data entries of the latest transactions in the cache. The number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: txa.get.latest
+      responses:
+        200:
+          description: Transaction query successful.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionList"
+
+    
+  /txa/{limit}:
+    summary: Cached data for latest transactions.
+    description: Return data entries of the latest transactions in the cache. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: txa.get.latest.limit
+      responses:
+        200:
+          description: Transaction query successful.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionList"
+
+    parameters:
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /txa/{limit}/{offset}:
+    summary: Cached data for latest transactions.
+    description: Return data entries of the latest transactions in the cache. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: txa.get.latest.range
+      responses:
+        200:
+          description: Transaction query successful.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionList"
+
+    parameters:
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /txa/{limit}/{offset}/{block_offset}:
+    summary: Cached data for transactions since a particular block.
+    description: Return cached data entries of transactions since a particular block. The block parameter is inclusive. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: txa.get.latest.range.block.offset
+      responses:
+        200:
+          description: Transaction query successful.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionList"
+
+    parameters:
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: block_offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+  /txa/{limit}/{offset}/{block_offset}/{block_end}:
+    summary: Cached data for transactions within a particular block range.
+    description: Return cached data entries of transactions within a particular block range in the cache. The block parameters are inclusive. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: txa.get.latest.range.block.range
+      responses:
+        200:
+          description: Transaction query successful.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionList"
+
+    parameters:
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: block_offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: block_end
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /txa/{address}:
+    summary: Cached data for batch of latest transactions by account.
+    description: Return cached data of the latest transactions where a specific account is the spender or beneficiary.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: txa.get.user
+      responses:
+        200:
+          description: Transaction query successful. 
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionList"
+
+    parameters:
+    - name: address
+      in: path
+      required: true
+      schema:
+        type: string
+
+
+  /txa/{address}/{limit}:
+    summary: Cached data for batch of latest transactions by account.
+    description: Return cached data of the latest transactions where a specific account is the spender or beneficiary. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: txa.get.user.limit
+      responses:
+        200:
+          description: Transaction query successful. 
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionList"
+
+    parameters:
+    - name: address
+      in: path
+      required: true
+      schema:
+        type: string
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
+  /txa/{address}/{limit}/{offset}:
+    summary: Cached data for batch of latest transactions by account.
+    description: Return cached data of the latest transactions where a specific account is the spender or beneficiary. If `limit` is 0, the number of maximum number of transactions returned is returned by the `/defaultlimit` API call.
+    get:
+      tags:
+        - transactions
+      description:
+        Retrieve transactions
+      operationId: txa.get.user.range
+      responses:
+        200:
+          description: Transaction query successful. 
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionList"
+
+    parameters:
+    - name: address
+      in: path
+      required: true
+      schema:
+        type: string
+    - name: limit
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+    - name: offset
+      in: path
+      required: true
+      schema:
+        type: integer
+        format: int32
+
+
 components:
   schemas:
+    Limit:
+      type: integer
+      format: int32
     BlocksBloom:
       type: object
       properties:
         low:
-          type: int
+          type: integer
           format: int32
           description: The lowest block number included in the filter
+        high:
+          type: integer
+          format: int32
+          description: The highest block number included in the filter
         block_filter:
           type: string
           format: byte
@@ -97,6 +555,89 @@ components:
           type: string
           description: Hashing algorithm (currently only using sha256)
         filter_rounds:
-          type: int
+          type: integer
           format: int32
           description: Number of hash rounds used to create the filter
+    TransactionList:
+      type: object
+      properties:
+        low:
+          type: integer
+          format: int32
+          description: The lowest block number included in the result set
+        high:
+          type: integer
+          format: int32
+          description: The highest block number included in the filter
+        data:
+          type: array
+          description: Cached transaction data
+          items:
+            $ref: "#/components/schemas/Transaction"
+    Transaction:
+      type: object
+      properties:
+        block_number:
+          type: integer
+          format: int64
+          description: Block number transaction was included in.
+        tx_hash:
+          type: string
+          description: Transaction hash, in hex.
+        date_block:
+          type: integer
+          format: int32
+          description: Block timestamp.
+        sender:
+          type: string
+          description: Spender address, in hex.
+        recipient:
+          type: string
+          description: Beneficiary address, in hex.
+        from_value:
+          type: integer
+          format: int64
+          description: Value deducted from spender's balance.
+        to_value:
+          type: integer
+          format: int64
+          description: Value added to beneficiary's balance.
+        source_token:
+          type: string
+          description: Network address of token in which `from_value` is denominated.
+        destination_token:
+          type: string
+          description: Network address of token in which `to_value` is denominated.
+        success:
+          type: boolean
+          description: Network consensus state on whether the transaction was successful or not.
+        tx_type:
+          type: string
+          enum:
+            - erc20.faucet
+            - faucet.give_to
+
+  examples:
+    data_last:
+      summary: Get the latest cached transactions, using the server's default limit. 
+      value: "/txa"
+
+    data_limit:
+      summary: Get the last 42 cached transactions. 
+      value: "/txa/42"
+
+    data_range:
+      summary: Get the next 42 cached transactions, starting from the 13th (zero-indexed).
+      value: "/txa/42/13"
+
+    data_range_block_offset:
+      summary: Get the next 42 cached transactions, starting from block 1337 (inclusive).
+      value: "/txa/42/0/1337"
+
+    data_range_block_offset:
+      summary: Get the next 42 cached transactions within blocks 1337 and 1453 (inclusive).
+      value: "/txa/42/0/1337/1453"
+
+    data_range_block_range:
+      summary: Get the next 42 cached transactions after the 13th, within blocks 1337 and 1453 (inclusive).
+      value: "/txa/42/13/1337/1453"

apps/cic-cache/docker/Dockerfile

@@ -4,9 +4,9 @@ FROM $DOCKER_REGISTRY/cic-base-images:python-3.8.6-dev-e8eb2ee2
 
 COPY requirements.txt .
 
-ARG EXTRA_PIP_INDEX_URL="https://pip.grassrootseconomics.net"
+ARG EXTRA_PIP_INDEX_URL=https://pip.grassrootseconomics.net
 ARG EXTRA_PIP_ARGS=""
-ARG PIP_INDEX_URL="https://pypi.org/simple"
+ARG PIP_INDEX_URL=https://pypi.org/simple
 
 RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
     pip install --index-url $PIP_INDEX_URL \
@@ -14,14 +14,9 @@ RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
     --extra-index-url $EXTRA_PIP_INDEX_URL $EXTRA_PIP_ARGS \
     -r requirements.txt
 
-COPY . . 
 
-RUN python setup.py install
+COPY . .
-
+RUN pip install .  --extra-index-url $EXTRA_PIP_INDEX_URL
-# ini files in config directory defines the configurable parameters for the application
-# they can all be overridden by environment variables
-# to generate a list of environment variables from configuration, use: confini-dump -z <dir> (executable provided by confini package)
-#COPY config/ /usr/local/etc/cic-cache/
 
 # for db migrations
 COPY ./aux/wait-for-it/wait-for-it.sh ./

apps/cic-cache/docker/db.sh

@@ -2,5 +2,5 @@
 
 set -e
 >&2 echo executing database migration
-python scripts/migrate.py --migrations-dir /usr/local/share/cic-cache/alembic -vv
+python scripts/migrate_cic_cache.py --migrations-dir /usr/local/share/cic-cache/alembic -vv
 set +e

apps/cic-cache/requirements.txt

@@ -1,14 +1,15 @@
 alembic==1.4.2
-confini>=0.3.6rc4,<0.5.0
+confini~=0.5.3
 uwsgi==2.0.19.1
-moolb~=0.1.1b2
+moolb~=0.2.0
-cic-eth-registry~=0.6.1a1
+cic-eth-registry~=0.6.6
 SQLAlchemy==1.3.20
 semver==2.13.0
 psycopg2==2.8.6
 celery==4.4.7
 redis==3.5.3
-chainsyncer[sql]>=0.0.6a3,<0.1.0
+chainsyncer[sql]~=0.0.7
-erc20-faucet>=0.3.2a2, <0.4.0
+erc20-faucet~=0.3.2
-chainlib-eth>=0.0.9a14,<0.1.0
+chainlib-eth~=0.0.15
-eth-address-index>=0.2.3a4,<0.3.0
+eth-address-index~=0.2.4
+okota~=0.2.5

apps/cic-cache/scripts/migrate_cic_cache.py

@@ -1,54 +1,55 @@
-#!/usr/bin/python
+#!/usr/bin/python3
+
+# standard imports
 import os
 import argparse
 import logging
 import re
 
+# external imports
 import alembic
 from alembic.config import Config as AlembicConfig
 import confini
 
+# local imports
 from cic_cache.db import dsn_from_config
+import cic_cache.cli
 
 logging.basicConfig(level=logging.WARNING)
 logg = logging.getLogger()
 
 # BUG: the dbdir doesn't work after script install
-rootdir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+rootdir = os.path.dirname(os.path.dirname(os.path.realpath(cic_cache.__file__)))
 dbdir = os.path.join(rootdir, 'cic_cache', 'db')
-migrationsdir = os.path.join(dbdir, 'migrations')
+default_migrations_dir = os.path.join(dbdir, 'migrations')
 configdir = os.path.join(rootdir, 'cic_cache', 'data', 'config')
 
 #config_dir = os.path.join('/usr/local/etc/cic-cache')
 
-argparser = argparse.ArgumentParser()
+arg_flags = cic_cache.cli.argflag_std_base
-argparser.add_argument('-c', type=str, help='config file')
+local_arg_flags = cic_cache.cli.argflag_local_sync
-argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration')
+argparser = cic_cache.cli.ArgumentParser(arg_flags)
-argparser.add_argument('--migrations-dir', dest='migrations_dir', default=migrationsdir, type=str, help='path to alembic migrations directory')
+argparser.process_local_flags(local_arg_flags)
 argparser.add_argument('--reset', action='store_true', help='downgrade before upgrading')
-argparser.add_argument('-f', action='store_true', help='force action')
+argparser.add_argument('-f', '--force', action='store_true', help='force action')
-argparser.add_argument('-v', action='store_true', help='be verbose')
+argparser.add_argument('--migrations-dir', dest='migrations_dir', default=default_migrations_dir, type=str, help='migrations directory')
-argparser.add_argument('-vv', action='store_true', help='be more verbose')
 args = argparser.parse_args()
 
-if args.vv:
+extra_args = {
-    logging.getLogger().setLevel(logging.DEBUG)
+    'reset': None,
-elif args.v:
+    'force': None,
-    logging.getLogger().setLevel(logging.INFO)
+    'migrations_dir': None,
+        }
+# process config
+config = cic_cache.cli.Config.from_args(args, arg_flags, local_arg_flags, extra_args=extra_args)
 
-config = confini.Config(configdir, args.env_prefix)
+migrations_dir = os.path.join(config.get('_MIGRATIONS_DIR'), config.get('DATABASE_ENGINE', 'default'))
-config.process()
-config.censor('PASSWORD', 'DATABASE')
-config.censor('PASSWORD', 'SSL')
-logg.debug('config:\n{}'.format(config))
-
-migrations_dir = os.path.join(args.migrations_dir, config.get('DATABASE_ENGINE'))
 if not os.path.isdir(migrations_dir):
     logg.debug('migrations dir for engine {} not found, reverting to default'.format(config.get('DATABASE_ENGINE')))
     migrations_dir = os.path.join(args.migrations_dir, 'default')
 
 # connect to database
-dsn = dsn_from_config(config)
+dsn = dsn_from_config(config, 'cic_cache')
 
 
 logg.info('using migrations dir {}'.format(migrations_dir))

apps/cic-cache/setup.cfg

@@ -1,6 +1,7 @@
 [metadata]
 name = cic-cache
 description = CIC Cache API and server
+version = 0.3.0a2
 author = Louis Holbrook
 author_email = dev@holbrook.no
 url = https://gitlab.com/grassrootseconomics/cic-eth
@@ -34,7 +35,7 @@ packages =
 	cic_cache.runnable.daemons
 	cic_cache.runnable.daemons.filters
 scripts =
-	./scripts/migrate.py
+	./scripts/migrate_cic_cache.py
 
 [options.entry_points]
 console_scripts =

apps/cic-cache/setup.py

@@ -1,38 +1,39 @@
 from setuptools import setup
 
-import configparser
+# import configparser
 import os
-import time
 
-from cic_cache.version import (
+# import time
-        version_object,
-        version_string
-        )
 
-class PleaseCommitFirstError(Exception):
+# from cic_cache.version import (
-    pass
+#        version_object,
-
+#        version_string
-def git_hash():
+#        )
-    import subprocess
+#
-    git_diff = subprocess.run(['git', 'diff'], capture_output=True)
+# class PleaseCommitFirstError(Exception):
-    if len(git_diff.stdout) > 0:
+#    pass
-        raise PleaseCommitFirstError()
+#
-    git_hash = subprocess.run(['git', 'rev-parse', 'HEAD'], capture_output=True)
+# def git_hash():
-    git_hash_brief = git_hash.stdout.decode('utf-8')[:8]
+#    import subprocess
-    return git_hash_brief
+#    git_diff = subprocess.run(['git', 'diff'], capture_output=True)
-
+#    if len(git_diff.stdout) > 0:
-version_string = str(version_object)
+#        raise PleaseCommitFirstError()
-
+#    git_hash = subprocess.run(['git', 'rev-parse', 'HEAD'], capture_output=True)
-try:
+#    git_hash_brief = git_hash.stdout.decode('utf-8')[:8]
-    version_git = git_hash()
+#    return git_hash_brief
-    version_string += '+build.{}'.format(version_git)
+#
-except FileNotFoundError:
+# version_string = str(version_object)
-    time_string_pair = str(time.time()).split('.')
+#
-    version_string += '+build.{}{:<09d}'.format(
+# try:
-            time_string_pair[0],
+#    version_git = git_hash()
-            int(time_string_pair[1]),
+#    version_string += '+build.{}'.format(version_git)
-            )
+# except FileNotFoundError:
-print('final version string will be {}'.format(version_string))
+#    time_string_pair = str(time.time()).split('.')
+#    version_string += '+build.{}{:<09d}'.format(
+#            time_string_pair[0],
+#            int(time_string_pair[1]),
+#            )
+# print('final version string will be {}'.format(version_string))
 
 requirements = []
 f = open('requirements.txt', 'r')
@@ -52,9 +53,8 @@ while True:
     test_requirements.append(l.rstrip())
 f.close()
 
-
 setup(
-    version=version_string,
+    #    version=version_string,
     install_requires=requirements,
     tests_require=test_requirements,
         )

apps/cic-cache/test_requirements.txt

@@ -7,4 +7,4 @@ pytest-celery==0.0.0a1
 eth_tester==0.5.0b3
 py-evm==0.3.0a20
 sarafu-faucet~=0.0.7a1
-erc20-transfer-authorization>=0.3.5a1,<0.4.0
+erc20-transfer-authorization~=0.3.6

apps/cic-cache/tests/conftest.py

@@ -6,6 +6,7 @@ import datetime
 # external imports
 import pytest
 import moolb
+from chainlib.encode import TxHexNormalizer
 
 # local imports
 from cic_cache import db
@@ -42,6 +43,8 @@ def txs(
         list_tokens,
         ):
 
+    tx_normalize = TxHexNormalizer()
+
     session = init_database
 
     tx_number = 13 
@@ -54,10 +57,10 @@ def txs(
         tx_hash_first,
         list_defaults['block'],
         tx_number,
-        list_actors['alice'],
+        tx_normalize.wallet_address(list_actors['alice']),
-        list_actors['bob'],
+        tx_normalize.wallet_address(list_actors['bob']),
-        list_tokens['foo'],
+        tx_normalize.executable_address(list_tokens['foo']),
-        list_tokens['foo'],
+        tx_normalize.executable_address(list_tokens['foo']),
         1024,
         2048,
         True,
@@ -74,10 +77,10 @@ def txs(
         tx_hash_second,
         list_defaults['block']-1,
         tx_number,
-        list_actors['diane'],
+        tx_normalize.wallet_address(list_actors['diane']),
-        list_actors['alice'],
+        tx_normalize.wallet_address(list_actors['alice']),
-        list_tokens['foo'],
+        tx_normalize.executable_address(list_tokens['foo']),
-        list_tokens['foo'],
+        tx_normalize.wallet_address(list_tokens['foo']),
         1024,
         2048,
         False,
@@ -103,6 +106,8 @@ def more_txs(
 
     session = init_database
 
+    tx_normalize = TxHexNormalizer()
+
     tx_number = 666
     tx_hash = '0x' + os.urandom(32).hex()
     tx_signed = '0x' + os.urandom(128).hex()
@@ -115,10 +120,10 @@ def more_txs(
         tx_hash,
         list_defaults['block']+2,
         tx_number,
-        list_actors['alice'],
+        tx_normalize.wallet_address(list_actors['alice']),
-        list_actors['diane'],
+        tx_normalize.wallet_address(list_actors['diane']),
-        list_tokens['bar'],
+        tx_normalize.executable_address(list_tokens['bar']),
-        list_tokens['bar'],
+        tx_normalize.executable_address(list_tokens['bar']),
         2048,
         4096,
         False,

apps/cic-cache/tests/fixtures_config.py

@@ -14,7 +14,8 @@ logg = logging.getLogger(__file__)
 @pytest.fixture(scope='session')
 def load_config():
     config_dir = os.path.join(root_dir, 'config/test')
-    conf = confini.Config(config_dir, 'CICTEST')
+    schema_config_dir = os.path.join(root_dir, 'cic_cache', 'data', 'config')
+    conf = confini.Config(schema_config_dir, 'CICTEST', override_dirs=config_dir)
     conf.process()
     logg.debug('config {}'.format(conf))
     return conf

apps/cic-cache/tests/fixtures_database.py

@@ -24,11 +24,15 @@ def database_engine(
     if load_config.get('DATABASE_ENGINE') == 'sqlite':
         SessionBase.transactional = False
         SessionBase.poolable = False
+        name = 'cic_cache'
+        database_name = name
+        if load_config.get('DATABASE_PREFIX'):
+            database_name = '{}_{}'.format(load_config.get('DATABASE_PREFIX'), database_name)
         try:
-            os.unlink(load_config.get('DATABASE_NAME'))
+            os.unlink(database_name)
         except FileNotFoundError:
             pass
-    dsn = dsn_from_config(load_config)
+    dsn = dsn_from_config(load_config, name)
     SessionBase.connect(dsn, debug=load_config.true('DATABASE_DEBUG'))
     return dsn
 

apps/cic-cache/tests/test_api.py

@@ -14,7 +14,7 @@ def test_api_all_data(
         ):
 
     env = {
-        'PATH_INFO': '/txa/410000/420000',
+        'PATH_INFO': '/txa/100/0/410000/420000',
         'HTTP_X_CIC_CACHE_MODE': 'all',
             }
     j = process_transactions_all_data(init_database, env)
@@ -23,7 +23,7 @@ def test_api_all_data(
     assert len(o['data']) == 2
 
     env = {
-        'PATH_INFO': '/txa/420000/410000',
+        'PATH_INFO': '/txa/100/0/420000/410000',
         'HTTP_X_CIC_CACHE_MODE': 'all',
             }
    

apps/cic-cache/tests/test_cache.py

@@ -6,6 +6,7 @@ import json
 
 # external imports
 import pytest
+from chainlib.encode import TxHexNormalizer
 
 # local imports
 from cic_cache import db
@@ -62,6 +63,8 @@ def test_cache_ranges(
 
     session = init_database
        
+    tx_normalize = TxHexNormalizer()
+
     oldest = list_defaults['block'] - 1
     mid = list_defaults['block']
     newest = list_defaults['block'] + 2
@@ -100,32 +103,39 @@ def test_cache_ranges(
     assert b[1] == mid
 
     # now check when supplying account
-    b = c.load_transactions_account(list_actors['alice'], 0, 100)
+    account = tx_normalize.wallet_address(list_actors['alice'])
+    b = c.load_transactions_account(account, 0, 100)
     assert b[0] == oldest
     assert b[1] == newest
 
-    b = c.load_transactions_account(list_actors['bob'], 0, 100)
+    account = tx_normalize.wallet_address(list_actors['bob'])
+    b = c.load_transactions_account(account, 0, 100)
     assert b[0] == mid
     assert b[1] == mid
 
-    b = c.load_transactions_account(list_actors['diane'], 0, 100)
+    account = tx_normalize.wallet_address(list_actors['diane'])
+    b = c.load_transactions_account(account, 0, 100)
     assert b[0] == oldest
     assert b[1] == newest
 
     # add block filter to the mix
-    b = c.load_transactions_account(list_actors['alice'], 0, 100, block_offset=list_defaults['block'])
+    account = tx_normalize.wallet_address(list_actors['alice'])
+    b = c.load_transactions_account(account, 0, 100, block_offset=list_defaults['block'])
     assert b[0] == mid
     assert b[1] == newest
     
-    b = c.load_transactions_account(list_actors['alice'], 0, 100, block_offset=list_defaults['block'])
+    account = tx_normalize.wallet_address(list_actors['alice'])
+    b = c.load_transactions_account(account, 0, 100, block_offset=list_defaults['block'])
     assert b[0] == mid
     assert b[1] == newest
 
-    b = c.load_transactions_account(list_actors['bob'], 0, 100, block_offset=list_defaults['block'] - 1, block_limit=list_defaults['block'])
+    account = tx_normalize.wallet_address(list_actors['bob'])
+    b = c.load_transactions_account(account, 0, 100, block_offset=list_defaults['block'] - 1, block_limit=list_defaults['block'])
     assert b[0] == mid
     assert b[1] == mid
 
-    b = c.load_transactions_account(list_actors['diane'], 0, 100, block_offset=list_defaults['block'] - 1, block_limit=list_defaults['block'])
+    account = tx_normalize.wallet_address(list_actors['diane'])
+    b = c.load_transactions_account(account, 0, 100, block_offset=list_defaults['block'] - 1, block_limit=list_defaults['block'])
     assert b[0] == oldest
     assert b[1] == oldest
 
@@ -140,6 +150,8 @@ def test_cache_ranges_data(
 
     session = init_database
        
+    tx_normalize = TxHexNormalizer()
+
     oldest = list_defaults['block'] - 1
     mid = list_defaults['block']
     newest = list_defaults['block'] + 2
@@ -203,7 +215,8 @@ def test_cache_ranges_data(
     assert b[2][1]['tx_hash'] == more_txs[1]
 
     # now check when supplying account
-    b = c.load_transactions_account_with_data(list_actors['alice'], 0, 100)
+    account = tx_normalize.wallet_address(list_actors['alice'])
+    b = c.load_transactions_account_with_data(account, 0, 100)
     assert b[0] == oldest
     assert b[1] == newest
     assert len(b[2]) == 3
@@ -211,13 +224,15 @@ def test_cache_ranges_data(
     assert b[2][1]['tx_hash'] == more_txs[1]
     assert b[2][2]['tx_hash'] == more_txs[2]
 
-    b = c.load_transactions_account_with_data(list_actors['bob'], 0, 100)
+    account = tx_normalize.wallet_address(list_actors['bob'])
+    b = c.load_transactions_account_with_data(account, 0, 100)
     assert b[0] == mid
     assert b[1] == mid
     assert len(b[2]) == 1
     assert b[2][0]['tx_hash'] == more_txs[1]
 
-    b = c.load_transactions_account_with_data(list_actors['diane'], 0, 100)
+    account = tx_normalize.wallet_address(list_actors['diane'])
+    b = c.load_transactions_account_with_data(account, 0, 100)
     assert b[0] == oldest
     assert b[1] == newest
     assert len(b[2]) == 2
@@ -225,27 +240,31 @@ def test_cache_ranges_data(
     assert b[2][1]['tx_hash'] == more_txs[2]
 
     # add block filter to the mix
-    b = c.load_transactions_account_with_data(list_actors['alice'], 0, 100, block_offset=list_defaults['block'])
+    account = tx_normalize.wallet_address(list_actors['alice'])
+    b = c.load_transactions_account_with_data(account, 0, 100, block_offset=list_defaults['block'])
     assert b[0] == mid
     assert b[1] == newest
     assert len(b[2]) == 2
     assert b[2][0]['tx_hash'] == more_txs[0]
     assert b[2][1]['tx_hash'] == more_txs[1]
 
-    b = c.load_transactions_account_with_data(list_actors['alice'], 0, 100, block_offset=list_defaults['block'])
+    account = tx_normalize.wallet_address(list_actors['alice'])
+    b = c.load_transactions_account_with_data(account, 0, 100, block_offset=list_defaults['block'])
     assert b[0] == mid
     assert b[1] == newest
     assert len(b[2]) == 2
     assert b[2][0]['tx_hash'] == more_txs[0]
     assert b[2][1]['tx_hash'] == more_txs[1]
 
-    b = c.load_transactions_account_with_data(list_actors['bob'], 0, 100, block_offset=list_defaults['block'] - 1, block_limit=list_defaults['block'])
+    account = tx_normalize.wallet_address(list_actors['bob'])
+    b = c.load_transactions_account_with_data(account, 0, 100, block_offset=list_defaults['block'] - 1, block_limit=list_defaults['block'])
     assert b[0] == mid
     assert b[1] == mid
     assert len(b[2]) == 1
     assert b[2][0]['tx_hash'] == more_txs[1]
 
-    b = c.load_transactions_account_with_data(list_actors['diane'], 0, 100, block_offset=list_defaults['block'] - 1, block_limit=list_defaults['block'])
+    account = tx_normalize.wallet_address(list_actors['diane'])
+    b = c.load_transactions_account_with_data(account, 0, 100, block_offset=list_defaults['block'] - 1, block_limit=list_defaults['block'])
     assert b[0] == oldest
     assert b[1] == oldest
     assert len(b[2]) == 1

apps/cic-cache/tests/test_query.py

@@ -82,7 +82,7 @@ def test_query_regex(
         [ 
             ('alice', None, None, [(420000, 13), (419999, 42)]),
             ('alice', None, 1, [(420000, 13)]),
-            ('alice', 1, None, [(419999, 42)]), # 420000 == list_defaults['block']
+            ('alice', 1, 1, [(419999, 42)]), # 420000 == list_defaults['block']
             ('alice', 2, None, []), # 420000 == list_defaults['block']
             ],
         )
@@ -107,10 +107,11 @@ def test_query_process_txs_account(
     path_info = '/tx/user/0x' + strip_0x(actor)
     if query_offset != None:
         path_info += '/' + str(query_offset)
-    if query_limit != None:
+    if query_limit == None:
-        if query_offset == None:
+        query_limit = 100
-            path_info += '/0'
+    path_info += '/' + str(query_limit)
-        path_info += '/' + str(query_limit)
+    if query_offset == None:
+        path_info += '/0'
     env = {
             'PATH_INFO': path_info,
             }
@@ -192,7 +193,7 @@ def test_query_process_txs_bloom(
 @pytest.mark.parametrize(
         'query_block_start, query_block_end, query_match_count',
         [ 
-            (None, 42, 0),
+            (1, 42, 0),
             (420000, 420001, 1),
             (419999, 419999, 1), # matches are inclusive
             (419999, 420000, 2),
@@ -211,7 +212,7 @@ def test_query_process_txs_data(
         query_match_count,
         ):
 
-    path_info = '/txa'
+    path_info = '/txa/100/0'
     if query_block_start != None:
         path_info += '/' + str(query_block_start)
     if query_block_end != None:
@@ -227,4 +228,5 @@ def test_query_process_txs_data(
     assert r != None
 
     o = json.loads(r[1])
+    logg.debug('oo {}'.format(o))
     assert len(o['data']) == query_match_count

apps/cic-eth-aux/erc20-demurrage-token/requirements.txt

@@ -1,5 +1,5 @@
 celery==4.4.7
-erc20-demurrage-token~=0.0.5a3
+erc20-demurrage-token~=0.0.6
-cic-eth-registry~=0.6.1a6
+cic-eth-registry~=0.6.3
-chainlib~=0.0.9rc1
+chainlib~=0.0.14
-cic_eth~=0.12.4a11
+cic_eth~=0.12.6

apps/cic-eth-aux/erc20-demurrage-token/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = cic-eth-aux-erc20-demurrage-token
-version = 0.0.2a7
+version = 0.0.3
 description = cic-eth tasks supporting erc20 demurrage token
 author = Louis Holbrook
 author_email = dev@holbrook.no

apps/cic-eth/admin_requirements.txt

@@ -1,5 +1,4 @@
 SQLAlchemy==1.3.20
-cic-eth-registry>=0.6.1a6,<0.7.0
+hexathon~=0.1.0
-hexathon~=0.0.1a8
+chainqueue~=0.0.6a4
-chainqueue>=0.0.4a6,<0.1.0
+eth-erc20~=0.1.5
-eth-erc20>=0.1.2a2,<0.2.0

apps/cic-eth/cic_eth/cli/config.py

@@ -63,22 +63,32 @@ class Config(BaseConfig):
                     config.get('REDIS_HOST'),
                     config.get('REDIS_PORT'),
                     )
+            db = getattr(args, 'redis_db', None)
+            if db != None:
+                db = str(db)
+
             redis_url = (
                     'redis',
                     hostport,
-                    getattr(args, 'redis_db', None),
+                    db,
                     )
+
+
             celery_config_url = urllib.parse.urlsplit(config.get('CELERY_BROKER_URL'))
             hostport = urlhostmerge(
                     celery_config_url[1],
                     getattr(args, 'celery_host', None),
                     getattr(args, 'celery_port', None),
                     )
+            db = getattr(args, 'redis_db', None)
+            if db != None:
+                db = str(db)
             celery_arg_url = (
                     getattr(args, 'celery_scheme', None),
                     hostport,
-                    getattr(args, 'celery_db', None),
+                    db,
                     )
+
             celery_url = urlmerge(redis_url, celery_config_url, celery_arg_url)
             celery_url_string = urllib.parse.urlunsplit(celery_url)
             local_celery_args_override['CELERY_BROKER_URL'] = celery_url_string

apps/cic-eth/cic_eth/eth/erc20.py

@@ -22,7 +22,7 @@ from hexathon import (
 from chainqueue.error import NotLocalTxError
 from eth_erc20 import ERC20
 from chainqueue.sql.tx import cache_tx_dict
-from okota.token_index import to_identifier
+from okota.token_index.index import to_identifier
 
 # local imports
 from cic_eth.db.models.base import SessionBase
@@ -46,13 +46,14 @@ from cic_eth.task import (
 from cic_eth.eth.nonce import CustodialTaskNonceOracle
 from cic_eth.encode import tx_normalize
 from cic_eth.eth.trust import verify_proofs
+from cic_eth.error import SignerError
 
 celery_app = celery.current_app
 logg = logging.getLogger()
 
 
-@celery_app.task(base=CriticalWeb3Task)
+@celery_app.task(bind=True, base=CriticalWeb3Task)
-def balance(tokens, holder_address, chain_spec_dict):
+def balance(self, tokens, holder_address, chain_spec_dict):
     """Return token balances for a list of tokens for given address
 
     :param tokens: Token addresses
@@ -71,8 +72,9 @@ def balance(tokens, holder_address, chain_spec_dict):
     for t in tokens:
         address = t['address']
         logg.debug('address {} {}'.format(address, holder_address))
+        gas_oracle = self.create_gas_oracle(rpc, min_price=self.min_fee_price)
         token = ERC20Token(chain_spec, rpc, add_0x(address))
-        c = ERC20(chain_spec)
+        c = ERC20(chain_spec, gas_oracle=gas_oracle)
         o = c.balance_of(address, holder_address, sender_address=caller_address)
         r = rpc.do(o)
         t['balance_network'] = c.parse_balance(r)

apps/cic-eth/cic_eth/eth/gas.py

@@ -92,7 +92,7 @@ def apply_gas_value_cache_local(address, method, value, tx_hash, session=None):
 
     if o == None:
         o = GasCache(address, method, value, tx_hash)
-    elif tx.gas_used > o.value:
+    elif value > o.value:
         o.value = value
         o.tx_hash = strip_0x(tx_hash)
 

apps/cic-eth/cic_eth/task.py

@@ -17,7 +17,7 @@ from cic_eth_registry.error import UnknownContractError
 # local imports
 from cic_eth.error import SeppukuError
 from cic_eth.db.models.base import SessionBase
-from cic_eth.eth.util import CacheGasOracle
+from cic_eth.eth.util import CacheGasOracle, MaxGasOracle
 
 #logg = logging.getLogger().getChild(__name__)
 logg = logging.getLogger()
@@ -25,12 +25,14 @@ logg = logging.getLogger()
 celery_app = celery.current_app
 
 
+
 class BaseTask(celery.Task):
 
     session_func = SessionBase.create_session
     call_address = ZERO_ADDRESS
     trusted_addresses = []
     min_fee_price = 1
+    min_fee_limit = 30000
     default_token_address = None
     default_token_symbol = None
     default_token_name = None
@@ -39,21 +41,28 @@ class BaseTask(celery.Task):
 
 
     def create_gas_oracle(self, conn, address=None, *args, **kwargs):
-        if address == None:
+        x = None
-            return RPCGasOracle(
+        if address is None:
+            x = RPCGasOracle(
                 conn,
-                code_callback=kwargs.get('code_callback'),
+                code_callback=kwargs.get('code_callback', self.get_min_fee_limit),
                 min_price=self.min_fee_price,
                 id_generator=kwargs.get('id_generator'),
                 )
+        else:
 
-        return CacheGasOracle(
+            x = MaxGasOracle(conn)
-                conn,
+            x.code_callback = x.get_fee_units
-                address,
+
-                method=kwargs.get('method'),
+        return x
-                min_price=self.min_fee_price,
+
-                id_generator=kwargs.get('id_generator'),
+
-                )
+    def get_min_fee_limit(self, code):
+        return self.min_fee_limit
+
+
+    def get_min_fee_limit(self, code):
+        return self.min_fee_limit
 
 
     def create_session(self):
@@ -78,7 +87,7 @@ class BaseTask(celery.Task):
                     )
             s.apply_async()
 
-    
+
 class CriticalTask(BaseTask):
     retry_jitter = True
     retry_backoff = True
@@ -90,7 +99,7 @@ class CriticalSQLAlchemyTask(CriticalTask):
         sqlalchemy.exc.DatabaseError,
         sqlalchemy.exc.TimeoutError,
         sqlalchemy.exc.ResourceClosedError,
-        ) 
+        )
 
 
 class CriticalWeb3Task(CriticalTask):
@@ -98,7 +107,7 @@ class CriticalWeb3Task(CriticalTask):
         ConnectionError,
         )
     safe_gas_threshold_amount = 60000 * 3
-    safe_gas_refill_amount = safe_gas_threshold_amount * 5 
+    safe_gas_refill_amount = safe_gas_threshold_amount * 5
     safe_gas_gifter_balance = safe_gas_threshold_amount * 5 * 100
 
 
@@ -116,13 +125,13 @@ class CriticalSQLAlchemyAndSignerTask(CriticalTask):
         sqlalchemy.exc.DatabaseError,
         sqlalchemy.exc.TimeoutError,
         sqlalchemy.exc.ResourceClosedError,
-        ) 
+        )
 
 class CriticalWeb3AndSignerTask(CriticalWeb3Task):
     autoretry_for = (
         ConnectionError,
         )
-    
+
 @celery_app.task()
 def check_health(self):
     pass

apps/cic-eth/docker/Dockerfile

@@ -11,13 +11,6 @@ ARG EXTRA_PIP_INDEX_URL=https://pip.grassrootseconomics.net
 ARG EXTRA_PIP_ARGS=""
 ARG PIP_INDEX_URL=https://pypi.org/simple
 
-RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
-    pip install --index-url $PIP_INDEX_URL \
-    --pre \
-    --extra-index-url $EXTRA_PIP_INDEX_URL $EXTRA_PIP_ARGS \
-    cic-eth-aux-erc20-demurrage-token~=0.0.2a7
-
-
 COPY *requirements.txt ./
 RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
     pip install --index-url $PIP_INDEX_URL \
@@ -25,7 +18,7 @@ RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
     --extra-index-url $EXTRA_PIP_INDEX_URL $EXTRA_PIP_ARGS \
     -r requirements.txt \
     -r services_requirements.txt \
-    -r admin_requirements.txt 
+    -r admin_requirements.txt
 
 COPY . .
 RUN python setup.py install
@@ -40,8 +33,6 @@ RUN chmod 755 *.sh
 # # they can all be overridden by environment variables
 # # to generate a list of environment variables from configuration, use: confini-dump -z <dir> (executable provided by confini package)
 #COPY config/ /usr/local/etc/cic-eth/
-COPY cic_eth/db/migrations/ /usr/local/share/cic-eth/alembic/
-COPY crypto_dev_signer_config/ /usr/local/etc/crypto-dev-signer/
 
 # TODO this kind of code sharing across projects should be discouraged...can we make util a library?
 #COPY util/liveness/health.sh /usr/local/bin/health.sh
@@ -66,9 +57,8 @@ ENTRYPOINT []
 ## # they can all be overridden by environment variables
 ## # to generate a list of environment variables from configuration, use: confini-dump -z <dir> (executable provided by confini package)
 #COPY config/ /usr/local/etc/cic-eth/
-#COPY cic_eth/db/migrations/ /usr/local/share/cic-eth/alembic/
+COPY cic_eth/db/migrations/ /usr/local/share/cic-eth/alembic/
-#COPY crypto_dev_signer_config/ /usr/local/etc/crypto-dev-signer/
+#COPY scripts/ scripts/
-#COPY scripts/ scripts/ 
 #
 ## TODO this kind of code sharing across projects should be discouraged...can we make util a library?
 ##COPY util/liveness/health.sh /usr/local/bin/health.sh

apps/cic-eth/requirements.txt

@@ -1,4 +1,7 @@
 celery==4.4.7
-chainlib-eth>=0.0.10a20,<0.1.0
 semver==2.13.0
-urlybird~=0.0.1a2
+chainlib-eth~=0.0.15
+urlybird~=0.0.1
+cic-eth-registry~=0.6.6
+cic-types~=0.2.1a8
+cic-eth-aux-erc20-demurrage-token~=0.0.3

apps/cic-eth/services_requirements.txt

@@ -1,16 +1,15 @@
-chainqueue>=0.0.6a1,<0.1.0
+chainqueue~=0.0.6a4
-chainsyncer[sql]>=0.0.7a3,<0.1.0
+chainsyncer[sql]~=0.0.7
 alembic==1.4.2
-confini>=0.3.6rc4,<0.5.0
+confini~=0.5.3
 redis==3.5.3
-hexathon~=0.0.1a8
+hexathon~=0.1.0
 pycryptodome==3.10.1
 liveness~=0.0.1a7
-eth-address-index>=0.2.4a1,<0.3.0
+eth-address-index~=0.2.4
-eth-accounts-index>=0.1.2a3,<0.2.0
+eth-accounts-index~=0.1.2
-cic-eth-registry>=0.6.1a6,<0.7.0
+erc20-faucet~=0.3.2
-erc20-faucet>=0.3.2a2,<0.4.0
+erc20-transfer-authorization~=0.3.6
-erc20-transfer-authorization>=0.3.5a2,<0.4.0
+sarafu-faucet~=0.0.7
-sarafu-faucet>=0.0.7a2,<0.1.0
+moolb~=0.2.0
-moolb~=0.1.1b2
+okota~=0.2.5
-okota>=0.2.4a6,<0.3.0

apps/cic-eth/setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
 name = cic-eth
 #version = attr: cic_eth.version.__version_string__
-version = 0.12.5a2
+version = 0.12.7
 description = CIC Network Ethereum interaction 
 author = Louis Holbrook
 author_email = dev@holbrook.no

apps/cic-eth/test_requirements.txt

@@ -6,4 +6,5 @@ pytest-redis==2.0.0
 redis==3.5.3
 eth-tester==0.5.0b3
 py-evm==0.3.0a20
-eth-erc20~=0.1.2a2
+eth-erc20~=0.1.5
+erc20-transfer-authorization~=0.3.6

apps/cic-eth/tests/filters/test_token_filter.py

@@ -40,6 +40,7 @@ def test_filter_gas(
         foo_token,
         token_registry,
         register_lookups,
+        register_tokens,
         celery_session_worker,
         cic_registry,
     ):
@@ -69,7 +70,7 @@ def test_filter_gas(
     tx = Tx(tx_src, block=block)
     tx.apply_receipt(rcpt)
     t = fltr.filter(eth_rpc, block, tx, db_session=init_database)
-    assert t == None
+    assert t.get() == None
 
     nonce_oracle = RPCNonceOracle(contract_roles['CONTRACT_DEPLOYER'], eth_rpc)
     c = TokenUniqueSymbolIndex(default_chain_spec, signer=eth_signer, nonce_oracle=nonce_oracle)

apps/cic-eth/tests/task/api/test_admin.py

@@ -288,7 +288,6 @@ def test_fix_nonce(
 
     init_database.commit()
    
-    logg.debug('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')
     txs = get_nonce_tx_local(default_chain_spec, 3, agent_roles['ALICE'], session=init_database)
     ks = txs.keys()
     assert len(ks) == 2

apps/cic-eth/tests/task/api/test_app_noncritical.py

@@ -191,11 +191,17 @@ def test_tokens(
         break
 
     api_param = str(uuid.uuid4())
+    fp = os.path.join(CallbackTask.mmap_path, api_param)
+    f = open(fp, 'wb+')
+    f.write(b'\x00')
+    f.close()
+
     api = Api(str(default_chain_spec), queue=None, callback_param=api_param, callback_task='cic_eth.pytest.mock.callback.test_callback')
     t = api.tokens(['BAR'], proof=[[bar_token_declaration]])
     r = t.get()
     logg.debug('rr  {} {}'.format(r, t.children))
 
+
     while True:
         fp = os.path.join(CallbackTask.mmap_path, api_param)
         try:

apps/cic-eth/tests/task/test_task_gas.py

@@ -35,10 +35,26 @@ from hexathon import strip_0x
 from cic_eth.eth.gas import cache_gas_data
 from cic_eth.error import OutOfGasError
 from cic_eth.queue.tx import queue_create
+from cic_eth.task import BaseTask
 
 logg = logging.getLogger()
 
 
+def test_task_gas_limit(
+        eth_rpc,
+        eth_signer,
+        default_chain_spec,
+        agent_roles,
+        celery_session_worker,
+        ):
+    rpc = RPCConnection.connect(default_chain_spec, 'default')
+    gas_oracle = BaseTask().create_gas_oracle(rpc)
+    c = Gas(default_chain_spec, signer=eth_signer, gas_oracle=gas_oracle)
+    (tx_hash_hex, o) = c.create(agent_roles['ALICE'], agent_roles['BOB'], 10, tx_format=TxFormat.RLP_SIGNED)
+    tx = unpack(bytes.fromhex(strip_0x(o)), default_chain_spec)
+    assert (tx['gas'], BaseTask.min_fee_price)
+
+
 def test_task_check_gas_ok(
         default_chain_spec,
         eth_rpc,

apps/cic-eth/tests/unit/queue/test_balances.py

@@ -143,7 +143,7 @@ def test_incoming_balance(
             'converters': [],
             }
     b = balance_incoming([token_data], recipient, default_chain_spec.asdict())
-    assert b[0]['balance_incoming'] == 0
+    assert b[0]['balance_incoming'] == 1000 
 
     otx.readysend(session=init_database)
     init_database.flush()
@@ -152,8 +152,8 @@ def test_incoming_balance(
     otx.sent(session=init_database)
     init_database.commit()
 
-    b = balance_incoming([token_data], recipient, default_chain_spec.asdict())
+    #b = balance_incoming([token_data], recipient, default_chain_spec.asdict())
-    assert b[0]['balance_incoming'] == 1000
+    #assert b[0]['balance_incoming'] == 1000
    
     otx.success(block=1024, session=init_database)
     init_database.commit()

apps/cic-eth/tools_requirements.txt

@@ -1,7 +1,5 @@
-crypto-dev-signer>=0.4.15rc2,<=0.4.15
+chainqueue~=0.0.6a4
-chainqueue>=0.0.5a3,<0.1.0
-cic-eth-registry>=0.6.1a6,<0.7.0
 redis==3.5.3
-hexathon~=0.0.1a8
+hexathon~=0.1.0
 pycryptodome==3.10.1
 pyxdg==0.27

apps/cic-notify/.config/test/database.ini

@@ -1,10 +1,9 @@
-[DATABASE]
+[database]
-user = postgres
+name=cic_notify_test
-password =
+user=
-host = localhost
+password=
-port = 5432
+host=localhost
-name = /tmp/cic-notify.db
+port=
-#engine = postgresql
+engine=sqlite
-#driver = psycopg2
+driver=pysqlite
-engine = sqlite
+debug=0
-driver = pysqlite

apps/cic-notify/.coveragerc

@@ -0,0 +1,7 @@
+[report]
+omit =
+	venv/*
+	scripts/*
+	cic_notify/db/migrations/*
+	cic_notify/runnable/*
+	cic_notify/version.py

apps/cic-notify/cic_notify/api.py

@@ -3,6 +3,7 @@ import logging
 import re
 
 # third-party imports
+import cic_notify.tasks.sms.db
 from celery.app.control import Inspect
 import celery
 
@@ -13,45 +14,16 @@ app = celery.current_app
 logging.basicConfig(level=logging.DEBUG)
 logg = logging.getLogger()
 
-sms_tasks_matcher = r"^(cic_notify.tasks.sms)(\.\w+)?"
-
-
-re_q = r'^cic-notify'
-def get_sms_queue_tasks(app, task_prefix='cic_notify.tasks.sms.'):
-    host_queues = []
-
-    i = Inspect(app=app)
-    qs = i.active_queues()
-    for host in qs.keys():
-        for q in qs[host]:
-            if re.match(re_q, q['name']):
-                host_queues.append((host, q['name'],))
-
-    task_prefix_len = len(task_prefix)
-    queue_tasks = []
-    for (host, queue) in host_queues:
-        i = Inspect(app=app, destination=[host])
-        for tasks in i.registered_tasks().values():
-            for task in tasks:
-                if len(task) >= task_prefix_len and task[:task_prefix_len] == task_prefix:
-                    queue_tasks.append((queue, task,))
-
-    return queue_tasks
-
 
 class Api:
-    # TODO: Implement callback strategy
+    def __init__(self, queue: any = 'cic-notify'):
-    def __init__(self, queue=None):
         """
         :param queue: The queue on which to execute notification tasks
         :type queue: str
         """
         self.queue = queue
-        self.sms_tasks = get_sms_queue_tasks(app)
-        logg.debug('sms tasks {}'.format(self.sms_tasks))
 
-
+    def sms(self, message: str, recipient: str):
-    def sms(self, message, recipient):
         """This function chains all sms tasks in order to send a message, log and persist said data to disk
         :param message: The message to be sent to the recipient.
         :type message: str
@@ -60,24 +32,9 @@ class Api:
         :return: a celery Task
         :rtype: Celery.Task
         """
-        signatures = []
+        s_send = celery.signature('cic_notify.tasks.sms.africastalking.send', [message, recipient], queue=self.queue)
-        for q in self.sms_tasks:
+        s_log = celery.signature('cic_notify.tasks.sms.log.log', [message, recipient], queue=self.queue)
-
+        s_persist_notification = celery.signature(
-            if not self.queue:
+            'cic_notify.tasks.sms.db.persist_notification', [message, recipient], queue=self.queue)
-                queue = q[0]
+        signatures = [s_send, s_log, s_persist_notification]
-            else:
+        return celery.group(signatures)()
-                queue = self.queue
-
-            signature = celery.signature(
-                    q[1],
-                    [
-                        message,
-                        recipient,
-                        ],
-                    queue=queue,
-                    )
-            signatures.append(signature)
-
-        t = celery.group(signatures)()
-
-        return t

apps/cic-notify/cic_notify/db/migrations/default/alembic.ini

@@ -2,7 +2,7 @@
 
 [alembic]
 # path to migration scripts
-script_location = migrations
+script_location = .
 
 # template used to generate migration files
 # file_template = %%(rev)s_%%(slug)s
@@ -27,28 +27,17 @@ script_location = migrations
 # sourceless = false
 
 # version location specification; this defaults
-# to migrations/versions.  When using multiple version
+# to ./versions.  When using multiple version
 # directories, initial revisions must be specified with --version-path
-# version_locations = %(here)s/bar %(here)s/bat migrations/versions
+# version_locations = %(here)s/bar %(here)s/bat ./versions
 
 # the output encoding used when revision files
 # are written from script.py.mako
 # output_encoding = utf-8
 
-sqlalchemy.url = postgres+psycopg2://postgres@localhost/cic-notify
+sqlalchemy.url = driver://user:pass@localhost/dbname
 
 
-[post_write_hooks]
-# post_write_hooks defines scripts or Python functions that are run
-# on newly generated revision scripts.  See the documentation for further
-# detail and examples
-
-# format using "black" - use the console_scripts runner, against the "black" entrypoint
-# hooks=black
-# black.type=console_scripts
-# black.entrypoint=black
-# black.options=-l 79
-
 # Logging configuration
 [loggers]
 keys = root,sqlalchemy,alembic

apps/cic-notify/cic_notify/db/migrations/default/env.py

@@ -11,7 +11,7 @@ config = context.config
 
 # Interpret the config file for Python logging.
 # This line sets up loggers basically.
-fileConfig(config.config_file_name)
+fileConfig(config.config_file_name, disable_existing_loggers=True)
 
 # add your model's MetaData object here
 # for 'autogenerate' support
@@ -56,11 +56,14 @@ def run_migrations_online():
     and associate a connection with the context.
 
     """
-    connectable = engine_from_config(
+    connectable = context.config.attributes.get("connection", None)
-        config.get_section(config.config_ini_section),
+
-        prefix="sqlalchemy.",
+    if connectable is None:
-        poolclass=pool.NullPool,
+        connectable = engine_from_config(
-    )
+            context.config.get_section(context.config.config_ini_section),
+            prefix="sqlalchemy.",
+            poolclass=pool.NullPool,
+        )
 
     with connectable.connect() as connection:
         context.configure(

apps/cic-notify/cic_notify/tasks/sms/log.py

@@ -7,7 +7,7 @@ import celery
 
 celery_app = celery.current_app
 logg = celery_app.log.get_default_logger()
-local_logg = logging.getLogger(__name__)
+local_logg = logging.getLogger()
 
 
 @celery_app.task

apps/cic-notify/cic_notify/version.py

@@ -9,7 +9,7 @@ import semver
 
 logg = logging.getLogger()
 
-version = (0, 4, 0, 'alpha.11')
+version = (0, 4, 0, 'alpha.12')
 
 version_object = semver.VersionInfo(
         major=version[0],

apps/cic-notify/requirements.txt

@@ -1,4 +1,4 @@
-confini>=0.3.6rc4,<0.5.0
+confini~=0.5.1
 africastalking==1.2.3
 SQLAlchemy==1.3.20
 alembic==1.4.2

apps/cic-notify/test_requirements.txt

@@ -1,5 +1,9 @@
-pytest~=6.0.1
+Faker==11.1.0
-pytest-celery~=0.0.0a1
+faker-e164==0.1.0
-pytest-mock~=3.3.1
+pytest==6.2.5
-pysqlite3~=0.4.3
+pytest-celery~=0.0.0
-pytest-cov==2.10.1
+pytest-mock==3.6.1
+pysqlite3~=0.4.6
+pytest-cov==3.0.0
+pytest-alembic==0.7.0
+requests-mock==1.9.3

apps/cic-notify/tests/cic_notify/db/migrations/test_migrations.py

@@ -0,0 +1,28 @@
+import pytest
+
+
+def test_single_head_revision(alembic_runner):
+    heads = alembic_runner.heads
+    head_count = len(heads)
+    assert head_count == 1
+
+
+def test_upgrade(alembic_runner):
+    try:
+        alembic_runner.migrate_up_to("head")
+    except RuntimeError:
+        pytest.fail('Failed to upgrade to the head revision.')
+
+
+def test_up_down_consistency(alembic_runner):
+    try:
+        for revision in alembic_runner.history.revisions:
+            alembic_runner.migrate_up_to(revision)
+    except RuntimeError:
+        pytest.fail('Failed to upgrade through each revision individually.')
+
+    try:
+        for revision in reversed(alembic_runner.history.revisions):
+            alembic_runner.migrate_down_to(revision)
+    except RuntimeError:
+        pytest.fail('Failed to downgrade through each revision individually.')

apps/cic-notify/tests/cic_notify/db/models/test_notification.py

@@ -0,0 +1,27 @@
+# standard imports
+
+# external imports
+from faker import Faker
+from faker_e164.providers import E164Provider
+
+# local imports
+from cic_notify.db.enum import NotificationStatusEnum, NotificationTransportEnum
+from cic_notify.db.models.notification import Notification
+
+
+# test imports
+from tests.helpers.phone import phone_number
+
+
+def test_notification(init_database):
+    message = 'Hello world'
+    recipient = phone_number()
+    notification = Notification(NotificationTransportEnum.SMS, recipient, message)
+    init_database.add(notification)
+    init_database.commit()
+
+    notification = init_database.query(Notification).get(1)
+    assert notification.status == NotificationStatusEnum.UNKNOWN
+    assert notification.recipient == recipient
+    assert notification.message == message
+    assert notification.transport == NotificationTransportEnum.SMS

apps/cic-notify/tests/cic_notify/db/test_db.py

@@ -0,0 +1,38 @@
+# standard imports
+import os
+
+# third-party imports
+
+# local imports
+from cic_notify.db import dsn_from_config
+
+
+def test_dsn_from_config(load_config):
+    """
+    """
+    # test dsn for other db formats
+    overrides = {
+        'DATABASE_PASSWORD': 'password',
+        'DATABASE_DRIVER': 'psycopg2',
+        'DATABASE_ENGINE': 'postgresql'
+    }
+    load_config.dict_override(dct=overrides, dct_description='Override values to test different db formats.')
+
+    scheme = f'{load_config.get("DATABASE_ENGINE")}+{load_config.get("DATABASE_DRIVER")}'
+
+    dsn = dsn_from_config(load_config)
+    assert dsn == f"{scheme}://{load_config.get('DATABASE_USER')}:{load_config.get('DATABASE_PASSWORD')}@{load_config.get('DATABASE_HOST')}:{load_config.get('DATABASE_PORT')}/{load_config.get('DATABASE_NAME')}"
+
+    # undoes overrides to revert engine and drivers to sqlite
+    overrides = {
+        'DATABASE_PASSWORD': '',
+        'DATABASE_DRIVER': 'pysqlite',
+        'DATABASE_ENGINE': 'sqlite'
+    }
+    load_config.dict_override(dct=overrides, dct_description='Override values to test different db formats.')
+
+    # test dsn for sqlite engine
+    dsn = dsn_from_config(load_config)
+    scheme = f'{load_config.get("DATABASE_ENGINE")}+{load_config.get("DATABASE_DRIVER")}'
+    assert dsn == f'{scheme}:///{load_config.get("DATABASE_NAME")}'
+

apps/cic-notify/tests/cic_notify/tasks/sms/test_africastalking_tasks.py

@@ -0,0 +1,75 @@
+# standard imports
+import logging
+import os
+
+# external imports
+import pytest
+import requests_mock
+
+
+# local imports
+from cic_notify.error import NotInitializedError, AlreadyInitializedError, NotificationSendError
+from cic_notify.tasks.sms.africastalking import AfricasTalkingNotifier
+
+# test imports
+from tests.helpers.phone import phone_number
+
+
+def test_africas_talking_notifier(africastalking_response, caplog):
+    caplog.set_level(logging.DEBUG)
+    with pytest.raises(NotInitializedError) as error:
+        AfricasTalkingNotifier()
+    assert str(error.value) == ''
+
+    api_key = os.urandom(24).hex()
+    sender_id = 'bar'
+    username = 'sandbox'
+    AfricasTalkingNotifier.initialize(username, api_key, sender_id)
+    africastalking_notifier = AfricasTalkingNotifier()
+    assert africastalking_notifier.sender_id == sender_id
+    assert africastalking_notifier.initiated is True
+
+    with pytest.raises(AlreadyInitializedError) as error:
+        AfricasTalkingNotifier.initialize(username, api_key, sender_id)
+    assert str(error.value) == ''
+
+    with requests_mock.Mocker(real_http=False) as request_mocker:
+        message = 'Hello world.'
+        recipient = phone_number()
+        africastalking_response.get('SMSMessageData').get('Recipients')[0]['number'] = recipient
+        request_mocker.register_uri(method='POST',
+                                    headers={'content-type': 'application/json'},
+                                    json=africastalking_response,
+                                    url='https://api.sandbox.africastalking.com/version1/messaging',
+                                    status_code=200)
+        africastalking_notifier.send(message, recipient)
+        assert f'Africastalking response sender-id {africastalking_response}' in caplog.text
+        africastalking_notifier.sender_id = None
+        africastalking_notifier.send(message, recipient)
+        assert f'africastalking response no-sender-id {africastalking_response}' in caplog.text
+        with pytest.raises(NotificationSendError) as error:
+            status = 'InvalidPhoneNumber'
+            status_code = 403
+            africastalking_response.get('SMSMessageData').get('Recipients')[0]['status'] = status
+            africastalking_response.get('SMSMessageData').get('Recipients')[0]['statusCode'] = status_code
+
+            request_mocker.register_uri(method='POST',
+                                        headers={'content-type': 'application/json'},
+                                        json=africastalking_response,
+                                        url='https://api.sandbox.africastalking.com/version1/messaging',
+                                        status_code=200)
+            africastalking_notifier.send(message, recipient)
+        assert str(error.value) == f'Sending notification failed due to: {status}'
+        with pytest.raises(NotificationSendError) as error:
+            recipients = []
+            status = 'InsufficientBalance'
+            africastalking_response.get('SMSMessageData')['Recipients'] = recipients
+            africastalking_response.get('SMSMessageData')['Message'] = status
+
+            request_mocker.register_uri(method='POST',
+                                        headers={'content-type': 'application/json'},
+                                        json=africastalking_response,
+                                        url='https://api.sandbox.africastalking.com/version1/messaging',
+                                        status_code=200)
+            africastalking_notifier.send(message, recipient)
+        assert str(error.value) == f'Unexpected number of recipients: {len(recipients)}. Status: {status}'

apps/cic-notify/tests/cic_notify/tasks/sms/test_db_tasks.py

@@ -0,0 +1,26 @@
+# standard imports
+
+# external imports
+import celery
+
+# local imports
+from cic_notify.db.enum import NotificationStatusEnum, NotificationTransportEnum
+from cic_notify.db.models.notification import Notification
+
+# test imports
+from tests.helpers.phone import phone_number
+
+
+def test_persist_notification(celery_session_worker, init_database):
+    message = 'Hello world.'
+    recipient = phone_number()
+    s_persist_notification = celery.signature(
+        'cic_notify.tasks.sms.db.persist_notification', (message, recipient)
+    )
+    s_persist_notification.apply_async().get()
+
+    notification = Notification.session.query(Notification).filter_by(recipient=recipient).first()
+    assert notification.status == NotificationStatusEnum.UNKNOWN
+    assert notification.recipient == recipient
+    assert notification.message == message
+    assert notification.transport == NotificationTransportEnum.SMS

apps/cic-notify/tests/cic_notify/tasks/sms/test_log_tasks.py

@@ -0,0 +1,21 @@
+# standard imports
+import logging
+
+# external imports
+import celery
+
+# local imports
+
+# test imports
+from tests.helpers.phone import phone_number
+
+
+def test_log(caplog, celery_session_worker):
+    message = 'Hello world.'
+    recipient = phone_number()
+    caplog.set_level(logging.INFO)
+    s_log = celery.signature(
+        'cic_notify.tasks.sms.log.log', [message, recipient]
+    )
+    s_log.apply_async().get()
+    assert f'message to {recipient}: {message}' in caplog.text

apps/cic-notify/tests/cic_notify/test_api.py

@@ -0,0 +1,24 @@
+# standard imports
+
+# external imports
+import celery
+
+# local imports
+from cic_notify.api import Api
+
+# test imports
+from tests.helpers.phone import phone_number
+
+
+def test_api(celery_session_worker, mocker):
+    mocked_group = mocker.patch('celery.group')
+    message = 'Hello world.'
+    recipient = phone_number()
+    s_send = celery.signature('cic_notify.tasks.sms.africastalking.send', [message, recipient], queue=None)
+    s_log = celery.signature('cic_notify.tasks.sms.log.log', [message, recipient], queue=None)
+    s_persist_notification = celery.signature(
+        'cic_notify.tasks.sms.db.persist_notification', [message, recipient], queue=None)
+    signatures = [s_send, s_log, s_persist_notification]
+    api = Api(queue=None)
+    api.sms(message, recipient)
+    mocked_group.assert_called_with(signatures)

apps/cic-notify/tests/conftest.py

@@ -1,31 +1,13 @@
 # standard imports
-import sys
-import os
-import pytest
 import logging
 
 # third party imports
-import confini
-
-script_dir = os.path.dirname(os.path.realpath(__file__))
-root_dir = os.path.dirname(script_dir)
-sys.path.insert(0, root_dir)
 
 # local imports
-from cic_notify.db.models.base import SessionBase
-#from transport.notification import AfricastalkingNotification
 
-# fixtures
+# test imports
-from tests.fixtures_config import *
-from tests.fixtures_celery import *
-from tests.fixtures_database import *
 
-logg = logging.getLogger()
+from .fixtures.celery import *
-
+from .fixtures.config import *
-
+from .fixtures.database import *
-#@pytest.fixture(scope='session')
+from .fixtures.result import *
-#def africastalking_notification(
-#        load_config,
-#        ):
-#    return AfricastalkingNotificationTransport(load_config)
-#

apps/cic-notify/tests/fixtures/celery.py

@@ -37,12 +37,6 @@ def celery_config():
     shutil.rmtree(rq)
 
 
-@pytest.fixture(scope='session')
-def celery_worker_parameters():
-    return {
-#            'queues': ('cic-notify'),
-            }
-
 @pytest.fixture(scope='session')
 def celery_enable_logging():
     return True

apps/cic-notify/tests/fixtures/config.py

@@ -0,0 +1,32 @@
+# standard imports
+import os
+import logging
+
+# external imports
+import pytest
+from confini import Config
+
+logg = logging.getLogger(__file__)
+
+
+fixtures_dir = os.path.dirname(__file__)
+root_directory = os.path.dirname(os.path.dirname(fixtures_dir))
+
+
+@pytest.fixture(scope='session')
+def alembic_config():
+    migrations_directory = os.path.join(root_directory, 'cic_notify', 'db', 'migrations', 'default')
+    file = os.path.join(migrations_directory, 'alembic.ini')
+    return {
+        'file': file,
+        'script_location': migrations_directory
+    }
+
+
+@pytest.fixture(scope='session')
+def load_config():
+    config_directory = os.path.join(root_directory, '.config/test')
+    config = Config(default_dir=config_directory)
+    config.process()
+    logg.debug('config loaded\n{}'.format(config))
+    return config

apps/cic-notify/tests/fixtures/database.py

@@ -0,0 +1,54 @@
+# standard imports
+import os
+
+# third-party imports
+import pytest
+import alembic
+from alembic.config import Config as AlembicConfig
+
+# local imports
+from cic_notify.db import dsn_from_config
+from cic_notify.db.models.base import SessionBase, create_engine
+
+from .config import root_directory
+
+
+@pytest.fixture(scope='session')
+def alembic_engine(load_config):
+    data_source_name = dsn_from_config(load_config)
+    return create_engine(data_source_name)
+
+
+@pytest.fixture(scope='session')
+def database_engine(load_config):
+    if load_config.get('DATABASE_ENGINE') == 'sqlite':
+        try:
+            os.unlink(load_config.get('DATABASE_NAME'))
+        except FileNotFoundError:
+            pass
+    dsn = dsn_from_config(load_config)
+    SessionBase.connect(dsn)
+    return dsn
+
+
+@pytest.fixture(scope='function')
+def init_database(load_config, database_engine):
+    db_directory = os.path.join(root_directory, 'cic_notify', 'db')
+    migrations_directory = os.path.join(db_directory, 'migrations', load_config.get('DATABASE_ENGINE'))
+    if not os.path.isdir(migrations_directory):
+        migrations_directory = os.path.join(db_directory, 'migrations', 'default')
+
+    session = SessionBase.create_session()
+
+    alembic_config = AlembicConfig(os.path.join(migrations_directory, 'alembic.ini'))
+    alembic_config.set_main_option('sqlalchemy.url', database_engine)
+    alembic_config.set_main_option('script_location', migrations_directory)
+
+    alembic.command.downgrade(alembic_config, 'base')
+    alembic.command.upgrade(alembic_config, 'head')
+
+    yield session
+    session.commit()
+    session.close()
+
+

apps/cic-notify/tests/fixtures/result.py

@@ -0,0 +1,24 @@
+# standard imports
+
+# external imports
+import pytest
+
+
+# local imports
+
+# test imports
+
+@pytest.fixture(scope="function")
+def africastalking_response():
+    return {
+        "SMSMessageData": {
+            "Message": "Sent to 1/1 Total Cost: KES 0.8000",
+            "Recipients": [{
+                "statusCode": 101,
+                "number": "+254711XXXYYY",
+                "status": "Success",
+                "cost": "KES 0.8000",
+                "messageId": "ATPid_SampleTxnId123"
+            }]
+        }
+    }

apps/cic-notify/tests/fixtures_config.py

@@ -1,20 +0,0 @@
-# standard imports
-import os
-import logging
-
-# third-party imports
-import pytest
-import confini
-
-script_dir = os.path.dirname(os.path.realpath(__file__))
-root_dir = os.path.dirname(script_dir)
-logg = logging.getLogger(__file__)
-
-
-@pytest.fixture(scope='session')
-def load_config():
-    config_dir = os.path.join(root_dir, '.config/test')
-    conf = confini.Config(config_dir, 'CICTEST')
-    conf.process()
-    logg.debug('config {}'.format(conf))
-    return conf

apps/cic-notify/tests/fixtures_database.py

@@ -1,48 +0,0 @@
-# standard imports
-import os
-
-# third-party imports
-import pytest
-import alembic
-from alembic.config import Config as AlembicConfig
-
-# local imports
-from cic_notify.db import SessionBase
-from cic_notify.db import dsn_from_config
-
-
-@pytest.fixture(scope='session')
-def database_engine(
-    load_config,
-        ):
-    dsn = dsn_from_config(load_config)
-    SessionBase.connect(dsn)
-    return dsn
-
-
-@pytest.fixture(scope='function')
-def init_database(
-        load_config,
-        database_engine,
-        ):
-
-    rootdir = os.path.dirname(os.path.dirname(__file__))
-    dbdir = os.path.join(rootdir, 'cic_notify', 'db')
-    migrationsdir = os.path.join(dbdir, 'migrations', load_config.get('DATABASE_ENGINE'))
-    if not os.path.isdir(migrationsdir):
-        migrationsdir = os.path.join(dbdir, 'migrations', 'default')
-
-    session = SessionBase.create_session()
-
-    ac = AlembicConfig(os.path.join(migrationsdir, 'alembic.ini'))
-    ac.set_main_option('sqlalchemy.url', database_engine)
-    ac.set_main_option('script_location', migrationsdir)
-
-    alembic.command.downgrade(ac, 'base')
-    alembic.command.upgrade(ac, 'head')
-
-    yield session
-    session.commit()
-    session.close()
-
-

apps/cic-notify/tests/helpers/phone.py

@@ -0,0 +1,16 @@
+# standard imports
+
+# external imports
+from faker import Faker
+from faker_e164.providers import E164Provider
+
+# local imports
+
+# test imports
+
+fake = Faker()
+fake.add_provider(E164Provider)
+
+
+def phone_number() -> str:
+    return fake.e164('KE')

apps/cic-notify/tests/test_sms.py

@@ -1,34 +0,0 @@
-# standard imports
-import json
-
-# third party imports
-import pytest
-import celery
-
-# local imports
-from cic_notify.tasks.sms import db
-from cic_notify.tasks.sms import log
-
-def test_log_notification(
-    celery_session_worker,
-        ):
-
-    recipient = '+25412121212'
-    content = 'bar'
-    s_log = celery.signature('cic_notify.tasks.sms.log.log')
-    t = s_log.apply_async(args=[recipient, content])
-
-    r = t.get()
-
-
-def test_db_notification(
-    init_database,
-    celery_session_worker,
-        ):
-
-    recipient = '+25412121213'
-    content = 'foo'
-    s_db = celery.signature('cic_notify.tasks.sms.db.persist_notification')
-    t = s_db.apply_async(args=[recipient, content])
-
-    r = t.get()

apps/cic-ussd/.coveragerc

@@ -3,4 +3,5 @@ omit =
 	venv/*
 	scripts/*
 	cic_ussd/db/migrations/*
-	cic_ussd/runnable/*
+	cic_ussd/runnable/*
+	cic_ussd/version.py

apps/cic-ussd/cic_ussd/account/guardianship.py

@@ -0,0 +1,22 @@
+# standard imports
+
+# external imports
+
+# local imports
+
+class Guardianship:
+    guardians: list = []
+
+    @classmethod
+    def load_system_guardians(cls, guardians_file: str):
+        with open(guardians_file, 'r') as system_guardians:
+            cls.guardians = [line.strip() for line in system_guardians]
+
+    def is_system_guardian(self, phone_number: str):
+        """
+        :param phone_number:
+        :type phone_number:
+        :return:
+        :rtype:
+        """
+        return phone_number in self.guardians

apps/cic-ussd/cic_ussd/account/statement.py

@@ -13,7 +13,6 @@ from cic_types.condiments import MetadataPointer
 from cic_ussd.account.chain import Chain
 from cic_ussd.account.transaction import from_wei
 from cic_ussd.cache import cache_data_key, get_cached_data
-from cic_ussd.translation import translation_for
 
 logg = logging.getLogger(__name__)
 
@@ -97,17 +96,3 @@ def query_statement(blockchain_address: str, limit: int = 9):
         callback_param=blockchain_address
     )
     cic_eth_api.list(address=blockchain_address, limit=limit)
-
-
-def statement_transaction_set(preferred_language: str, transaction_reprs: list):
-    """
-    :param preferred_language:
-    :type preferred_language:
-    :param transaction_reprs:
-    :type transaction_reprs:
-    :return:
-    :rtype:
-    """
-    if not transaction_reprs:
-        return translation_for('helpers.no_transaction_history', preferred_language)
-    return ''.join(f'{transaction_repr}\n' for transaction_repr in transaction_reprs)

apps/cic-ussd/cic_ussd/account/tokens.py

@@ -15,7 +15,6 @@ from cic_ussd.cache import cache_data, cache_data_key, get_cached_data
 from cic_ussd.error import CachedDataNotFoundError, SeppukuError
 from cic_ussd.metadata.tokens import query_token_info, query_token_metadata
 from cic_ussd.processor.util import wait_for_cache
-from cic_ussd.translation import translation_for
 
 logg = logging.getLogger(__file__)
 
@@ -326,16 +325,3 @@ def set_active_token(blockchain_address: str, token_symbol: str):
     cache_data(key=key, data=token_symbol)
 
 
-def token_list_set(preferred_language: str, token_data_reprs: list):
-    """
-    :param preferred_language:
-    :type preferred_language:
-    :param token_data_reprs:
-    :type token_data_reprs:
-    :return:
-    :rtype:
-    """
-    if not token_data_reprs:
-        return translation_for('helpers.no_tokens_list', preferred_language)
-    return ''.join(f'{token_data_repr}\n' for token_data_repr in token_data_reprs)
-

apps/cic-ussd/cic_ussd/cache.py

@@ -14,7 +14,7 @@ class Cache:
     store: Redis = None
 
 
-def cache_data(key: str, data: str):
+def cache_data(key: str, data: [bytes, float, int, str]):
     """
     :param key:
     :type key:
@@ -55,5 +55,6 @@ def cache_data_key(identifier: Union[list, bytes], salt: MetadataPointer):
             hash_object.update(identity)
     else:
         hash_object.update(identifier)
-    hash_object.update(salt.value.encode(encoding="utf-8"))
+    if salt != MetadataPointer.NONE:
+        hash_object.update(salt.value.encode(encoding="utf-8"))
     return hash_object.digest().hex()

apps/cic-ussd/cic_ussd/db/models/account.py

@@ -63,10 +63,7 @@ class Account(SessionBase):
     def remove_guardian(self, phone_number: str):
         set_guardians = self.guardians.split(',')
         set_guardians.remove(phone_number)
-        if len(set_guardians) > 1:
+        self.guardians = ','.join(set_guardians)
-            self.guardians = ','.join(set_guardians)
-        else:
-            self.guardians = set_guardians[0]
 
     def get_guardians(self) -> list:
         return self.guardians.split(',') if self.guardians else []
@@ -171,7 +168,7 @@ class Account(SessionBase):
         return check_password_hash(password, self.password_hash)
 
 
-def create(chain_str: str, phone_number: str, session: Session):
+def create(chain_str: str, phone_number: str, session: Session, preferred_language: str):
     """
     :param chain_str:
     :type chain_str:
@@ -179,12 +176,14 @@ def create(chain_str: str, phone_number: str, session: Session):
     :type phone_number:
     :param session:
     :type session:
+    :param preferred_language:
+    :type preferred_language:
     :return:
     :rtype:
     """
     api = Api(callback_task='cic_ussd.tasks.callback_handler.account_creation_callback',
               callback_queue='cic-ussd',
-              callback_param='',
+              callback_param=preferred_language,
               chain_str=chain_str)
     task_uuid = api.create_account().id
     TaskTracker.add(session=session, task_uuid=task_uuid)

apps/cic-ussd/cic_ussd/db/ussd_menu.json

@@ -2,417 +2,441 @@
     "ussd_menu": {
         "1": {
             "description": "Entry point for users to select their preferred language.",
-            "display_key": "ussd.kenya.initial_language_selection",
+            "display_key": "ussd.initial_language_selection",
             "name": "initial_language_selection",
             "parent": null
         },
         "2": {
             "description": "Entry point for users to enter a pin to secure their account.",
-            "display_key": "ussd.kenya.initial_pin_entry",
+            "display_key": "ussd.initial_pin_entry",
             "name": "initial_pin_entry",
             "parent": null
         },
         "3": {
             "description": "Pin confirmation entry menu.",
-            "display_key": "ussd.kenya.initial_pin_confirmation",
+            "display_key": "ussd.initial_pin_confirmation",
             "name": "initial_pin_confirmation",
             "parent": "initial_pin_entry"
         },
         "4": {
             "description": "The signup process has been initiated and the account is being created.",
-            "display_key": "ussd.kenya.account_creation_prompt",
+            "display_key": "ussd.account_creation_prompt",
             "name": "account_creation_prompt",
             "parent": null
         },
         "5": {
             "description": "Entry point for activated users.",
-            "display_key": "ussd.kenya.start",
+            "display_key": "ussd.start",
             "name": "start",
             "parent": null
         },
         "6": {
             "description": "Given name entry menu.",
-            "display_key": "ussd.kenya.enter_given_name",
+            "display_key": "ussd.enter_given_name",
             "name": "enter_given_name",
             "parent": "metadata_management"
         },
         "7": {
             "description": "Family name entry menu.",
-            "display_key": "ussd.kenya.enter_family_name",
+            "display_key": "ussd.enter_family_name",
             "name": "enter_family_name",
             "parent": "metadata_management"
         },
         "8": {
             "description": "Gender entry menu.",
-            "display_key": "ussd.kenya.enter_gender",
+            "display_key": "ussd.enter_gender",
             "name": "enter_gender",
             "parent": "metadata_management"
         },
         "9": {
             "description": "Age entry menu.",
-            "display_key": "ussd.kenya.enter_gender",
+            "display_key": "ussd.enter_gender",
             "name": "enter_gender",
             "parent": "metadata_management"
         },
         "10": {
             "description": "Location entry menu.",
-            "display_key": "ussd.kenya.enter_location",
+            "display_key": "ussd.enter_location",
             "name": "enter_location",
             "parent": "metadata_management"
         },
         "11": {
             "description": "Products entry menu.",
-            "display_key": "ussd.kenya.enter_products",
+            "display_key": "ussd.enter_products",
             "name": "enter_products",
             "parent": "metadata_management"
         },
         "12": {
             "description": "Entry point for activated users.",
-            "display_key": "ussd.kenya.start",
+            "display_key": "ussd.start",
             "name": "start",
             "parent": null
         },
         "13": {
             "description": "Send Token recipient entry.",
-            "display_key": "ussd.kenya.enter_transaction_recipient",
+            "display_key": "ussd.enter_transaction_recipient",
             "name": "enter_transaction_recipient",
             "parent": "start"
         },
         "14": {
             "description": "Send Token amount prompt menu.",
-            "display_key": "ussd.kenya.enter_transaction_amount",
+            "display_key": "ussd.enter_transaction_amount",
             "name": "enter_transaction_amount",
             "parent": "start"
         },
         "15": {
             "description": "Pin entry for authorization to send token.",
-            "display_key": "ussd.kenya.transaction_pin_authorization",
+            "display_key": "ussd.transaction_pin_authorization",
             "name": "transaction_pin_authorization",
             "parent": "start"
         },
         "16": {
             "description": "Manage account menu.",
-            "display_key": "ussd.kenya.account_management",
+            "display_key": "ussd.account_management",
             "name": "account_management",
             "parent": "start"
         },
         "17": {
             "description": "Manage metadata menu.",
-            "display_key": "ussd.kenya.metadata_management",
+            "display_key": "ussd.metadata_management",
             "name": "metadata_management",
             "parent": "start"
         },
         "18": {
             "description": "Manage user's preferred language menu.",
-            "display_key": "ussd.kenya.select_preferred_language",
+            "display_key": "ussd.select_preferred_language",
             "name": "select_preferred_language",
             "parent": "account_management"
         },
         "19": {
             "description": "Retrieve mini-statement menu.",
-            "display_key": "ussd.kenya.mini_statement_pin_authorization",
+            "display_key": "ussd.mini_statement_pin_authorization",
             "name": "mini_statement_pin_authorization",
             "parent": "account_management"
         },
         "20": {
             "description": "Manage user's pin menu.",
-            "display_key": "ussd.kenya.enter_current_pin",
+            "display_key": "ussd.enter_current_pin",
             "name": "enter_current_pin",
             "parent": "account_management"
         },
         "21": {
             "description": "New pin entry menu.",
-            "display_key": "ussd.kenya.enter_new_pin",
+            "display_key": "ussd.enter_new_pin",
             "name": "enter_new_pin",
             "parent": "account_management"
         },
         "22": {
             "description": "Pin entry menu.",
-            "display_key": "ussd.kenya.display_metadata_pin_authorization",
+            "display_key": "ussd.display_metadata_pin_authorization",
             "name": "display_metadata_pin_authorization",
             "parent": "start"
         },
         "23": {
             "description": "Exit menu.",
-            "display_key": "ussd.kenya.exit",
+            "display_key": "ussd.exit",
             "name": "exit",
             "parent": null
         },
         "24": {
             "description": "Invalid menu option.",
-            "display_key": "ussd.kenya.exit_invalid_menu_option",
+            "display_key": "ussd.exit_invalid_menu_option",
             "name": "exit_invalid_menu_option",
             "parent": null
         },
         "25": {
             "description": "Pin policy violation.",
-            "display_key": "ussd.kenya.exit_invalid_pin",
+            "display_key": "ussd.exit_invalid_pin",
             "name": "exit_invalid_pin",
             "parent": null
         },
         "26": {
             "description": "Pin mismatch. New pin and the new pin confirmation do not match",
-            "display_key": "ussd.kenya.exit_pin_mismatch",
+            "display_key": "ussd.exit_pin_mismatch",
             "name": "exit_pin_mismatch",
             "parent": null
         },
         "27": {
             "description": "Ussd pin blocked Menu",
-            "display_key": "ussd.kenya.exit_pin_blocked",
+            "display_key": "ussd.exit_pin_blocked",
             "name": "exit_pin_blocked",
             "parent": null
         },
         "28": {
             "description": "Key params missing in request.",
-            "display_key": "ussd.kenya.exit_invalid_request",
+            "display_key": "ussd.exit_invalid_request",
             "name": "exit_invalid_request",
             "parent": null
         },
         "29": {
             "description": "The user did not select a choice.",
-            "display_key": "ussd.kenya.exit_invalid_input",
+            "display_key": "ussd.exit_invalid_input",
             "name": "exit_invalid_input",
             "parent": null
         },
         "30": {
             "description": "Exit following unsuccessful transaction due to insufficient account balance.",
-            "display_key": "ussd.kenya.exit_insufficient_balance",
+            "display_key": "ussd.exit_insufficient_balance",
             "name": "exit_insufficient_balance",
             "parent": null
         },
         "31": {
             "description": "Exit following a successful transaction.",
-            "display_key": "ussd.kenya.exit_successful_transaction",
+            "display_key": "ussd.exit_successful_transaction",
             "name": "exit_successful_transaction",
             "parent": null
         },
         "32": {
             "description": "End of a menu flow.",
-            "display_key": "ussd.kenya.complete",
+            "display_key": "ussd.complete",
             "name": "complete",
             "parent": null
         },
         "33": {
             "description": "Pin entry menu to view account balances.",
-            "display_key": "ussd.kenya.account_balances_pin_authorization",
+            "display_key": "ussd.account_balances_pin_authorization",
             "name": "account_balances_pin_authorization",
             "parent": "account_management"
         },
         "34": {
             "description": "Pin entry menu to view account statement.",
-            "display_key": "ussd.kenya.account_statement_pin_authorization",
+            "display_key": "ussd.account_statement_pin_authorization",
             "name": "account_statement_pin_authorization",
             "parent": "account_management"
         },
         "35": {
             "description": "Menu to display account balances.",
-            "display_key": "ussd.kenya.account_balances",
+            "display_key": "ussd.account_balances",
             "name": "account_balances",
             "parent": "account_management"
         },
         "36": {
             "description": "Menu to display first set of transactions in statement.",
-            "display_key": "ussd.kenya.first_transaction_set",
+            "display_key": "ussd.first_transaction_set",
             "name": "first_transaction_set",
-            "parent": null
+            "parent": "account_management"
         },
         "37": {
             "description": "Menu to display middle set of transactions in statement.",
-            "display_key": "ussd.kenya.middle_transaction_set",
+            "display_key": "ussd.middle_transaction_set",
             "name": "middle_transaction_set",
             "parent": null
         },
         "38": {
             "description": "Menu to display last set of transactions in statement.",
-            "display_key": "ussd.kenya.last_transaction_set",
+            "display_key": "ussd.last_transaction_set",
             "name": "last_transaction_set",
             "parent": null
         },
         "39": {
             "description": "Menu to instruct users to call the office.",
-            "display_key": "ussd.kenya.help",
+            "display_key": "ussd.help",
             "name": "help",
             "parent": null
         },
         "40": {
             "description": "Menu to display a user's entire profile",
-            "display_key": "ussd.kenya.display_user_metadata",
+            "display_key": "ussd.display_user_metadata",
             "name": "display_user_metadata",
             "parent": "metadata_management"
         },
         "41": {
             "description": "The recipient is not in the system",
-            "display_key": "ussd.kenya.exit_invalid_recipient",
+            "display_key": "ussd.exit_invalid_recipient",
             "name": "exit_invalid_recipient",
             "parent": null
         },
         "42": {
             "description": "Pin entry menu for changing name data.",
-            "display_key": "ussd.kenya.name_edit_pin_authorization",
+            "display_key": "ussd.name_edit_pin_authorization",
             "name": "name_edit_pin_authorization",
             "parent": "metadata_management"
         },
         "43": {
             "description": "Pin entry menu for changing gender data.",
-            "display_key": "ussd.kenya.gender_edit_pin_authorization",
+            "display_key": "ussd.gender_edit_pin_authorization",
             "name": "gender_edit_pin_authorization",
             "parent": "metadata_management"
         },
         "44": {
             "description": "Pin entry menu for changing location data.",
-            "display_key": "ussd.kenya.location_edit_pin_authorization",
+            "display_key": "ussd.location_edit_pin_authorization",
             "name": "location_edit_pin_authorization",
             "parent": "metadata_management"
         },
         "45": {
             "description": "Pin entry menu for changing products data.",
-            "display_key": "ussd.kenya.products_edit_pin_authorization",
+            "display_key": "ussd.products_edit_pin_authorization",
             "name": "products_edit_pin_authorization",
             "parent": "metadata_management"
         },
         "46": {
             "description": "Pin confirmation for pin change.",
-            "display_key": "ussd.kenya.new_pin_confirmation",
+            "display_key": "ussd.new_pin_confirmation",
             "name": "new_pin_confirmation",
             "parent": "metadata_management"
         },
         "47": {
             "description": "Year of birth entry menu.",
-            "display_key": "ussd.kenya.enter_date_of_birth",
+            "display_key": "ussd.enter_date_of_birth",
             "name": "enter_date_of_birth",
             "parent": "metadata_management"
         },
         "48": {
             "description": "Pin entry menu for changing year of birth data.",
-            "display_key": "ussd.kenya.dob_edit_pin_authorization",
+            "display_key": "ussd.dob_edit_pin_authorization",
             "name": "dob_edit_pin_authorization",
             "parent": "metadata_management"
         },
         "49": {
             "description": "Menu to display first set of tokens in the account's token list.",
-            "display_key": "ussd.kenya.first_account_tokens_set",
+            "display_key": "ussd.first_account_tokens_set",
             "name": "first_account_tokens_set",
-            "parent": null
+            "parent": "start"
         },
         "50": {
             "description": "Menu to display middle set of tokens in the account's token list.",
-            "display_key": "ussd.kenya.middle_account_tokens_set",
+            "display_key": "ussd.middle_account_tokens_set",
             "name": "middle_account_tokens_set",
             "parent": null
         },
         "51": {
             "description": "Menu to display last set of tokens in the account's token list.",
-            "display_key": "ussd.kenya.last_account_tokens_set",
+            "display_key": "ussd.last_account_tokens_set",
             "name": "last_account_tokens_set",
             "parent": null
         },
         "52": {
             "description": "Pin entry menu for setting an active token.",
-            "display_key": "ussd.kenya.token_selection_pin_authorization",
+            "display_key": "ussd.token_selection_pin_authorization",
             "name": "token_selection_pin_authorization",
-            "parent": null
+            "parent": "first_account_tokens_set"
         },
         "53": {
             "description": "Exit following a successful active token setting.",
-            "display_key": "ussd.kenya.exit_successful_token_selection",
+            "display_key": "ussd.exit_successful_token_selection",
             "name": "exit_successful_token_selection",
             "parent": null
         },
         "54": {
             "description": "Pin management menu for operations related to an account's pin.",
-            "display_key": "ussd.kenya.pin_management",
+            "display_key": "ussd.pin_management",
             "name": "pin_management",
             "parent": "start"
         },
         "55": {
             "description": "Phone number entry for account whose pin is being reset.",
-            "display_key": "ussd.kenya.reset_guarded_pin",
+            "display_key": "ussd.reset_guarded_pin",
             "name": "reset_guarded_pin",
             "parent": "pin_management"
         },
         "56": {
             "description": "Pin entry for initiating request to reset an account's pin.",
-            "display_key": "ussd.kenya.reset_guarded_pin_authorization",
+            "display_key": "ussd.reset_guarded_pin_authorization",
             "name": "reset_guarded_pin_authorization",
             "parent": "pin_management"
         },
         "57": {
             "description": "Exit menu following successful pin reset initiation.",
-            "display_key": "ussd.kenya.exit_pin_reset_initiated_success",
+            "display_key": "ussd.exit_pin_reset_initiated_success",
             "name": "exit_pin_reset_initiated_success",
             "parent": "pin_management"
         },
         "58": {
             "description": "Exit menu in the event that an account is not a set guardian.",
-            "display_key": "ussd.kenya.exit_not_authorized_for_pin_reset",
+            "display_key": "ussd.exit_not_authorized_for_pin_reset",
             "name": "exit_not_authorized_for_pin_reset",
             "parent": "pin_management"
         },
         "59": {
             "description": "Pin guard menu for handling guardianship operations.",
-            "display_key": "ussd.kenya.guard_pin",
+            "display_key": "ussd.guard_pin",
             "name": "guard_pin",
             "parent": "pin_management"
         },
         "60": {
             "description": "Pin entry to display a list of set guardians.",
-            "display_key": "ussd.kenya.guardian_list_pin_authorization",
+            "display_key": "ussd.guardian_list_pin_authorization",
             "name": "guardian_list_pin_authorization",
             "parent": "guard_pin"
         },
         "61": {
             "description": "Menu to display list of set guardians.",
-            "display_key": "ussd.kenya.guardian_list",
+            "display_key": "ussd.guardian_list",
             "name": "guardian_list",
             "parent": "guard_pin"
         },
         "62": {
             "description": "Phone number entry to add an account as a guardian to reset pin.",
-            "display_key": "ussd.kenya.add_guardian",
+            "display_key": "ussd.add_guardian",
             "name": "add_guardian",
             "parent": "guard_pin"
         },
         "63": {
             "description": "Pin entry to confirm addition of an account as a guardian.",
-            "display_key": "ussd.kenya.add_guardian_pin_authorization",
+            "display_key": "ussd.add_guardian_pin_authorization",
             "name": "add_guardian_pin_authorization",
             "parent": "guard_pin"
         },
         "64": {
             "description": "Exit menu when an account is successfully added as pin reset guardian.",
-            "display_key": "ussd.kenya.exit_guardian_addition_success",
+            "display_key": "ussd.exit_guardian_addition_success",
             "name": "exit_guardian_addition_success",
             "parent": "guard_pin"
         },
         "65": {
             "description": "Phone number entry to remove an account as a guardian to reset pin.",
-            "display_key": "ussd.kenya.remove_guardian",
+            "display_key": "ussd.remove_guardian",
             "name": "remove_guardian",
             "parent": "guard_pin"
         },
         "66": {
             "description": "Pin entry to confirm removal of an account as a guardian.",
-            "display_key": "ussd.kenya.remove_guardian_pin_authorization",
+            "display_key": "ussd.remove_guardian_pin_authorization",
             "name": "remove_guardian_pin_authorization",
             "parent": "guard_pin"
         },
         "67": {
             "description": "Exit menu when an account is successfully removed as pin reset guardian.",
-            "display_key": "ussd.kenya.exit_guardian_removal_success",
+            "display_key": "ussd.exit_guardian_removal_success",
             "name": "exit_guardian_removal_success",
             "parent": "guard_pin"
         },
         "68": {
-            "description": "Exit menu when invalid phone number entry for guardian addition. ",
+            "description": "Exit menu when invalid phone number entry for guardian addition.",
-            "display_key": "ussd.kenya.exit_invalid_guardian_addition",
+            "display_key": "ussd.exit_invalid_guardian_addition",
             "name": "exit_invalid_guardian_addition",
             "parent": "guard_pin"
         },
         "69": {
-            "description": "Exit menu when invalid phone number entry for guardian removal. ",
+            "description": "Exit menu when invalid phone number entry for guardian removal.",
-            "display_key": "ussd.kenya.exit_invalid_guardian_removal",
+            "display_key": "ussd.exit_invalid_guardian_removal",
             "name": "exit_invalid_guardian_removal",
             "parent": "guard_pin"
+        },
+        "70": {
+            "description": "Menu to display middle set of languages to select.",
+            "display_key": "ussd.initial_middle_language_set",
+            "name": "initial_middle_language_set",
+            "parent": null
+        },
+        "71": {
+            "description": "Menu to display last set of languages to select.",
+            "display_key": "ussd.initial_last_language_set",
+            "name": "initial_last_language_set",
+            "parent": null
+        },
+        "72": {
+            "description": "Menu to display middle set of languages to select.",
+            "display_key": "ussd.middle_language_set",
+            "name": "middle_language_set",
+            "parent": null
+        },
+        "73": {
+            "description": "Menu to display last set of languages to select.",
+            "display_key": "ussd.last_language_set",
+            "name": "last_language_set",
+            "parent": null
         }
     }
 }

apps/cic-ussd/cic_ussd/metadata/__init__.py

@@ -7,3 +7,4 @@ from .custom import CustomMetadata
 from .person import PersonMetadata
 from .phone import PhonePointerMetadata
 from .preferences import PreferencesMetadata
+from .tokens import TokenMetadata

apps/cic-ussd/cic_ussd/processor/menu.py

@@ -19,34 +19,33 @@ from cic_ussd.account.metadata import get_cached_preferred_language
 from cic_ussd.account.statement import (
     get_cached_statement,
     parse_statement_transactions,
-    query_statement,
+    query_statement)
-    statement_transaction_set
-)
 from cic_ussd.account.tokens import (create_account_tokens_list,
                                      get_active_token_symbol,
                                      get_cached_token_data,
                                      get_cached_token_symbol_list,
                                      get_cached_token_data_list,
-                                     parse_token_list,
+                                     parse_token_list)
-                                     token_list_set)
 from cic_ussd.account.transaction import from_wei, to_wei
-from cic_ussd.cache import cache_data_key, cache_data
+from cic_ussd.cache import cache_data_key, cache_data, get_cached_data
 from cic_ussd.db.models.account import Account
 from cic_ussd.metadata import PersonMetadata
 from cic_ussd.phone_number import Support
-from cic_ussd.processor.util import parse_person_metadata
+from cic_ussd.processor.util import parse_person_metadata, ussd_menu_list, wait_for_session_data
 from cic_ussd.session.ussd_session import save_session_data
+from cic_ussd.state_machine.logic.language import preferred_langauge_from_selection
 from cic_ussd.translation import translation_for
 from sqlalchemy.orm.session import Session
 
-logg = logging.getLogger(__name__)
+logg = logging.getLogger(__file__)
 
 
 class MenuProcessor:
     def __init__(self, account: Account, display_key: str, menu_name: str, session: Session, ussd_session: dict):
         self.account = account
         self.display_key = display_key
-        self.identifier = bytes.fromhex(self.account.blockchain_address)
+        if account:
+            self.identifier = bytes.fromhex(self.account.blockchain_address)
         self.menu_name = menu_name
         self.session = session
         self.ussd_session = ussd_session
@@ -89,36 +88,29 @@ class MenuProcessor:
         :rtype:
         """
         cached_statement = get_cached_statement(self.account.blockchain_address)
-        transaction_sets = []
+
-        if cached_statement:
-            statement = json.loads(cached_statement)
-            statement_transactions = parse_statement_transactions(statement)
-            transaction_sets = [statement_transactions[tx:tx + 3] for tx in range(0, len(statement_transactions), 3)]
         preferred_language = get_cached_preferred_language(self.account.blockchain_address)
         if not preferred_language:
             preferred_language = i18n.config.get('fallback')
-        no_transaction_history = statement_transaction_set(preferred_language, transaction_sets)
-        first_transaction_set = no_transaction_history
-        middle_transaction_set = no_transaction_history
-        last_transaction_set = no_transaction_history
-        if transaction_sets:
-            first_transaction_set = statement_transaction_set(preferred_language, transaction_sets[0])
-        if len(transaction_sets) >= 2:
-            middle_transaction_set = statement_transaction_set(preferred_language, transaction_sets[1])
-        if len(transaction_sets) >= 3:
-            last_transaction_set = statement_transaction_set(preferred_language, transaction_sets[2])
 
-        if self.display_key == 'ussd.kenya.first_transaction_set':
+        statement_list = []
+        if cached_statement:
+            statement_list = parse_statement_transactions(statement=json.loads(cached_statement))
+
+        fallback = translation_for('helpers.no_transaction_history', preferred_language)
+        transaction_sets = ussd_menu_list(fallback=fallback, menu_list=statement_list, split=3)
+
+        if self.display_key == 'ussd.first_transaction_set':
             return translation_for(
-                self.display_key, preferred_language, first_transaction_set=first_transaction_set
+                self.display_key, preferred_language, first_transaction_set=transaction_sets[0]
             )
-        if self.display_key == 'ussd.kenya.middle_transaction_set':
+        if self.display_key == 'ussd.middle_transaction_set':
             return translation_for(
-                self.display_key, preferred_language, middle_transaction_set=middle_transaction_set
+                self.display_key, preferred_language, middle_transaction_set=transaction_sets[1]
             )
-        if self.display_key == 'ussd.kenya.last_transaction_set':
+        if self.display_key == 'ussd.last_transaction_set':
             return translation_for(
-                self.display_key, preferred_language, last_transaction_set=last_transaction_set
+                self.display_key, preferred_language, last_transaction_set=transaction_sets[2]
             )
 
     def add_guardian_pin_authorization(self):
@@ -129,7 +121,7 @@ class MenuProcessor:
         preferred_language = get_cached_preferred_language(self.account.blockchain_address)
         if not preferred_language:
             preferred_language = i18n.config.get('fallback')
-        set_guardians = self.account.get_guardians()
+        set_guardians = self.account.get_guardians()[:3]
         if set_guardians:
             guardians_list = ''
             guardians_list_header = translation_for('helpers.guardians_list_header', preferred_language)
@@ -145,36 +137,30 @@ class MenuProcessor:
     def account_tokens(self) -> str:
         cached_token_data_list = get_cached_token_data_list(self.account.blockchain_address)
         token_data_list = parse_token_list(cached_token_data_list)
-        token_list_sets = [token_data_list[tds:tds + 3] for tds in range(0, len(token_data_list), 3)]
+
         preferred_language = get_cached_preferred_language(self.account.blockchain_address)
         if not preferred_language:
             preferred_language = i18n.config.get('fallback')
-        no_token_list = token_list_set(preferred_language, [])
-        first_account_tokens_set = no_token_list
-        middle_account_tokens_set = no_token_list
-        last_account_tokens_set = no_token_list
-        if token_list_sets:
-            data = {
-                'account_tokens_list': cached_token_data_list
-            }
-            save_session_data(data=data, queue='cic-ussd', session=self.session, ussd_session=self.ussd_session)
-            first_account_tokens_set = token_list_set(preferred_language, token_list_sets[0])
 
-        if len(token_list_sets) >= 2:
+        fallback = translation_for('helpers.no_tokens_list', preferred_language)
-            middle_account_tokens_set = token_list_set(preferred_language, token_list_sets[1])
+        token_list_sets = ussd_menu_list(fallback=fallback, menu_list=token_data_list, split=3)
-        if len(token_list_sets) >= 3:
+
-            last_account_tokens_set = token_list_set(preferred_language, token_list_sets[2])
+        data = {
-        if self.display_key == 'ussd.kenya.first_account_tokens_set':
+            'account_tokens_list': cached_token_data_list
+        }
+        save_session_data(data=data, queue='cic-ussd', session=self.session, ussd_session=self.ussd_session)
+
+        if self.display_key == 'ussd.first_account_tokens_set':
             return translation_for(
-                self.display_key, preferred_language, first_account_tokens_set=first_account_tokens_set
+                self.display_key, preferred_language, first_account_tokens_set=token_list_sets[0]
             )
-        if self.display_key == 'ussd.kenya.middle_account_tokens_set':
+        if self.display_key == 'ussd.middle_account_tokens_set':
             return translation_for(
-                self.display_key, preferred_language, middle_account_tokens_set=middle_account_tokens_set
+                self.display_key, preferred_language, middle_account_tokens_set=token_list_sets[1]
             )
-        if self.display_key == 'ussd.kenya.last_account_tokens_set':
+        if self.display_key == 'ussd.last_account_tokens_set':
             return translation_for(
-                self.display_key, preferred_language, last_account_tokens_set=last_account_tokens_set
+                self.display_key, preferred_language, last_account_tokens_set=token_list_sets[2]
             )
 
     def help(self) -> str:
@@ -222,7 +208,7 @@ class MenuProcessor:
         remaining_attempts = 3
         remaining_attempts -= self.account.failed_pin_attempts
         retry_pin_entry = translation_for(
-            'ussd.kenya.retry_pin_entry', preferred_language, remaining_attempts=remaining_attempts
+            'ussd.retry_pin_entry', preferred_language, remaining_attempts=remaining_attempts
         )
         return translation_for(
             f'{self.display_key}.retry', preferred_language, retry_pin_entry=retry_pin_entry
@@ -238,6 +224,38 @@ class MenuProcessor:
         guardian = Account.get_by_phone_number(guardian_phone_number, self.session)
         return guardian.standard_metadata_id()
 
+    def language(self):
+        key = cache_data_key('system:languages'.encode('utf-8'), MetadataPointer.NONE)
+        cached_system_languages = get_cached_data(key)
+        language_list: list = json.loads(cached_system_languages)
+
+        if self.account:
+            preferred_language = get_cached_preferred_language(self.account.blockchain_address)
+        else:
+            preferred_language = i18n.config.get('fallback')
+
+        fallback = translation_for('helpers.no_language_list', preferred_language)
+        language_list_sets = ussd_menu_list(fallback=fallback, menu_list=language_list, split=3)
+
+        if self.display_key in ['ussd.initial_language_selection', 'ussd.select_preferred_language']:
+            return translation_for(
+                self.display_key, preferred_language, first_language_set=language_list_sets[0]
+            )
+
+        if 'middle_language_set' in self.display_key:
+            return translation_for(
+                self.display_key, preferred_language, middle_language_set=language_list_sets[1]
+            )
+
+        if 'last_language_set' in self.display_key:
+            return translation_for(
+                self.display_key, preferred_language, last_language_set=language_list_sets[2]
+            )
+
+    def account_creation_prompt(self):
+        preferred_language = preferred_langauge_from_selection(self.ussd_session.get('user_input'))
+        return translation_for(self.display_key, preferred_language)
+
     def reset_guarded_pin_authorization(self):
         guarded_account_information = self.guarded_account_metadata()
         return self.pin_authorization(guarded_account_information=guarded_account_information)
@@ -381,8 +399,9 @@ class MenuProcessor:
         )
 
     def exit_invalid_menu_option(self):
-        preferred_language = get_cached_preferred_language(self.account.blockchain_address)
+        if self.account:
-        if not preferred_language:
+            preferred_language = get_cached_preferred_language(self.account.blockchain_address)
+        else:
             preferred_language = i18n.config.get('fallback')
         return translation_for(self.display_key, preferred_language, support_phone=Support.phone_number)
 
@@ -390,7 +409,7 @@ class MenuProcessor:
         preferred_language = get_cached_preferred_language(self.account.blockchain_address)
         if not preferred_language:
             preferred_language = i18n.config.get('fallback')
-        return translation_for('ussd.kenya.exit_pin_blocked', preferred_language, support_phone=Support.phone_number)
+        return translation_for('ussd.exit_pin_blocked', preferred_language, support_phone=Support.phone_number)
 
     def exit_successful_token_selection(self) -> str:
         selected_token = self.ussd_session.get('data').get('selected_token')
@@ -398,7 +417,7 @@ class MenuProcessor:
         preferred_language = get_cached_preferred_language(self.account.blockchain_address)
         if not preferred_language:
             preferred_language = i18n.config.get('fallback')
-        return translation_for(self.display_key,preferred_language,token_symbol=token_symbol)
+        return translation_for(self.display_key, preferred_language, token_symbol=token_symbol)
 
     def exit_successful_transaction(self):
         """
@@ -445,6 +464,9 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio
     """
     menu_processor = MenuProcessor(account, display_key, menu_name, session, ussd_session)
 
+    if menu_name == 'account_creation_prompt':
+        return menu_processor.account_creation_prompt()
+
     if menu_name == 'start':
         return menu_processor.start_menu()
 
@@ -502,6 +524,9 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio
     if 'account_tokens_set' in menu_name:
         return menu_processor.account_tokens()
 
+    if 'language' in menu_name:
+        return menu_processor.language()
+
     if menu_name == 'display_user_metadata':
         return menu_processor.person_metadata()
 
@@ -515,5 +540,4 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio
         return menu_processor.exit_successful_token_selection()
 
     preferred_language = get_cached_preferred_language(account.blockchain_address)
-
     return translation_for(display_key, preferred_language)

apps/cic-ussd/cic_ussd/processor/ussd.py

@@ -8,7 +8,7 @@ from sqlalchemy.orm.session import Session
 from tinydb.table import Document
 
 # local imports
-from cic_ussd.db.models.account import Account, create
+from cic_ussd.db.models.account import Account
 from cic_ussd.db.models.base import SessionBase
 from cic_ussd.db.models.ussd_session import UssdSession
 from cic_ussd.menu.ussd_menu import UssdMenu
@@ -16,7 +16,6 @@ from cic_ussd.processor.menu import response
 from cic_ussd.processor.util import latest_input, resume_last_ussd_session
 from cic_ussd.session.ussd_session import create_or_update_session, persist_ussd_session
 from cic_ussd.state_machine import UssdStateMachine
-from cic_ussd.translation import translation_for
 from cic_ussd.validator import is_valid_response
 
 
@@ -36,9 +35,6 @@ def handle_menu(account: Account, session: Session) -> Document:
         last_ussd_session = UssdSession.last_ussd_session(account.phone_number, session)
         if last_ussd_session:
             return resume_last_ussd_session(last_ussd_session.state)
-
-    elif not account.has_preferred_language():
-        return UssdMenu.find_by_name('initial_language_selection')
     else:
         return UssdMenu.find_by_name('initial_pin_entry')
 
@@ -71,16 +67,13 @@ def get_menu(account: Account,
     return UssdMenu.find_by_name(state)
 
 
-def handle_menu_operations(chain_str: str,
+def handle_menu_operations(external_session_id: str,
-                           external_session_id: str,
                            phone_number: str,
                            queue: str,
                            service_code: str,
                            session,
                            user_input: str):
     """
-    :param chain_str:
-    :type chain_str:
     :param external_session_id:
     :type external_session_id:
     :param phone_number:
@@ -100,10 +93,38 @@ def handle_menu_operations(chain_str: str,
     account: Account = Account.get_by_phone_number(phone_number, session)
     if account:
         return handle_account_menu_operations(account, external_session_id, queue, session, service_code, user_input)
-    create(chain_str, phone_number, session)
+    else:
-    menu = UssdMenu.find_by_name('account_creation_prompt')
+        return handle_no_account_menu_operations(
-    preferred_language = i18n.config.get('fallback')
+            account, external_session_id, phone_number, queue, session, service_code, user_input)
-    create_or_update_session(
+
+
+def handle_no_account_menu_operations(account: Optional[Account],
+                                      external_session_id: str,
+                                      phone_number: str,
+                                      queue: str,
+                                      session: Session,
+                                      service_code: str,
+                                      user_input: str):
+    """
+    :param account:
+    :type account:
+    :param external_session_id:
+    :type external_session_id:
+    :param phone_number:
+    :type phone_number:
+    :param queue:
+    :type queue:
+    :param session:
+    :type session:
+    :param service_code:
+    :type service_code:
+    :param user_input:
+    :type user_input:
+    :return:
+    :rtype:
+    """
+    menu = UssdMenu.find_by_name('initial_language_selection')
+    ussd_session = create_or_update_session(
         external_session_id=external_session_id,
         msisdn=phone_number,
         service_code=service_code,
@@ -111,7 +132,20 @@ def handle_menu_operations(chain_str: str,
         session=session,
         user_input=user_input)
     persist_ussd_session(external_session_id, queue)
-    return translation_for('ussd.kenya.account_creation_prompt', preferred_language)
+    last_ussd_session: UssdSession = UssdSession.last_ussd_session(phone_number, session)
+    if last_ussd_session:
+        if not user_input:
+            menu = resume_last_ussd_session(last_ussd_session.state)
+        else:
+            session = SessionBase.bind_session(session)
+            state = next_state(account, session, user_input, last_ussd_session.to_json())
+            menu = UssdMenu.find_by_name(state)
+
+    return response(account=account,
+                    display_key=menu.get('display_key'),
+                    menu_name=menu.get('name'),
+                    session=session,
+                    ussd_session=ussd_session.to_json())
 
 
 def handle_account_menu_operations(account: Account,
@@ -152,15 +186,12 @@ def handle_account_menu_operations(account: Account,
     if last_ussd_session:
         ussd_session = create_or_update_session(
             external_session_id, phone_number, service_code, user_input, menu.get('name'), session,
-            last_ussd_session.data
+            last_ussd_session.data)
-        )
     else:
         ussd_session = create_or_update_session(
-            external_session_id, phone_number, service_code, user_input, menu.get('name'), session, None
+            external_session_id, phone_number, service_code, user_input, menu.get('name'), session, {})
-        )
     menu_response = response(
-        account, menu.get('display_key'), menu.get('name'), session, ussd_session.to_json()
+        account, menu.get('display_key'), menu.get('name'), session, ussd_session.to_json())
-    )
     if not is_valid_response(menu_response):
         raise ValueError(f'Invalid response: {response}')
     persist_ussd_session(external_session_id, queue)

apps/cic-ussd/cic_ussd/processor/util.py

@@ -3,7 +3,7 @@ import datetime
 import json
 import logging
 import time
-from typing import Union
+from typing import List, Union
 
 # external imports
 from cic_types.condiments import MetadataPointer
@@ -21,9 +21,7 @@ logg = logging.getLogger(__file__)
 def latest_input(user_input: str) -> str:
     """
     :param user_input:
-    :type user_input:
     :return:
-    :rtype:
     """
     return user_input.split('*')[-1]
 
@@ -85,6 +83,27 @@ def resume_last_ussd_session(last_state: str) -> Document:
     return UssdMenu.find_by_name(last_state)
 
 
+def ussd_menu_list(fallback: str, menu_list: list, split: int = 3) -> List[str]:
+    """
+    :param fallback:
+    :type fallback:
+    :param menu_list:
+    :type menu_list:
+    :param split:
+    :type split:
+    :return:
+    :rtype:
+    """
+    menu_list_sets = [menu_list[item:item + split] for item in range(0, len(menu_list), split)]
+    menu_list_reprs = []
+    for i in range(split):
+        try:
+            menu_list_reprs.append(''.join(f'{list_set_item}\n' for list_set_item in menu_list_sets[i]).rstrip('\n'))
+        except IndexError:
+            menu_list_reprs.append(fallback)
+    return menu_list_reprs
+
+
 def wait_for_cache(identifier: Union[list, bytes], resource_name: str, salt: MetadataPointer, interval: int = 1, max_retry: int = 5):
     """
     :param identifier:
@@ -132,17 +151,28 @@ def wait_for_session_data(resource_name: str, session_data_key: str, ussd_sessio
     :return:
     :rtype:
     """
-    session_data = ussd_session.get('data').get(session_data_key)
+    data = ussd_session.get('data')
-    counter = 0
+    data_poller = 0
-    while session_data is None:
+    while not data:
-        logg.debug(f'Waiting for: {resource_name}. Checking after: {interval} ...')
+        logg.debug(f'Waiting for data object on ussd session: {ussd_session.get("external_session_id")}')
+        logg.debug(f'Data poller at: {data_poller}. Checking again after: {interval} secs...')
         time.sleep(interval)
-        counter += 1
+        data_poller += 1
-        session_data = ussd_session.get('data').get(session_data_key)
+        if data:
-        if session_data is not None:
+            logg.debug(f'Data object found, proceeding to poll for: {session_data_key}')
-            logg.debug(f'{resource_name} now available.')
             break
-        else:
+    if data:
-            if counter == max_retry:
+        session_data_poller = 0
-                logg.debug(f'Could not find: {resource_name} within: {max_retry}')
+        session_data = data.get(session_data_key)
+        while not session_data_key:
+            logg.debug(
+                f'Session data poller at: {data_poller} with max retry at: {max_retry}. Checking again after: {interval} secs...')
+            time.sleep(interval)
+            session_data_poller += 1
+
+            if session_data:
+                logg.debug(f'{resource_name} now available.')
                 break
+
+            elif session_data_poller >= max_retry:
+                logg.debug(f'Could not find data object within: {max_retry}')

apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_tasker.py

@@ -20,6 +20,7 @@ from cic_ussd.db import dsn_from_config
 from cic_ussd.db.models.base import SessionBase
 from cic_ussd.phone_number import Support
 from cic_ussd.session.ussd_session import UssdSession as InMemoryUssdSession
+from cic_ussd.translation import generate_locale_files
 from cic_ussd.validator import validate_presence
 
 logging.basicConfig(level=logging.WARNING)
@@ -83,6 +84,10 @@ if key_file_path:
     validate_presence(path=key_file_path)
 Signer.key_file_path = key_file_path
 
+generate_locale_files(locale_dir=config.get('LOCALE_PATH'),
+                      schema_file_path=config.get('SCHEMA_FILE_PATH'),
+                      translation_builder_path=config.get('LOCALE_FILE_BUILDERS'))
+
 # set up translations
 i18n.load_path.append(config.get('LOCALE_PATH'))
 i18n.set('fallback', config.get('LOCALE_FALLBACK'))

apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_ussd_server.py

@@ -18,6 +18,7 @@ from cic_types.ext.metadata.signer import Signer
 
 # local imports
 from cic_ussd.account.chain import Chain
+from cic_ussd.account.guardianship import Guardianship
 from cic_ussd.account.tokens import query_default_token
 from cic_ussd.cache import cache_data, cache_data_key, Cache
 from cic_ussd.db import dsn_from_config
@@ -33,7 +34,7 @@ from cic_ussd.processor.ussd import handle_menu_operations
 from cic_ussd.runnable.server_base import exportable_parser, logg
 from cic_ussd.session.ussd_session import UssdSession as InMemoryUssdSession
 from cic_ussd.state_machine import UssdStateMachine
-from cic_ussd.translation import translation_for
+from cic_ussd.translation import generate_locale_files, Languages, translation_for
 from cic_ussd.validator import check_ip, check_request_content_length, validate_phone_number, validate_presence
 
 args = exportable_parser.parse_args()
@@ -56,10 +57,6 @@ SessionBase.connect(data_source_name,
                     pool_size=int(config.get('DATABASE_POOL_SIZE')),
                     debug=config.true('DATABASE_DEBUG'))
 
-# set up translations
-i18n.load_path.append(config.get('LOCALE_PATH'))
-i18n.set('fallback', config.get('LOCALE_FALLBACK'))
-
 # set Fernet key
 PasswordEncoder.set_key(config.get('APP_PASSWORD_PEPPER'))
 
@@ -121,6 +118,22 @@ valid_service_codes = config.get('USSD_SERVICE_CODE').split(",")
 E164Format.region = config.get('E164_REGION')
 Support.phone_number = config.get('OFFICE_SUPPORT_PHONE')
 
+validate_presence(config.get('SYSTEM_GUARDIANS_FILE'))
+Guardianship.load_system_guardians(config.get('SYSTEM_GUARDIANS_FILE'))
+
+generate_locale_files(locale_dir=config.get('LOCALE_PATH'),
+                      schema_file_path=config.get('SCHEMA_FILE_PATH'),
+                      translation_builder_path=config.get('LOCALE_FILE_BUILDERS'))
+
+# set up translations
+i18n.load_path.append(config.get('LOCALE_PATH'))
+i18n.set('fallback', config.get('LOCALE_FALLBACK'))
+
+validate_presence(config.get('LANGUAGES_FILE'))
+Languages.load_languages_dict(config.get('LANGUAGES_FILE'))
+languages = Languages()
+languages.cache_system_languages()
+
 
 def application(env, start_response):
     """Loads python code for application to be accessible over web server
@@ -175,7 +188,7 @@ def application(env, start_response):
 
         if service_code not in valid_service_codes:
             response = translation_for(
-                'ussd.kenya.invalid_service_code',
+                'ussd.invalid_service_code',
                 i18n.config.get('fallback'),
                 valid_service_code=valid_service_codes[0]
             )
@@ -189,9 +202,7 @@ def application(env, start_response):
             return []
         logg.debug('session {} started for {}'.format(external_session_id, phone_number))
 
-        response = handle_menu_operations(
+        response = handle_menu_operations(external_session_id, phone_number, args.q, service_code, session, user_input)
-            chain_str, external_session_id, phone_number, args.q, service_code, session, user_input
-        )
         response_bytes, headers = with_content_headers(headers, response)
         start_response('200 OK,', headers)
         session.commit()

apps/cic-ussd/cic_ussd/state_machine/logic/account.py

@@ -11,46 +11,20 @@ from cic_types.models.person import get_contact_data_from_vcard, generate_vcard_
 
 # local imports
 from cic_ussd.account.chain import Chain
-from cic_ussd.account.maps import gender, language
+from cic_ussd.account.maps import gender
 from cic_ussd.account.metadata import get_cached_preferred_language
-from cic_ussd.db.models.account import Account
+from cic_ussd.db.models.account import Account, create
 from cic_ussd.db.models.base import SessionBase
 from cic_ussd.error import MetadataNotFoundError
 from cic_ussd.metadata import PersonMetadata
 from cic_ussd.session.ussd_session import save_session_data
+from cic_ussd.state_machine.logic.language import preferred_langauge_from_selection
 from cic_ussd.translation import translation_for
 from sqlalchemy.orm.session import Session
 
 logg = logging.getLogger(__file__)
 
 
-def change_preferred_language(state_machine_data: Tuple[str, dict, Account, Session]):
-    """
-    :param state_machine_data:
-    :type state_machine_data:
-    :return:
-    :rtype:
-    """
-    user_input, ussd_session, account, session = state_machine_data
-    r_user_input = language().get(user_input)
-    session = SessionBase.bind_session(session)
-    account.preferred_language = r_user_input
-    session.add(account)
-    session.flush()
-    SessionBase.release_session(session)
-
-    preferences_data = {
-        'preferred_language': r_user_input
-    }
-
-    s = celery.signature(
-        'cic_ussd.tasks.metadata.add_preferences_metadata',
-        [account.blockchain_address, preferences_data],
-        queue='cic-ussd'
-    )
-    return s.apply_async()
-
-
 def update_account_status_to_active(state_machine_data: Tuple[str, dict, Account, Session]):
     """This function sets user's account to active.
     :param state_machine_data: A tuple containing user input, a ussd session and user object.
@@ -245,3 +219,16 @@ def edit_user_metadata_attribute(state_machine_data: Tuple[str, dict, Account, S
         [blockchain_address, parsed_person_metadata]
     )
     s_edit_person_metadata.apply_async(queue='cic-ussd')
+
+
+def process_account_creation(state_machine_data: Tuple[str, dict, Account, Session]):
+    """
+    :param state_machine_data:
+    :type state_machine_data:
+    :return:
+    :rtype:
+    """
+    user_input, ussd_session, account, session = state_machine_data
+    preferred_language = preferred_langauge_from_selection(user_input=user_input)
+    chain_str = Chain.spec.__str__()
+    create(chain_str, ussd_session.get('msisdn'), session, preferred_language)

apps/cic-ussd/cic_ussd/state_machine/logic/language.py

@@ -0,0 +1,95 @@
+# standard imports
+import json
+from typing import Tuple
+
+# external imports
+import celery
+import i18n
+from cic_types.condiments import MetadataPointer
+from sqlalchemy.orm.session import Session
+
+# local imports
+from cic_ussd.cache import cache_data_key, get_cached_data
+from cic_ussd.db.models.account import Account
+from cic_ussd.processor.util import wait_for_cache, wait_for_session_data
+from cic_ussd.session.ussd_session import save_session_data
+from cic_ussd.translation import Languages
+
+
+def is_valid_language_selection(state_machine_data: Tuple[str, dict, Account, Session]):
+    """
+    :param state_machine_data:
+    :type state_machine_data:
+    :return:
+    :rtype:
+    """
+    user_input, ussd_session, account, session = state_machine_data
+
+    key = cache_data_key('system:languages'.encode('utf-8'), MetadataPointer.NONE)
+    cached_system_languages = get_cached_data(key)
+    language_list = json.loads(cached_system_languages)
+
+    if not language_list:
+        wait_for_cache(identifier='system:languages'.encode('utf-8'), resource_name='Languages list', salt=MetadataPointer.NONE)
+
+    if user_input in ['00', '11', '22']:
+        return False
+    user_input = int(user_input)
+    return user_input <= len(language_list)
+
+
+def change_preferred_language(state_machine_data: Tuple[str, dict, Account, Session]):
+    """
+    :param state_machine_data:
+    :type state_machine_data:
+    :return:
+    :rtype:
+    """
+    process_language_selection(state_machine_data=state_machine_data)
+    user_input, ussd_session, account, session = state_machine_data
+    wait_for_session_data(resource_name='Preferred language', session_data_key='preferred_language', ussd_session=ussd_session)
+    preferred_language = ussd_session.get('data').get('preferred_language')
+    preferences_data = {
+        'preferred_language': preferred_language
+    }
+
+    s = celery.signature(
+        'cic_ussd.tasks.metadata.add_preferences_metadata',
+        [account.blockchain_address, preferences_data],
+        queue='cic-ussd'
+    )
+    return s.apply_async()
+
+
+def process_language_selection(state_machine_data: Tuple[str, dict, Account, Session]):
+    """
+    :param state_machine_data:
+    :type state_machine_data:
+    :return:
+    :rtype:
+    """
+    user_input, ussd_session, account, session = state_machine_data
+    preferred_language = preferred_langauge_from_selection(user_input=user_input)
+    data = {
+        'preferred_language': preferred_language
+    }
+    save_session_data(queue='cic-ussd', session=session, data=data, ussd_session=ussd_session)
+
+
+def preferred_langauge_from_selection(user_input: str):
+    """
+    :param user_input:
+    :type user_input:
+    :return:
+    :rtype:
+    """
+    key = cache_data_key('system:languages'.encode('utf-8'), MetadataPointer.NONE)
+    cached_system_languages = get_cached_data(key)
+    language_list = json.loads(cached_system_languages)
+    user_input = int(user_input)
+    selected_language = language_list[user_input - 1]
+    preferred_language = i18n.config.get('fallback')
+    for key, value in Languages.languages_dict.items():
+        if selected_language[3:] == value:
+            preferred_language = key
+    return preferred_language

apps/cic-ussd/cic_ussd/state_machine/logic/pin_guard.py

@@ -9,9 +9,11 @@ from phonenumbers.phonenumberutil import NumberParseException
 from sqlalchemy.orm.session import Session
 
 # local imports
+from cic_ussd.account.guardianship import Guardianship
 from cic_ussd.account.metadata import get_cached_preferred_language
 from cic_ussd.db.models.account import Account
 from cic_ussd.db.models.base import SessionBase
+from cic_ussd.notifications import Notifier
 from cic_ussd.phone_number import process_phone_number, E164Format
 from cic_ussd.session.ussd_session import save_session_data
 from cic_ussd.translation import translation_for
@@ -82,8 +84,10 @@ def is_valid_guardian_addition(state_machine_data: Tuple[str, dict, Account, Ses
         preferred_language = i18n.config.get('fallback')
 
     is_valid_account = Account.get_by_phone_number(phone_number, session) is not None
+    guardianship = Guardianship()
+    is_system_guardian = guardianship.is_system_guardian(phone_number)
     is_initiator = phone_number == account.phone_number
-    is_existent_guardian = phone_number in account.get_guardians()
+    is_existent_guardian = phone_number in account.get_guardians() or is_system_guardian
 
     failure_reason = ''
     if not is_valid_account:
@@ -100,7 +104,7 @@ def is_valid_guardian_addition(state_machine_data: Tuple[str, dict, Account, Ses
         session_data['failure_reason'] = failure_reason
         save_session_data('cic-ussd', session, session_data, ussd_session)
 
-    return phone_number is not None and is_valid_account and not is_existent_guardian and not is_initiator
+    return phone_number is not None and is_valid_account and not is_existent_guardian and not is_initiator and not is_system_guardian
 
 
 def add_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]):
@@ -130,6 +134,9 @@ def is_set_pin_guardian(account: Account, checked_number: str, preferred_languag
     is_set_guardian = checked_number in set_guardians
     is_initiator = checked_number == account.phone_number
 
+    guardianship = Guardianship()
+    is_system_guardian = guardianship.is_system_guardian(checked_number)
+
     if not is_set_guardian:
         failure_reason = translation_for('helpers.error.is_not_existent_guardian', preferred_language)
 
@@ -141,7 +148,7 @@ def is_set_pin_guardian(account: Account, checked_number: str, preferred_languag
         session_data['failure_reason'] = failure_reason
         save_session_data('cic-ussd', session, session_data, ussd_session)
 
-    return is_set_guardian and not is_initiator
+    return (is_set_guardian or is_system_guardian) and not is_initiator
 
 
 def is_dialers_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]):
@@ -193,8 +200,20 @@ def initiate_pin_reset(state_machine_data: Tuple[str, dict, Account, Session]):
     save_session_data('cic-ussd', session, session_data, ussd_session)
     guarded_account_phone_number = session_data.get('guarded_account_phone_number')
     guarded_account = Account.get_by_phone_number(guarded_account_phone_number, session)
+
     if quorum_count >= guarded_account.guardian_quora:
         guarded_account.reset_pin(session)
         logg.debug(f'Reset initiated for: {guarded_account.phone_number}')
         session_data['quorum_count'] = 0
         save_session_data('cic-ussd', session, session_data, ussd_session)
+
+        preferred_language = get_cached_preferred_language(guarded_account.blockchain_address)
+        if not preferred_language:
+            preferred_language = i18n.config.get('fallback')
+
+        notifier = Notifier()
+        notifier.send_sms_notification(
+            key='sms.pin_reset_initiated',
+            phone_number=guarded_account.phone_number,
+            preferred_language=preferred_language,
+            pin_initiator=account.standard_metadata_id())

apps/cic-ussd/cic_ussd/state_machine/logic/tokens.py

@@ -23,7 +23,7 @@ def is_valid_token_selection(state_machine_data: Tuple[str, dict, Account, Sessi
     account_tokens_list = session_data.get('account_tokens_list')
     if not account_tokens_list:
         wait_for_session_data('Account token list', session_data_key='account_tokens_list', ussd_session=ussd_session)
-    if user_input not in ['00', '22']:
+    if user_input not in ['00', '11', '22']:
         try:
             user_input = int(user_input)
             return user_input <= len(account_tokens_list)