Downgrade chainsyncer

add keystore

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

.gitignore

@@ -8,3 +8,8 @@ gmon.out
 *.egg-info
 dist/
 build/
+**/*sqlite
+**/.nyc_output
+**/coverage
+**/.venv
+.idea

apps/cic-eth/cic_eth/api/api_admin.py

@@ -31,7 +31,7 @@ from chainqueue.db.enum import (
         status_str,
     )
 from chainqueue.error import TxStateChangeError
-from chainqueue.query import get_tx
+from chainqueue.sql.query import get_tx
 from eth_erc20 import ERC20
 
 # local imports

apps/cic-eth/cic_eth/ext/tx.py

@@ -19,7 +19,7 @@ from cic_eth_registry import CICRegistry
 from cic_eth_registry.erc20 import ERC20Token
 from chainqueue.db.models.otx import Otx
 from chainqueue.db.enum import StatusEnum
-from chainqueue.query import get_tx_cache
+from chainqueue.sql.query import get_tx_cache
 from eth_erc20 import ERC20
 
 # local imports

apps/cic-eth/cic_eth/queue/query.py

@@ -5,7 +5,7 @@ import datetime
 import celery
 from chainlib.chain import ChainSpec
 from chainlib.eth.tx import unpack
-import chainqueue.query
+import chainqueue.sql.query
 from chainqueue.db.enum import (
         StatusEnum,
         is_alive,
@@ -28,7 +28,7 @@ celery_app = celery.current_app
 def get_tx_cache(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.query.get_tx_cache(chain_spec, tx_hash, session=session)
+    r = chainqueue.sql.query.get_tx_cache(chain_spec, tx_hash, session=session)
     session.close()
     return r
 
@@ -37,7 +37,7 @@ def get_tx_cache(chain_spec_dict, tx_hash):
 def get_tx(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r =  chainqueue.query.get_tx(chain_spec, tx_hash, session=session)
+    r =  chainqueue.sql.query.get_tx(chain_spec, tx_hash, session=session)
     session.close()
     return r
 
@@ -46,7 +46,7 @@ def get_tx(chain_spec_dict, tx_hash):
 def get_account_tx(chain_spec_dict, address, as_sender=True, as_recipient=True, counterpart=None):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.query.get_account_tx(chain_spec, address, as_sender=True, as_recipient=True, counterpart=None, session=session)
+    r = chainqueue.sql.query.get_account_tx(chain_spec, address, as_sender=True, as_recipient=True, counterpart=None, session=session)
     session.close()
     return r
 
@@ -55,17 +55,17 @@ def get_account_tx(chain_spec_dict, address, as_sender=True, as_recipient=True,
 def get_upcoming_tx_nolock(chain_spec_dict, status=StatusEnum.READYSEND, not_status=None, recipient=None, before=None, limit=0, session=None):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.query.get_upcoming_tx(chain_spec, status, not_status=not_status, recipient=recipient, before=before, limit=limit, session=session, decoder=unpack)
+    r = chainqueue.sql.query.get_upcoming_tx(chain_spec, status, not_status=not_status, recipient=recipient, before=before, limit=limit, session=session, decoder=unpack)
     session.close()
     return r
 
 
 def get_status_tx(chain_spec, status, not_status=None, before=None, exact=False, limit=0, session=None):
-    return chainqueue.query.get_status_tx_cache(chain_spec, status, not_status=not_status, before=before, exact=exact, limit=limit, session=session, decoder=unpack)
+    return chainqueue.sql.query.get_status_tx_cache(chain_spec, status, not_status=not_status, before=before, exact=exact, limit=limit, session=session, decoder=unpack)
 
 
 def get_paused_tx(chain_spec, status=None, sender=None, session=None, decoder=None):
-    return chainqueue.query.get_paused_tx_cache(chain_spec, status=status, sender=sender, session=session, decoder=unpack)
+    return chainqueue.sql.query.get_paused_tx_cache(chain_spec, status=status, sender=sender, session=session, decoder=unpack)
 
 
 def get_nonce_tx(chain_spec, nonce, sender):

apps/cic-eth/cic_eth/queue/state.py

@@ -1,6 +1,6 @@
 # external imports
 from chainlib.chain import ChainSpec
-import chainqueue.state
+import chainqueue.sql.state
 
 # local imports
 import celery
@@ -14,7 +14,7 @@ celery_app = celery.current_app
 def set_sent(chain_spec_dict, tx_hash, fail=False):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_sent(chain_spec, tx_hash, fail, session=session)
+    r = chainqueue.sql.state.set_sent(chain_spec, tx_hash, fail, session=session)
     session.close()
     return r
 
@@ -23,7 +23,7 @@ def set_sent(chain_spec_dict, tx_hash, fail=False):
 def set_final(chain_spec_dict, tx_hash, block=None, tx_index=None, fail=False):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_final(chain_spec, tx_hash, block=block, tx_index=tx_index, fail=fail, session=session)
+    r = chainqueue.sql.state.set_final(chain_spec, tx_hash, block=block, tx_index=tx_index, fail=fail, session=session)
     session.close()
     return r
 
@@ -32,7 +32,7 @@ def set_final(chain_spec_dict, tx_hash, block=None, tx_index=None, fail=False):
 def set_cancel(chain_spec_dict, tx_hash, manual=False):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_cancel(chain_spec, tx_hash, manual, session=session)
+    r = chainqueue.sql.state.set_cancel(chain_spec, tx_hash, manual, session=session)
     session.close()
     return r
 
@@ -41,7 +41,7 @@ def set_cancel(chain_spec_dict, tx_hash, manual=False):
 def set_rejected(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_rejected(chain_spec, tx_hash, session=session)
+    r = chainqueue.sql.state.set_rejected(chain_spec, tx_hash, session=session)
     session.close()
     return r
 
@@ -50,7 +50,7 @@ def set_rejected(chain_spec_dict, tx_hash):
 def set_fubar(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_fubar(chain_spec, tx_hash, session=session)
+    r = chainqueue.sql.state.set_fubar(chain_spec, tx_hash, session=session)
     session.close()
     return r
 
@@ -59,7 +59,7 @@ def set_fubar(chain_spec_dict, tx_hash):
 def set_manual(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_manual(chain_spec, tx_hash, session=session)
+    r = chainqueue.sql.state.set_manual(chain_spec, tx_hash, session=session)
     session.close()
     return r
 
@@ -68,7 +68,7 @@ def set_manual(chain_spec_dict, tx_hash):
 def set_ready(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_ready(chain_spec, tx_hash, session=session)
+    r = chainqueue.sql.state.set_ready(chain_spec, tx_hash, session=session)
     session.close()
     return r
 
@@ -77,7 +77,7 @@ def set_ready(chain_spec_dict, tx_hash):
 def set_reserved(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_reserved(chain_spec, tx_hash, session=session)
+    r = chainqueue.sql.state.set_reserved(chain_spec, tx_hash, session=session)
     session.close()
     return r
 
@@ -86,7 +86,7 @@ def set_reserved(chain_spec_dict, tx_hash):
 def set_waitforgas(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.set_waitforgas(chain_spec, tx_hash, session=session)
+    r = chainqueue.sql.state.set_waitforgas(chain_spec, tx_hash, session=session)
     session.close()
     return r
     
@@ -95,7 +95,7 @@ def set_waitforgas(chain_spec_dict, tx_hash):
 def get_state_log(chain_spec_dict, tx_hash):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.get_state_log(chain_spec, tx_hash, session=session)
+    r = chainqueue.sql.state.get_state_log(chain_spec, tx_hash, session=session)
     session.close()
     return r
 
@@ -104,6 +104,6 @@ def get_state_log(chain_spec_dict, tx_hash):
 def obsolete(chain_spec_dict, tx_hash, final):
     chain_spec = ChainSpec.from_dict(chain_spec_dict)
     session = SessionBase.create_session()
-    r = chainqueue.state.obsolete_by_cache(chain_spec, tx_hash, final, session=session)
+    r = chainqueue.sql.state.obsolete_by_cache(chain_spec, tx_hash, final, session=session)
     session.close()
     return r

apps/cic-eth/cic_eth/queue/tx.py

@@ -15,14 +15,14 @@ from sqlalchemy import tuple_
 from sqlalchemy import func
 from chainlib.chain import ChainSpec
 from chainlib.eth.tx import unpack
-import chainqueue.state
+import chainqueue.sql.state
 from chainqueue.db.enum import (
         StatusEnum,
         StatusBits,
         is_alive,
         dead,
         )
-from chainqueue.tx import create
+from chainqueue.sql.tx import create
 from chainqueue.error import NotLocalTxError
 from chainqueue.db.enum import status_str
 

apps/cic-eth/cic_eth/runnable/daemons/dispatcher.py

@@ -21,7 +21,7 @@ from chainqueue.db.enum import (
     StatusBits,
     )
 from chainqueue.error import NotLocalTxError
-from chainqueue.state import set_reserved
+from chainqueue.sql.state import set_reserved
 
 # local imports
 import cic_eth

apps/cic-eth/cic_eth/runnable/daemons/filters/gas.py

@@ -10,7 +10,7 @@ from chainlib.eth.tx import unpack
 from chainqueue.db.enum import StatusBits
 from chainqueue.db.models.tx import TxCache
 from chainqueue.db.models.otx import Otx
-from chainqueue.query import get_paused_tx_cache as get_paused_tx
+from chainqueue.sql.query import get_paused_tx_cache as get_paused_tx
 
 # local imports
 from cic_eth.db.models.base import SessionBase

apps/cic-eth/cic_eth/runnable/daemons/filters/straggler.py

@@ -3,7 +3,7 @@ import logging
 
 # external imports
 import celery
-from chainqueue.state import obsolete_by_cache
+from chainqueue.sql.state import obsolete_by_cache
 
 logg = logging.getLogger()
 

apps/cic-eth/cic_eth/runnable/daemons/tasker.py

@@ -194,6 +194,7 @@ def main():
     except UnknownContractError as e:
         logg.exception('Registry contract connection failed for {}: {}'.format(config.get('CIC_REGISTRY_ADDRESS'), e))
         sys.exit(1)
+    logg.info('connected contract registry {}'.format(config.get('CIC_REGISTRY_ADDRESS')))
 
     trusted_addresses_src = config.get('CIC_TRUST_ADDRESS')
     if trusted_addresses_src == None:

apps/cic-eth/cic_eth/version.py

@@ -10,7 +10,7 @@ version = (
         0,
         11,
         0,
-        'beta.15',
+        'beta.16',
         )
 
 version_object = semver.VersionInfo(

apps/cic-eth/requirements.txt

@@ -1,4 +1,4 @@
-cic-base~=0.1.2b14
+cic-base~=0.1.2b15
 celery==4.4.7
 crypto-dev-signer~=0.4.14b3
 confini~=0.3.6rc3
@@ -16,10 +16,10 @@ moolb~=0.1.1b2
 eth-address-index~=0.1.1a11
 chainlib~=0.0.3rc2
 hexathon~=0.0.1a7
-chainsyncer[sql]~=0.0.2a4
-chainqueue~=0.0.2b1
-sarafu-faucet==0.0.3a3
-erc20-faucet==0.2.1a4
+chainsyncer[sql]==0.0.2a5
+chainqueue~=0.0.2b3
+sarafu-faucet~=0.0.3a3
+erc20-faucet~=0.2.1a5
 coincurve==15.0.0
 potaahto~=0.0.1a2
 pycryptodome==3.10.1

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

@@ -1,7 +1,7 @@
 # external imports
 from chainlib.connection import RPCConnection
 from chainlib.eth.nonce import OverrideNonceOracle
-from chainqueue.tx import create as queue_create
+from chainqueue.sql.tx import create as queue_create
 from chainlib.eth.tx import (
         TxFormat,
         unpack,
@@ -16,7 +16,7 @@ from chainlib.eth.block import (
         block_by_number,
         Block,
         )
-from chainqueue.state import (
+from chainqueue.sql.state import (
         set_waitforgas,
         )
 from hexathon import strip_0x

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

@@ -15,7 +15,7 @@ from chainlib.eth.block import (
         )
 from erc20_faucet import Faucet
 from hexathon import strip_0x
-from chainqueue.query import get_account_tx
+from chainqueue.sql.query import get_account_tx
 
 # local imports
 from cic_eth.runnable.daemons.filters.register import RegistrationFilter

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

@@ -17,8 +17,8 @@ from chainlib.eth.block import (
         )
 from chainqueue.db.models.otx import Otx
 from chainqueue.db.enum import StatusBits
-from chainqueue.tx import create as queue_create
-from chainqueue.state import (
+from chainqueue.sql.tx import create as queue_create
+from chainqueue.sql.state import (
         set_reserved,
         set_ready,
         set_sent,

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

@@ -15,7 +15,7 @@ from chainlib.eth.block import (
         Block,
         )
 from hexathon import strip_0x
-from chainqueue.query import get_account_tx
+from chainqueue.sql.query import get_account_tx
 
 # local imports
 from cic_eth.runnable.daemons.filters.transferauth import TransferAuthFilter

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

@@ -17,8 +17,8 @@ from chainlib.eth.block import (
         )
 from chainqueue.db.models.otx import Otx
 from chainqueue.db.enum import StatusBits
-from chainqueue.tx import create as queue_create
-from chainqueue.state import (
+from chainqueue.sql.tx import create as queue_create
+from chainqueue.sql.state import (
         set_reserved,
         set_ready,
         set_sent,

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

@@ -29,12 +29,12 @@ from chainqueue.db.enum import (
         StatusBits,
         status_str,
         )
-from chainqueue.state import (
+from chainqueue.sql.state import (
         set_fubar,
         set_ready,
         set_reserved,
         )
-from chainqueue.query import (
+from chainqueue.sql.query import (
         get_tx,
         get_nonce_tx_cache,
         )

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

@@ -11,7 +11,7 @@ from chainlib.eth.nonce import (
         OverrideNonceOracle,
         RPCNonceOracle,
         )
-from chainqueue.tx import create as queue_create
+from chainqueue.sql.tx import create as queue_create
 from chainlib.eth.tx import (
         raw,
         receipt,
@@ -23,14 +23,14 @@ from chainlib.eth.gas import (
         Gas,
         OverrideGasOracle,
         )
-from chainqueue.state import (
+from chainqueue.sql.state import (
         set_reserved,
         set_sent,
         set_ready,
         )
 from chainqueue.db.models.otx import Otx
 from chainqueue.db.enum import StatusBits
-from chainqueue.query import get_nonce_tx_cache
+from chainqueue.sql.query import get_nonce_tx_cache
 from eth_erc20 import ERC20
 from cic_eth_registry import CICRegistry
 

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

@@ -12,7 +12,7 @@ from eth_accounts_index import AccountsIndex
 from chainlib.eth.tx import (
         transaction,
         )
-from chainqueue.state import (
+from chainqueue.sql.state import (
         set_reserved,
         )
 

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

@@ -5,7 +5,7 @@ import logging
 import celery
 from chainlib.connection import RPCConnection
 from chainlib.eth.nonce import OverrideNonceOracle
-from chainqueue.tx import (
+from chainqueue.sql.tx import (
         create as queue_create,
         )
 from chainlib.eth.gas import (
@@ -13,7 +13,7 @@ from chainlib.eth.gas import (
         OverrideGasOracle,
         )
 from chainlib.eth.tx import TxFormat
-from chainqueue.query import get_nonce_tx_cache
+from chainqueue.sql.query import get_nonce_tx_cache
 from chainqueue.db.models.otx import Otx
 from chainqueue.db.enum import StatusBits
 from hexathon import add_0x

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

@@ -21,10 +21,10 @@ from chainlib.eth.constant import (
         MINIMUM_FEE_UNITS,
         MINIMUM_FEE_PRICE,
         )
-from chainqueue.tx import create as queue_create
-from chainqueue.query import get_tx
+from chainqueue.sql.tx import create as queue_create
+from chainqueue.sql.query import get_tx
 from chainqueue.db.enum import StatusBits
-from chainqueue.state import (
+from chainqueue.sql.state import (
         set_ready,
         set_reserved,
         set_sent,

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

@@ -18,8 +18,8 @@ from chainlib.eth.tx import (
         )
 from hexathon import strip_0x
 from chainqueue.db.models.otx import Otx
-from chainqueue.tx import create as queue_create
-from chainqueue.state import (
+from chainqueue.sql.tx import create as queue_create
+from chainqueue.sql.state import (
         set_reserved,
         set_ready,
         set_sent,

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

@@ -5,7 +5,7 @@ import logging
 # external imports
 import pytest
 import celery
-from chainqueue.tx import create as queue_create
+from chainqueue.sql.tx import create as queue_create
 from chainlib.eth.nonce import (
         RPCNonceOracle,
         OverrideNonceOracle,
@@ -23,7 +23,7 @@ from hexathon import (
         add_0x,
         strip_0x,
         )
-from chainqueue.state import (
+from chainqueue.sql.state import (
         set_reserved,
         set_ready,
         )

apps/cic-meta/.gitignore

@@ -3,3 +3,5 @@ dist
 dist-web
 dist-server
 scratch
+coverage
+.nyc_output

apps/cic-meta/.gitlab-ci.yml

@@ -3,17 +3,38 @@
     variables:
         APP_NAME: cic-meta
         DOCKERFILE_PATH: $APP_NAME/docker/Dockerfile
+        IMAGE_TAG: $CI_REGISTRY_IMAGE/$APP_NAME:unittest-$CI_COMMIT_SHORT_SHA
 
 .cic_meta_changes_target:
     rules:
-        - changes:
-            - $CONTEXT/$APP_NAME/*
+        - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+#        - changes:
+#            - $CONTEXT/$APP_NAME/*
+        - when: always
 
-build-mr-cic-meta:
+cic-meta-build-mr:
+  stage: build
+  extends:
+    - .cic_meta_variables
+    - .cic_meta_changes_target
+  script:
+    - mkdir -p /kaniko/.docker
+    - echo "{\"auths\":{\"$CI_REGISTRY\":{\"username\":\"$CI_REGISTRY_USER\",\"password\":\"$CI_REGISTRY_PASSWORD\"}}}" > "/kaniko/.docker/config.json"
+    # - /kaniko/executor --context $CONTEXT --dockerfile $DOCKERFILE_PATH $KANIKO_CACHE_ARGS --destination $IMAGE_TAG
+    - /kaniko/executor --context $CONTEXT --dockerfile $DOCKERFILE_PATH $KANIKO_CACHE_ARGS --destination $IMAGE_TAG 
+
+test-mr-cic-meta:
     extends:
-        - .cic_meta_changes_target
-        - .py_build_merge_request
         - .cic_meta_variables
+        - .cic_meta_changes_target
+    stage: test
+    image: $IMAGE_TAG 
+    script:
+        - cd /tmp/src/cic-meta
+        - npm install --dev 
+        - npm run test
+        - npm run test:coverage
+    needs: ["cic-meta-build-mr"]
 
 build-push-cic-meta:
     extends:

apps/cic-meta/docker/Dockerfile

@@ -4,29 +4,28 @@ WORKDIR /tmp/src/cic-meta
 
 RUN apk add --no-cache postgresql bash
 
-COPY cic-meta/package.json \
-     ./
-
+# required to build the cic-client-meta module
 COPY cic-meta/src/ src/
-COPY cic-meta/tests/ tests/
 COPY cic-meta/scripts/ scripts/
 
+# copy the dependencies
+COPY cic-meta/package.json .
+COPY cic-meta/tsconfig.json . 
+COPY cic-meta/webpack.config.js .
+     
 RUN npm install
 
-# see exports_dir gpg.ini
+COPY cic-meta/tests/ tests/
 COPY cic-meta/tests/*.asc /root/pgp/
-RUN alias tsc=node_modules/typescript/bin/tsc 
-
 
+# copy runtime configs
 COPY cic-meta/.config/ /usr/local/etc/cic-meta/
-# COPY cic-meta/scripts/server/initdb/server.postgres.sql /usr/local/share/cic-meta/sql/server.sql
 
+# db migrations
 COPY cic-meta/docker/db.sh ./db.sh
 RUN chmod 755 ./db.sh
 
-#RUN alias ts-node=/tmp/src/cic-meta/node_modules/ts-node/dist/bin.js
-#ENTRYPOINT [ "./node_modules/ts-node/dist/bin.js", "./scripts/server/server.ts" ]
-
+RUN alias tsc=node_modules/typescript/bin/tsc 
 COPY cic-meta/docker/start_server.sh ./start_server.sh
 RUN chmod 755 ./start_server.sh
 ENTRYPOINT ["sh", "./start_server.sh"]

apps/cic-meta/package.json

@@ -11,6 +11,7 @@
 	"preferGlobal": true,
 	"scripts": {
 		"test": "mocha -r node_modules/node-localstorage/register -r ts-node/register tests/*.ts",
+		"test:coverage": "nyc mocha tests/*.ts --timeout 3000 --check-coverage=true",
 		"build": "node_modules/typescript/bin/tsc -d --outDir dist src/index.ts",
 		"build-server": "tsc -d --outDir dist-server scripts/server/*.ts",
 		"pack": "node_modules/typescript/bin/tsc -d --outDir dist && webpack",
@@ -34,7 +35,9 @@
 	"devDependencies": {
 		"@types/mocha": "^8.0.3",
 		"mocha": "^8.2.0",
+		"nock": "^13.1.0",
 		"node-localstorage": "^2.1.6",
+		"nyc": "^15.1.0",
 		"ts-node": "^9.0.0",
 		"typescript": "^4.0.5",
 		"webpack": "^5.4.0",
@@ -50,5 +53,26 @@
 	"license": "GPL-3.0-or-later",
 	"engines": {
 		"node": ">=14.16.1"
+	},
+	"nyc": {
+		"include": [
+			"src/**/*.ts"
+		],
+		"extension": [
+			".ts"
+		],
+		"require": [
+			"ts-node/register"
+		],
+		"reporter": [
+			"text",
+			"html"
+		],
+		"sourceMap": true,
+		"instrument": true,
+		"branches": ">80",
+		"lines": ">80",
+		"functions": ">80",
+		"statements": ">80"
 	}
 }

apps/cic-meta/scripts/server/handlers.ts

@@ -31,7 +31,7 @@ function handleNoMergeGet(db, digest, keystore) {
 					doh(e);
 				});
 			}).catch((e) => {
-				console.error('mesage', e);
+				console.error('message', e);
 				doh(e);
 			});
 		})
@@ -46,7 +46,7 @@ function handleServerMergePost(data, db, digest, keystore, signer) {
 			let e = undefined;
 			let s = undefined;
 			if (v === undefined) {
-				s = new Syncable(digest, data);
+				s = new Syncable(digest, o);
 				s.onwrap = (e) => {
 					whohoo(e.toJSON());
 				};

apps/cic-meta/scripts/server/server.ts

@@ -204,7 +204,7 @@ async function processRequest(req, res) {
 		}
 
 		if (content === undefined) {
-			console.error('empty onctent', data);
+			console.error('empty content', data);
 			res.writeHead(400, {"Content-Type": "text/plain"});
 			res.end();
 			return;

apps/cic-meta/src/custom.ts

@@ -9,7 +9,7 @@ class Custom extends Syncable implements Addressable {
         super('', v);
         Custom.toKey(name).then((cid) => {
             this.id = cid;
-            this.value = v;
+            this.name = name;
         });
     }
 

apps/cic-meta/src/meta.ts

@@ -100,13 +100,15 @@ class Meta {
             identifier = await User.toKey(name);
         } else if (type === 'phone') {
             identifier = await Phone.toKey(name);
-        } else {
+        } else if (type === 'custom') {
             identifier = await Custom.toKey(name);
+        } else {
+            identifier = await Custom.toKey(name, type);
         }
         return identifier;
     }
 
-    private wrap(syncable: Syncable): Promise<Envelope> {
+    wrap(syncable: Syncable): Promise<Envelope> {
         return new Promise<Envelope>(async (resolve, reject) => {
             syncable.setSigner(this.signer);
             syncable.onwrap = async (env) => {

apps/cic-meta/tests/custom.ts

@@ -0,0 +1,49 @@
+import * as assert from 'assert';
+import {Custom} from "../src";
+
+const testName = 'areas';
+const testObject = {
+    area: ['Nairobi', 'Mombasa', 'Kilifi']
+}
+const testNameKey = '8f3da0c90ba2b89ff217da96f6088cbaf987a1b58bc33c3a5e526e53cec7cfed';
+const testIdentifier = ':cic.area'
+const testIdentifierKey = 'da6194e6f33726546e82c328df4c120b844d6427859156518bd600765bf8b2b7';
+
+describe('custom', () => {
+
+    context('with predefined data', () => {
+        it('should create a custom object', () => {
+            const custom = new Custom(testName, testObject);
+            setTimeout(() => {
+                assert.strictEqual(custom.name, testName);
+                assert.deepStrictEqual(custom.m.data, testObject);
+                assert.strictEqual(custom.key(), testNameKey)
+            }, 0);
+        });
+    });
+
+    context('without predefined data', () => {
+        it('should create a custom object', () => {
+            const custom = new Custom(testName);
+            setTimeout(() => {
+                assert.strictEqual(custom.name, testName);
+                assert.deepStrictEqual(custom.m.data, {});
+                assert.strictEqual(custom.key(), testNameKey)
+            }, 0);
+        });
+    });
+
+    describe('#toKey()', () => {
+        context('without a custom identifier', () => {
+            it('should generate a key from the custom name', async () => {
+                assert.strictEqual(await Custom.toKey(testName), testNameKey);
+            });
+        });
+
+        context('with a custom identifier', () => {
+            it('should generate a key from the custom name with a custom identifier', async () => {
+                assert.strictEqual(await Custom.toKey(testName, testIdentifier), testIdentifierKey);
+            });
+        });
+    });
+});

apps/cic-meta/tests/meta.ts

@@ -0,0 +1,176 @@
+import * as assert from 'assert';
+import * as fs from 'fs';
+const nock = require('nock');
+import {Meta} from "../src";
+import {getResponse, metaData, networkErrorResponse, notFoundResponse, putResponse} from "./response";
+import {Syncable} from "@cicnet/crdt-meta";
+
+const metaUrl = 'https://meta.dev.grassrootseconomics.net';
+const testAddress = '0xc1912fee45d61c87cc5ea59dae31190fffff232d';
+const testAddressKey = 'a51472cb4df63b199a4de01335b1b4d1bbee27ff4f03340aa1d592f26c6acfe2';
+const testPhone = '+254123456789';
+const testPhoneKey = 'be3cc8212b7eb57c6217ddd42230bd8ccd2f01382bf8c1c77d3a683fa5a9bb16';
+const testName = 'areas'
+const testNameKey = '8f3da0c90ba2b89ff217da96f6088cbaf987a1b58bc33c3a5e526e53cec7cfed';
+const testIdentifier = ':cic.area'
+const testIdentifierKey = 'da6194e6f33726546e82c328df4c120b844d6427859156518bd600765bf8b2b7';
+
+function readFile(filename) {
+    if(!fs.existsSync(filename)) {
+        console.error(`File ${filename} not found`);
+        return;
+    }
+    return fs.readFileSync(filename, {encoding: 'utf8', flag: 'r'});
+}
+
+const privateKey = readFile('./privatekeys.asc');
+
+describe('meta', () => {
+    beforeEach(() => {
+        nock(metaUrl)
+            .get(`/${testAddressKey}`)
+            .reply(200, getResponse);
+
+        nock(metaUrl)
+            .get(`/${testPhoneKey}`)
+            .reply(200, getResponse);
+
+        nock(metaUrl)
+            .get(`/${testAddress}`)
+            .reply(404);
+
+        nock(metaUrl)
+            .get(`/${testIdentifier}`)
+            .replyWithError(networkErrorResponse);
+
+        nock(metaUrl)
+            .put(`/${testAddressKey}`)
+            .reply(200, putResponse);
+
+        nock(metaUrl)
+            .put(`/${testAddress}`)
+            .reply(404);
+
+        nock(metaUrl)
+            .post('/post')
+            .reply(500);
+    });
+
+    describe('#get()', () => {
+        it('should fetch data from the meta service', async () => {
+            const account = await Meta.get(testAddressKey, metaUrl);
+            assert.strictEqual(account.toJSON(account), getResponse.payload);
+        });
+
+        context('if item is not found', () => {
+            it('should respond with an error', async () => {
+                const account = await Meta.get(testAddress, metaUrl);
+                assert.strictEqual(account, `404: Not Found`);
+            });
+        });
+
+        context('in case of network error', () => {
+            it('should respond with an error', async () => {
+                const account = await Meta.get(testIdentifier, metaUrl);
+                assert.strictEqual(account, `Request to ${metaUrl}/${testIdentifier} failed. Connection error.`);
+            });
+        });
+    })
+
+    describe('#set()', () => {
+        context('object data', () => {
+            it('should set data to the meta server', () => {
+                const meta = new Meta(metaUrl, privateKey);
+                meta.onload = async (status) => {
+                    const response = await meta.set(testAddressKey, metaData);
+                    assert.strictEqual(response, `${putResponse.status}: ${putResponse.statusText}`);
+                }
+            });
+        });
+
+        context('string data', () => {
+            it('should set data to the meta server', () => {
+                const meta = new Meta(metaUrl, privateKey);
+                meta.onload = async (status) => {
+                    const response = await meta.set(testPhoneKey, testAddress);
+                    assert.strictEqual(response, `${putResponse.status}: ${putResponse.statusText}`);
+                }
+            });
+        });
+
+        context('in case of network error', () => {
+            it('should respond with an error', () => {
+                const meta = new Meta(metaUrl, privateKey);
+                meta.onload = async (status) => {
+                    const response = await meta.set(testIdentifier, metaData);
+                    assert.strictEqual(response, `Request to ${metaUrl}/${testIdentifier} failed. Connection error.`);
+                }
+            });
+        });
+    });
+
+    describe('#updateMeta()', () => {
+        it('should update data in the meta server', async () => {
+            const syncable = new Syncable(testAddressKey, metaData);
+            const meta = new Meta(metaUrl, privateKey);
+            meta.onload = async (status) => {
+                const response = await meta.updateMeta(syncable, testAddressKey);
+                assert.strictEqual(response, putResponse);
+            }
+        });
+
+        context('if item is not found', () => {
+            it('should respond with an error', () => {
+                const syncable = new Syncable(testAddress, metaData);
+                const meta = new Meta(metaUrl, privateKey);
+                meta.onload = async (status) => {
+                    const response = await meta.updateMeta(syncable, testAddress);
+                    assert.strictEqual(response, notFoundResponse);
+                }
+            });
+        });
+    });
+
+    describe('#wrap()', () => {
+        it('should sign a syncable object', function () {
+            const syncable = new Syncable(testAddressKey, metaData);
+            const meta = new Meta(metaUrl, privateKey);
+            meta.onload = async (status) => {
+                const response = await meta.wrap(syncable);
+                assert.strictEqual(response.toJSON(), getResponse);
+            }
+        });
+    })
+
+    describe('#getIdentifier()', () => {
+        context('without type', () => {
+            it('should return an identifier', async () => {
+                assert.strictEqual(await Meta.getIdentifier(testName), testNameKey);
+            });
+        });
+
+        context('with user type', () => {
+            it('should return an identifier', async () => {
+                assert.strictEqual(await Meta.getIdentifier(testAddress, 'user'), testAddressKey);
+            });
+        });
+
+        context('with phone type', () => {
+            it('should return an identifier', async () => {
+                assert.strictEqual(await Meta.getIdentifier(testPhone, 'phone'), testPhoneKey);
+            });
+        });
+
+        context('with custom type', () => {
+            it('should return an identifier', async () => {
+                assert.strictEqual(await Meta.getIdentifier(testName, 'custom'), testNameKey);
+            });
+        });
+
+        context('with unrecognised type', () => {
+            it('should return an identifier', async () => {
+                assert.strictEqual(await Meta.getIdentifier(testName, testIdentifier), testIdentifierKey);
+            });
+        });
+    });
+});

apps/cic-meta/tests/phone.ts

@@ -0,0 +1,24 @@
+import * as assert from 'assert';
+import {Phone} from "../src";
+
+const testAddress = '0xc1912fee45d61c87cc5ea59dae31190fffff232d';
+const testPhone = '+254123456789';
+const testPhoneKey = 'be3cc8212b7eb57c6217ddd42230bd8ccd2f01382bf8c1c77d3a683fa5a9bb16';
+
+describe('phone', () => {
+
+    it('should create a phone object', () => {
+        const phone = new Phone(testAddress, testPhone);
+        setTimeout(() => {
+            assert.strictEqual(phone.address, testAddress);
+            assert.strictEqual(phone.m.data.msisdn, testPhone);
+            assert.strictEqual(phone.key(), testPhoneKey)
+        }, 0);
+    });
+
+    describe('#toKey()', () => {
+        it('should generate a key from the phone number', async () => {
+            assert.strictEqual(await Phone.toKey(testPhone), testPhoneKey);
+        });
+    });
+});

apps/cic-meta/tests/user.ts

@@ -0,0 +1,54 @@
+import * as assert from 'assert';
+
+import { User } from "../src";
+
+const testAddress = '0xc1912fee45d61c87cc5ea59dae31190fffff232d';
+const testAddressKey = 'a51472cb4df63b199a4de01335b1b4d1bbee27ff4f03340aa1d592f26c6acfe2';
+const testUser = {
+    user: {
+        firstName: 'Test',
+        lastName: 'User'
+    }
+}
+
+describe('user', () => {
+
+    context('without predefined data', () => {
+        it('should create a user object', () => {
+            const user = new User(testAddress);
+            setTimeout(() => {
+                assert.strictEqual(user.address, testAddress);
+                assert.strictEqual(user.key(), testAddressKey);
+                assert.strictEqual(user.m.data.user.firstName, '');
+                assert.strictEqual(user.m.data.user.lastName, '');
+            }, 0);
+        });
+    });
+
+    context('with predefined data', () => {
+        it('should create a user object', () => {
+            const user = new User(testAddress, testUser);
+            setTimeout(() => {
+                assert.strictEqual(user.address, testAddress);
+                assert.strictEqual(user.key(), testAddressKey);
+                assert.strictEqual(user.m.data.user.firstName, testUser.user.firstName);
+                assert.strictEqual(user.m.data.user.lastName, testUser.user.lastName);
+            }, 0);
+        });
+    });
+
+    describe('#setName()', () => {
+        it('should set user\'s names to metadata', () => {
+            const user = new User(testAddress);
+            user.setName(testUser.user.firstName, testUser.user.lastName);
+            assert.strictEqual(user.m.data.user.firstName, testUser.user.firstName);
+            assert.strictEqual(user.m.data.user.lastName, testUser.user.lastName);
+        });
+    });
+
+    describe('#toKey()', () => {
+        it('should generate a key from the user\'s address', async () => {
+            assert.strictEqual(await User.toKey(testAddress), testAddressKey);
+        });
+    });
+});

apps/cic-meta/tsconfig.json

@@ -2,7 +2,7 @@
   "compilerOptions": {
     "baseUrl": ".",
     "outDir": "./dist.browser",
-    "target": "es5",
+    "target": "es2015",
     "module": "commonjs",
     "moduleResolution": "node",
     "lib": ["es2016", "dom", "es5"],

apps/cic-notify/cic_notify/runnable/tasker.py

@@ -87,10 +87,18 @@ for key in config.store.keys():
         module = importlib.import_module(config.store[key])
         if key == 'TASKS_AFRICASTALKING':
             africastalking_notifier = module.AfricasTalkingNotifier
+
+            api_sender_id = config.get('AFRICASTALKING_API_SENDER_ID')
+            logg.debug(f'SENDER ID VALUE IS: {api_sender_id}')
+
+            if not api_sender_id:
+                api_sender_id = None
+                logg.debug(f'SENDER ID RESOLVED TO NONE: {api_sender_id}')
+
             africastalking_notifier.initialize(
                 config.get('AFRICASTALKING_API_USERNAME'),
                 config.get('AFRICASTALKING_API_KEY'),
-                config.get('AFRICASTALKING_API_SENDER_ID')
+                api_sender_id
             )
 
 

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

@@ -56,7 +56,7 @@ class AfricasTalkingNotifier:
             response = self.api_client.send(message=message, recipients=[recipient])
             logg.debug(f'africastalking response no-sender-id {response}')
 
-        recipients = response.get('Recipients')
+        recipients = response.get('SMSMessageData').get('Recipients')
 
         if len(recipients) != 1:
             status = response.get('SMSMessageData').get('Message')

apps/cic-notify/setup.cfg

@@ -28,6 +28,7 @@ packages =
 	cic_notify
 	cic_notify.db
 	cic_notify.db.models
+	cic_notify.ext
 	cic_notify.tasks.sms
 	cic_notify.runnable
 scripts =

apps/cic-ussd/.config/app.ini

@@ -5,6 +5,7 @@ LOCALE_PATH=/usr/src/cic-ussd/var/lib/locale/
 MAX_BODY_LENGTH=1024
 PASSWORD_PEPPER=QYbzKff6NhiQzY3ygl2BkiKOpER8RE/Upqs/5aZWW+I=
 SERVICE_CODE=*483*46#,*483*061#,*384*96#
+SUPPORT_PHONE_NUMBER=0757628885
 
 [phone_number]
 REGION=KE

apps/cic-ussd/.config/test/app.ini

@@ -5,6 +5,7 @@ LOCALE_PATH=var/lib/locale/
 MAX_BODY_LENGTH=1024
 PASSWORD_PEPPER=QYbzKff6NhiQzY3ygl2BkiKOpER8RE/Upqs/5aZWW+I=
 SERVICE_CODE=*483*46#
+SUPPORT_PHONE_NUMBER=0757628885
 
 [ussd]
 MENU_FILE=/usr/local/lib/python3.8/site-packages/cic_ussd/db/ussd_menu.json

apps/cic-ussd/.config/test/integration.ini

@@ -0,0 +1,4 @@
+[test]
+gift_value = 50.00
+server_url = http://localhost:63315/
+token_symbol = GFT

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

@@ -238,13 +238,55 @@
             "description": "Menu to display a user's entire profile",
             "display_key": "ussd.kenya.display_user_metadata",
             "name": "display_user_metadata",
-            "parent": "account_management"
+            "parent": "metadata_management"
         },
         "41": {
             "description": "The recipient is not in the system",
             "display_key": "ussd.kenya.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",
+            "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",
+            "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",
+            "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",
+            "name": "products_edit_pin_authorization",
+            "parent": "metadata_management"
+        },
+        "46": {
+            "description": "Pin confirmation for pin change.",
+            "display_key": "ussd.kenya.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",
+            "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",
+            "name": "dob_edit_pin_authorization",
+            "parent": "metadata_management"
         }
 
     }

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

@@ -78,28 +78,27 @@ class MetadataRequestsHandler(Metadata):
         :param data: The data to be stored in the metadata server.
         :type data: dict|str
         """
-        data = json.dumps(data).encode('utf-8')
+        data = json.dumps(data)
         result = make_request(method='POST', url=self.url, data=data, headers=self.headers)
         metadata_http_error_handler(result=result)
-        metadata = result.content
+        metadata = result.json()
         self.edit(data=metadata)
 
-    def edit(self, data: bytes):
+    def edit(self, data: Union[Dict, str]):
         """ This function is responsible for editing data in the metadata server corresponding to a unique pointer.
         :param data: The data to be edited in the metadata server.
-        :type data: bytes
+        :type data: dict
         """
         cic_meta_signer = Signer()
         signature = cic_meta_signer.sign_digest(data=data)
         algorithm = cic_meta_signer.get_operational_key().get('algo')
-        decoded_data = data.decode('utf-8')
         formatted_data = {
-            'm': data.decode('utf-8'),
+            'm': json.dumps(data),
             's': {
                 'engine': self.engine,
                 'algo': algorithm,
                 'data': signature,
-                'digest': json.loads(data).get('digest'),
+                'digest': data.get('digest'),
             }
         }
         formatted_data = json.dumps(formatted_data)
@@ -110,19 +109,32 @@ class MetadataRequestsHandler(Metadata):
             decoded_identifier = self.identifier.decode("utf-8")
         except UnicodeDecodeError:
             decoded_identifier = self.identifier.hex()
-        logg.info(f'identifier: {decoded_identifier}. metadata pointer: {self.metadata_pointer} set to: {decoded_data}.')
+        logg.info(f'identifier: {decoded_identifier}. metadata pointer: {self.metadata_pointer} set to: {data}.')
 
     def query(self):
-        """This function is responsible for querying the metadata server for data corresponding to a unique pointer."""
+        """
+        :return:
+        :rtype:
+        """
+        # retrieve the  metadata
         result = make_request(method='GET', url=self.url)
         metadata_http_error_handler(result=result)
-        response_data = result.json()
-        data = json.loads(response_data)
-        if not isinstance(data, dict):
-            raise ValueError(f'Invalid data object: {data}.')
+
+        # json serialize retrieved data
+        result_data = result.json()
+
+        # validate result data format
+        if not isinstance(result_data, dict):
+            raise ValueError(f'Invalid result data object: {result_data}.')
+
         if result.status_code == 200 and self.cic_type == ':cic.person':
+            # validate person metadata
             person = Person()
-            deserialized_person = person.deserialize(person_data=data)
-            data = json.dumps(deserialized_person.serialize())
-            cache_data(self.metadata_pointer, data=data)
+            person_data = person.deserialize(person_data=result_data)
+
+            # format new person data for caching
+            data = json.dumps(person_data.serialize())
+
+            # cache metadata
+            cache_data(key=self.metadata_pointer, data=data)
             logg.debug(f'caching: {data} with key: {self.metadata_pointer}')

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

@@ -0,0 +1,12 @@
+# standard imports
+
+# external imports
+
+# local imports
+from .base import MetadataRequestsHandler
+
+
+class CustomMetadata(MetadataRequestsHandler):
+
+    def __init__(self, identifier: bytes):
+        super().__init__(cic_type=':cic.custom', identifier=identifier)

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

@@ -0,0 +1,12 @@
+# standard imports
+
+# external imports
+
+# local imports
+from .base import MetadataRequestsHandler
+
+
+class PreferencesMetadata(MetadataRequestsHandler):
+
+    def __init__(self, identifier: bytes):
+        super().__init__(cic_type=':cic.preferences', identifier=identifier)

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

@@ -47,14 +47,13 @@ class Signer:
         logg.debug(f'using signing key: {key_id}, algorithm: {key_algorithm}')
         return gpg_keys[0]
 
-    def sign_digest(self, data: bytes):
+    def sign_digest(self, data: dict):
         """
         :param data:
         :type data:
         :return:
         :rtype:
         """
-        data = json.loads(data)
         digest = data['digest']
         key_id = self.get_operational_key().get('keyid')
         signature = self.gpg.sign(digest, passphrase=self.gpg_passphrase, keyid=key_id)

apps/cic-ussd/cic_ussd/phone_number.py

@@ -8,6 +8,10 @@ import phonenumbers
 from cic_ussd.db.models.account import Account
 
 
+class E164Format:
+    region = None
+
+
 def process_phone_number(phone_number: str, region: str):
     """This function parses any phone number for the provided region
     :param phone_number: A string with a phone number.
@@ -38,6 +42,10 @@ def get_user_by_phone_number(phone_number: str) -> Optional[Account]:
     :rtype: Account|None
     """
     # consider adding region to user's metadata
-    phone_number = process_phone_number(phone_number=phone_number, region='KE')
+    phone_number = process_phone_number(phone_number=phone_number, region=E164Format.region)
     user = Account.session.query(Account).filter_by(phone_number=phone_number).first()
     return user
+
+
+class Support:
+    phone_number = None

apps/cic-ussd/cic_ussd/processor.py

@@ -1,4 +1,5 @@
 # standard imports
+import datetime
 import logging
 import json
 import re
@@ -19,7 +20,7 @@ from cic_ussd.db.models.ussd_session import UssdSession
 from cic_ussd.error import MetadataNotFoundError, SeppukuError
 from cic_ussd.menu.ussd_menu import UssdMenu
 from cic_ussd.metadata import blockchain_address_to_metadata_pointer
-from cic_ussd.phone_number import get_user_by_phone_number
+from cic_ussd.phone_number import get_user_by_phone_number, Support
 from cic_ussd.redis import cache_data, create_cached_data_key, get_cached_data
 from cic_ussd.state_machine import UssdStateMachine
 from cic_ussd.conversions import to_wei, from_wei
@@ -251,12 +252,16 @@ def process_display_user_metadata(user: Account, display_key: str):
         identifier=blockchain_address_to_metadata_pointer(blockchain_address=user.blockchain_address),
         cic_type=':cic.person'
     )
-    user_metadata = get_cached_data(key)
-    if user_metadata:
-        user_metadata = json.loads(user_metadata)
+    cached_metadata = get_cached_data(key)
+    if cached_metadata:
+        user_metadata = json.loads(cached_metadata)
         contact_data = get_contact_data_from_vcard(vcard=user_metadata.get('vcard'))
         logg.debug(f'{contact_data}')
         full_name = f'{contact_data.get("given")} {contact_data.get("family")}'
+        date_of_birth = user_metadata.get('date_of_birth')
+        year_of_birth = date_of_birth.get('year')
+        present_year = datetime.datetime.now().year
+        age = present_year - year_of_birth
         gender = user_metadata.get('gender')
         products = ', '.join(user_metadata.get('products'))
         location = user_metadata.get('location').get('area_name')
@@ -265,12 +270,29 @@ def process_display_user_metadata(user: Account, display_key: str):
             key=display_key,
             preferred_language=user.preferred_language,
             full_name=full_name,
+            age=age,
             gender=gender,
             location=location,
             products=products
         )
     else:
-        raise MetadataNotFoundError(f'Expected person metadata but found none in cache for key: {key}')
+        # TODO [Philip]: All these translations could be moved to translation files.
+        logg.warning(f'Expected person metadata but found none in cache for key: {key}')
+
+        absent = ''
+        if user.preferred_language == 'en':
+            absent = 'Not provided'
+        elif user.preferred_language == 'sw':
+            absent = 'Haijawekwa'
+
+        return translation_for(
+            key=display_key,
+            preferred_language=user.preferred_language,
+            full_name=absent,
+            gender=absent,
+            location=absent,
+            products=absent
+        )
 
 
 def process_account_statement(user: Account, display_key: str, ussd_session: dict):
@@ -406,12 +428,6 @@ def process_request(user_input: str, user: Account, ussd_session: Optional[dict]
     :return: A ussd menu's corresponding text value.
     :rtype: Document
     """
-    # retrieve metadata before any transition
-    key = generate_metadata_pointer(
-        identifier=blockchain_address_to_metadata_pointer(blockchain_address=user.blockchain_address),
-        cic_type=':cic.person'
-    )
-    person_metadata = get_cached_data(key=key)
 
     if ussd_session:
         if user_input == "0":
@@ -433,8 +449,9 @@ def process_request(user_input: str, user: Account, ussd_session: Optional[dict]
                     'exit_invalid_pin',
                     'exit_invalid_new_pin',
                     'exit_pin_mismatch',
-                    'exit_invalid_request'
-                ] and person_metadata is not None:
+                    'exit_invalid_request',
+                    'exit_successful_transaction'
+                ]:
                     return UssdMenu.find_by_name(name='start')
                 else:
                     return UssdMenu.find_by_name(name=last_state)
@@ -466,6 +483,14 @@ def next_state(ussd_session: dict, user: Account, user_input: str) -> str:
     return new_state
 
 
+def process_exit_invalid_menu_option(display_key: str, preferred_language: str):
+    return translation_for(
+        key=display_key,
+        preferred_language=preferred_language,
+        support_phone=Support.phone_number
+    )
+
+
 def custom_display_text(
         display_key: str,
         menu_name: str,
@@ -502,5 +527,7 @@ def custom_display_text(
         return process_account_statement(display_key=display_key, user=user, ussd_session=ussd_session)
     elif menu_name == 'display_user_metadata':
         return process_display_user_metadata(display_key=display_key, user=user)
+    elif menu_name == 'exit_invalid_menu_option':
+        return process_exit_invalid_menu_option(display_key=display_key, preferred_language=user.preferred_language)
     else:
         return translation_for(key=display_key, preferred_language=user.preferred_language)

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

@@ -26,7 +26,7 @@ from cic_ussd.metadata.base import Metadata
 from cic_ussd.operations import (define_response_with_content,
                                  process_menu_interaction_requests,
                                  define_multilingual_responses)
-from cic_ussd.phone_number import process_phone_number
+from cic_ussd.phone_number import process_phone_number, Support, E164Format
 from cic_ussd.processor import get_default_token_data
 from cic_ussd.redis import cache_data, create_cached_data_key, InMemoryStore
 from cic_ussd.requests import (get_request_endpoint,
@@ -126,6 +126,9 @@ else:
 
 valid_service_codes = config.get('APP_SERVICE_CODE').split(",")
 
+E164Format.region = config.get('PHONE_NUMBER_REGION')
+Support.phone_number = config.get('APP_SUPPORT_PHONE_NUMBER')
+
 
 def application(env, start_response):
     """Loads python code for application to be accessible over web server
@@ -143,7 +146,7 @@ def application(env, start_response):
     if get_request_method(env=env) == 'POST' and get_request_endpoint(env=env) == '/':
 
         if env.get('CONTENT_TYPE') != 'application/x-www-form-urlencoded':
-            start_response('405 Play by the rules', errors_headers)
+            start_response('405 Urlencoded, please', errors_headers)
             return []
 
         post_data = env.get('wsgi.input').read()
@@ -166,7 +169,7 @@ def application(env, start_response):
 
         # add validation for phone number
         if phone_number:
-            phone_number = process_phone_number(phone_number=phone_number, region=config.get('PHONE_NUMBER_REGION'))
+            phone_number = process_phone_number(phone_number=phone_number, region=E164Format.region)
 
         # validate ip address
         if not check_ip(config=config, env=env):
@@ -211,6 +214,9 @@ def application(env, start_response):
         return [response_bytes]
 
     else:
+        logg.error('invalid query {}'.format(env))
+        for r in env:
+            logg.debug('{}: {}'.format(r, env))
         start_response('405 Play by the rules', errors_headers)
         return []
 

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

@@ -66,6 +66,18 @@ def menu_five_selected(state_machine_data: Tuple[str, dict, Account]) -> bool:
     return user_input == '5'
 
 
+def menu_six_selected(state_machine_data: Tuple[str, dict, Account]) -> bool:
+    """
+    This function checks that user input matches a string with value '6'
+    :param state_machine_data: A tuple containing user input, a ussd session and user object.
+    :type state_machine_data: tuple
+    :return: A user input's match with '6'
+    :rtype: bool
+    """
+    user_input, ussd_session, user = state_machine_data
+    return user_input == '6'
+
+
 def menu_zero_zero_selected(state_machine_data: Tuple[str, dict, Account]) -> bool:
     """
     This function checks that user input matches a string with value '00'

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

@@ -13,7 +13,7 @@ import bcrypt
 
 # local imports
 from cic_ussd.db.models.account import AccountStatus, Account
-from cic_ussd.encoder import PasswordEncoder, create_password_hash
+from cic_ussd.encoder import PasswordEncoder, create_password_hash, check_password_hash
 from cic_ussd.operations import persist_session_to_db_task, create_or_update_session
 from cic_ussd.redis import InMemoryStore
 
@@ -78,9 +78,13 @@ def save_initial_pin_to_session_data(state_machine_data: Tuple[str, dict, Accoun
 
     # set initial pin data
     initial_pin = create_password_hash(user_input)
-    session_data = {
-        'initial_pin': initial_pin
-    }
+    if ussd_session.get('session_data'):
+        session_data = ussd_session.get('session_data')
+        session_data['initial_pin'] = initial_pin
+    else:
+        session_data = {
+            'initial_pin': initial_pin
+        }
 
     # create new in memory ussd session with current ussd session data
     create_or_update_session(
@@ -103,9 +107,8 @@ def pins_match(state_machine_data: Tuple[str, dict, Account]) -> bool:
     """
     user_input, ussd_session, user = state_machine_data
     initial_pin = ussd_session.get('session_data').get('initial_pin')
-    fernet = PasswordEncoder(PasswordEncoder.key)
-    initial_pin = fernet.decrypt(initial_pin.encode())
-    return bcrypt.checkpw(user_input.encode(), initial_pin)
+    logg.debug(f'USSD SESSION:  {ussd_session}')
+    return check_password_hash(user_input, initial_pin)
 
 
 def complete_pin_change(state_machine_data: Tuple[str, dict, Account]):

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

@@ -11,7 +11,7 @@ from cic_ussd.balance import BalanceManager, compute_operational_balance
 from cic_ussd.chain import Chain
 from cic_ussd.db.models.account import AccountStatus, Account
 from cic_ussd.operations import save_to_in_memory_ussd_session_data
-from cic_ussd.phone_number import get_user_by_phone_number
+from cic_ussd.phone_number import get_user_by_phone_number, process_phone_number, E164Format
 from cic_ussd.processor import retrieve_token_symbol
 from cic_ussd.redis import create_cached_data_key, get_cached_data
 from cic_ussd.transactions import OutgoingTransactionProcessor
@@ -29,8 +29,9 @@ def is_valid_recipient(state_machine_data: Tuple[str, dict, Account]) -> bool:
     :rtype: bool
     """
     user_input, ussd_session, user = state_machine_data
+    phone_number = process_phone_number(user_input, E164Format.region)
     recipient = get_user_by_phone_number(phone_number=user_input)
-    is_not_initiator = user_input != user.phone_number
+    is_not_initiator = phone_number != user.phone_number
     has_active_account_status = user.get_account_status() == AccountStatus.ACTIVE.name
     return is_not_initiator and has_active_account_status and recipient is not None
 

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

@@ -29,6 +29,16 @@ def change_preferred_language_to_en(state_machine_data: Tuple[str, dict, Account
     Account.session.add(user)
     Account.session.commit()
 
+    preferences_data = {
+        'preferred_language': 'en'
+    }
+
+    s = celery.signature(
+        'cic_ussd.tasks.metadata.add_preferences_metadata',
+        [user.blockchain_address, preferences_data]
+    )
+    s.apply_async(queue='cic-ussd')
+
 
 def change_preferred_language_to_sw(state_machine_data: Tuple[str, dict, Account]):
     """This function changes the user's preferred language to swahili.
@@ -40,6 +50,16 @@ def change_preferred_language_to_sw(state_machine_data: Tuple[str, dict, Account
     Account.session.add(user)
     Account.session.commit()
 
+    preferences_data = {
+        'preferred_language': 'sw'
+    }
+
+    s = celery.signature(
+        'cic_ussd.tasks.metadata.add_preferences_metadata',
+        [user.blockchain_address, preferences_data]
+    )
+    s.apply_async(queue='cic-ussd')
+
 
 def update_account_status_to_active(state_machine_data: Tuple[str, dict, Account]):
     """This function sets user's account to active.
@@ -64,13 +84,17 @@ def process_gender_user_input(user: Account, user_input: str):
     if user.preferred_language == 'en':
         if user_input == '1':
             gender = 'Male'
-        else:
+        elif user_input == '2':
             gender = 'Female'
+        elif user_input == '3':
+            gender = 'Other'
     else:
         if user_input == '1':
             gender = 'Mwanaume'
-        else:
+        elif user_input == '2':
             gender = 'Mwanamke'
+        elif user_input == '3':
+            gender = 'Nyingine'
     return gender
 
 
@@ -88,14 +112,21 @@ def save_metadata_attribute_to_session_data(state_machine_data: Tuple[str, dict,
     key = ''
     if 'given_name' in current_state:
         key = 'given_name'
-    elif 'family_name' in current_state:
+
+    if 'date_of_birth' in current_state:
+        key = 'date_of_birth'
+
+    if 'family_name' in current_state:
         key = 'family_name'
-    elif 'gender' in current_state:
+
+    if 'gender' in current_state:
         key = 'gender'
         user_input = process_gender_user_input(user=user, user_input=user_input)
-    elif 'location' in current_state:
+
+    if 'location' in current_state:
         key = 'location'
-    elif 'products' in current_state:
+
+    if 'products' in current_state:
         key = 'products'
 
     # check if there is existing session data
@@ -121,12 +152,27 @@ def format_user_metadata(metadata: dict, user: Account):
     gender = metadata.get('gender')
     given_name = metadata.get('given_name')
     family_name = metadata.get('family_name')
-    location = {
-        "area_name": metadata.get('location')
-    }
-    products = []
-    if metadata.get('products'):
+
+    if isinstance(metadata.get('date_of_birth'), dict):
+        date_of_birth = metadata.get('date_of_birth')
+    else:
+        date_of_birth = {
+            "year": int(metadata.get('date_of_birth')[:4])
+        }
+
+    # check whether there's existing location data
+    if isinstance(metadata.get('location'), dict):
+        location = metadata.get('location')
+    else:
+        location = {
+            "area_name": metadata.get('location')
+        }
+    # check whether it is a list
+    if isinstance(metadata.get('products'), list):
+        products = metadata.get('products')
+    else:
         products = metadata.get('products').split(',')
+
     phone_number = user.phone_number
     date_registered = int(user.created.replace().timestamp())
     blockchain_address = user.blockchain_address
@@ -138,6 +184,7 @@ def format_user_metadata(metadata: dict, user: Account):
     )
     return {
         "date_registered": date_registered,
+        "date_of_birth": date_of_birth,
         "gender": gender,
         "identities": identities,
         "location": location,
@@ -185,35 +232,39 @@ def edit_user_metadata_attribute(state_machine_data: Tuple[str, dict, Account]):
 
     given_name = ussd_session.get('session_data').get('given_name')
     family_name = ussd_session.get('session_data').get('family_name')
+    date_of_birth = ussd_session.get('session_data').get('date_of_birth')
     gender = ussd_session.get('session_data').get('gender')
     location = ussd_session.get('session_data').get('location')
     products = ussd_session.get('session_data').get('products')
 
     # validate user metadata
-    person = Person()
     user_metadata = json.loads(user_metadata)
-    deserialized_person = person.deserialize(person_data=user_metadata)
 
     # edit specific metadata attribute
     if given_name:
-        deserialized_person.given_name = given_name
-    elif family_name:
-        deserialized_person.family_name = family_name
-    elif gender:
-        deserialized_person.gender = gender
-    elif location:
+        user_metadata['given_name'] = given_name
+    if family_name:
+        user_metadata['family_name'] = family_name
+    if date_of_birth and len(date_of_birth) == 4:
+        year = int(date_of_birth[:4])
+        user_metadata['date_of_birth'] = {
+            'year': year
+        }
+    if gender:
+        user_metadata['gender'] = gender
+    if location:
         # get existing location metadata:
         location_data = user_metadata.get('location')
         location_data['area_name'] = location
-        deserialized_person.location = location_data
-    elif products:
-        deserialized_person.products = products
+        user_metadata['location'] = location_data
+    if products:
+        user_metadata['products'] = products
 
-    edited_metadata = deserialized_person.serialize()
+    user_metadata = format_user_metadata(metadata=user_metadata, user=user)
 
     s_edit_person_metadata = celery.signature(
-        'cic_ussd.tasks.metadata.edit_person_metadata',
-        [blockchain_address, edited_metadata]
+        'cic_ussd.tasks.metadata.create_person_metadata',
+        [blockchain_address, user_metadata]
     )
     s_edit_person_metadata.apply_async(queue='cic-ussd')
 

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

@@ -56,3 +56,15 @@ def is_valid_gender_selection(state_machine_data: Tuple[str, dict, Account]):
         return True
     else:
         return False
+
+
+def is_valid_date(state_machine_data: Tuple[str, dict, Account]):
+    """
+    :param state_machine_data:
+    :type state_machine_data:
+    :return:
+    :rtype:
+    """
+    user_input, ussd_session, user = state_machine_data
+    # For MVP this value is defaulting to year
+    return len(user_input) == 4 and int(user_input) >= 1900

apps/cic-ussd/cic_ussd/tasks/callback_handler.py

@@ -53,13 +53,25 @@ def process_account_creation_callback(self, result: str, url: str, status_code:
             session.add(user)
             session.commit()
             session.close()
-    
+
             queue = self.request.delivery_info.get('routing_key')
-            s = celery.signature(
+
+            # add phone number metadata lookup
+            s_phone_pointer = celery.signature(
                     'cic_ussd.tasks.metadata.add_phone_pointer',
                     [result, phone_number]
                     )
-            s.apply_async(queue=queue)
+            s_phone_pointer.apply_async(queue=queue)
+
+            # add custom metadata tags
+            custom_metadata = {
+                "tags": ["ussd", "individual"]
+            }
+            s_custom_metadata = celery.signature(
+                'cic_ussd.tasks.metadata.add_custom_metadata',
+                [result, custom_metadata]
+            )
+            s_custom_metadata.apply_async(queue=queue)
 
             # expire cache
             cache.expire(task_id, timedelta(seconds=180))

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

@@ -7,8 +7,10 @@ from hexathon import strip_0x
 
 # local imports
 from cic_ussd.metadata import blockchain_address_to_metadata_pointer
+from cic_ussd.metadata.custom import CustomMetadata
 from cic_ussd.metadata.person import PersonMetadata
 from cic_ussd.metadata.phone import PhonePointerMetadata
+from cic_ussd.metadata.preferences import PreferencesMetadata
 from cic_ussd.tasks.base import CriticalMetadataTask
 
 celery_app = celery.current_app
@@ -44,7 +46,7 @@ def create_person_metadata(blockchain_address: str, data: dict):
 
 
 @celery_app.task
-def edit_person_metadata(blockchain_address: str, data: bytes):
+def edit_person_metadata(blockchain_address: str, data: dict):
     identifier = blockchain_address_to_metadata_pointer(blockchain_address=blockchain_address)
     person_metadata_client = PersonMetadata(identifier=identifier)
     person_metadata_client.edit(data=data)
@@ -56,3 +58,17 @@ def add_phone_pointer(self, blockchain_address: str, phone_number: str):
     stripped_address = strip_0x(blockchain_address)
     phone_metadata_client = PhonePointerMetadata(identifier=identifier)
     phone_metadata_client.create(data=stripped_address)
+
+
+@celery_app.task()
+def add_custom_metadata(blockchain_address: str, data: dict):
+    identifier = blockchain_address_to_metadata_pointer(blockchain_address=blockchain_address)
+    custom_metadata_client = CustomMetadata(identifier=identifier)
+    custom_metadata_client.create(data=data)
+
+
+@celery_app.task()
+def add_preferences_metadata(blockchain_address: str, data: dict):
+    identifier = blockchain_address_to_metadata_pointer(blockchain_address=blockchain_address)
+    custom_metadata_client = PreferencesMetadata(identifier=identifier)
+    custom_metadata_client.create(data=data)

apps/cic-ussd/cic_ussd/translation.py

@@ -19,4 +19,6 @@ def translation_for(key: str, preferred_language: Optional[str] = None, **kwargs
     """
     if preferred_language:
         i18n.set('locale', preferred_language)
+    else:
+        i18n.set('locale', i18n.config.get('fallback'))
     return i18n.t(key, **kwargs)

apps/cic-ussd/requirements.txt

@@ -1,4 +1,4 @@
-cic_base[full_graph]~=0.1.2b2
-cic-eth~=0.11.0b9
-cic-notify~=0.4.0a4
-cic-types~=0.1.0a10
+cic_base[full_graph]~=0.1.2b21
+cic-eth~=0.11.0b16
+cic-notify~=0.4.0a5
+cic-types~=0.1.0a11

apps/cic-ussd/states/account_management_states.json

@@ -6,7 +6,11 @@
   "enter_new_pin",
   "new_pin_confirmation",
   "display_user_metadata",
-  "standard_pin_authorization",
+  "name_edit_pin_authorization",
+  "dob_edit_pin_authorization",
+  "gender_edit_pin_authorization",
+  "location_edit_pin_authorization",
+  "products_edit_pin_authorization",
   "account_balances_pin_authorization",
   "account_statement_pin_authorization",
   "account_balances"

apps/cic-ussd/states/user_metadata_states.json

@@ -5,5 +5,6 @@
   "enter_age",
   "enter_location",
   "enter_products",
+  "enter_date_of_birth",
   "display_metadata_pin_authorization"
 ]

apps/cic-ussd/test_requirements.txt

@@ -1,7 +1,11 @@
-pytest==6.0.1
+Faker==8.1.2
+faker-e164==0.1.0
+pytest==6.2.4
 pytest-alembic==0.2.5
 pytest-celery==0.0.0a1
 pytest-cov==2.10.1
 pytest-mock==3.3.1
+pytest-ordering==0.6
 pytest-redis==2.0.0
-requests-mock==1.8.0
+requests-mock==1.8.0
+tavern==1.14.2

apps/cic-ussd/tests/conftest.py

@@ -6,6 +6,7 @@ from cic_types.pytest import *
 from tests.fixtures.config import *
 from tests.fixtures.db import *
 from tests.fixtures.celery import *
+from tests.fixtures.integration import *
 from tests.fixtures.user import *
 from tests.fixtures.ussd_session import *
 from tests.fixtures.redis import *

apps/cic-ussd/tests/fixtures/integration.py

@@ -0,0 +1,249 @@
+# standard imports
+
+# external imports
+
+import pytest
+from faker import Faker
+
+# local imports
+
+# test imports
+from tests.helpers.accounts import phone_number, pin_number, session_id
+
+
+fake = Faker()
+
+
+@pytest.fixture(scope='function')
+def generate_phone_number() -> str:
+    return phone_number()
+
+
+@pytest.fixture(scope='function')
+def generate_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_account_phone_number() -> str:
+    return phone_number()
+
+
+@pytest.fixture(scope='session')
+def second_account_phone_number() -> str:
+    return phone_number()
+
+
+@pytest.fixture(scope='session')
+def first_account_pin_number() -> str:
+    return pin_number()
+
+
+@pytest.fixture(scope='session')
+def second_account_pin_number() -> str:
+    return pin_number()
+
+
+@pytest.fixture(scope='session')
+def first_metadata_entry_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_metadata_entry_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_transaction_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_transaction_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_account_given_name() -> str:
+    return fake.first_name()
+
+
+@pytest.fixture(scope='session')
+def second_account_given_name() -> str:
+    return fake.first_name()
+
+
+@pytest.fixture(scope='session')
+def first_account_family_name() -> str:
+    return fake.last_name()
+
+
+@pytest.fixture(scope='session')
+def second_account_family_name() -> str:
+    return fake.last_name()
+
+
+@pytest.fixture(scope='session')
+def first_account_location() -> str:
+    return fake.city()
+
+
+@pytest.fixture(scope='session')
+def second_account_location() -> str:
+    return fake.city()
+
+
+@pytest.fixture(scope='session')
+def first_account_product() -> str:
+    return fake.color_name()
+
+
+@pytest.fixture(scope='session')
+def second_account_product() -> str:
+    return fake.color_name()
+
+
+@pytest.fixture(scope='session')
+def first_account_verify_balance_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_account_verify_balance_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_profile_management_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_profile_management_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_account_change_given_name() -> str:
+    return fake.first_name()
+
+
+@pytest.fixture(scope='session')
+def second_account_change_given_name() -> str:
+    return fake.first_name()
+
+
+@pytest.fixture(scope='session')
+def first_account_change_family_name() -> str:
+    return fake.last_name()
+
+
+@pytest.fixture(scope='session')
+def second_account_change_family_name() -> str:
+    return fake.last_name()
+
+
+@pytest.fixture(scope='session')
+def first_account_change_location() -> str:
+    return fake.city()
+
+
+@pytest.fixture(scope='session')
+def second_account_change_location() -> str:
+    return fake.city()
+
+
+@pytest.fixture(scope='session')
+def first_account_change_product() -> str:
+    return fake.color_name()
+
+
+@pytest.fixture(scope='session')
+def second_account_change_product() -> str:
+    return fake.color_name()
+
+
+@pytest.fixture(scope='session')
+def first_profile_management_session_id_1() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_profile_management_session_id_1() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_profile_management_session_id_2() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_profile_management_session_id_2() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_profile_management_session_id_3() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_profile_management_session_id_3() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_profile_management_session_id_4() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_profile_management_session_id_4() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_account_management_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_account_management_session_id() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_account_management_session_id_1() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def second_account_management_session_id_1() -> str:
+    return session_id()
+
+
+@pytest.fixture(scope='session')
+def first_account_new_pin_number() -> str:
+    return pin_number()
+
+
+@pytest.fixture(scope='session')
+def second_account_new_pin_number() -> str:
+    return pin_number()
+
+
+@pytest.fixture(scope='session')
+def gift_value(load_config):
+    return load_config.get('TEST_GIFT_VALUE')
+
+
+@pytest.fixture(scope='session')
+def server_url(load_config):
+    return load_config.get('TEST_SERVER_URL')
+
+
+@pytest.fixture(scope='session')
+def token_symbol(load_config):
+    return load_config.get('TEST_TOKEN_SYMBOL')

apps/cic-ussd/tests/helpers/accounts.py

@@ -0,0 +1,26 @@
+# standard imports
+import random
+import uuid
+
+# 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')
+
+
+def session_id() -> str:
+    return uuid.uuid4().hex
+
+
+def pin_number() -> int:
+    return random.randint(1000, 9999)

apps/cic-ussd/tests/integration/ext/validator.py

@@ -0,0 +1,11 @@
+import logging
+
+
+logg = logging.getLogger()
+logg.setLevel(logging.DEBUG)
+
+
+def validate_response(response, expected_response):
+    """Makes sure that the response received matches the expected response"""
+    logg.debug(f'RESPONSE: {response.content.decode("utf-8")}')
+    assert response.content.decode('utf-8') == expected_response

apps/cic-ussd/tests/integration/run.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+PYTHONPATH=. py.test --debug -vv --log-level debug -s --log-cli-level debug

apps/cic-ussd/tests/integration/test_account_creation.tavern.yaml

@@ -0,0 +1,466 @@
+test_name: Test the creation of accounts through the cic_user_ussd_server entrypoint.
+marks:
+  - usefixtures:
+    - gift_value
+    - server_url
+    - token_symbol
+    - generate_session_id
+    - first_account_phone_number
+    - second_account_phone_number
+    - first_account_pin_number
+    - second_account_pin_number
+    - first_account_family_name
+    - second_account_family_name
+    - first_account_given_name
+    - second_account_given_name
+    - first_account_location
+    - second_account_location
+    - first_account_product
+    - second_account_product
+    - first_metadata_entry_session_id
+    - second_metadata_entry_session_id
+  - first
+
+stages:
+  - name: Initiate account creation process [first account].
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{generate_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '175'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "END Your account is being created. You will receive an SMS when your account is ready.\nAkaunti yako ya Sarafu inatayarishwa. Utapokea ujumbe wa SMS akaunti yako ikiwa tayari.\n"
+
+  - name: Initiate account creation process [second account].
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{generate_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '175'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "END Your account is being created. You will receive an SMS when your account is ready.\nAkaunti yako ya Sarafu inatayarishwa. Utapokea ujumbe wa SMS akaunti yako ikiwa tayari.\n"
+    delay_after: 5
+
+  - name: Initaite account metadata entry [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '61'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Welcome to Sarafu Network\n1. English\n2. Kiswahili\n3. Help"
+
+  - name: Initaite account metadata entry [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '61'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Welcome to Sarafu Network\n1. English\n2. Kiswahili\n3. Help"
+
+  - name: Select preferred language [English]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '64'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Please enter a new four number PIN for your account.\n0. Back"
+
+  - name: Select preferred language [Kiswahili]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '71'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Tafadhali weka pin mpya yenye nambari nne kwa akaunti yako\n0. Nyuma"
+
+  - name: Enter pin number [{first_account_pin_number} - first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{first_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '44'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter your four number PIN again\n0. Back"
+
+  - name: Enter pin number [second_account_pin_number - second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*{second_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '31'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka PIN yako tena\n0. Nyuma"
+
+  - name: Pin number confirmation [first_account_pin_number - first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{first_account_pin_number}*{first_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '28'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter first name\n0. Back"
+
+  - name: Pin number confirmation [{second_account_pin_number} - second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*{second_account_pin_number}*{second_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '37'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka jina lako la kwanza\n0. Nyuma"
+
+  - name: Enter first name [first_account_given_name - first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '29'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter family name\n0. Back"
+
+  - name: Enter first name [second_account_given_name - second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '37'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka jina lako la mwisho\n0. Nyuma"
+
+  - name: Enter last name [first_account_family_name - first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}*{first_account_family_name}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '51'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter gender\n1. Male\n2. Female\n3. Other\n0. Back"
+
+  - name: Enter last name [second_account_family_name - second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}*{second_account_family_name}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '64'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka jinsia yako\n1. Mwanaume\n2. Mwanamke\n3. Nyngine\n0. Nyuma"
+
+  - name: Select gender [Male - first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}*{first_account_family_name}*1"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '31'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter your location\n0. Back"
+
+  - name: Select gender [Female - second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}*{second_account_family_name}*2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '27'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka eneo lako\n0. Nyuma"
+
+  - name: Enter location [first_account_location - first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}*{first_account_family_name}*1*{first_account_location}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '55'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Please enter a product or service you offer\n0. Back"
+
+  - name: Enter location [second_account_location - second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}*{second_account_family_name}*2*{second_account_location}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '42'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka bidhaa ama huduma unauza\n0. Nyuma"
+
+  - name: Enter product [first_account_product - first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_metadata_entry_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}*{first_account_family_name}*1*{first_account_location}*{first_account_product}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '51'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Balance {gift_value} {token_symbol}\n1. Send\n2. My Account\n3. Help"
+    delay_before: 10
+
+  - name: Enter product [second_account_product - second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_metadata_entry_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}*{second_account_family_name}*2*{second_account_location}*{second_account_product}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '56'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Salio {gift_value} {token_symbol}\n1. Tuma\n2. Akaunti yangu\n3. Usaidizi"
+    delay_before: 10

apps/cic-ussd/tests/integration/test_account_management.tavern.yaml

@@ -0,0 +1,587 @@
+test_name: Test performing account management operations.
+marks:
+  - usefixtures:
+    - server_url
+    - token_symbol
+    - first_account_pin_number
+    - second_account_pin_number
+    - first_account_phone_number
+    - second_account_phone_number
+    - first_account_management_session_id
+    - second_account_management_session_id
+    - first_account_management_session_id_1
+    - second_account_management_session_id_1
+    - first_account_new_pin_number
+    - second_account_new_pin_number
+  - fourth
+
+stages:
+  - name: Account management start menu [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '51'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Balance 58.00 {token_symbol}\n1. Send\n2. My Account\n3. Help"
+
+  - name: Account management start menu [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '56'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Salio 42.00 {token_symbol}\n1. Tuma\n2. Akaunti yangu\n3. Usaidizi"
+
+  - name: Account management menu [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '105'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON My account\n1. My profile\n2. Change language\n3. Check balance\n4. Check statement\n5. Change PIN\n0. Back"
+
+  - name: Account management menu [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '148'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Akaunti yangu\n1. Wasifu wangu\n2. Chagua lugha utakayotumia\n3. Angalia salio\n4. Angalia taarifa ya matumizi\n5. Badilisha nambari ya siri\n0. Nyuma"
+
+  - name: Language change [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '51'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Choose language\n1. English\n2. Kiswahili\n0. Back"
+
+  - name: Language change [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '51'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Chagua lugha\n1. Kingereza\n2. Kiswahili\n0. Nyuma"
+
+  - name: Select language [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*2*2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '30'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "END Asante kwa kutumia huduma."
+
+  - name: Select language [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*2*1"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '36'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "END Thank you for using the service."
+
+  - name: Second account management start menu [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '56'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Salio 58.00 {token_symbol}\n1. Tuma\n2. Akaunti yangu\n3. Usaidizi"
+
+  - name: Second account management start menu [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '51'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Balance 42.00 {token_symbol}\n1. Send\n2. My Account\n3. Help"
+
+  - name: Second account management menu [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '148'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Akaunti yangu\n1. Wasifu wangu\n2. Chagua lugha utakayotumia\n3. Angalia salio\n4. Angalia taarifa ya matumizi\n5. Badilisha nambari ya siri\n0. Nyuma"
+
+  - name: Second account management menu [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '105'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON My account\n1. My profile\n2. Change language\n3. Check balance\n4. Check statement\n5. Change PIN\n0. Back"
+
+  - name: Check balance [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*3"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '49'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Tafadhali weka PIN yako kuona salio.\n0. Nyuma"
+
+  - name: Check balance [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*3"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '50'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Please enter your PIN to view balances\n0. Back"
+
+  - name: Display balances [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*3*{first_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Salio zako ni zifuatazo:\n  salio: 58.00 {token_symbol}\n  ushuru:  {token_symbol}\n  tuzo:  {token_symbol}\n0. Nyuma"
+
+  - name: Display balances [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*3*{second_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Your balances are as follows:\n  balance: 42.00 {token_symbol}\n  fees:  {token_symbol}\n  rewards:  {token_symbol}\n0. Back"
+
+  - name: Resume account management menu [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*3*{first_account_pin_number}*0"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '148'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Akaunti yangu\n1. Wasifu wangu\n2. Chagua lugha utakayotumia\n3. Angalia salio\n4. Angalia taarifa ya matumizi\n5. Badilisha nambari ya siri\n0. Nyuma"
+
+  - name: Resume account management menu [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*3*{second_account_pin_number}*0"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '105'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON My account\n1. My profile\n2. Change language\n3. Check balance\n4. Check statement\n5. Change PIN\n0. Back"
+
+  - name: Change pin number [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*3*{first_account_pin_number}*0*5"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '34'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka nambari ya siri.\n0. Nyuma"
+
+  - name: Change pin number [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*3*{second_account_pin_number}*0*5"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '30'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter current PIN.\n0. Back"
+
+  - name: Enter old pin [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*3*{first_account_pin_number}*0*5*{first_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '38'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka nambari ya siri mpya\n0. Nyuma"
+
+  - name: Enter old pin [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*3*{second_account_pin_number}*0*5*{second_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '42'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter your new four number PIN\n0. Back"
+
+  - name: Enter new pin [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*3*{first_account_pin_number}*0*5*{first_account_pin_number}*{first_account_new_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '31'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka PIN yako tena\n0. Nyuma"
+
+  - name: Enter new pin [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*3*{second_account_pin_number}*0*5*{second_account_pin_number}*{second_account_new_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '48'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter your new four number PIN again\n0. Back"
+
+  - name: Enter new pin confirmation [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_management_session_id_1}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "2*3*{first_account_pin_number}*0*5*{first_account_pin_number}*{first_account_new_pin_number}*{first_account_new_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '91'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Ombi lako limetumwa. Utapokea uthibitishaji wa SMS kwa muda mfupi.\n00. Nyuma\n99. Ondoka"
+
+  - name: Enter new pin confirmation [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_management_session_id_1}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "2*3*{second_account_pin_number}*0*5*{second_account_pin_number}*{second_account_new_pin_number}*{second_account_new_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '82'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Your request has been sent. You will receive an SMS shortly.\n00. Back\n99. Exit"

apps/cic-ussd/tests/integration/test_transactions.tavern.yaml

@@ -0,0 +1,282 @@
+test_name: Test that the two test accounts can trade with each other.
+marks:
+  - usefixtures:
+    - gift_value
+    - server_url
+    - token_symbol
+    - first_account_family_name
+    - second_account_family_name
+    - first_account_given_name
+    - second_account_given_name
+    - first_account_phone_number
+    - second_account_phone_number
+    - first_account_pin_number
+    - second_account_pin_number
+    - first_transaction_session_id
+    - second_transaction_session_id
+    - first_account_verify_balance_session_id
+    - second_account_verify_balance_session_id
+  - second
+
+stages:
+  - name: Transactions start menu [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_transaction_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '51'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Balance {gift_value} {token_symbol}\n1. Send\n2. My Account\n3. Help"
+
+  - name: Transactions start menu [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_transaction_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '56'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Salio {gift_value} {token_symbol}\n1. Tuma\n2. Akaunti yangu\n3. Usaidizi"
+
+  - name: Initate transcation attempt [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_transaction_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '30'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter phone number\n0. Back"
+
+  - name: Initate transcation attempt [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_transaction_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "1"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '33'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka nambari ya simu\n0. Nyuma"
+
+  - name: Enter phone number [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_transaction_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{second_account_phone_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '24'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Enter amount\n0. Back"
+
+  - name: Enter phone number [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_transaction_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "1*{first_account_phone_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '25'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Weka kiwango\n0. Nyuma"
+
+  - name: Enter transcation amount [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_transaction_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{second_account_phone_number}*17"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON {second_account_given_name} {second_account_family_name} {second_account_phone_number} will receive 17.00 {token_symbol} from {first_account_given_name} {first_account_family_name} {first_account_phone_number}.\nPlease enter your PIN to confirm.\n0. Back"
+
+  - name: Enter transcation amount [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_transaction_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "1*{first_account_phone_number}*25"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON {first_account_given_name} {first_account_family_name} {first_account_phone_number} atapokea 25.00 {token_symbol} kutoka kwa {second_account_given_name} {second_account_family_name} {second_account_phone_number}.\nTafadhali weka nambari yako ya siri kudhibitisha.\n0. Nyuma"
+
+  - name: Pin to authorize transaction [first account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_transaction_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: "1*{second_account_phone_number}*17*{first_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Your request has been sent. {second_account_given_name} {second_account_family_name} {second_account_phone_number} will receive 17.00 {token_symbol} from {first_account_given_name} {first_account_family_name} {first_account_phone_number}.\n00. Back\n99. Exit"
+
+  - name: Pin to authorize transaction [second account]
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_transaction_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: "1*{first_account_phone_number}*25*{second_account_pin_number}"
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Ombi lako limetumwa. {first_account_given_name} {first_account_family_name} {first_account_phone_number} atapokea 25.00 {token_symbol} kutoka kwa {second_account_given_name} {second_account_family_name} {second_account_phone_number}.\n00. Nyuma\n99. Ondoka"
+
+  - name: Verify balance changes [first account]
+    delay_before: 10
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{first_account_verify_balance_session_id}"
+        phoneNumber: "{first_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '51'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Balance 58.00 {token_symbol}\n1. Send\n2. My Account\n3. Help"
+
+  - name: Verify balance changes [second account]
+    delay_before: 10
+    request:
+      url: "{server_url}"
+      data:
+        serviceCode: "*483*46#"
+        sessionId: "{second_account_verify_balance_session_id}"
+        phoneNumber: "{second_account_phone_number}"
+        text: ""
+      headers:
+        content-type: "application/x-www-form-urlencoded"
+      method: POST
+    response:
+      status_code:
+        - 200
+      headers:
+        Content-Length: '56'
+        Content-Type: "text/plain"
+      verify_response_with:
+        function: ext.validator:validate_response
+        extra_kwargs:
+          expected_response: "CON Salio 42.00 {token_symbol}\n1. Tuma\n2. Akaunti yangu\n3. Usaidizi"

apps/cic-ussd/transitions/age_setting_transitions.json

@@ -0,0 +1,39 @@
+[
+  {
+    "trigger": "scan_data",
+    "source": "enter_date_of_birth",
+    "dest": "dob_edit_pin_authorization",
+    "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
+    "conditions": [
+      "cic_ussd.state_machine.logic.validator.has_cached_user_metadata",
+      "cic_ussd.state_machine.logic.validator.is_valid_date"
+    ]
+  },
+  {
+    "trigger": "scan_data",
+    "source": "enter_date_of_birth",
+    "dest": "enter_gender",
+    "conditions": "cic_ussd.state_machine.logic.validator.is_valid_date",
+    "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
+    "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
+  },
+  {
+    "trigger": "scan_data",
+    "source": "enter_date_of_birth",
+    "dest": "exit_invalid_input",
+    "unless": "cic_ussd.state_machine.logic.validator.is_valid_date"
+  },
+  {
+    "trigger": "scan_data",
+    "source": "dob_edit_pin_authorization",
+    "dest": "exit",
+    "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin",
+    "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute"
+  },
+  {
+    "trigger": "scan_data",
+    "source": "dob_edit_pin_authorization",
+    "dest": "exit_pin_blocked",
+    "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account"
+  }
+]

apps/cic-ussd/transitions/gender_setting_transitions.json

@@ -4,12 +4,13 @@
     "source": "enter_gender",
     "dest": "enter_location",
     "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
-    "conditions": "cic_ussd.state_machine.logic.validator.is_valid_gender_selection"
+    "conditions": "cic_ussd.state_machine.logic.validator.is_valid_gender_selection",
+    "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
   },
   {
     "trigger": "scan_data",
     "source": "enter_gender",
-    "dest": "standard_pin_authorization",
+    "dest": "gender_edit_pin_authorization",
     "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
     "conditions": [
       "cic_ussd.state_machine.logic.validator.has_cached_user_metadata",
@@ -18,15 +19,14 @@
   },
   {
     "trigger": "scan_data",
-    "source": "standard_pin_authorization",
+    "source": "gender_edit_pin_authorization",
     "dest": "exit",
     "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin",
-    "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute",
-    "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
+    "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute"
   },
   {
     "trigger": "scan_data",
-    "source": "standard_pin_authorization",
+    "source": "gender_edit_pin_authorization",
     "dest": "exit_pin_blocked",
     "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account"
   },

apps/cic-ussd/transitions/location_setting_transitions.json

@@ -3,26 +3,26 @@
     "trigger": "scan_data",
     "source": "enter_location",
     "dest": "enter_products",
-    "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data"
+    "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
+    "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
   },
   {
     "trigger": "scan_data",
     "source": "enter_location",
-    "dest": "standard_pin_authorization",
+    "dest": "location_edit_pin_authorization",
     "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
     "conditions": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
   },
   {
     "trigger": "scan_data",
-    "source": "standard_pin_authorization",
+    "source": "location_edit_pin_authorization",
     "dest": "exit",
     "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin",
-    "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute",
-    "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
+    "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute"
   },
   {
     "trigger": "scan_data",
-    "source": "standard_pin_authorization",
+    "source": "location_edit_pin_authorization",
     "dest": "exit_pin_blocked",
     "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account"
   }

apps/cic-ussd/transitions/name_setting_transitions.json

@@ -7,49 +7,28 @@
   },
   {
     "trigger": "scan_data",
-    "source": "enter_given_name",
-    "dest": "standard_pin_authorization",
+    "source": "enter_family_name",
+    "dest": "name_edit_pin_authorization",
     "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
     "conditions": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
   },
-  {
-    "trigger": "scan_data",
-    "source": "standard_pin_authorization",
-    "dest": "exit",
-    "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin",
-    "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute",
-    "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
-  },
-  {
-    "trigger": "scan_data",
-    "source": "standard_pin_authorization",
-    "dest": "exit_pin_blocked",
-    "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account"
-  },
   {
     "trigger": "scan_data",
     "source": "enter_family_name",
-    "dest": "enter_gender",
-    "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data"
-  },
-  {
-    "trigger": "scan_data",
-    "source": "enter_family_name",
-    "dest": "standard_pin_authorization",
+    "dest": "enter_date_of_birth",
     "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
-    "conditions": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
-  },
-  {
-    "trigger": "scan_data",
-    "source": "standard_pin_authorization",
-    "dest": "exit",
-    "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin",
-    "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute",
     "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
   },
   {
     "trigger": "scan_data",
-    "source": "standard_pin_authorization",
+    "source": "name_edit_pin_authorization",
+    "dest": "exit",
+    "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin",
+    "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute"
+  },
+  {
+    "trigger": "scan_data",
+    "source": "name_edit_pin_authorization",
     "dest": "exit_pin_blocked",
     "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account"
   }

apps/cic-ussd/transitions/pin_setting_transitions.json

@@ -9,14 +9,14 @@
     "trigger": "scan_data",
     "source": "enter_current_pin",
     "dest": "exit_pin_blocked",
-    "conditions": "cic_ussd.state_machine.logic.menu.is_blocked_pin"
+    "conditions": "cic_ussd.state_machine.logic.pin.is_blocked_pin"
   },
   {
     "trigger": "scan_data",
     "source": "enter_new_pin",
     "dest": "new_pin_confirmation",
     "after": "cic_ussd.state_machine.logic.pin.save_initial_pin_to_session_data",
-    "conditions": "cic_ussd.state_machine.logic.menu.is_valid_new_pin"
+    "conditions": "cic_ussd.state_machine.logic.pin.is_valid_new_pin"
   },
   {
     "trigger": "scan_data",
@@ -28,7 +28,7 @@
     "source": "new_pin_confirmation",
     "dest": "complete",
     "conditions": "cic_ussd.state_machine.logic.pin.pins_match",
-    "after": "cic_ussd.state_machine.logic.menu.complete_pin_change"
+    "after": "cic_ussd.state_machine.logic.pin.complete_pin_change"
   },
   {
     "trigger": "scan_data",

apps/cic-ussd/transitions/products_setting_transitions.json

@@ -2,7 +2,7 @@
   {
     "trigger": "scan_data",
     "source": "enter_products",
-    "dest": "standard_pin_authorization",
+    "dest": "products_edit_pin_authorization",
     "conditions": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata",
     "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data"
   },
@@ -13,18 +13,19 @@
     "after": [
       "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data",
       "cic_ussd.state_machine.logic.user.save_complete_user_metadata"
-    ]
+    ],
+    "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
   },
   {
     "trigger": "scan_data",
-    "source": "standard_pin_authorization",
+    "source": "products_edit_pin_authorization",
     "dest": "exit",
     "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin",
     "after": "cic_ussd.state_machine.logic.user.edit_user_metadata_attribute"
   },
   {
     "trigger": "scan_data",
-    "source": "standard_pin_authorization",
+    "source": "products_edit_pin_authorization",
     "dest": "exit_pin_blocked",
     "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account"
   }

apps/cic-ussd/transitions/signup_transitions.json

@@ -36,26 +36,12 @@
     "source": "initial_pin_entry",
     "dest": "exit_invalid_pin"
   },
-  {
-    "trigger": "scan_data",
-    "source": "initial_pin_confirmation",
-    "dest": "start",
-    "conditions": [
-      "cic_ussd.state_machine.logic.pin.pins_match",
-      "cic_ussd.state_machine.logic.validator.has_cached_user_metadata"
-    ],
-    "after": [
-      "cic_ussd.state_machine.logic.pin.complete_pin_change",
-      "cic_ussd.state_machine.logic.user.get_user_metadata",
-      "cic_ussd.state_machine.logic.user.update_account_status_to_active"
-    ]
-  },
   {
     "trigger": "scan_data",
     "source": "initial_pin_confirmation",
     "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata",
     "conditions": "cic_ussd.state_machine.logic.pin.pins_match",
-    "dest": "enter_given_name",
+    "dest": "start",
     "after": [
       "cic_ussd.state_machine.logic.pin.complete_pin_change",
       "cic_ussd.state_machine.logic.user.update_account_status_to_active"

apps/cic-ussd/transitions/user_metadata_transitions.json

@@ -8,27 +8,33 @@
   {
     "trigger": "scan_data",
     "source": "metadata_management",
-    "dest": "enter_age",
+    "dest": "enter_gender",
     "conditions": "cic_ussd.state_machine.logic.menu.menu_two_selected"
   },
   {
     "trigger": "scan_data",
     "source": "metadata_management",
-    "dest": "enter_location",
+    "dest": "enter_date_of_birth",
     "conditions": "cic_ussd.state_machine.logic.menu.menu_three_selected"
   },
   {
     "trigger": "scan_data",
     "source": "metadata_management",
-    "dest": "enter_products",
+    "dest": "enter_location",
     "conditions": "cic_ussd.state_machine.logic.menu.menu_four_selected"
   },
   {
     "trigger": "scan_data",
     "source": "metadata_management",
-    "dest": "display_metadata_pin_authorization",
+    "dest": "enter_products",
     "conditions": "cic_ussd.state_machine.logic.menu.menu_five_selected"
   },
+  {
+    "trigger": "scan_data",
+    "source": "metadata_management",
+    "dest": "display_metadata_pin_authorization",
+    "conditions": "cic_ussd.state_machine.logic.menu.menu_six_selected"
+  },
   {
     "trigger": "scan_data",
     "source": "display_metadata_pin_authorization",

apps/cic-ussd/var/lib/locale/ussd.en.yml

@@ -6,7 +6,7 @@ en:
       2. Kiswahili
       3. Help
     initial_pin_entry: |-
-      CON Please enter a new four number PIN for your account. 
+      CON Please enter a new four number PIN for your account.
       0. Back
     initial_pin_confirmation: |-
       CON Enter your four number PIN again
@@ -17,6 +17,9 @@ en:
     enter_family_name: |-
       CON Enter family name
       0. Back
+    enter_date_of_birth: |-
+      CON Enter year of birth
+      0. Back
     enter_gender: |-
       CON Enter gender
       1. Male
@@ -52,14 +55,16 @@ en:
       CON My profile
       1. Edit name
       2. Edit gender
-      3. Edit location
-      4. Edit products
-      5. View my profile
+      3. Edit Age
+      4. Edit location
+      5. Edit products
+      6. View my profile
       0. Back
     display_user_metadata: |-
       CON Your details are:
         Name: %{full_name}
         Gender: %{gender}
+        Age: %{age}
         Location: %{location}
         You sell: %{products}
       0. Back
@@ -76,7 +81,10 @@ en:
         CON Enter current PIN. You have %{remaining_attempts} attempts remaining.
         0. Back
     enter_new_pin: |-
-      CON Enter new PIN again
+      CON Enter your new four number PIN
+      0. Back
+    new_pin_confirmation: |-
+      CON Enter your new four number PIN again
       0. Back
     transaction_pin_authorization:
       first: |-
@@ -107,6 +115,41 @@ en:
       retry: |-
         CON Please enter your PIN. You have %{remaining_attempts} attempts remaining
         0. Back
+    name_edit_pin_authorization:
+      first: |-
+        CON Please enter your PIN
+        0. Back
+      retry: |-
+        CON Please enter your PIN. You have %{remaining_attempts} attempts remaining
+        0. Back
+    dob_edit_pin_authorization:
+      first: |-
+        CON Please enter your PIN
+        0. Back
+      retry: |-
+        CON Please enter your PIN. You have %{remaining_attempts} attempts remaining
+        0. Back
+    gender_edit_pin_authorization:
+      first: |-
+        CON Please enter your PIN
+        0. Back
+      retry: |-
+        CON Please enter your PIN. You have %{remaining_attempts} attempts remaining
+        0. Back
+    location_edit_pin_authorization:
+      first: |-
+        CON Please enter your PIN
+        0. Back
+      retry: |-
+        CON Please enter your PIN. You have %{remaining_attempts} attempts remaining
+        0. Back
+    products_edit_pin_authorization:
+      first: |-
+        CON Please enter your PIN
+        0. Back
+      retry: |-
+        CON Please enter your PIN. You have %{remaining_attempts} attempts remaining
+        0. Back
     account_balances: |-
       CON Your balances are as follows:
         balance: %{operational_balance} %{token_symbol}

apps/cic-ussd/var/lib/locale/ussd.sw.yml

@@ -17,11 +17,14 @@ sw:
     enter_family_name: |-
       CON Weka jina lako la mwisho
       0. Nyuma
+    enter_date_of_birth: |-
+      CON Weka mwaka wa kuzaliwa
+      0. Nyuma
     enter_gender: |-
       CON Weka jinsia yako
       1. Mwanaume
       2. Mwanamke
-      3. Nyngine 
+      3. Nyngine
       0. Nyuma
     enter_location: |-
       CON Weka eneo lako
@@ -52,16 +55,18 @@ sw:
       CON Wasifu wangu
       1. Weka jina
       2. Weka jinsia
-      3. Weka eneo
-      4. Weka bidhaa
-      5. Angalia wasifu wako
+      3  Weka umri
+      4. Weka eneo
+      5. Weka bidhaa
+      6. Angalia wasifu wako
       0. Nyuma
     display_user_metadata: |-
       CON Wasifu wako una maelezo yafuatayo:
         Jina: %{full_name}
         Jinsia: %{gender}
+        Umri: %{age}
         Eneo: %{location}
-        Unauza: %{user_bio}
+        Unauza: %{products}
       0. Nyuma
     select_preferred_language: |-
       CON Chagua lugha
@@ -78,6 +83,9 @@ sw:
     enter_new_pin: |-
       CON Weka nambari ya siri mpya
       0. Nyuma
+    new_pin_confirmation: |-
+      CON Weka PIN yako tena
+      0. Nyuma
     transaction_pin_authorization:
       first: |-
         CON %{recipient_information} atapokea %{transaction_amount} %{token_symbol} kutoka kwa %{sender_information}.
@@ -86,9 +94,9 @@ sw:
       retry: |-
         CON Weka nambari ya siri. Una majaribio %{remaining_attempts} yaliyobaki.
         0. Nyuma
-    standard_pin_authorization:
+    display_metadata_pin_authorization:
       first: |-
-        CON Tafadhali weka PIN yako.
+        CON Tafadhali weka PIN yako
         0. Nyuma
       retry: |-
         CON Tafadhali weka PIN yako. Una majaribio %{remaining_attempts} yaliyobaki.
@@ -107,12 +115,47 @@ sw:
       retry: |-
         CON Tafadhali weka PIN yako. Una majaribio %{remaining_attempts} yaliyobaki.
         0. Nyuma
+    name_edit_pin_authorization:
+      first: |-
+        CON Tafadhali weka PIN yako
+        0. Nyuma
+      retry: |-
+        CON Tafadhali weka PIN yako. Una majaribio %{remaining_attempts} yaliyobaki.
+        0. Nyuma
+    dob_edit_pin_authorization:
+      first: |-
+        CON Tafadhali weka PIN yako
+        0. Nyuma
+      retry: |-
+        CON Tafadhali weka PIN yako. Una majaribio %{remaining_attempts} yaliyobaki.
+        0. Nyuma
+    gender_edit_pin_authorization:
+      first: |-
+        CON Tafadhali weka PIN yako
+        0. Nyuma
+      retry: |-
+        CON Tafadhali weka PIN yako. Una majaribio %{remaining_attempts} yaliyobaki.
+        0. Nyuma
+    location_edit_pin_authorization:
+      first: |-
+        CON Tafadhali weka PIN yako
+        0. Nyuma
+      retry: |-
+        CON Tafadhali weka PIN yako. Una majaribio %{remaining_attempts} yaliyobaki.
+        0. Nyuma
+    products_edit_pin_authorization:
+      first: |-
+        CON Tafadhali weka PIN yako
+        0. Nyuma
+      retry: |-
+        CON Tafadhali weka PIN yako. Una majaribio %{remaining_attempts} yaliyobaki.
+        0. Nyuma
     account_balances: |-
       CON Salio zako ni zifuatazo:
-        salio: %{operational_balance}
-        ushuru: %{tax}
-        tuzo: %{bonus}
-      0. Back
+        salio: %{operational_balance} %{token_symbol}
+        ushuru: %{tax} %{token_symbol}
+        tuzo: %{bonus} %{token_symbol}
+      0. Nyuma
     first_transaction_set: |-
       CON %{first_transaction_set}
       1. Mbele

apps/contract-migration/docker/Dockerfile

@@ -51,19 +51,13 @@ ENV PATH      $NVM_DIR/versions/node//v$NODE_VERSION/bin:$PATH
 # WORKDIR /home/grassroots
 # USER grassroots
 
+COPY contract-migration/requirements.txt . 
+
 ARG pip_extra_args=""
 ARG pip_index_url=https://pypi.org/simple
 ARG pip_extra_index_url=https://pip.grassrootseconomics.net:8433
-ARG cic_base_version=0.1.2b11
-ARG cic_eth_version=0.11.0b14
-ARG sarafu_token_version=0.0.1a8
-ARG sarafu_faucet_version=0.0.3a3
-RUN pip install --index-url https://pypi.org/simple --extra-index-url $pip_extra_index_url \
-	cic-base[full_graph]==$cic_base_version \
-	cic-eth==$cic_eth_version \
-	sarafu-faucet==$sarafu_faucet_version \
-	sarafu-token==$sarafu_token_version \
-	cic-eth==$cic_eth_version 
+RUN pip install --index-url https://pypi.org/simple \
+    --extra-index-url $pip_extra_index_url -r requirements.txt
 
 # -------------- begin runtime container ---------------- 
 FROM python:3.8.6-slim-buster as runtime-image

apps/contract-migration/requirements.txt

@@ -0,0 +1,4 @@
+	cic-base[full_graph]==0.1.2b15
+	sarafu-faucet==0.0.3a3
+	sarafu-token==0.0.1a8
+	cic-eth==0.11.0b16 

apps/contract-migration/reset.sh

@@ -76,6 +76,7 @@ if [[ -n "${ETH_PROVIDER}" ]]; then
 	>&2 echo "add deployer address as account index writer"
 	eth-accounts-index-writer $gas_price_arg -y $DEV_ETH_KEYSTORE_FILE -i $CIC_CHAIN_SPEC -p $ETH_PROVIDER -a $DEV_ACCOUNT_INDEX_ADDRESS -ww -vv $debug $DEV_ETH_ACCOUNT_CONTRACT_DEPLOYER
 
+	>&2 echo "deploy contract registry contract"
 	CIC_REGISTRY_ADDRESS=`eth-contract-registry-deploy $gas_price_arg -i $CIC_CHAIN_SPEC -y $DEV_ETH_KEYSTORE_FILE --identifier BancorRegistry --identifier AccountRegistry --identifier TokenRegistry --identifier AddressDeclarator --identifier Faucet --identifier TransferAuthorization -p $ETH_PROVIDER -vv -w`
 	eth-contract-registry-set $gas_price_arg -w -y $DEV_ETH_KEYSTORE_FILE -r $CIC_REGISTRY_ADDRESS -i $CIC_CHAIN_SPEC  -p $ETH_PROVIDER -vv ContractRegistry $CIC_REGISTRY_ADDRESS
 	eth-contract-registry-set $gas_price_arg -w -y $DEV_ETH_KEYSTORE_FILE -r $CIC_REGISTRY_ADDRESS -i $CIC_CHAIN_SPEC -p $ETH_PROVIDER -vv AccountRegistry $DEV_ACCOUNT_INDEX_ADDRESS
@@ -87,7 +88,7 @@ if [[ -n "${ETH_PROVIDER}" ]]; then
 	eth-contract-registry-set $gas_price_arg -w -y $DEV_ETH_KEYSTORE_FILE -r $CIC_REGISTRY_ADDRESS -i $CIC_CHAIN_SPEC -p $ETH_PROVIDER -vv AddressDeclarator $DEV_DECLARATOR_ADDRESS
 
 	# Deploy transfer authorization contact
-	>&2 echo "deploy address declarator contract"
+	>&2 echo "deploy transfer auth contract"
 	DEV_TRANSFER_AUTHORIZATION_ADDRESS=`erc20-transfer-auth-deploy $gas_price_arg -y $DEV_ETH_KEYSTORE_FILE -i $CIC_CHAIN_SPEC -p $ETH_PROVIDER -w -vv`
 	eth-contract-registry-set $gas_price_arg -w -y $DEV_ETH_KEYSTORE_FILE -r $CIC_REGISTRY_ADDRESS -i $CIC_CHAIN_SPEC  -p $ETH_PROVIDER -vv TransferAuthorization $DEV_TRANSFER_AUTHORIZATION_ADDRESS
 

apps/contract-migration/seed_cic_eth.sh

@@ -47,7 +47,7 @@ EOF
 
 >&2 echo "create account for gas gifter"
 old_gas_provider=$DEV_ETH_ACCOUNT_GAS_PROVIDER
-DEV_ETH_ACCOUNT_GAS_GIFTER=`cic-eth-create $debug --redis-host-callback=$REDIS_HOST --redis-port-callback=$REDIS_PORT --no-register`
+DEV_ETH_ACCOUNT_GAS_GIFTER=`cic-eth-create --timeout 120 $debug --redis-host-callback=$REDIS_HOST --redis-port-callback=$REDIS_PORT --no-register`
 echo DEV_ETH_ACCOUNT_GAS_GIFTER=$DEV_ETH_ACCOUNT_GAS_GIFTER >> $env_out_file
 cic-eth-tag -i $CIC_CHAIN_SPEC GAS_GIFTER $DEV_ETH_ACCOUNT_GAS_GIFTER
 

apps/data-seeding/README.md

@@ -136,7 +136,7 @@ First, make a note of the **block height** before running anything:
 
 To import, run to _completion_:
 
-`python eth/import_users.py -v -c config -p <eth_provider> -r <cic_registry_address> -y ../keystore/UTC--2021-01-08T17-18-44.521011372Z--eb3907ecad74a0013c259d5874ae7f22dcbcc95c <datadir>`
+`python eth/import_users.py -v -c config -p <eth_provider> -r <cic_registry_address> -y ../contract-migration/keystore/UTC--2021-01-08T17-18-44.521011372Z--eb3907ecad74a0013c259d5874ae7f22dcbcc95c <datadir>`
 
 After the script completes, keystore files for all generated accouts will be found in `<datadir>/keystore`, all with `foo` as password (would set it empty, but believe it or not some interfaces out there won't work unless you have one).
 
@@ -150,7 +150,7 @@ Then run:
 
 Run in sequence, in first terminal:
 
-`python cic_eth/import_balance.py -v -c config -p <eth_provider> -r <cic_registry_address> --token-symbol <token_symbol> -y ../keystore/UTC--2021-01-08T17-18-44.521011372Z--eb3907ecad74a0013c259d5874ae7f22dcbcc95c --head out`
+`python cic_eth/import_balance.py -v -c config -p <eth_provider> -r <cic_registry_address> --token-symbol <token_symbol> -y ../contract-migration/keystore/UTC--2021-01-08T17-18-44.521011372Z--eb3907ecad74a0013c259d5874ae7f22dcbcc95c --head out`
 
 In another terminal:
 
@@ -226,7 +226,7 @@ The connection parameters for the `cic-ussd-server` is currently _hardcoded_ in
 
 ### Step 5 - Verify
 
-`python verify.py -v -c config -r <cic_registry_address> -p <eth_provider> <datadir>` 
+`python verify.py -v -c config -r <cic_registry_address> -p <eth_provider> --token-symbol <token_symbol> <datadir>` 
 
 Included checks:
 * Private key is in cic-eth keystore
@@ -259,4 +259,8 @@ Should exit with code 0 if all input data is found in the respective services.
 
 - Running the balance script should be _optional_ in all cases, but is currently required in the case of `cic_ussd` because it is needed to generate the metadata. An improvement would be moving the task to `import_users.py`, for a different queue than the balance tx handler.
 
+- MacOS BigSur issue when installing psycopg2: ld: library not found for -lssl -> https://github.com/psycopg/psycopg2/issues/1115#issuecomment-831498953
+
 - `cic_ussd` imports is poorly implemented, and consumes a lot of resources. Therefore it takes a long time to complete. Reducing the amount of polls for the phone pointer would go a long way to improve it.
+
+- A strict constraint is maintained insistin the use of postgresql-12.

apps/data-seeding/cic_eth/import_balance.py

@@ -76,6 +76,7 @@ args_override = {
         'CIC_CHAIN_SPEC': getattr(args, 'i'),
         'ETH_PROVIDER': getattr(args, 'p'),
         'CIC_REGISTRY_ADDRESS': getattr(args, 'r'),
+        'KEYSTORE_FILE_PATH': getattr(args, 'key-file')
         }
 config.dict_override(args_override, 'cli flag')
 config.censor('PASSWORD', 'DATABASE')

apps/data-seeding/cic_eth/import_users.py

@@ -194,8 +194,7 @@ if __name__ == '__main__':
             f.write(json.dumps(o))
             f.close()
 
-            #fi.write('{},{}\n'.format(new_address, old_address))
-            meta_key = generate_metadata_pointer(bytes.fromhex(new_address_clean), 'cic.person')
+            meta_key = generate_metadata_pointer(bytes.fromhex(new_address_clean), ':cic.person')
             meta_filepath = os.path.join(meta_dir, '{}.json'.format(new_address_clean.upper()))
             os.symlink(os.path.realpath(filepath), meta_filepath)
 
@@ -221,7 +220,7 @@ if __name__ == '__main__':
 
 
             # custom data
-            custom_key = generate_metadata_pointer(phone.encode('utf-8'), ':cic.custom')
+            custom_key = generate_metadata_pointer(bytes.fromhex(new_address_clean), ':cic.custom')
             custom_filepath = os.path.join(custom_dir, 'meta', custom_key)
 
             filepath = os.path.join(

apps/data-seeding/cic_meta/import_meta_preferences.js

@@ -0,0 +1,133 @@
+const fs = require('fs');
+const path = require('path');
+const http = require('http');
+
+const cic = require('@cicnet/cic-client-meta');
+const crdt = require('@cicnet/crdt-meta');
+
+//const conf = JSON.parse(fs.readFileSync('./cic.conf'));
+
+const config = new crdt.Config('./config');
+config.process();
+console.log(config);
+
+
+function sendit(uid, envelope) {
+	const d = envelope.toJSON();
+
+	const contentLength = (new TextEncoder().encode(d)).length;
+	const opts = {
+		method: 'PUT',
+		headers: {
+			'Content-Type': 'application/json',
+			'Content-Length': contentLength,
+			'X-CIC-AUTOMERGE': 'client',
+
+		},
+	};
+	let url = config.get('META_URL');
+	url = url.replace(new RegExp('^(.+://[^/]+)/*$'), '$1/');
+	console.log('posting to url: ' + url + uid);
+	const req = http.request(url + uid, opts, (res) => {
+		res.on('data', process.stdout.write);
+		res.on('end', () => {
+			console.log('result', res.statusCode, res.headers);
+		});
+	});
+	if (!req.write(d)) {
+		console.error('foo', d);
+		process.exit(1);
+	}
+	req.end();
+}
+
+function doOne(keystore, filePath, identifier) {
+	const signer = new crdt.PGPSigner(keystore);
+
+	const o = JSON.parse(fs.readFileSync(filePath).toString());
+
+	cic.Custom.toKey(identifier).then((uid) => {
+		const s = new crdt.Syncable(uid, o);
+		s.setSigner(signer);
+		s.onwrap = (env) => {
+			sendit(identifier, env);
+		};
+		s.sign();
+	});
+}
+
+const privateKeyPath = path.join(config.get('PGP_EXPORTS_DIR'), config.get('PGP_PRIVATE_KEY_FILE'));
+const publicKeyPath = path.join(config.get('PGP_EXPORTS_DIR'), config.get('PGP_PRIVATE_KEY_FILE'));
+pk = fs.readFileSync(privateKeyPath);
+pubk = fs.readFileSync(publicKeyPath);
+
+new crdt.PGPKeyStore(
+	config.get('PGP_PASSPHRASE'),
+	pk,
+	pubk,
+	undefined,
+	undefined,
+	importMetaCustom,
+);
+
+const batchSize = 16;
+const batchDelay = 1000;
+const total = parseInt(process.argv[3]);
+const dataDir = process.argv[2];
+const workDir = path.join(dataDir, 'preferences/meta');
+const userDir = path.join(dataDir, 'preferences/new');
+let count = 0;
+let batchCount = 0;
+
+
+function importMetaCustom(keystore) {
+	let err;
+	let files;
+
+	try {
+		err, files = fs.readdirSync(workDir);
+	} catch {
+		console.error('source directory not yet ready', workDir);
+		setTimeout(importMetaCustom, batchDelay, keystore);
+		return;
+	}
+	let limit = batchSize;
+	if (files.length < limit) {
+		limit = files.length;
+	}
+	for (let i = 0; i < limit; i++) {
+		const file = files[i];
+		if (file.length < 3) {
+			console.debug('skipping file', file);
+			continue;
+		}
+		//const identifier = file.substr(0,file.length-5);
+		const identifier = file;
+		const filePath = path.join(workDir, file);
+		console.log(filePath);
+
+		//const address = fs.readFileSync(filePath).toString().substring(2).toUpperCase();
+		const custom = JSON.parse(fs.readFileSync(filePath).toString());
+		const customFilePath = path.join(
+			userDir,
+			identifier.substring(0, 2),
+			identifier.substring(2, 4),
+			identifier + '.json',
+		);
+
+		doOne(keystore, filePath, identifier);
+		fs.unlinkSync(filePath);
+		count++;
+		batchCount++;
+		if (batchCount == batchSize) {
+			console.debug('reached batch size, breathing');
+			batchCount=0;
+			setTimeout(importMetaCustom, batchDelay, keystore);
+			return;
+		}
+	}
+	if (count == total) {
+		return;
+	}
+	setTimeout(importMetaCustom, 100, keystore);
+}

apps/data-seeding/cic_ussd/import_balance.py

@@ -70,6 +70,7 @@ args_override = {
         'REDIS_DB': getattr(args, 'redis_db'),
         'META_HOST': getattr(args, 'meta_host'),
         'META_PORT': getattr(args, 'meta_port'),
+        'KEYSTORE_FILE_PATH': getattr(args, 'key-file')
         }
 config.dict_override(args_override, 'cli flag')
 config.censor('PASSWORD', 'DATABASE')
@@ -114,7 +115,7 @@ def main():
     conn = EthHTTPConnection(config.get('ETH_PROVIDER'))
    
     ImportTask.balance_processor = BalanceProcessor(conn, chain_spec, config.get('CIC_REGISTRY_ADDRESS'), signer_address, signer)
-    ImportTask.balance_processor.init()
+    ImportTask.balance_processor.init(token_symbol)
 
     # TODO get decimals from token
     balances = {}
@@ -139,6 +140,7 @@ def main():
 
     ImportTask.balances = balances
     ImportTask.count = i
+    ImportTask.import_dir = user_dir
 
     s = celery.signature(
             'import_task.send_txs',

apps/data-seeding/cic_ussd/import_pins.py

@@ -39,6 +39,7 @@ elif args.vv:
 config_dir = args.c
 config = confini.Config(config_dir, os.environ.get('CONFINI_ENV_PREFIX'))
 config.process()
+logg.debug('config loaded from {}:\n{}'.format(args.c, config))
 
 celery_app = celery.Celery(broker=config.get('CELERY_BROKER_URL'), backend=config.get('CELERY_RESULT_URL'))
 
@@ -62,9 +63,6 @@ def main():
     )
     s_import_pins.apply_async()
 
-    argv = ['worker', '-Q', 'cic-import-ussd', '--loglevel=DEBUG']
-    celery_app.worker_main(argv)
-
 
 if __name__ == '__main__':
     main()

apps/data-seeding/cic_ussd/import_task.py

@@ -1,6 +1,7 @@
 # standard imports
 import os
 import logging
+import random
 import urllib.parse
 import urllib.error
 import urllib.request
@@ -136,6 +137,42 @@ def generate_metadata(self, address, phone):
             )
     os.symlink(os.path.realpath(filepath), meta_filepath)
 
+    # write ussd data
+    ussd_data = {
+        'phone': phone,
+        'is_activated': 1,
+        'preferred_language': random.sample(['en', 'sw'], 1)[0],
+        'is_disabled': False
+    }
+    ussd_data_dir = os.path.join(self.import_dir, 'ussd')
+    ussd_data_file_path = os.path.join(ussd_data_dir, f'{old_address}.json')
+    f = open(ussd_data_file_path, 'w')
+    f.write(json.dumps(ussd_data))
+    f.close()
+
+    # write preferences data
+    preferences_dir = os.path.join(self.import_dir, 'preferences')
+    preferences_data = {
+        'preferred_language': ussd_data['preferred_language']
+    }
+
+    preferences_key = generate_metadata_pointer(bytes.fromhex(new_address_clean[2:]), ':cic.preferences')
+    preferences_filepath = os.path.join(preferences_dir, 'meta', preferences_key)
+
+    filepath = os.path.join(
+        preferences_dir,
+        'new',
+        preferences_key[:2].upper(),
+        preferences_key[2:4].upper(),
+        preferences_key.upper() + '.json'
+    )
+    os.makedirs(os.path.dirname(filepath), exist_ok=True)
+
+    f = open(filepath, 'w')
+    f.write(json.dumps(preferences_data))
+    f.close()
+    os.symlink(os.path.realpath(filepath), preferences_filepath)
+
     logg.debug('found metadata {} for phone {}'.format(o, phone))
 
     return address

apps/data-seeding/cic_ussd/import_users.py

@@ -1,29 +1,21 @@
 # standard imports
-import os
-import sys
+import argparse
 import json
 import logging
-import argparse
-import uuid
-import datetime
+import os
+import sys
 import time
 import urllib.request
-from glob import glob
+import uuid
+from urllib.parse import urlencode
 
-# third-party imports
-import redis
-import confini
+# external imports
 import celery
-from hexathon import (
-        add_0x,
-        strip_0x,
-        )
-from chainlib.eth.address import to_checksum
-from cic_types.models.person import Person
-from cic_eth.api.api_task import Api
-from chainlib.chain import ChainSpec
-from cic_types.processor import generate_metadata_pointer
+import confini
 import phonenumbers
+import redis
+from chainlib.chain import ChainSpec
+from cic_types.models.person import Person
 
 logging.basicConfig(level=logging.WARNING)
 logg = logging.getLogger()
@@ -72,6 +64,12 @@ ps = r.pubsub()
 user_new_dir = os.path.join(args.user_dir, 'new')
 os.makedirs(user_new_dir)
 
+ussd_data_dir = os.path.join(args.user_dir, 'ussd')
+os.makedirs(ussd_data_dir)
+
+preferences_dir = os.path.join(args.user_dir, 'preferences')
+os.makedirs(os.path.join(preferences_dir, 'meta'))
+
 meta_dir = os.path.join(args.user_dir, 'meta')
 os.makedirs(meta_dir)
 
@@ -87,21 +85,13 @@ chain_str = str(chain_spec)
 batch_size = args.batch_size
 batch_delay = args.batch_delay
 
-db_configs = {
-    'database': config.get('DATABASE_NAME'),
-    'host': config.get('DATABASE_HOST'),
-    'port': config.get('DATABASE_PORT'),
-    'user': config.get('DATABASE_USER'),
-    'password': config.get('DATABASE_PASSWORD')
-}
-  
 
 def build_ussd_request(phone, host, port, service_code, username, password, ssl=False):
     url = 'http'
     if ssl:
         url += 's'
     url += '://{}:{}'.format(host, port)
-    url += '/?username={}&password={}'.format(username, password) #config.get('USSD_USER'), config.get('USSD_PASS'))
+    url += '/?username={}&password={}'.format(username, password)
 
     logg.info('ussd service url {}'.format(url))
     logg.info('ussd phone {}'.format(phone))
@@ -114,9 +104,10 @@ def build_ussd_request(phone, host, port, service_code, username, password, ssl=
             'text': service_code,
         }
     req = urllib.request.Request(url)
-    data_str = json.dumps(data)
+    req.method=('POST')
+    data_str = urlencode(data)
     data_bytes = data_str.encode('utf-8')
-    req.add_header('Content-Type', 'application/json')
+    req.add_header('Content-Type', 'application/x-www-form-urlencoded')
     req.data = data_bytes
 
     return req
@@ -126,7 +117,13 @@ def register_ussd(i, u):
     phone_object = phonenumbers.parse(u.tel)
     phone = phonenumbers.format_number(phone_object, phonenumbers.PhoneNumberFormat.E164)
     logg.debug('tel {} {}'.format(u.tel, phone))
-    req = build_ussd_request(phone, 'localhost', 63315, '*483*46#', '', '') 
+    req = build_ussd_request(
+        phone,
+        'localhost',
+        config.get('CIC_USER_USSD_SVC_SERVICE_PORT'),
+        config.get('APP_SERVICE_CODE'),
+        '',
+        '')
     response = urllib.request.urlopen(req)
     response_data = response.read().decode('utf-8')
     state = response_data[:3]
@@ -143,59 +140,57 @@ if __name__ == '__main__':
             if y[len(y)-5:] != '.json':
                 continue
             # handle json containing person object
-            filepath = None
-            if y[:15] != '_ussd_data.json':
-                filepath = os.path.join(x[0], y)
-                f = open(filepath, 'r')
-                try:
-                    o = json.load(f)
-                except json.decoder.JSONDecodeError as e:
-                    f.close()
-                    logg.error('load error for {}: {}'.format(y, e))
-                    continue
+            filepath = os.path.join(x[0], y)
+            f = open(filepath, 'r')
+            try:
+                o = json.load(f)
+            except json.decoder.JSONDecodeError as e:
                 f.close()
-                u = Person.deserialize(o)
+                logg.error('load error for {}: {}'.format(y, e))
+                continue
+            f.close()
+            u = Person.deserialize(o)
 
-                new_address = register_ussd(i, u)
+            new_address = register_ussd(i, u)
 
-                phone_object = phonenumbers.parse(u.tel)
-                phone = phonenumbers.format_number(phone_object, phonenumbers.PhoneNumberFormat.E164)
+            phone_object = phonenumbers.parse(u.tel)
+            phone = phonenumbers.format_number(phone_object, phonenumbers.PhoneNumberFormat.E164)
 
-                s_phone = celery.signature(
-                        'import_task.resolve_phone',
-                        [
-                            phone,
-                            ],
-                        queue='cic-import-ussd',
-                        )
+            s_phone = celery.signature(
+                    'import_task.resolve_phone',
+                    [
+                        phone,
+                        ],
+                    queue='cic-import-ussd',
+                    )
 
-                s_meta = celery.signature(
-                        'import_task.generate_metadata',
-                        [
-                            phone,
-                            ],
-                        queue='cic-import-ussd',
-                        )
+            s_meta = celery.signature(
+                    'import_task.generate_metadata',
+                    [
+                        phone,
+                        ],
+                    queue='cic-import-ussd',
+                    )
 
-                s_balance = celery.signature(
-                        'import_task.opening_balance_tx',
-                        [
-                            phone,
-                            i,
-                            ],
-                        queue='cic-import-ussd',
-                        )
+            s_balance = celery.signature(
+                    'import_task.opening_balance_tx',
+                    [
+                        phone,
+                        i,
+                        ],
+                    queue='cic-import-ussd',
+                    )
 
-                s_meta.link(s_balance)
-                s_phone.link(s_meta)
-                # block time plus a bit of time for ussd processing
-                s_phone.apply_async(countdown=7)
+            s_meta.link(s_balance)
+            s_phone.link(s_meta)
+            # block time plus a bit of time for ussd processing
+            s_phone.apply_async(countdown=7)
 
-                i += 1
-                sys.stdout.write('imported {} {}'.format(i, u).ljust(200) + "\r")
+            i += 1
+            sys.stdout.write('imported {} {}'.format(i, u).ljust(200) + "\r")
 
-                j += 1
-                if j == batch_size:
-                    time.sleep(batch_delay)
-                    j = 0
+            j += 1
+            if j == batch_size:
+                time.sleep(batch_delay)
+                j = 0
 

apps/data-seeding/cic_ussd/import_ussd_data.py

@@ -31,9 +31,9 @@ elif args.vv:
 config_dir = args.c
 config = Config(config_dir, os.environ.get('CONFINI_ENV_PREFIX'))
 config.process()
+logg.debug('config loaded from {}:\n{}'.format(args.c, config))
 
-user_old_dir = os.path.join(args.user_dir, 'old')
-os.stat(user_old_dir)
+ussd_data_dir = os.path.join(args.user_dir, 'ussd')
 
 db_configs = {
     'database': config.get('DATABASE_NAME'),
@@ -45,18 +45,15 @@ db_configs = {
 celery_app = celery.Celery(broker=config.get('CELERY_BROKER_URL'), backend=config.get('CELERY_RESULT_URL'))
 
 if __name__ == '__main__':
-    for x in os.walk(user_old_dir):
+    for x in os.walk(ussd_data_dir):
         for y in x[2]:
 
-            if y[len(y) - 5:] != '.json':
-                continue
-
-            # handle ussd_data json object
-            if y[:15] == '_ussd_data.json':
+            if y[len(y) - 5:] == '.json':
                 filepath = os.path.join(x[0], y)
                 f = open(filepath, 'r')
                 try:
                     ussd_data = json.load(f)
+                    logg.debug(f'LOADING USSD DATA: {ussd_data}')
                 except json.decoder.JSONDecodeError as e:
                     f.close()
                     logg.error('load error for {}: {}'.format(y, e))

apps/data-seeding/cic_ussd/import_util.py

@@ -6,7 +6,7 @@ from eth_contract_registry import Registry
 from eth_token_index import TokenUniqueSymbolIndex
 from chainlib.eth.gas import OverrideGasOracle
 from chainlib.eth.nonce import OverrideNonceOracle
-from chainlib.eth.erc20 import ERC20
+from eth_erc20 import ERC20
 from chainlib.eth.tx import (
         count,
         TxFormat,
@@ -37,7 +37,7 @@ class BalanceProcessor:
         self.value_multiplier = 1
     
 
-    def init(self):
+    def init(self, token_symbol):
         # Get Token registry address
         registry = Registry(self.chain_spec)
         o = registry.address_of(self.registry_address, 'TokenRegistry')
@@ -46,10 +46,10 @@ class BalanceProcessor:
         logg.info('found token index address {}'.format(self.token_index_address))
 
         token_registry = TokenUniqueSymbolIndex(self.chain_spec)
-        o = token_registry.address_of(self.token_index_address, 'SRF')
+        o = token_registry.address_of(self.token_index_address, token_symbol)
         r = self.conn.do(o)
         self.token_address = token_registry.parse_address_of(r)
-        logg.info('found SRF token address {}'.format(self.token_address))
+        logg.info('found {} token address {}'.format(token_symbol, self.token_address))
 
         tx_factory = ERC20(self.chain_spec)
         o = tx_factory.decimals(self.token_address)

apps/data-seeding/config/app.ini

@@ -22,3 +22,6 @@ TRANSITIONS=/usr/src/cic-ussd/transitions/
 host =
 port =
 ssl =
+
+[keystore]
+file_path = keystore/UTC--2021-01-08T17-18-44.521011372Z--eb3907ecad74a0013c259d5874ae7f22dcbcc95c

apps/data-seeding/config/cic.ini

@@ -7,3 +7,4 @@ approval_escrow_address =
 chain_spec = evm:bloxberg:8996
 tx_retry_delay = 
 trust_address = 0xEb3907eCad74a0013c259D5874AE7f22DcBcC95C
+user_ussd_svc_service_port=