Compare commits
43 Commits
lash/funga
...
lash/token
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cd477ff587 | ||
| b15cfee1c9 | |||
| efb1967f46 | |||
| 019824d1f4 | |||
| d4c7fd3d7e | |||
| 4b87a40cc2 | |||
| 9f9d557c73 | |||
| 9814da78b8 | |||
| cd102807a6 | |||
| c3c43c28a5 | |||
| e132e534d3 | |||
| e426f7b451 | |||
| b368b022c1 | |||
| bd266ac8dd | |||
| 69dbbcb6a9 | |||
| dd709d7d47 | |||
| a9c84bb2b1 | |||
|
|
85aa1f3066 | ||
| 28936a58fe | |||
| 4b8096ff49 | |||
| c9eb3e32da | |||
| 1be5a92f44 | |||
|
8a86428d4f
|
|||
|
|
8600e282b3
|
||
|
|
a42efb2529
|
||
|
|
8855ccd3d2 | ||
|
|
09dfdbb38a | ||
| 1abb642361 | |||
| 93bcbd7d51 | |||
|
|
818899670a | ||
|
|
1882910a8e | ||
| 3cc909c936 | |||
| 60b6e1abdb | |||
|
|
9c7e72f71c | ||
|
|
e3acc1757a | ||
|
|
8250b15d32 | ||
|
|
31d7cf5789 | ||
|
|
2544c159c2 | ||
|
|
7691d9a127 | ||
|
|
a2a3634683 | ||
|
|
fe0835a4e7 | ||
| d8f51c5bdd | |||
|
|
13fb67d2d8 |
@@ -10,6 +10,7 @@ include:
|
|||||||
#- local: 'apps/data-seeding/.gitlab-ci.yml'
|
#- local: 'apps/data-seeding/.gitlab-ci.yml'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
|
- version
|
||||||
- build
|
- build
|
||||||
- test
|
- test
|
||||||
- deploy
|
- deploy
|
||||||
@@ -20,9 +21,41 @@ variables:
|
|||||||
DOCKER_BUILDKIT: "1"
|
DOCKER_BUILDKIT: "1"
|
||||||
COMPOSE_DOCKER_CLI_BUILD: "1"
|
COMPOSE_DOCKER_CLI_BUILD: "1"
|
||||||
CI_DEBUG_TRACE: "true"
|
CI_DEBUG_TRACE: "true"
|
||||||
|
SEMVERBOT_VERSION: "0.2.0"
|
||||||
|
|
||||||
before_script:
|
#before_script:
|
||||||
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
|
# - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
|
||||||
|
|
||||||
|
version:
|
||||||
|
#image: python:3.7-stretch
|
||||||
|
image: registry.gitlab.com/grassrootseconomics/cic-base-images/ci-version:b01318ae
|
||||||
|
stage: version
|
||||||
|
tags:
|
||||||
|
- integration
|
||||||
|
script:
|
||||||
|
- mkdir -p ~/.ssh && chmod 700 ~/.ssh
|
||||||
|
- ssh-keyscan gitlab.com >> ~/.ssh/known_hosts && chmod 644 ~/.ssh/known_hosts
|
||||||
|
- eval $(ssh-agent -s)
|
||||||
|
- ssh-add <(echo "$SSH_PRIVATE_KEY")
|
||||||
|
- git remote set-url origin git@gitlab.com:grassrootseconomics/cic-internal-integration.git
|
||||||
|
- export TAG=$(sbot predict version -m auto)
|
||||||
|
- |
|
||||||
|
if [[ -z $TAG ]]
|
||||||
|
then
|
||||||
|
echo "tag could not be set $@"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
- echo $TAG > version
|
||||||
|
- git tag -a v$TAG -m "ci tagged"
|
||||||
|
- git push origin v$TAG
|
||||||
|
artifacts:
|
||||||
|
paths:
|
||||||
|
- version
|
||||||
|
rules:
|
||||||
|
- if: $CI_COMMIT_REF_PROTECTED == "true"
|
||||||
|
when: always
|
||||||
|
- if: $CI_COMMIT_REF_NAME == "master"
|
||||||
|
when: always
|
||||||
|
|
||||||
# runs on protected branches and pushes to repo
|
# runs on protected branches and pushes to repo
|
||||||
build-push:
|
build-push:
|
||||||
@@ -30,12 +63,17 @@ build-push:
|
|||||||
tags:
|
tags:
|
||||||
- integration
|
- integration
|
||||||
#script:
|
#script:
|
||||||
# - TAG=$CI_COMMIT_REF_SLUG-$CI_COMMIT_SHORT_SHA sh ./scripts/build-push.sh
|
# - TAG=$CI_Cbefore_script:
|
||||||
|
before_script:
|
||||||
|
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
|
||||||
script:
|
script:
|
||||||
- TAG=latest sh ./scripts/build-push.sh
|
- TAG=latest ./scripts/build-push.sh
|
||||||
|
- TAG=$(cat ./version) ./scripts/build-push.sh
|
||||||
rules:
|
rules:
|
||||||
- if: $CI_COMMIT_REF_PROTECTED == "true"
|
- if: $CI_COMMIT_REF_PROTECTED == "true"
|
||||||
when: always
|
when: always
|
||||||
|
- if: $CI_COMMIT_REF_NAME == "master"
|
||||||
|
when: always
|
||||||
|
|
||||||
deploy-dev:
|
deploy-dev:
|
||||||
stage: deploy
|
stage: deploy
|
||||||
|
|||||||
44
.gitlab/issue_templates/bug.md
Normal file
44
.gitlab/issue_templates/bug.md
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
<!---
|
||||||
|
Please read this!
|
||||||
|
|
||||||
|
Before opening a new issue, make sure to search for keywords in the issues
|
||||||
|
filtered by the "bug" label:
|
||||||
|
|
||||||
|
- https://gitlab.com/groups/grassrootseconomics/-/issues?scope=all&state=all&label_name[]=bug
|
||||||
|
|
||||||
|
and verify the issue you're about to submit isn't a duplicate.
|
||||||
|
--->
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
|
||||||
|
<!-- Summarize the bug encountered concisely. -->
|
||||||
|
|
||||||
|
### Steps to reproduce
|
||||||
|
|
||||||
|
<!-- Describe how one can reproduce the issue - this is very important. Please use an ordered list. -->
|
||||||
|
|
||||||
|
### Example Project
|
||||||
|
|
||||||
|
<!-- If possible, please create an example project here on GitLab.com that exhibits the problematic
|
||||||
|
behavior, and link to it here in the bug report. If you are using an older version of GitLab, this
|
||||||
|
will also determine whether the bug is fixed in a more recent version. -->
|
||||||
|
|
||||||
|
### What is the current *bug* behavior?
|
||||||
|
|
||||||
|
<!-- Describe what actually happens. -->
|
||||||
|
|
||||||
|
### What is the expected *correct* behavior?
|
||||||
|
|
||||||
|
<!-- Describe what you should see instead. -->
|
||||||
|
|
||||||
|
### Relevant logs and/or screenshots
|
||||||
|
|
||||||
|
<!-- Paste any relevant logs - please use code blocks (```) to format console output, logs, and code
|
||||||
|
as it's tough to read otherwise. -->
|
||||||
|
|
||||||
|
|
||||||
|
### Possible fixes
|
||||||
|
|
||||||
|
<!-- If you can, link to the line of code that might be responsible for the problem. -->
|
||||||
|
|
||||||
|
/label ~"bug"
|
||||||
16
.semverbot.toml
Normal file
16
.semverbot.toml
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
[git]
|
||||||
|
|
||||||
|
[git.config]
|
||||||
|
email = "semverbot@grassroots.org"
|
||||||
|
name = "semvervot"
|
||||||
|
|
||||||
|
[git.tags]
|
||||||
|
prefix = "v"
|
||||||
|
|
||||||
|
[semver]
|
||||||
|
mode = "git-commit"
|
||||||
|
|
||||||
|
[semver.detection]
|
||||||
|
patch = ["fix", "[fix]", "patch", "[patch]"]
|
||||||
|
minor = ["minor", "[minor]", "feat", "[feat]", "release", "[release]", "bump", "[bump]"]
|
||||||
|
major = ["BREAKING CHANGE"]
|
||||||
83
CODE_OF_CONDUCT.md
Normal file
83
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
In the interest of fostering an open and welcoming environment, we as
|
||||||
|
contributors and maintainers pledge to make participation in our project and
|
||||||
|
our community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
||||||
|
level of experience, education, socio-economic status, nationality, personal
|
||||||
|
appearance, race, religion, or sexual identity and orientation.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to creating a positive environment
|
||||||
|
include:
|
||||||
|
|
||||||
|
* Using welcoming and inclusive language
|
||||||
|
* Being respectful of differing viewpoints and experiences
|
||||||
|
* Gracefully accepting constructive criticism
|
||||||
|
* Focusing on what is best for the community
|
||||||
|
* Showing empathy towards other community members
|
||||||
|
|
||||||
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||||
|
advances
|
||||||
|
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or electronic
|
||||||
|
address, without explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
Project maintainers are responsible for clarifying the standards of acceptable
|
||||||
|
behavior and are expected to take appropriate and fair corrective action in
|
||||||
|
response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
|
Project maintainers have the right and responsibility to remove, edit, or
|
||||||
|
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||||
|
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||||
|
permanently any contributor for other behaviors that they deem inappropriate,
|
||||||
|
threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all project spaces, and it also applies when
|
||||||
|
an individual is representing the project or its community in public spaces.
|
||||||
|
Examples of representing a project or community include using an official
|
||||||
|
project e-mail address, posting via an official social media account, or acting
|
||||||
|
as an appointed representative at an online or offline event. Representation of
|
||||||
|
a project may be further defined and clarified by project maintainers.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
|
||||||
|
complaints will be reviewed and investigated and will result in a response that
|
||||||
|
is deemed necessary and appropriate to the circumstances. The project team is
|
||||||
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||||
|
Further details of specific enforcement policies may be posted separately.
|
||||||
|
|
||||||
|
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||||
|
faith may face temporary or permanent repercussions as determined by other
|
||||||
|
members of the project's leadership.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||||
|
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see
|
||||||
|
https://www.contributor-covenant.org/faq
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
...Try to keep in mind the immortal
|
||||||
|
words of Bill and Ted, "Be excellent to each other."
|
||||||
|
|
||||||
16
CONTRIBUTING.md
Normal file
16
CONTRIBUTING.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
Hello and welcome to the CIC Stack repository. Targeted for use with the ethereum virtual machine and a ussd capable telecom provider.
|
||||||
|
|
||||||
|
__To request a change to the code please fork this repository and sumbit a merge request.__
|
||||||
|
|
||||||
|
__If there is a Grassroots Economics Kanban Issue please include that in our MR it will help us track contributions. Karibu sana!__
|
||||||
|
|
||||||
|
__Visit the Development Kanban board here: https://gitlab.com/grassrootseconomics/cic-internal-integration/-/boards/2419764__
|
||||||
|
|
||||||
|
__Ask a question in our dev chat:__
|
||||||
|
|
||||||
|
[Mattermost](https://chat.grassrootseconomics.net/cic/channels/dev)
|
||||||
|
|
||||||
|
[Discord](https://discord.gg/XWunwAsX)
|
||||||
|
|
||||||
|
[Matrix, IRC soon?]
|
||||||
|
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
cic-internal-integration
|
||||||
|
Copyright (C) 2021 Grassroots Economics
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published
|
||||||
|
by the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
33
README.md
33
README.md
@@ -1,4 +1,6 @@
|
|||||||
# cic-internal-integration
|
# Community Inclusion Currency Stack (CIC Stack)
|
||||||
|
|
||||||
|
A custodial evm wallet for executing transactions via USSD
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
@@ -9,32 +11,9 @@ export COMPOSE_DOCKER_CLI_BUILD=1
|
|||||||
export DOCKER_BUILDKIT=1
|
export DOCKER_BUILDKIT=1
|
||||||
```
|
```
|
||||||
|
|
||||||
start services, database, redis and local ethereum node
|
To get started see [./apps/contract-migration/README.md](./apps/contract-migration/README.md)
|
||||||
```
|
|
||||||
docker-compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
Run app/contract-migration to deploy contracts
|
## Documentation
|
||||||
```
|
|
||||||
RUN_MASK=3 docker-compose up contract-migration
|
|
||||||
```
|
|
||||||
|
|
||||||
stop cluster
|
[https://docs.grassecon.org/cic_stack/](https://docs.grassecon.org/cic_stack/)
|
||||||
```
|
|
||||||
docker-compose down
|
|
||||||
```
|
|
||||||
|
|
||||||
stop cluster and delete data
|
|
||||||
```
|
|
||||||
docker-compose down -v --remove-orphans
|
|
||||||
```
|
|
||||||
|
|
||||||
rebuild an images
|
|
||||||
```
|
|
||||||
docker-compose up --build <service_name>
|
|
||||||
```
|
|
||||||
|
|
||||||
to delete the buildkit cache
|
|
||||||
```
|
|
||||||
docker builder prune --filter type=exec.cachemount
|
|
||||||
```
|
|
||||||
|
|||||||
3
apps/cic-base-os/aux/wait-for-it/.gitignore
vendored
Normal file
3
apps/cic-base-os/aux/wait-for-it/.gitignore
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
**/*.pyc
|
||||||
|
.pydevproject
|
||||||
|
/vendor/
|
||||||
7
apps/cic-base-os/aux/wait-for-it/.travis.yml
Normal file
7
apps/cic-base-os/aux/wait-for-it/.travis.yml
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
language: python
|
||||||
|
python:
|
||||||
|
- "2.7"
|
||||||
|
|
||||||
|
script:
|
||||||
|
- python test/wait-for-it.py
|
||||||
|
|
||||||
20
apps/cic-base-os/aux/wait-for-it/LICENSE
Normal file
20
apps/cic-base-os/aux/wait-for-it/LICENSE
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
Copyright (c) 2016 Giles Hall
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||||
|
of the Software, and to permit persons to whom the Software is furnished to do
|
||||||
|
so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
75
apps/cic-base-os/aux/wait-for-it/README.md
Normal file
75
apps/cic-base-os/aux/wait-for-it/README.md
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
# wait-for-it
|
||||||
|
|
||||||
|
`wait-for-it.sh` is a pure bash script that will wait on the availability of a
|
||||||
|
host and TCP port. It is useful for synchronizing the spin-up of
|
||||||
|
interdependent services, such as linked docker containers. Since it is a pure
|
||||||
|
bash script, it does not have any external dependencies.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```text
|
||||||
|
wait-for-it.sh host:port [-s] [-t timeout] [-- command args]
|
||||||
|
-h HOST | --host=HOST Host or IP under test
|
||||||
|
-p PORT | --port=PORT TCP port under test
|
||||||
|
Alternatively, you specify the host and port as host:port
|
||||||
|
-s | --strict Only execute subcommand if the test succeeds
|
||||||
|
-q | --quiet Don't output any status messages
|
||||||
|
-t TIMEOUT | --timeout=TIMEOUT
|
||||||
|
Timeout in seconds, zero for no timeout
|
||||||
|
-- COMMAND ARGS Execute command with args after the test finishes
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
For example, let's test to see if we can access port 80 on `www.google.com`,
|
||||||
|
and if it is available, echo the message `google is up`.
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ ./wait-for-it.sh www.google.com:80 -- echo "google is up"
|
||||||
|
wait-for-it.sh: waiting 15 seconds for www.google.com:80
|
||||||
|
wait-for-it.sh: www.google.com:80 is available after 0 seconds
|
||||||
|
google is up
|
||||||
|
```
|
||||||
|
|
||||||
|
You can set your own timeout with the `-t` or `--timeout=` option. Setting
|
||||||
|
the timeout value to 0 will disable the timeout:
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ ./wait-for-it.sh -t 0 www.google.com:80 -- echo "google is up"
|
||||||
|
wait-for-it.sh: waiting for www.google.com:80 without a timeout
|
||||||
|
wait-for-it.sh: www.google.com:80 is available after 0 seconds
|
||||||
|
google is up
|
||||||
|
```
|
||||||
|
|
||||||
|
The subcommand will be executed regardless if the service is up or not. If you
|
||||||
|
wish to execute the subcommand only if the service is up, add the `--strict`
|
||||||
|
argument. In this example, we will test port 81 on `www.google.com` which will
|
||||||
|
fail:
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ ./wait-for-it.sh www.google.com:81 --timeout=1 --strict -- echo "google is up"
|
||||||
|
wait-for-it.sh: waiting 1 seconds for www.google.com:81
|
||||||
|
wait-for-it.sh: timeout occurred after waiting 1 seconds for www.google.com:81
|
||||||
|
wait-for-it.sh: strict mode, refusing to execute subprocess
|
||||||
|
```
|
||||||
|
|
||||||
|
If you don't want to execute a subcommand, leave off the `--` argument. This
|
||||||
|
way, you can test the exit condition of `wait-for-it.sh` in your own scripts,
|
||||||
|
and determine how to proceed:
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ ./wait-for-it.sh www.google.com:80
|
||||||
|
wait-for-it.sh: waiting 15 seconds for www.google.com:80
|
||||||
|
wait-for-it.sh: www.google.com:80 is available after 0 seconds
|
||||||
|
$ echo $?
|
||||||
|
0
|
||||||
|
$ ./wait-for-it.sh www.google.com:81
|
||||||
|
wait-for-it.sh: waiting 15 seconds for www.google.com:81
|
||||||
|
wait-for-it.sh: timeout occurred after waiting 15 seconds for www.google.com:81
|
||||||
|
$ echo $?
|
||||||
|
124
|
||||||
|
```
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
*Debian*: There is a [Debian package](https://tracker.debian.org/pkg/wait-for-it).
|
||||||
182
apps/cic-base-os/aux/wait-for-it/wait-for-it.sh
Executable file
182
apps/cic-base-os/aux/wait-for-it/wait-for-it.sh
Executable file
@@ -0,0 +1,182 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Use this script to test if a given TCP host/port are available
|
||||||
|
|
||||||
|
WAITFORIT_cmdname=${0##*/}
|
||||||
|
|
||||||
|
echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
|
||||||
|
|
||||||
|
usage()
|
||||||
|
{
|
||||||
|
cat << USAGE >&2
|
||||||
|
Usage:
|
||||||
|
$WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
|
||||||
|
-h HOST | --host=HOST Host or IP under test
|
||||||
|
-p PORT | --port=PORT TCP port under test
|
||||||
|
Alternatively, you specify the host and port as host:port
|
||||||
|
-s | --strict Only execute subcommand if the test succeeds
|
||||||
|
-q | --quiet Don't output any status messages
|
||||||
|
-t TIMEOUT | --timeout=TIMEOUT
|
||||||
|
Timeout in seconds, zero for no timeout
|
||||||
|
-- COMMAND ARGS Execute command with args after the test finishes
|
||||||
|
USAGE
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
wait_for()
|
||||||
|
{
|
||||||
|
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
|
||||||
|
echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
|
||||||
|
else
|
||||||
|
echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
|
||||||
|
fi
|
||||||
|
WAITFORIT_start_ts=$(date +%s)
|
||||||
|
while :
|
||||||
|
do
|
||||||
|
if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
|
||||||
|
nc -z $WAITFORIT_HOST $WAITFORIT_PORT
|
||||||
|
WAITFORIT_result=$?
|
||||||
|
else
|
||||||
|
(echo -n > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
|
||||||
|
WAITFORIT_result=$?
|
||||||
|
fi
|
||||||
|
if [[ $WAITFORIT_result -eq 0 ]]; then
|
||||||
|
WAITFORIT_end_ts=$(date +%s)
|
||||||
|
echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
return $WAITFORIT_result
|
||||||
|
}
|
||||||
|
|
||||||
|
wait_for_wrapper()
|
||||||
|
{
|
||||||
|
# In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
|
||||||
|
if [[ $WAITFORIT_QUIET -eq 1 ]]; then
|
||||||
|
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
|
||||||
|
else
|
||||||
|
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
|
||||||
|
fi
|
||||||
|
WAITFORIT_PID=$!
|
||||||
|
trap "kill -INT -$WAITFORIT_PID" INT
|
||||||
|
wait $WAITFORIT_PID
|
||||||
|
WAITFORIT_RESULT=$?
|
||||||
|
if [[ $WAITFORIT_RESULT -ne 0 ]]; then
|
||||||
|
echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
|
||||||
|
fi
|
||||||
|
return $WAITFORIT_RESULT
|
||||||
|
}
|
||||||
|
|
||||||
|
# process arguments
|
||||||
|
while [[ $# -gt 0 ]]
|
||||||
|
do
|
||||||
|
case "$1" in
|
||||||
|
*:* )
|
||||||
|
WAITFORIT_hostport=(${1//:/ })
|
||||||
|
WAITFORIT_HOST=${WAITFORIT_hostport[0]}
|
||||||
|
WAITFORIT_PORT=${WAITFORIT_hostport[1]}
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
--child)
|
||||||
|
WAITFORIT_CHILD=1
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-q | --quiet)
|
||||||
|
WAITFORIT_QUIET=1
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-s | --strict)
|
||||||
|
WAITFORIT_STRICT=1
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-h)
|
||||||
|
WAITFORIT_HOST="$2"
|
||||||
|
if [[ $WAITFORIT_HOST == "" ]]; then break; fi
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--host=*)
|
||||||
|
WAITFORIT_HOST="${1#*=}"
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-p)
|
||||||
|
WAITFORIT_PORT="$2"
|
||||||
|
if [[ $WAITFORIT_PORT == "" ]]; then break; fi
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--port=*)
|
||||||
|
WAITFORIT_PORT="${1#*=}"
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-t)
|
||||||
|
WAITFORIT_TIMEOUT="$2"
|
||||||
|
if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--timeout=*)
|
||||||
|
WAITFORIT_TIMEOUT="${1#*=}"
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
--)
|
||||||
|
shift
|
||||||
|
WAITFORIT_CLI=("$@")
|
||||||
|
break
|
||||||
|
;;
|
||||||
|
--help)
|
||||||
|
usage
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echoerr "Unknown argument: $1"
|
||||||
|
usage
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
|
||||||
|
echoerr "Error: you need to provide a host and port to test."
|
||||||
|
usage
|
||||||
|
fi
|
||||||
|
|
||||||
|
WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
|
||||||
|
WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
|
||||||
|
WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
|
||||||
|
WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
|
||||||
|
|
||||||
|
# Check to see if timeout is from busybox?
|
||||||
|
WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
|
||||||
|
WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
|
||||||
|
|
||||||
|
WAITFORIT_BUSYTIMEFLAG=""
|
||||||
|
if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
|
||||||
|
WAITFORIT_ISBUSY=1
|
||||||
|
# Check if busybox timeout uses -t flag
|
||||||
|
# (recent Alpine versions don't support -t anymore)
|
||||||
|
if timeout &>/dev/stdout | grep -q -e '-t '; then
|
||||||
|
WAITFORIT_BUSYTIMEFLAG="-t"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
WAITFORIT_ISBUSY=0
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ $WAITFORIT_CHILD -gt 0 ]]; then
|
||||||
|
wait_for
|
||||||
|
WAITFORIT_RESULT=$?
|
||||||
|
exit $WAITFORIT_RESULT
|
||||||
|
else
|
||||||
|
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
|
||||||
|
wait_for_wrapper
|
||||||
|
WAITFORIT_RESULT=$?
|
||||||
|
else
|
||||||
|
wait_for
|
||||||
|
WAITFORIT_RESULT=$?
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ $WAITFORIT_CLI != "" ]]; then
|
||||||
|
if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
|
||||||
|
echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
|
||||||
|
exit $WAITFORIT_RESULT
|
||||||
|
fi
|
||||||
|
exec "${WAITFORIT_CLI[@]}"
|
||||||
|
else
|
||||||
|
exit $WAITFORIT_RESULT
|
||||||
|
fi
|
||||||
3
apps/cic-cache/aux/wait-for-it/.gitignore
vendored
Normal file
3
apps/cic-cache/aux/wait-for-it/.gitignore
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
**/*.pyc
|
||||||
|
.pydevproject
|
||||||
|
/vendor/
|
||||||
7
apps/cic-cache/aux/wait-for-it/.travis.yml
Normal file
7
apps/cic-cache/aux/wait-for-it/.travis.yml
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
language: python
|
||||||
|
python:
|
||||||
|
- "2.7"
|
||||||
|
|
||||||
|
script:
|
||||||
|
- python test/wait-for-it.py
|
||||||
|
|
||||||
20
apps/cic-cache/aux/wait-for-it/LICENSE
Normal file
20
apps/cic-cache/aux/wait-for-it/LICENSE
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
Copyright (c) 2016 Giles Hall
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||||
|
of the Software, and to permit persons to whom the Software is furnished to do
|
||||||
|
so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
75
apps/cic-cache/aux/wait-for-it/README.md
Normal file
75
apps/cic-cache/aux/wait-for-it/README.md
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
# wait-for-it
|
||||||
|
|
||||||
|
`wait-for-it.sh` is a pure bash script that will wait on the availability of a
|
||||||
|
host and TCP port. It is useful for synchronizing the spin-up of
|
||||||
|
interdependent services, such as linked docker containers. Since it is a pure
|
||||||
|
bash script, it does not have any external dependencies.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```text
|
||||||
|
wait-for-it.sh host:port [-s] [-t timeout] [-- command args]
|
||||||
|
-h HOST | --host=HOST Host or IP under test
|
||||||
|
-p PORT | --port=PORT TCP port under test
|
||||||
|
Alternatively, you specify the host and port as host:port
|
||||||
|
-s | --strict Only execute subcommand if the test succeeds
|
||||||
|
-q | --quiet Don't output any status messages
|
||||||
|
-t TIMEOUT | --timeout=TIMEOUT
|
||||||
|
Timeout in seconds, zero for no timeout
|
||||||
|
-- COMMAND ARGS Execute command with args after the test finishes
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
For example, let's test to see if we can access port 80 on `www.google.com`,
|
||||||
|
and if it is available, echo the message `google is up`.
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ ./wait-for-it.sh www.google.com:80 -- echo "google is up"
|
||||||
|
wait-for-it.sh: waiting 15 seconds for www.google.com:80
|
||||||
|
wait-for-it.sh: www.google.com:80 is available after 0 seconds
|
||||||
|
google is up
|
||||||
|
```
|
||||||
|
|
||||||
|
You can set your own timeout with the `-t` or `--timeout=` option. Setting
|
||||||
|
the timeout value to 0 will disable the timeout:
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ ./wait-for-it.sh -t 0 www.google.com:80 -- echo "google is up"
|
||||||
|
wait-for-it.sh: waiting for www.google.com:80 without a timeout
|
||||||
|
wait-for-it.sh: www.google.com:80 is available after 0 seconds
|
||||||
|
google is up
|
||||||
|
```
|
||||||
|
|
||||||
|
The subcommand will be executed regardless if the service is up or not. If you
|
||||||
|
wish to execute the subcommand only if the service is up, add the `--strict`
|
||||||
|
argument. In this example, we will test port 81 on `www.google.com` which will
|
||||||
|
fail:
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ ./wait-for-it.sh www.google.com:81 --timeout=1 --strict -- echo "google is up"
|
||||||
|
wait-for-it.sh: waiting 1 seconds for www.google.com:81
|
||||||
|
wait-for-it.sh: timeout occurred after waiting 1 seconds for www.google.com:81
|
||||||
|
wait-for-it.sh: strict mode, refusing to execute subprocess
|
||||||
|
```
|
||||||
|
|
||||||
|
If you don't want to execute a subcommand, leave off the `--` argument. This
|
||||||
|
way, you can test the exit condition of `wait-for-it.sh` in your own scripts,
|
||||||
|
and determine how to proceed:
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ ./wait-for-it.sh www.google.com:80
|
||||||
|
wait-for-it.sh: waiting 15 seconds for www.google.com:80
|
||||||
|
wait-for-it.sh: www.google.com:80 is available after 0 seconds
|
||||||
|
$ echo $?
|
||||||
|
0
|
||||||
|
$ ./wait-for-it.sh www.google.com:81
|
||||||
|
wait-for-it.sh: waiting 15 seconds for www.google.com:81
|
||||||
|
wait-for-it.sh: timeout occurred after waiting 15 seconds for www.google.com:81
|
||||||
|
$ echo $?
|
||||||
|
124
|
||||||
|
```
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
*Debian*: There is a [Debian package](https://tracker.debian.org/pkg/wait-for-it).
|
||||||
182
apps/cic-cache/aux/wait-for-it/wait-for-it.sh
Executable file
182
apps/cic-cache/aux/wait-for-it/wait-for-it.sh
Executable file
@@ -0,0 +1,182 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Use this script to test if a given TCP host/port are available
|
||||||
|
|
||||||
|
WAITFORIT_cmdname=${0##*/}
|
||||||
|
|
||||||
|
echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
|
||||||
|
|
||||||
|
usage()
|
||||||
|
{
|
||||||
|
cat << USAGE >&2
|
||||||
|
Usage:
|
||||||
|
$WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
|
||||||
|
-h HOST | --host=HOST Host or IP under test
|
||||||
|
-p PORT | --port=PORT TCP port under test
|
||||||
|
Alternatively, you specify the host and port as host:port
|
||||||
|
-s | --strict Only execute subcommand if the test succeeds
|
||||||
|
-q | --quiet Don't output any status messages
|
||||||
|
-t TIMEOUT | --timeout=TIMEOUT
|
||||||
|
Timeout in seconds, zero for no timeout
|
||||||
|
-- COMMAND ARGS Execute command with args after the test finishes
|
||||||
|
USAGE
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
wait_for()
|
||||||
|
{
|
||||||
|
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
|
||||||
|
echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
|
||||||
|
else
|
||||||
|
echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
|
||||||
|
fi
|
||||||
|
WAITFORIT_start_ts=$(date +%s)
|
||||||
|
while :
|
||||||
|
do
|
||||||
|
if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
|
||||||
|
nc -z $WAITFORIT_HOST $WAITFORIT_PORT
|
||||||
|
WAITFORIT_result=$?
|
||||||
|
else
|
||||||
|
(echo -n > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
|
||||||
|
WAITFORIT_result=$?
|
||||||
|
fi
|
||||||
|
if [[ $WAITFORIT_result -eq 0 ]]; then
|
||||||
|
WAITFORIT_end_ts=$(date +%s)
|
||||||
|
echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
return $WAITFORIT_result
|
||||||
|
}
|
||||||
|
|
||||||
|
wait_for_wrapper()
|
||||||
|
{
|
||||||
|
# In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
|
||||||
|
if [[ $WAITFORIT_QUIET -eq 1 ]]; then
|
||||||
|
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
|
||||||
|
else
|
||||||
|
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
|
||||||
|
fi
|
||||||
|
WAITFORIT_PID=$!
|
||||||
|
trap "kill -INT -$WAITFORIT_PID" INT
|
||||||
|
wait $WAITFORIT_PID
|
||||||
|
WAITFORIT_RESULT=$?
|
||||||
|
if [[ $WAITFORIT_RESULT -ne 0 ]]; then
|
||||||
|
echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
|
||||||
|
fi
|
||||||
|
return $WAITFORIT_RESULT
|
||||||
|
}
|
||||||
|
|
||||||
|
# process arguments
|
||||||
|
while [[ $# -gt 0 ]]
|
||||||
|
do
|
||||||
|
case "$1" in
|
||||||
|
*:* )
|
||||||
|
WAITFORIT_hostport=(${1//:/ })
|
||||||
|
WAITFORIT_HOST=${WAITFORIT_hostport[0]}
|
||||||
|
WAITFORIT_PORT=${WAITFORIT_hostport[1]}
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
--child)
|
||||||
|
WAITFORIT_CHILD=1
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-q | --quiet)
|
||||||
|
WAITFORIT_QUIET=1
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-s | --strict)
|
||||||
|
WAITFORIT_STRICT=1
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-h)
|
||||||
|
WAITFORIT_HOST="$2"
|
||||||
|
if [[ $WAITFORIT_HOST == "" ]]; then break; fi
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--host=*)
|
||||||
|
WAITFORIT_HOST="${1#*=}"
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-p)
|
||||||
|
WAITFORIT_PORT="$2"
|
||||||
|
if [[ $WAITFORIT_PORT == "" ]]; then break; fi
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--port=*)
|
||||||
|
WAITFORIT_PORT="${1#*=}"
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
-t)
|
||||||
|
WAITFORIT_TIMEOUT="$2"
|
||||||
|
if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--timeout=*)
|
||||||
|
WAITFORIT_TIMEOUT="${1#*=}"
|
||||||
|
shift 1
|
||||||
|
;;
|
||||||
|
--)
|
||||||
|
shift
|
||||||
|
WAITFORIT_CLI=("$@")
|
||||||
|
break
|
||||||
|
;;
|
||||||
|
--help)
|
||||||
|
usage
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echoerr "Unknown argument: $1"
|
||||||
|
usage
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
|
||||||
|
echoerr "Error: you need to provide a host and port to test."
|
||||||
|
usage
|
||||||
|
fi
|
||||||
|
|
||||||
|
WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
|
||||||
|
WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
|
||||||
|
WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
|
||||||
|
WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
|
||||||
|
|
||||||
|
# Check to see if timeout is from busybox?
|
||||||
|
WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
|
||||||
|
WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
|
||||||
|
|
||||||
|
WAITFORIT_BUSYTIMEFLAG=""
|
||||||
|
if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
|
||||||
|
WAITFORIT_ISBUSY=1
|
||||||
|
# Check if busybox timeout uses -t flag
|
||||||
|
# (recent Alpine versions don't support -t anymore)
|
||||||
|
if timeout &>/dev/stdout | grep -q -e '-t '; then
|
||||||
|
WAITFORIT_BUSYTIMEFLAG="-t"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
WAITFORIT_ISBUSY=0
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ $WAITFORIT_CHILD -gt 0 ]]; then
|
||||||
|
wait_for
|
||||||
|
WAITFORIT_RESULT=$?
|
||||||
|
exit $WAITFORIT_RESULT
|
||||||
|
else
|
||||||
|
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
|
||||||
|
wait_for_wrapper
|
||||||
|
WAITFORIT_RESULT=$?
|
||||||
|
else
|
||||||
|
wait_for
|
||||||
|
WAITFORIT_RESULT=$?
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ $WAITFORIT_CLI != "" ]]; then
|
||||||
|
if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
|
||||||
|
echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
|
||||||
|
exit $WAITFORIT_RESULT
|
||||||
|
fi
|
||||||
|
exec "${WAITFORIT_CLI[@]}"
|
||||||
|
else
|
||||||
|
exit $WAITFORIT_RESULT
|
||||||
|
fi
|
||||||
@@ -8,6 +8,7 @@ import base64
|
|||||||
import confini
|
import confini
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
|
import cic_cache.cli
|
||||||
from cic_cache.db import dsn_from_config
|
from cic_cache.db import dsn_from_config
|
||||||
from cic_cache.db.models.base import SessionBase
|
from cic_cache.db.models.base import SessionBase
|
||||||
from cic_cache.runnable.daemons.query import (
|
from cic_cache.runnable.daemons.query import (
|
||||||
@@ -23,26 +24,17 @@ rootdir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
|
|||||||
dbdir = os.path.join(rootdir, 'cic_cache', 'db')
|
dbdir = os.path.join(rootdir, 'cic_cache', 'db')
|
||||||
migrationsdir = os.path.join(dbdir, 'migrations')
|
migrationsdir = os.path.join(dbdir, 'migrations')
|
||||||
|
|
||||||
config_dir = os.path.join('/usr/local/etc/cic-cache')
|
# process args
|
||||||
|
arg_flags = cic_cache.cli.argflag_std_base
|
||||||
argparser = argparse.ArgumentParser()
|
local_arg_flags = cic_cache.cli.argflag_local_task
|
||||||
argparser.add_argument('-c', type=str, default=config_dir, help='config file')
|
argparser = cic_cache.cli.ArgumentParser(arg_flags)
|
||||||
argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration')
|
argparser.process_local_flags(local_arg_flags)
|
||||||
argparser.add_argument('-v', action='store_true', help='be verbose')
|
|
||||||
argparser.add_argument('-vv', action='store_true', help='be more verbose')
|
|
||||||
args = argparser.parse_args()
|
args = argparser.parse_args()
|
||||||
|
|
||||||
if args.vv:
|
# process config
|
||||||
logging.getLogger().setLevel(logging.DEBUG)
|
config = cic_cache.cli.Config.from_args(args, arg_flags, local_arg_flags)
|
||||||
elif args.v:
|
|
||||||
logging.getLogger().setLevel(logging.INFO)
|
|
||||||
|
|
||||||
config = confini.Config(args.c, args.env_prefix)
|
|
||||||
config.process()
|
|
||||||
config.censor('PASSWORD', 'DATABASE')
|
|
||||||
config.censor('PASSWORD', 'SSL')
|
|
||||||
logg.debug('config:\n{}'.format(config))
|
|
||||||
|
|
||||||
|
# connect to database
|
||||||
dsn = dsn_from_config(config)
|
dsn = dsn_from_config(config)
|
||||||
SessionBase.connect(dsn, config.true('DATABASE_DEBUG'))
|
SessionBase.connect(dsn, config.true('DATABASE_DEBUG'))
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import celery
|
|||||||
import confini
|
import confini
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
|
import cic_cache.cli
|
||||||
from cic_cache.db import dsn_from_config
|
from cic_cache.db import dsn_from_config
|
||||||
from cic_cache.db.models.base import SessionBase
|
from cic_cache.db.models.base import SessionBase
|
||||||
from cic_cache.tasks.tx import *
|
from cic_cache.tasks.tx import *
|
||||||
@@ -16,35 +17,20 @@ from cic_cache.tasks.tx import *
|
|||||||
logging.basicConfig(level=logging.WARNING)
|
logging.basicConfig(level=logging.WARNING)
|
||||||
logg = logging.getLogger()
|
logg = logging.getLogger()
|
||||||
|
|
||||||
config_dir = os.path.join('/usr/local/etc/cic-cache')
|
# process args
|
||||||
|
arg_flags = cic_cache.cli.argflag_std_base
|
||||||
|
local_arg_flags = cic_cache.cli.argflag_local_task
|
||||||
argparser = argparse.ArgumentParser()
|
argparser = cic_cache.cli.ArgumentParser(arg_flags)
|
||||||
argparser.add_argument('-c', type=str, default=config_dir, help='config file')
|
argparser.process_local_flags(local_arg_flags)
|
||||||
argparser.add_argument('-q', type=str, default='cic-cache', help='queue name for worker tasks')
|
|
||||||
argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration')
|
|
||||||
argparser.add_argument('-v', action='store_true', help='be verbose')
|
|
||||||
argparser.add_argument('-vv', action='store_true', help='be more verbose')
|
|
||||||
|
|
||||||
args = argparser.parse_args()
|
args = argparser.parse_args()
|
||||||
|
|
||||||
if args.vv:
|
# process config
|
||||||
logging.getLogger().setLevel(logging.DEBUG)
|
config = cic_cache.cli.Config.from_args(args, arg_flags, local_arg_flags)
|
||||||
elif args.v:
|
|
||||||
logging.getLogger().setLevel(logging.INFO)
|
|
||||||
|
|
||||||
config = confini.Config(args.c, args.env_prefix)
|
|
||||||
config.process()
|
|
||||||
|
|
||||||
# connect to database
|
# connect to database
|
||||||
dsn = dsn_from_config(config)
|
dsn = dsn_from_config(config)
|
||||||
SessionBase.connect(dsn)
|
SessionBase.connect(dsn)
|
||||||
|
|
||||||
# verify database connection with minimal sanity query
|
|
||||||
#session = SessionBase.create_session()
|
|
||||||
#session.execute('select version_num from alembic_version')
|
|
||||||
#session.close()
|
|
||||||
|
|
||||||
# set up celery
|
# set up celery
|
||||||
current_app = celery.Celery(__name__)
|
current_app = celery.Celery(__name__)
|
||||||
|
|
||||||
@@ -87,9 +73,9 @@ def main():
|
|||||||
elif args.v:
|
elif args.v:
|
||||||
argv.append('--loglevel=INFO')
|
argv.append('--loglevel=INFO')
|
||||||
argv.append('-Q')
|
argv.append('-Q')
|
||||||
argv.append(args.q)
|
argv.append(config.get('CELERY_QUEUE'))
|
||||||
argv.append('-n')
|
argv.append('-n')
|
||||||
argv.append(args.q)
|
argv.append(config.get('CELERY_QUEUE'))
|
||||||
|
|
||||||
current_app.worker_main(argv)
|
current_app.worker_main(argv)
|
||||||
|
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ logging.basicConfig(level=logging.WARNING)
|
|||||||
logg = logging.getLogger()
|
logg = logging.getLogger()
|
||||||
|
|
||||||
# process args
|
# process args
|
||||||
arg_flags = cic_cache.cli.argflag_std_read
|
arg_flags = cic_cache.cli.argflag_std_base
|
||||||
local_arg_flags = cic_cache.cli.argflag_local_sync
|
local_arg_flags = cic_cache.cli.argflag_local_sync
|
||||||
argparser = cic_cache.cli.ArgumentParser(arg_flags)
|
argparser = cic_cache.cli.ArgumentParser(arg_flags)
|
||||||
argparser.process_local_flags(local_arg_flags)
|
argparser.process_local_flags(local_arg_flags)
|
||||||
|
|||||||
@@ -1,19 +1,17 @@
|
|||||||
# syntax = docker/dockerfile:1.2
|
ARG DOCKER_REGISTRY="registry.gitlab.com/grassrootseconomics"
|
||||||
FROM registry.gitlab.com/grassrootseconomics/cic-base-images:python-3.8.6-dev-55da5f4e as dev
|
|
||||||
|
FROM $DOCKER_REGISTRY/cic-base-images:python-3.8.6-dev-e8eb2ee2
|
||||||
# RUN pip install $pip_extra_index_url_flag cic-base[full_graph]==0.1.2b9
|
|
||||||
|
|
||||||
COPY requirements.txt .
|
COPY requirements.txt .
|
||||||
#RUN pip install $pip_extra_index_url_flag -r test_requirements.txt
|
|
||||||
#RUN pip install $pip_extra_index_url_flag .
|
|
||||||
#RUN pip install .[server]
|
|
||||||
|
|
||||||
ARG EXTRA_INDEX_URL="https://pip.grassrootseconomics.net:8433"
|
ARG EXTRA_PIP_INDEX_URL="https://pip.grassrootseconomics.net"
|
||||||
ARG GITLAB_PYTHON_REGISTRY="https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple"
|
|
||||||
ARG EXTRA_PIP_ARGS=""
|
ARG EXTRA_PIP_ARGS=""
|
||||||
|
ARG PIP_INDEX_URL="https://pypi.org/simple"
|
||||||
|
|
||||||
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
||||||
pip install --index-url https://pypi.org/simple \
|
pip install --index-url $PIP_INDEX_URL \
|
||||||
--extra-index-url $GITLAB_PYTHON_REGISTRY --extra-index-url $EXTRA_INDEX_URL $EXTRA_PIP_ARGS \
|
--pre \
|
||||||
|
--extra-index-url $EXTRA_PIP_INDEX_URL $EXTRA_PIP_ARGS \
|
||||||
-r requirements.txt
|
-r requirements.txt
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
@@ -23,10 +21,10 @@ RUN python setup.py install
|
|||||||
# ini files in config directory defines the configurable parameters for the application
|
# ini files in config directory defines the configurable parameters for the application
|
||||||
# they can all be overridden by environment variables
|
# they can all be overridden by environment variables
|
||||||
# to generate a list of environment variables from configuration, use: confini-dump -z <dir> (executable provided by confini package)
|
# to generate a list of environment variables from configuration, use: confini-dump -z <dir> (executable provided by confini package)
|
||||||
COPY config/ /usr/local/etc/cic-cache/
|
#COPY config/ /usr/local/etc/cic-cache/
|
||||||
|
|
||||||
# for db migrations
|
# for db migrations
|
||||||
RUN git clone https://github.com/vishnubob/wait-for-it.git /usr/local/bin/wait-for-it/
|
COPY ./aux/wait-for-it/wait-for-it.sh ./
|
||||||
COPY cic_cache/db/migrations/ /usr/local/share/cic-cache/alembic/
|
COPY cic_cache/db/migrations/ /usr/local/share/cic-cache/alembic/
|
||||||
|
|
||||||
COPY /docker/start_tracker.sh ./start_tracker.sh
|
COPY /docker/start_tracker.sh ./start_tracker.sh
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
pip install --extra-index-url https://pip.grassrootseconomics.net:8433 \
|
pip install --extra-index-url https://pip.grassrootseconomics.net \
|
||||||
--extra-index-url https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple \
|
--extra-index-url https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple \
|
||||||
-r test_requirements.txt
|
-r test_requirements.txt
|
||||||
|
|
||||||
|
|||||||
@@ -17,11 +17,12 @@ logg = logging.getLogger()
|
|||||||
rootdir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
|
rootdir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
|
||||||
dbdir = os.path.join(rootdir, 'cic_cache', 'db')
|
dbdir = os.path.join(rootdir, 'cic_cache', 'db')
|
||||||
migrationsdir = os.path.join(dbdir, 'migrations')
|
migrationsdir = os.path.join(dbdir, 'migrations')
|
||||||
|
configdir = os.path.join(rootdir, 'cic_cache', 'data', 'config')
|
||||||
|
|
||||||
config_dir = os.path.join('/usr/local/etc/cic-cache')
|
#config_dir = os.path.join('/usr/local/etc/cic-cache')
|
||||||
|
|
||||||
argparser = argparse.ArgumentParser()
|
argparser = argparse.ArgumentParser()
|
||||||
argparser.add_argument('-c', type=str, default=config_dir, help='config file')
|
argparser.add_argument('-c', type=str, help='config file')
|
||||||
argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration')
|
argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration')
|
||||||
argparser.add_argument('--migrations-dir', dest='migrations_dir', default=migrationsdir, type=str, help='path to alembic migrations directory')
|
argparser.add_argument('--migrations-dir', dest='migrations_dir', default=migrationsdir, type=str, help='path to alembic migrations directory')
|
||||||
argparser.add_argument('--reset', action='store_true', help='downgrade before upgrading')
|
argparser.add_argument('--reset', action='store_true', help='downgrade before upgrading')
|
||||||
@@ -35,7 +36,7 @@ if args.vv:
|
|||||||
elif args.v:
|
elif args.v:
|
||||||
logging.getLogger().setLevel(logging.INFO)
|
logging.getLogger().setLevel(logging.INFO)
|
||||||
|
|
||||||
config = confini.Config(args.c, args.env_prefix)
|
config = confini.Config(configdir, args.env_prefix)
|
||||||
config.process()
|
config.process()
|
||||||
config.censor('PASSWORD', 'DATABASE')
|
config.censor('PASSWORD', 'DATABASE')
|
||||||
config.censor('PASSWORD', 'SSL')
|
config.censor('PASSWORD', 'SSL')
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
celery==4.4.7
|
celery==4.4.7
|
||||||
erc20-demurrage-token~=0.0.5a3
|
erc20-demurrage-token~=0.0.5a3
|
||||||
cic-eth-registry~=0.6.1a5
|
cic-eth-registry~=0.6.1a6
|
||||||
chainlib~=0.0.9rc3
|
chainlib~=0.0.9rc1
|
||||||
cic_eth~=0.12.4a9
|
cic_eth~=0.12.4a11
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
[metadata]
|
[metadata]
|
||||||
name = cic-eth-aux-erc20-demurrage-token
|
name = cic-eth-aux-erc20-demurrage-token
|
||||||
version = 0.0.2a6
|
version = 0.0.2a7
|
||||||
description = cic-eth tasks supporting erc20 demurrage token
|
description = cic-eth tasks supporting erc20 demurrage token
|
||||||
author = Louis Holbrook
|
author = Louis Holbrook
|
||||||
author_email = dev@holbrook.no
|
author_email = dev@holbrook.no
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
SQLAlchemy==1.3.20
|
SQLAlchemy==1.3.20
|
||||||
cic-eth-registry>=0.6.1a5,<0.7.0
|
cic-eth-registry>=0.6.1a6,<0.7.0
|
||||||
hexathon~=0.0.1a8
|
hexathon~=0.0.1a8
|
||||||
chainqueue>=0.0.4a6,<0.1.0
|
chainqueue>=0.0.4a6,<0.1.0
|
||||||
eth-erc20>=0.1.2a2,<0.2.0
|
eth-erc20>=0.1.2a2,<0.2.0
|
||||||
|
|||||||
@@ -515,7 +515,7 @@ class Api(ApiBase):
|
|||||||
:param password: Password to encode the password with in the backend (careful, you will have to remember it)
|
:param password: Password to encode the password with in the backend (careful, you will have to remember it)
|
||||||
:type password: str
|
:type password: str
|
||||||
:param register: Register the new account in accounts index backend
|
:param register: Register the new account in accounts index backend
|
||||||
:type password: bool
|
:type register: bool
|
||||||
:returns: uuid of root task
|
:returns: uuid of root task
|
||||||
:rtype: celery.Task
|
:rtype: celery.Task
|
||||||
"""
|
"""
|
||||||
@@ -683,3 +683,4 @@ class Api(ApiBase):
|
|||||||
|
|
||||||
t = self.callback_success.apply_async([r])
|
t = self.callback_success.apply_async([r])
|
||||||
return t
|
return t
|
||||||
|
|
||||||
|
|||||||
@@ -382,6 +382,8 @@ def cache_transfer_data(
|
|||||||
sender_address = tx_normalize.wallet_address(tx['from'])
|
sender_address = tx_normalize.wallet_address(tx['from'])
|
||||||
recipient_address = tx_normalize.wallet_address(tx_data[0])
|
recipient_address = tx_normalize.wallet_address(tx_data[0])
|
||||||
token_value = tx_data[1]
|
token_value = tx_data[1]
|
||||||
|
source_token_address = tx_normalize.executable_address(tx['to'])
|
||||||
|
destination_token_address = source_token_address
|
||||||
|
|
||||||
|
|
||||||
session = SessionBase.create_session()
|
session = SessionBase.create_session()
|
||||||
@@ -389,8 +391,8 @@ def cache_transfer_data(
|
|||||||
'hash': tx_hash_hex,
|
'hash': tx_hash_hex,
|
||||||
'from': sender_address,
|
'from': sender_address,
|
||||||
'to': recipient_address,
|
'to': recipient_address,
|
||||||
'source_token': tx['to'],
|
'source_token': source_token_address,
|
||||||
'destination_token': tx['to'],
|
'destination_token': destination_token_address,
|
||||||
'from_value': token_value,
|
'from_value': token_value,
|
||||||
'to_value': token_value,
|
'to_value': token_value,
|
||||||
}
|
}
|
||||||
@@ -422,14 +424,16 @@ def cache_transfer_from_data(
|
|||||||
spender_address = tx_data[0]
|
spender_address = tx_data[0]
|
||||||
recipient_address = tx_data[1]
|
recipient_address = tx_data[1]
|
||||||
token_value = tx_data[2]
|
token_value = tx_data[2]
|
||||||
|
source_token_address = tx_normalize.executable_address(tx['to'])
|
||||||
|
destination_token_address = source_token_address
|
||||||
|
|
||||||
session = SessionBase.create_session()
|
session = SessionBase.create_session()
|
||||||
tx_dict = {
|
tx_dict = {
|
||||||
'hash': tx_hash_hex,
|
'hash': tx_hash_hex,
|
||||||
'from': tx['from'],
|
'from': tx['from'],
|
||||||
'to': recipient_address,
|
'to': recipient_address,
|
||||||
'source_token': tx['to'],
|
'source_token': source_token_address,
|
||||||
'destination_token': tx['to'],
|
'destination_token': destination_token_address,
|
||||||
'from_value': token_value,
|
'from_value': token_value,
|
||||||
'to_value': token_value,
|
'to_value': token_value,
|
||||||
}
|
}
|
||||||
@@ -461,14 +465,16 @@ def cache_approve_data(
|
|||||||
sender_address = tx_normalize.wallet_address(tx['from'])
|
sender_address = tx_normalize.wallet_address(tx['from'])
|
||||||
recipient_address = tx_normalize.wallet_address(tx_data[0])
|
recipient_address = tx_normalize.wallet_address(tx_data[0])
|
||||||
token_value = tx_data[1]
|
token_value = tx_data[1]
|
||||||
|
source_token_address = tx_normalize.executable_address(tx['to'])
|
||||||
|
destination_token_address = source_token_address
|
||||||
|
|
||||||
session = SessionBase.create_session()
|
session = SessionBase.create_session()
|
||||||
tx_dict = {
|
tx_dict = {
|
||||||
'hash': tx_hash_hex,
|
'hash': tx_hash_hex,
|
||||||
'from': sender_address,
|
'from': sender_address,
|
||||||
'to': recipient_address,
|
'to': recipient_address,
|
||||||
'source_token': tx['to'],
|
'source_token': source_token_address,
|
||||||
'destination_token': tx['to'],
|
'destination_token': destination_token_address,
|
||||||
'from_value': token_value,
|
'from_value': token_value,
|
||||||
'to_value': token_value,
|
'to_value': token_value,
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ def __balance_incoming_compatible(token_address, receiver_address):
|
|||||||
status_compare = dead()
|
status_compare = dead()
|
||||||
q = q.filter(Otx.status.op('&')(status_compare)==0)
|
q = q.filter(Otx.status.op('&')(status_compare)==0)
|
||||||
# TODO: this can change the result for the recipient if tx is later obsoleted and resubmission is delayed.
|
# TODO: this can change the result for the recipient if tx is later obsoleted and resubmission is delayed.
|
||||||
q = q.filter(Otx.status.op('&')(StatusBits.IN_NETWORK)==StatusBits.IN_NETWORK)
|
#q = q.filter(Otx.status.op('&')(StatusBits.IN_NETWORK)==StatusBits.IN_NETWORK)
|
||||||
q = q.filter(TxCache.destination_token_address==token_address)
|
q = q.filter(TxCache.destination_token_address==token_address)
|
||||||
delta = 0
|
delta = 0
|
||||||
for r in q.all():
|
for r in q.all():
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import datetime
|
|||||||
|
|
||||||
# external imports
|
# external imports
|
||||||
import celery
|
import celery
|
||||||
from cic_eth_registry import CICRegistry
|
|
||||||
from chainlib.chain import ChainSpec
|
from chainlib.chain import ChainSpec
|
||||||
from chainlib.eth.tx import unpack
|
from chainlib.eth.tx import unpack
|
||||||
from chainlib.connection import RPCConnection
|
from chainlib.connection import RPCConnection
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ arg_flags = cic_eth.cli.argflag_std_read
|
|||||||
local_arg_flags = cic_eth.cli.argflag_local_task
|
local_arg_flags = cic_eth.cli.argflag_local_task
|
||||||
argparser = cic_eth.cli.ArgumentParser(arg_flags)
|
argparser = cic_eth.cli.ArgumentParser(arg_flags)
|
||||||
argparser.process_local_flags(local_arg_flags)
|
argparser.process_local_flags(local_arg_flags)
|
||||||
argparser.add_argument('--default-token-symbol', dest='default_token_symbol', type=str, help='Symbol of default token to use')
|
#argparser.add_argument('--default-token-symbol', dest='default_token_symbol', type=str, help='Symbol of default token to use')
|
||||||
argparser.add_argument('--trace-queue-status', default=None, dest='trace_queue_status', action='store_true', help='set to perist all queue entry status changes to storage')
|
argparser.add_argument('--trace-queue-status', default=None, dest='trace_queue_status', action='store_true', help='set to perist all queue entry status changes to storage')
|
||||||
argparser.add_argument('--aux-all', action='store_true', help='include tasks from all submodules from the aux module path')
|
argparser.add_argument('--aux-all', action='store_true', help='include tasks from all submodules from the aux module path')
|
||||||
argparser.add_argument('--aux', action='append', type=str, default=[], help='add single submodule from the aux module path')
|
argparser.add_argument('--aux', action='append', type=str, default=[], help='add single submodule from the aux module path')
|
||||||
@@ -84,7 +84,7 @@ args = argparser.parse_args()
|
|||||||
|
|
||||||
# process config
|
# process config
|
||||||
extra_args = {
|
extra_args = {
|
||||||
'default_token_symbol': 'CIC_DEFAULT_TOKEN_SYMBOL',
|
# 'default_token_symbol': 'CIC_DEFAULT_TOKEN_SYMBOL',
|
||||||
'aux_all': None,
|
'aux_all': None,
|
||||||
'aux': None,
|
'aux': None,
|
||||||
'trace_queue_status': 'TASKS_TRACE_QUEUE_STATUS',
|
'trace_queue_status': 'TASKS_TRACE_QUEUE_STATUS',
|
||||||
@@ -187,6 +187,17 @@ elif len(args.aux) > 0:
|
|||||||
logg.info('aux module {} found in path {}'.format(v, aux_dir))
|
logg.info('aux module {} found in path {}'.format(v, aux_dir))
|
||||||
aux.append(v)
|
aux.append(v)
|
||||||
|
|
||||||
|
default_token_symbol = config.get('CIC_DEFAULT_TOKEN_SYMBOL')
|
||||||
|
defaullt_token_address = None
|
||||||
|
if default_token_symbol:
|
||||||
|
default_token_address = registry.by_name(default_token_symbol)
|
||||||
|
else:
|
||||||
|
default_token_address = registry.by_name('DefaultToken')
|
||||||
|
c = ERC20Token(chain_spec, conn, default_token_address)
|
||||||
|
default_token_symbol = c.symbol
|
||||||
|
logg.info('found default token {} address {}'.format(default_token_symbol, default_token_address))
|
||||||
|
config.add(default_token_symbol, 'CIC_DEFAULT_TOKEN_SYMBOL', exists_ok=True)
|
||||||
|
|
||||||
for v in aux:
|
for v in aux:
|
||||||
mname = 'cic_eth_aux.' + v
|
mname = 'cic_eth_aux.' + v
|
||||||
mod = importlib.import_module(mname)
|
mod = importlib.import_module(mname)
|
||||||
@@ -204,8 +215,8 @@ def main():
|
|||||||
argv.append('-n')
|
argv.append('-n')
|
||||||
argv.append(config.get('CELERY_QUEUE'))
|
argv.append(config.get('CELERY_QUEUE'))
|
||||||
|
|
||||||
BaseTask.default_token_symbol = config.get('CIC_DEFAULT_TOKEN_SYMBOL')
|
BaseTask.default_token_symbol = default_token_symbol
|
||||||
BaseTask.default_token_address = registry.by_name(BaseTask.default_token_symbol)
|
BaseTask.default_token_address = default_token_address
|
||||||
default_token = ERC20Token(chain_spec, conn, add_0x(BaseTask.default_token_address))
|
default_token = ERC20Token(chain_spec, conn, add_0x(BaseTask.default_token_address))
|
||||||
default_token.load(conn)
|
default_token.load(conn)
|
||||||
BaseTask.default_token_decimals = default_token.decimals
|
BaseTask.default_token_decimals = default_token.decimals
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ version = (
|
|||||||
0,
|
0,
|
||||||
12,
|
12,
|
||||||
4,
|
4,
|
||||||
'alpha.11',
|
'alpha.14',
|
||||||
)
|
)
|
||||||
|
|
||||||
version_object = semver.VersionInfo(
|
version_object = semver.VersionInfo(
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
@node cic-eth-accounts
|
|
||||||
@section Accounts
|
@section Accounts
|
||||||
|
|
||||||
Accounts are private keys in the signer component keyed by "addresses," a one-way transformation of a public key. Data can be signed by using the account as identifier for corresponding RPC requests.
|
Accounts are private keys in the signer component keyed by "addresses," a one-way transformation of a public key. Data can be signed by using the account as identifier for corresponding RPC requests.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
@node cic-eth system maintenance
|
@anchor{cic-eth-appendix-system-maintenance}
|
||||||
@appendix Admin API
|
@appendix Admin API
|
||||||
|
|
||||||
The admin API is still in an early stage of refinement. User friendliness can be considerably improved.
|
The admin API is still in an early stage of refinement. User friendliness can be considerably improved.
|
||||||
@@ -33,7 +33,7 @@ Get the current state of a lock
|
|||||||
|
|
||||||
@appendixsection tag_account
|
@appendixsection tag_account
|
||||||
|
|
||||||
Associate an identifier with an account address (@xref{cic-eth system accounts})
|
Associate an identifier with an account address (@xref{cic-eth-system-accounts})
|
||||||
|
|
||||||
@appendixsection have_account
|
@appendixsection have_account
|
||||||
|
|
||||||
|
|||||||
@@ -14,5 +14,6 @@ Released 2021 under GPL3
|
|||||||
@c
|
@c
|
||||||
@contents
|
@contents
|
||||||
|
|
||||||
@include index.texi
|
@include content.texi
|
||||||
|
@include appendix.texi
|
||||||
|
|
||||||
|
|||||||
3
apps/cic-eth/doc/texinfo/appendix.texi
Normal file
3
apps/cic-eth/doc/texinfo/appendix.texi
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
@include admin.texi
|
||||||
|
@include chains.texi
|
||||||
|
@include transfertypes.texi
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
@node cic-eth Appendix Task chains
|
@anchor{cic-eth-appendix-task-chains}
|
||||||
@appendix Task chains
|
@appendix Task chains
|
||||||
|
|
||||||
TBC - explain here how to generate these chain diagrams
|
TBC - explain here how to generate these chain diagrams
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
@node cic-eth configuration
|
|
||||||
@section Configuration
|
@section Configuration
|
||||||
|
|
||||||
Configuration parameters are grouped by configuration filename.
|
Configuration parameters are grouped by configuration filename.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
|
@node cic-eth
|
||||||
@top cic-eth
|
@top cic-eth
|
||||||
|
|
||||||
@include intro.texi
|
|
||||||
@include dependencies.texi
|
@include dependencies.texi
|
||||||
@include configuration.texi
|
@include configuration.texi
|
||||||
@include system.texi
|
@include system.texi
|
||||||
@@ -9,6 +9,3 @@
|
|||||||
@include incoming.texi
|
@include incoming.texi
|
||||||
@include services.texi
|
@include services.texi
|
||||||
@include tools.texi
|
@include tools.texi
|
||||||
@include admin.texi
|
|
||||||
@include chains.texi
|
|
||||||
@include transfertypes.texi
|
|
||||||
@@ -1,4 +1,3 @@
|
|||||||
@node cic-eth-dependencies
|
|
||||||
@section Dependencies
|
@section Dependencies
|
||||||
|
|
||||||
This application is written in Python 3.8. It is tightly coupled with @code{python-celery}, which provides the task worker ecosystem. It also uses @code{SQLAlchemy} which provides useful abstractions for persistent storage though SQL, and @code{alembic} for database schema migrations.
|
This application is written in Python 3.8. It is tightly coupled with @code{python-celery}, which provides the task worker ecosystem. It also uses @code{SQLAlchemy} which provides useful abstractions for persistent storage though SQL, and @code{alembic} for database schema migrations.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
@node cic-eth-incoming
|
@anchor{cic-eth-incoming}
|
||||||
@section Incoming transactions
|
@section Incoming transactions
|
||||||
|
|
||||||
All transactions in mined blocks will be passed to a selection of plugin filters to the @code{chainsyncer} component. Each of these filters are individual python module files in @code{cic_eth.runnable.daemons.filters}. This section describes their function.
|
All transactions in mined blocks will be passed to a selection of plugin filters to the @code{chainsyncer} component. Each of these filters are individual python module files in @code{cic_eth.runnable.daemons.filters}. This section describes their function.
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
@node cic-eth-interacting
|
|
||||||
@section Interacting with the system
|
@section Interacting with the system
|
||||||
|
|
||||||
The API to the @var{cic-eth} component is a proxy for executing @emph{chains of Celery tasks}. The tasks that compose individual chains are documented in @ref{cic-eth Appendix Task chains,the Task Chain appendix}, which also describes a CLI tool that can generate graph representationso of them.
|
The API to the @var{cic-eth} component is a proxy for executing @emph{chains of Celery tasks}. The tasks that compose individual chains are documented in @ref{cic-eth-appendix-task-chains,the Task Chain appendix}, which also describes a CLI tool that can generate graph representationso of them.
|
||||||
|
|
||||||
There are two API classes, @var{Api} and @var{AdminApi}. The former is described later in this section, the latter described in @ref{cic-eth system maintenance,the Admin API appendix}.
|
There are two API classes, @var{Api} and @var{AdminApi}. The former is described later in this section, the latter described in @ref{cic-eth-appendix-system-maintenance,the Admin API appendix}.
|
||||||
|
|
||||||
|
|
||||||
@subsection Interface
|
@subsection Interface
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
@node cic-eth-outgoing
|
|
||||||
@section Outgoing transactions
|
@section Outgoing transactions
|
||||||
|
|
||||||
@strong{Important! A pre-requisite for proper functioning of the component is that no other agent is sending transactions to the network for any of the keys in the keystore.}
|
@strong{Important! A pre-requisite for proper functioning of the component is that no other agent is sending transactions to the network for any of the keys in the keystore.}
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
@node cic-eth-services
|
|
||||||
@section Services
|
@section Services
|
||||||
|
|
||||||
There are four daemons that together orchestrate all of the aforementioned recipes. This section will provide a high level description of them.
|
There are four daemons that together orchestrate all of the aforementioned recipes. This section will provide a high level description of them.
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
@node cic-eth system accounts
|
|
||||||
@section System initialization
|
@section System initialization
|
||||||
|
|
||||||
When the system starts for the first time, it is locked for any state change request other than account creation@footnote{Specifically, the @code{INIT}, @code{SEND} and @code{QUEUE} lock bits are set.}. These locks should be @emph{reset} once system initialization has been completed. Currently, system initialization only involves creating and tagging required system accounts, as specified below.
|
When the system starts for the first time, it is locked for any state change request other than account creation@footnote{Specifically, the @code{INIT}, @code{SEND} and @code{QUEUE} lock bits are set.}. These locks should be @emph{reset} once system initialization has been completed. Currently, system initialization only involves creating and tagging required system accounts, as specified below.
|
||||||
|
|
||||||
See @ref{cic-eth-locking,Locking} and @ref{cic-eth-tools-ctrl,ctrl in Tools} for details on locking.
|
See @ref{cic-eth-locking,Locking} and @ref{cic-eth-tools-ctrl,ctrl in Tools} for details on locking.
|
||||||
|
|
||||||
|
@anchor{cic-eth-system-accounts}
|
||||||
@subsection System accounts
|
@subsection System accounts
|
||||||
|
|
||||||
Certain accounts in the system have special roles. These are defined by @emph{tagging} certain accounts addresses with well-known identifiers.
|
Certain accounts in the system have special roles. These are defined by @emph{tagging} certain accounts addresses with well-known identifiers.
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
@node cic-eth-tools
|
|
||||||
@section Tools
|
@section Tools
|
||||||
|
|
||||||
A collection of CLI tools have been provided to help with diagnostics and other administrative tasks. These use the same configuration infrastructure as the daemons.
|
A collection of CLI tools have been provided to help with diagnostics and other administrative tasks. These use the same configuration infrastructure as the daemons.
|
||||||
@@ -37,7 +36,7 @@ Execute a token transfer on behalf of a custodial account.
|
|||||||
|
|
||||||
@subsection tag (cic-eth-tag)
|
@subsection tag (cic-eth-tag)
|
||||||
|
|
||||||
Associate an account address with a string identifier. @xref{cic-eth system accounts}
|
Associate an account address with a string identifier. @xref{cic-eth-system-accounts}
|
||||||
|
|
||||||
|
|
||||||
@anchor{cic-eth-tools-ctrl}
|
@anchor{cic-eth-tools-ctrl}
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
@node cic-eth Appendix Transaction types
|
|
||||||
@appendix Transfer types
|
@appendix Transfer types
|
||||||
|
|
||||||
@table @var
|
@table @var
|
||||||
|
|||||||
@@ -1,45 +1,31 @@
|
|||||||
# syntax = docker/dockerfile:1.2
|
ARG DOCKER_REGISTRY="registry.gitlab.com/grassrootseconomics"
|
||||||
FROM registry.gitlab.com/grassrootseconomics/cic-base-images:python-3.8.6-dev-55da5f4e as dev
|
|
||||||
|
FROM $DOCKER_REGISTRY/cic-base-images:python-3.8.6-dev-e8eb2ee2
|
||||||
|
|
||||||
# Copy just the requirements and install....this _might_ give docker a hint on caching but we
|
# Copy just the requirements and install....this _might_ give docker a hint on caching but we
|
||||||
# do load these all into setup.py later
|
# do load these all into setup.py later
|
||||||
# TODO can we take all the requirements out of setup.py and just do a pip install -r requirements.txt && python setup.py
|
# TODO can we take all the requirements out of setup.py and just do a pip install -r requirements.txt && python setup.py
|
||||||
#COPY cic-eth/requirements.txt .
|
#COPY cic-eth/requirements.txt .
|
||||||
|
|
||||||
ARG EXTRA_INDEX_URL="https://pip.grassrootseconomics.net:8433"
|
ARG EXTRA_PIP_INDEX_URL=https://pip.grassrootseconomics.net
|
||||||
ARG GITLAB_PYTHON_REGISTRY="https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple"
|
|
||||||
ARG EXTRA_PIP_ARGS=""
|
ARG EXTRA_PIP_ARGS=""
|
||||||
#RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
ARG PIP_INDEX_URL=https://pypi.org/simple
|
||||||
# pip install --index-url https://pypi.org/simple \
|
|
||||||
# --force-reinstall \
|
|
||||||
# --extra-index-url $GITLAB_PYTHON_REGISTRY --extra-index-url $EXTRA_INDEX_URL \
|
|
||||||
# -r requirements.txt
|
|
||||||
|
|
||||||
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
||||||
pip install --index-url https://pypi.org/simple \
|
pip install --index-url $PIP_INDEX_URL \
|
||||||
--extra-index-url $GITLAB_PYTHON_REGISTRY \
|
--pre \
|
||||||
--extra-index-url $EXTRA_INDEX_URL \
|
--extra-index-url $EXTRA_PIP_INDEX_URL $EXTRA_PIP_ARGS \
|
||||||
$EXTRA_PIP_ARGS \
|
cic-eth-aux-erc20-demurrage-token~=0.0.2a7
|
||||||
cic-eth-aux-erc20-demurrage-token~=0.0.2a6
|
|
||||||
|
|
||||||
|
|
||||||
COPY *requirements.txt ./
|
COPY *requirements.txt ./
|
||||||
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
||||||
pip install --index-url https://pypi.org/simple \
|
pip install --index-url $PIP_INDEX_URL \
|
||||||
--extra-index-url $GITLAB_PYTHON_REGISTRY \
|
--pre \
|
||||||
--extra-index-url $EXTRA_INDEX_URL \
|
--extra-index-url $EXTRA_PIP_INDEX_URL $EXTRA_PIP_ARGS \
|
||||||
$EXTRA_PIP_ARGS \
|
|
||||||
-r requirements.txt \
|
-r requirements.txt \
|
||||||
-r services_requirements.txt \
|
-r services_requirements.txt \
|
||||||
-r admin_requirements.txt
|
-r admin_requirements.txt
|
||||||
|
|
||||||
# always install the latest signer
|
|
||||||
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
|
||||||
pip install --index-url https://pypi.org/simple \
|
|
||||||
--extra-index-url $GITLAB_PYTHON_REGISTRY \
|
|
||||||
--extra-index-url $EXTRA_INDEX_URL \
|
|
||||||
$EXTRA_PIP_ARGS \
|
|
||||||
crypto-dev-signer
|
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN python setup.py install
|
RUN python setup.py install
|
||||||
@@ -53,7 +39,7 @@ RUN chmod 755 *.sh
|
|||||||
# # ini files in config directory defines the configurable parameters for the application
|
# # ini files in config directory defines the configurable parameters for the application
|
||||||
# # they can all be overridden by environment variables
|
# # they can all be overridden by environment variables
|
||||||
# # to generate a list of environment variables from configuration, use: confini-dump -z <dir> (executable provided by confini package)
|
# # to generate a list of environment variables from configuration, use: confini-dump -z <dir> (executable provided by confini package)
|
||||||
COPY config/ /usr/local/etc/cic-eth/
|
#COPY config/ /usr/local/etc/cic-eth/
|
||||||
COPY cic_eth/db/migrations/ /usr/local/share/cic-eth/alembic/
|
COPY cic_eth/db/migrations/ /usr/local/share/cic-eth/alembic/
|
||||||
COPY crypto_dev_signer_config/ /usr/local/etc/crypto-dev-signer/
|
COPY crypto_dev_signer_config/ /usr/local/etc/crypto-dev-signer/
|
||||||
|
|
||||||
|
|||||||
@@ -2,5 +2,6 @@
|
|||||||
|
|
||||||
set -e
|
set -e
|
||||||
>&2 echo executing database migration
|
>&2 echo executing database migration
|
||||||
python scripts/migrate.py -c /usr/local/etc/cic-eth --migrations-dir /usr/local/share/cic-eth/alembic -vv
|
#python scripts/migrate.py -c /usr/local/etc/cic-eth --migrations-dir /usr/local/share/cic-eth/alembic -vv
|
||||||
|
python scripts/migrate.py --migrations-dir /usr/local/share/cic-eth/alembic -vv
|
||||||
set +e
|
set +e
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
pip install --extra-index-url https://pip.grassrootseconomics.net:8433 --extra-index-url https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple \
|
pip install --extra-index-url https://pip.grassrootseconomics.net --extra-index-url https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple \
|
||||||
-r admin_requirements.txt \
|
-r admin_requirements.txt \
|
||||||
-r services_requirements.txt \
|
-r services_requirements.txt \
|
||||||
-r test_requirements.txt
|
-r test_requirements.txt
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
celery==4.4.7
|
celery==4.4.7
|
||||||
chainlib-eth>=0.0.9rc4,<0.1.0
|
chainlib-eth>=0.0.10a16,<0.1.0
|
||||||
semver==2.13.0
|
semver==2.13.0
|
||||||
crypto-dev-signer>=0.4.15rc2,<0.5.0
|
crypto-dev-signer>=0.4.15rc2,<0.5.0
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
chainqueue>=0.0.5a1,<0.1.0
|
chainqueue>=0.0.6a1,<0.1.0
|
||||||
chainsyncer[sql]>=0.0.6a3,<0.1.0
|
chainsyncer[sql]>=0.0.7a3,<0.1.0
|
||||||
alembic==1.4.2
|
alembic==1.4.2
|
||||||
confini>=0.3.6rc4,<0.5.0
|
confini>=0.3.6rc4,<0.5.0
|
||||||
redis==3.5.3
|
redis==3.5.3
|
||||||
@@ -8,7 +8,7 @@ pycryptodome==3.10.1
|
|||||||
liveness~=0.0.1a7
|
liveness~=0.0.1a7
|
||||||
eth-address-index>=0.2.4a1,<0.3.0
|
eth-address-index>=0.2.4a1,<0.3.0
|
||||||
eth-accounts-index>=0.1.2a3,<0.2.0
|
eth-accounts-index>=0.1.2a3,<0.2.0
|
||||||
cic-eth-registry>=0.6.1a5,<0.7.0
|
cic-eth-registry>=0.6.1a6,<0.7.0
|
||||||
erc20-faucet>=0.3.2a2,<0.4.0
|
erc20-faucet>=0.3.2a2,<0.4.0
|
||||||
erc20-transfer-authorization>=0.3.5a2,<0.4.0
|
erc20-transfer-authorization>=0.3.5a2,<0.4.0
|
||||||
sarafu-faucet>=0.0.7a2,<0.1.0
|
sarafu-faucet>=0.0.7a2,<0.1.0
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
[metadata]
|
[metadata]
|
||||||
name = cic-eth
|
name = cic-eth
|
||||||
version = attr: cic_eth.version.__version_string__
|
#version = attr: cic_eth.version.__version_string__
|
||||||
|
version = 0.12.4a13
|
||||||
description = CIC Network Ethereum interaction
|
description = CIC Network Ethereum interaction
|
||||||
author = Louis Holbrook
|
author = Louis Holbrook
|
||||||
author_email = dev@holbrook.no
|
author_email = dev@holbrook.no
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
pip install --extra-index-url https://pip.grassrootseconomics.net:8433 --extra-index-url https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple
|
pip install --extra-index-url https://pip.grassrootseconomics.net --extra-index-url https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple
|
||||||
-r admin_requirements.txt
|
-r admin_requirements.txt
|
||||||
-r services_requirements.txt
|
-r services_requirements.txt
|
||||||
-r test_requirements.txt
|
-r test_requirements.txt
|
||||||
|
|||||||
@@ -110,7 +110,7 @@ def test_tokens_noproof(
|
|||||||
custodial_roles,
|
custodial_roles,
|
||||||
foo_token_declaration,
|
foo_token_declaration,
|
||||||
bar_token_declaration,
|
bar_token_declaration,
|
||||||
celery_worker,
|
celery_session_worker,
|
||||||
):
|
):
|
||||||
|
|
||||||
api = Api(str(default_chain_spec), queue=None, callback_param='foo')
|
api = Api(str(default_chain_spec), queue=None, callback_param='foo')
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
crypto-dev-signer>=0.4.15rc2,<=0.4.15
|
crypto-dev-signer>=0.4.15rc2,<=0.4.15
|
||||||
chainqueue>=0.0.5a1,<0.1.0
|
chainqueue>=0.0.5a3,<0.1.0
|
||||||
cic-eth-registry>=0.6.1a5,<0.7.0
|
cic-eth-registry>=0.6.1a6,<0.7.0
|
||||||
redis==3.5.3
|
redis==3.5.3
|
||||||
hexathon~=0.0.1a8
|
hexathon~=0.0.1a8
|
||||||
pycryptodome==3.10.1
|
pycryptodome==3.10.1
|
||||||
|
|||||||
@@ -1,19 +1,23 @@
|
|||||||
# syntax = docker/dockerfile:1.2
|
FROM node:15.3.0-alpine3.10
|
||||||
#FROM node:15.3.0-alpine3.10
|
|
||||||
FROM node:lts-alpine3.14
|
|
||||||
|
|
||||||
WORKDIR /root
|
WORKDIR /root
|
||||||
|
|
||||||
RUN apk add --no-cache postgresql bash
|
RUN apk add --no-cache postgresql bash
|
||||||
|
|
||||||
|
ARG NPM_REPOSITORY=${NPM_REPOSITORY:-https://registry.npmjs.org}
|
||||||
|
RUN npm config set snyk=false
|
||||||
|
#RUN npm config set registry={NPM_REPOSITORY}
|
||||||
|
RUN npm config set registry=${NPM_REPOSITORY}
|
||||||
|
|
||||||
# copy the dependencies
|
# copy the dependencies
|
||||||
COPY package.json package-lock.json .
|
COPY package.json package-lock.json ./
|
||||||
RUN --mount=type=cache,mode=0755,target=/root/.npm \
|
RUN --mount=type=cache,mode=0755,target=/root/.npm \
|
||||||
npm set cache /root/.npm && \
|
npm set cache /root/.npm && \
|
||||||
npm ci
|
npm cache verify && \
|
||||||
|
npm ci --verbose
|
||||||
|
|
||||||
COPY webpack.config.js .
|
COPY webpack.config.js ./
|
||||||
COPY tsconfig.json .
|
COPY tsconfig.json ./
|
||||||
## required to build the cic-client-meta module
|
## required to build the cic-client-meta module
|
||||||
COPY . .
|
COPY . .
|
||||||
COPY tests/*.asc /root/pgp/
|
COPY tests/*.asc /root/pgp/
|
||||||
|
|||||||
5650
apps/cic-meta/package-lock.json
generated
5650
apps/cic-meta/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -1,8 +1,9 @@
|
|||||||
create table if not exists store (
|
create table if not exists store (
|
||||||
id serial primary key not null,
|
id serial primary key not null,
|
||||||
owner_fingerprint text not null,
|
owner_fingerprint text default null,
|
||||||
hash char(64) not null unique,
|
hash char(64) not null unique,
|
||||||
content text not null
|
content text not null,
|
||||||
|
mime_type text
|
||||||
);
|
);
|
||||||
|
|
||||||
create index if not exists idx_fp on store ((lower(owner_fingerprint)));
|
create index if not exists idx_fp on store ((lower(owner_fingerprint)));
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
create table if not exists store (
|
create table if not exists store (
|
||||||
/*id serial primary key not null,*/
|
/*id serial primary key not null,*/
|
||||||
id integer primary key autoincrement,
|
id integer primary key autoincrement,
|
||||||
owner_fingerprint text not null,
|
owner_fingerprint text default null,
|
||||||
hash char(64) not null unique,
|
hash char(64) not null unique,
|
||||||
content text not null
|
content text not null,
|
||||||
|
mime_type text
|
||||||
);
|
);
|
||||||
|
|
||||||
create index if not exists idx_fp on store ((lower(owner_fingerprint)));
|
create index if not exists idx_fp on store ((lower(owner_fingerprint)));
|
||||||
|
|||||||
@@ -1,12 +1,13 @@
|
|||||||
import * as Automerge from 'automerge';
|
import * as Automerge from 'automerge';
|
||||||
import * as pgp from 'openpgp';
|
import * as pgp from 'openpgp';
|
||||||
|
import * as crypto from 'crypto';
|
||||||
|
|
||||||
import { Envelope, Syncable } from '@cicnet/crdt-meta';
|
import { Envelope, Syncable, bytesToHex } from '@cicnet/crdt-meta';
|
||||||
|
|
||||||
|
|
||||||
function handleNoMergeGet(db, digest, keystore) {
|
function handleNoMergeGet(db, digest, keystore) {
|
||||||
const sql = "SELECT content FROM store WHERE hash = '" + digest + "'";
|
const sql = "SELECT owner_fingerprint, content, mime_type FROM store WHERE hash = '" + digest + "'";
|
||||||
return new Promise<string|boolean>((whohoo, doh) => {
|
return new Promise<any>((whohoo, doh) => {
|
||||||
db.query(sql, (e, rs) => {
|
db.query(sql, (e, rs) => {
|
||||||
if (e !== null && e !== undefined) {
|
if (e !== null && e !== undefined) {
|
||||||
doh(e);
|
doh(e);
|
||||||
@@ -16,16 +17,36 @@ function handleNoMergeGet(db, digest, keystore) {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const immutable = rs.rows[0]['owner_fingerprint'] == undefined;
|
||||||
|
let mimeType;
|
||||||
|
if (immutable) {
|
||||||
|
if (rs.rows[0]['mime_type'] === undefined) {
|
||||||
|
mimeType = 'application/octet-stream';
|
||||||
|
} else {
|
||||||
|
mimeType = rs.rows[0]['mime_type'];
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
mimeType = 'application/json';
|
||||||
|
}
|
||||||
|
|
||||||
const cipherText = rs.rows[0]['content'];
|
const cipherText = rs.rows[0]['content'];
|
||||||
pgp.message.readArmored(cipherText).then((m) => {
|
pgp.message.readArmored(cipherText).then((m) => {
|
||||||
const opts = {
|
const opts = {
|
||||||
message: m,
|
message: m,
|
||||||
privateKeys: [keystore.getPrivateKey()],
|
privateKeys: [keystore.getPrivateKey()],
|
||||||
|
format: 'binary',
|
||||||
};
|
};
|
||||||
pgp.decrypt(opts).then((plainText) => {
|
pgp.decrypt(opts).then((plainText) => {
|
||||||
const o = Syncable.fromJSON(plainText.data);
|
let r;
|
||||||
const r = JSON.stringify(o.m['data']);
|
if (immutable) {
|
||||||
whohoo(r);
|
r = plainText.data;
|
||||||
|
} else {
|
||||||
|
mimeType = 'application/json';
|
||||||
|
const d = new TextDecoder().decode(plainText.data);
|
||||||
|
const o = Syncable.fromJSON(d);
|
||||||
|
r = JSON.stringify(o.m['data']);
|
||||||
|
}
|
||||||
|
whohoo([r, mimeType]);
|
||||||
}).catch((e) => {
|
}).catch((e) => {
|
||||||
console.error('decrypt', e);
|
console.error('decrypt', e);
|
||||||
doh(e);
|
doh(e);
|
||||||
@@ -57,6 +78,7 @@ function handleServerMergePost(data, db, digest, keystore, signer) {
|
|||||||
} else {
|
} else {
|
||||||
e = Envelope.fromJSON(v);
|
e = Envelope.fromJSON(v);
|
||||||
s = e.unwrap();
|
s = e.unwrap();
|
||||||
|
console.debug('s', s, o)
|
||||||
s.replace(o, 'server merge');
|
s.replace(o, 'server merge');
|
||||||
e.set(s);
|
e.set(s);
|
||||||
s.onwrap = (e) => {
|
s.onwrap = (e) => {
|
||||||
@@ -139,7 +161,13 @@ function handleClientMergeGet(db, digest, keystore) {
|
|||||||
privateKeys: [keystore.getPrivateKey()],
|
privateKeys: [keystore.getPrivateKey()],
|
||||||
};
|
};
|
||||||
pgp.decrypt(opts).then((plainText) => {
|
pgp.decrypt(opts).then((plainText) => {
|
||||||
const o = Syncable.fromJSON(plainText.data);
|
let d;
|
||||||
|
if (typeof(plainText.data) == 'string') {
|
||||||
|
d = plainText.data;
|
||||||
|
} else {
|
||||||
|
d = new TextDecoder().decode(plainText.data);
|
||||||
|
}
|
||||||
|
const o = Syncable.fromJSON(d);
|
||||||
const e = new Envelope(o);
|
const e = new Envelope(o);
|
||||||
whohoo(e.toJSON());
|
whohoo(e.toJSON());
|
||||||
}).catch((e) => {
|
}).catch((e) => {
|
||||||
@@ -201,10 +229,65 @@ function handleClientMergePut(data, db, digest, keystore, signer) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
function handleImmutablePost(data, db, digest, keystore, contentType) {
|
||||||
|
return new Promise<Array<string|boolean>>((whohoo, doh) => {
|
||||||
|
let data_binary = data;
|
||||||
|
const h = crypto.createHash('sha256');
|
||||||
|
h.update(data_binary);
|
||||||
|
const z = h.digest();
|
||||||
|
const r = bytesToHex(z);
|
||||||
|
|
||||||
|
if (digest) {
|
||||||
|
if (r != digest) {
|
||||||
|
doh('hash mismatch: ' + r + ' != ' + digest);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
digest = r;
|
||||||
|
console.debug('calculated digest ' + digest);
|
||||||
|
}
|
||||||
|
|
||||||
|
handleNoMergeGet(db, digest, keystore).then((haveDigest) => {
|
||||||
|
if (haveDigest !== false) {
|
||||||
|
whohoo([false, digest]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let message;
|
||||||
|
if (typeof(data) == 'string') {
|
||||||
|
data_binary = new TextEncoder().encode(data);
|
||||||
|
message = pgp.message.fromText(data);
|
||||||
|
} else {
|
||||||
|
message = pgp.message.fromBinary(data);
|
||||||
|
}
|
||||||
|
|
||||||
|
const opts = {
|
||||||
|
message: message,
|
||||||
|
publicKeys: keystore.getEncryptKeys(),
|
||||||
|
};
|
||||||
|
pgp.encrypt(opts).then((cipherText) => {
|
||||||
|
const sql = "INSERT INTO store (hash, content, mime_type) VALUES ('" + digest + "', '" + cipherText.data + "', '" + contentType + "') ON CONFLICT (hash) DO UPDATE SET content = EXCLUDED.content;";
|
||||||
|
db.query(sql, (e, rs) => {
|
||||||
|
if (e !== null && e !== undefined) {
|
||||||
|
doh(e);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
whohoo([true, digest]);
|
||||||
|
});
|
||||||
|
}).catch((e) => {
|
||||||
|
doh(e);
|
||||||
|
});
|
||||||
|
}).catch((e) => {
|
||||||
|
doh(e);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
export {
|
export {
|
||||||
handleClientMergePut,
|
handleClientMergePut,
|
||||||
handleClientMergeGet,
|
handleClientMergeGet,
|
||||||
handleServerMergePost,
|
handleServerMergePost,
|
||||||
handleServerMergePut,
|
handleServerMergePut,
|
||||||
handleNoMergeGet,
|
handleNoMergeGet,
|
||||||
|
handleImmutablePost,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -118,37 +118,71 @@ async function processRequest(req, res) {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let mod = req.method.toLowerCase() + ":automerge:";
|
||||||
|
let modDetail = undefined;
|
||||||
|
let immutablePost = false;
|
||||||
try {
|
try {
|
||||||
digest = parseDigest(req.url);
|
digest = parseDigest(req.url);
|
||||||
} catch(e) {
|
} catch(e) {
|
||||||
console.error('digest error: ' + e)
|
if (req.url == '/') {
|
||||||
res.writeHead(400, {"Content-Type": "text/plain"});
|
immutablePost = true;
|
||||||
res.end();
|
modDetail = 'immutable';
|
||||||
return;
|
} else {
|
||||||
|
console.error('url is not empty (' + req.url + ') and not valid digest error: ' + e)
|
||||||
|
res.writeHead(400, {"Content-Type": "text/plain"});
|
||||||
|
res.end();
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const mergeHeader = req.headers['x-cic-automerge'];
|
if (modDetail === undefined) {
|
||||||
let mod = req.method.toLowerCase() + ":automerge:";
|
const mergeHeader = req.headers['x-cic-automerge'];
|
||||||
switch (mergeHeader) {
|
switch (mergeHeader) {
|
||||||
case "client":
|
case "client":
|
||||||
mod += "client"; // client handles merges
|
if (immutablePost) {
|
||||||
break;
|
res.writeHead(400, 'Valid digest missing', {"Content-Type": "text/plain"});
|
||||||
case "server":
|
res.end();
|
||||||
mod += "server"; // server handles merges
|
return;
|
||||||
break;
|
}
|
||||||
default:
|
modDetail = "client"; // client handles merges
|
||||||
mod += "none"; // merged object only (get only)
|
break;
|
||||||
|
case "server":
|
||||||
|
if (immutablePost) {
|
||||||
|
res.writeHead(400, 'Valid digest missing', {"Content-Type": "text/plain"});
|
||||||
|
res.end();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
modDetail = "server"; // server handles merges
|
||||||
|
break;
|
||||||
|
case "immutable":
|
||||||
|
modDetail = "immutable"; // no merging, literal immutable content with content-addressing
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
modDetail = "none"; // merged object only (get only)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
mod += modDetail;
|
||||||
|
|
||||||
let data = '';
|
|
||||||
|
// handle bigger chunks of data
|
||||||
|
let data;
|
||||||
req.on('data', (d) => {
|
req.on('data', (d) => {
|
||||||
data += d;
|
if (data === undefined) {
|
||||||
|
data = d;
|
||||||
|
} else {
|
||||||
|
data += d;
|
||||||
|
}
|
||||||
});
|
});
|
||||||
req.on('end', async () => {
|
req.on('end', async (d) => {
|
||||||
console.debug('mode', mod);
|
let inputContentType = req.headers['content-type'];
|
||||||
let content = '';
|
let debugString = 'executing mode ' + mod ;
|
||||||
|
if (data !== undefined) {
|
||||||
|
debugString += ' for content type ' + inputContentType + ' length ' + data.length;
|
||||||
|
}
|
||||||
|
console.debug(debugString);
|
||||||
|
let content;
|
||||||
let contentType = 'application/json';
|
let contentType = 'application/json';
|
||||||
console.debug('handling data', data);
|
let statusCode = 200;
|
||||||
let r:any = undefined;
|
let r:any = undefined;
|
||||||
try {
|
try {
|
||||||
switch (mod) {
|
switch (mod) {
|
||||||
@@ -159,6 +193,7 @@ async function processRequest(req, res) {
|
|||||||
res.end();
|
res.end();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
content = '';
|
||||||
break;
|
break;
|
||||||
|
|
||||||
case 'get:automerge:client':
|
case 'get:automerge:client':
|
||||||
@@ -176,6 +211,7 @@ async function processRequest(req, res) {
|
|||||||
res.end();
|
res.end();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
content = '';
|
||||||
break;
|
break;
|
||||||
//case 'get:automerge:server':
|
//case 'get:automerge:server':
|
||||||
// content = await handlers.handleServerMergeGet(db, digest, keystore);
|
// content = await handlers.handleServerMergeGet(db, digest, keystore);
|
||||||
@@ -183,12 +219,24 @@ async function processRequest(req, res) {
|
|||||||
|
|
||||||
case 'get:automerge:none':
|
case 'get:automerge:none':
|
||||||
r = await handlers.handleNoMergeGet(db, digest, keystore);
|
r = await handlers.handleNoMergeGet(db, digest, keystore);
|
||||||
if (r == false) {
|
if (r === false) {
|
||||||
res.writeHead(404, {"Content-Type": "text/plain"});
|
res.writeHead(404, {"Content-Type": "text/plain"});
|
||||||
res.end();
|
res.end();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
content = r;
|
content = r[0];
|
||||||
|
contentType = r[1];
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'post:automerge:immutable':
|
||||||
|
if (inputContentType === undefined) {
|
||||||
|
inputContentType = 'application/octet-stream';
|
||||||
|
}
|
||||||
|
r = await handlers.handleImmutablePost(data, db, digest, keystore, inputContentType);
|
||||||
|
if (r[0]) {
|
||||||
|
statusCode = 201;
|
||||||
|
}
|
||||||
|
content = r[1];
|
||||||
break;
|
break;
|
||||||
|
|
||||||
default:
|
default:
|
||||||
@@ -204,14 +252,21 @@ async function processRequest(req, res) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (content === undefined) {
|
if (content === undefined) {
|
||||||
console.error('empty content', data);
|
console.error('empty content', mod, digest, data);
|
||||||
res.writeHead(404, {"Content-Type": "text/plain"});
|
res.writeHead(404, {"Content-Type": "text/plain"});
|
||||||
res.end();
|
res.end();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const responseContentLength = (new TextEncoder().encode(content)).length;
|
//let responseContentLength;
|
||||||
res.writeHead(200, {
|
//if (typeof(content) == 'string') {
|
||||||
|
// (new TextEncoder().encode(content)).length;
|
||||||
|
//}
|
||||||
|
const responseContentLength = content.length;
|
||||||
|
//if (responseContentLength === undefined) {
|
||||||
|
// responseContentLength = 0;
|
||||||
|
//}
|
||||||
|
res.writeHead(statusCode, {
|
||||||
"Access-Control-Allow-Origin": "*",
|
"Access-Control-Allow-Origin": "*",
|
||||||
"Content-Type": contentType,
|
"Content-Type": contentType,
|
||||||
"Content-Length": responseContentLength,
|
"Content-Length": responseContentLength,
|
||||||
|
|||||||
@@ -7,6 +7,8 @@ import * as handlers from '../scripts/server/handlers';
|
|||||||
import { Envelope, Syncable, ArgPair, PGPKeyStore, PGPSigner, KeyStore, Signer } from '@cicnet/crdt-meta';
|
import { Envelope, Syncable, ArgPair, PGPKeyStore, PGPSigner, KeyStore, Signer } from '@cicnet/crdt-meta';
|
||||||
import { SqliteAdapter } from '../src/db';
|
import { SqliteAdapter } from '../src/db';
|
||||||
|
|
||||||
|
const hashOfFoo = '2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae';
|
||||||
|
|
||||||
function createKeystore() {
|
function createKeystore() {
|
||||||
const pksa = fs.readFileSync(__dirname + '/privatekeys.asc', 'utf-8');
|
const pksa = fs.readFileSync(__dirname + '/privatekeys.asc', 'utf-8');
|
||||||
const pubksa = fs.readFileSync(__dirname + '/publickeys.asc', 'utf-8');
|
const pubksa = fs.readFileSync(__dirname + '/publickeys.asc', 'utf-8');
|
||||||
@@ -44,11 +46,13 @@ function createDatabase(sqlite_file:string):Promise<any> {
|
|||||||
// doh(e);
|
// doh(e);
|
||||||
// return;
|
// return;
|
||||||
// }
|
// }
|
||||||
|
// get this from real sql files sources
|
||||||
const sql = `CREATE TABLE store (
|
const sql = `CREATE TABLE store (
|
||||||
id integer primary key autoincrement,
|
id integer primary key autoincrement,
|
||||||
owner_fingerprint text not null,
|
owner_fingerprint text default null,
|
||||||
hash char(64) not null unique,
|
hash char(64) not null unique,
|
||||||
content text not null
|
content text not null,
|
||||||
|
mime_type text default null
|
||||||
);
|
);
|
||||||
`
|
`
|
||||||
|
|
||||||
@@ -111,15 +115,18 @@ describe('server', async () => {
|
|||||||
let j = env.toJSON();
|
let j = env.toJSON();
|
||||||
const content = await handlers.handleClientMergePut(j, db, digest, keystore, signer);
|
const content = await handlers.handleClientMergePut(j, db, digest, keystore, signer);
|
||||||
assert(content); // true-ish
|
assert(content); // true-ish
|
||||||
|
console.debug('content', content);
|
||||||
|
|
||||||
let v = await handlers.handleNoMergeGet(db, digest, keystore);
|
let v = await handlers.handleNoMergeGet(db, digest, keystore);
|
||||||
if (v === undefined) {
|
if (v === false) {
|
||||||
db.close();
|
db.close();
|
||||||
assert.fail('');
|
assert.fail('');
|
||||||
}
|
}
|
||||||
|
db.close();
|
||||||
|
return;
|
||||||
|
|
||||||
v = await handlers.handleClientMergeGet(db, digest, keystore);
|
v = await handlers.handleClientMergeGet(db, digest, keystore);
|
||||||
if (v === undefined) {
|
if (v === false) {
|
||||||
db.close();
|
db.close();
|
||||||
assert.fail('');
|
assert.fail('');
|
||||||
}
|
}
|
||||||
@@ -187,7 +194,7 @@ describe('server', async () => {
|
|||||||
j = await handlers.handleNoMergeGet(db, digest, keystore);
|
j = await handlers.handleNoMergeGet(db, digest, keystore);
|
||||||
assert(v); // true-ish
|
assert(v); // true-ish
|
||||||
|
|
||||||
let o = JSON.parse(j);
|
let o = JSON.parse(j[0]);
|
||||||
o.bar = 'xyzzy';
|
o.bar = 'xyzzy';
|
||||||
j = JSON.stringify(o);
|
j = JSON.stringify(o);
|
||||||
|
|
||||||
@@ -212,82 +219,39 @@ describe('server', async () => {
|
|||||||
|
|
||||||
j = await handlers.handleNoMergeGet(db, digest, keystore);
|
j = await handlers.handleNoMergeGet(db, digest, keystore);
|
||||||
assert(j); // true-ish
|
assert(j); // true-ish
|
||||||
o = JSON.parse(j);
|
o = JSON.parse(j[0]);
|
||||||
console.log(o);
|
console.log(o);
|
||||||
|
|
||||||
db.close();
|
db.close();
|
||||||
});
|
});
|
||||||
|
|
||||||
await it('server_merge', async () => {
|
// await it('server_merge', async () => {
|
||||||
const keystore = await createKeystore();
|
|
||||||
const signer = new PGPSigner(keystore);
|
|
||||||
|
|
||||||
const db = await createDatabase(__dirname + '/db.three.sqlite');
|
|
||||||
|
|
||||||
const digest = 'deadbeef';
|
|
||||||
let s = new Syncable(digest, {
|
|
||||||
bar: 'baz',
|
|
||||||
});
|
|
||||||
let env = await wrap(s, signer)
|
|
||||||
let j:any = env.toJSON();
|
|
||||||
|
|
||||||
let v = await handlers.handleClientMergePut(j, db, digest, keystore, signer);
|
|
||||||
assert(v); // true-ish
|
|
||||||
|
|
||||||
j = await handlers.handleNoMergeGet(db, digest, keystore);
|
|
||||||
assert(v); // true-ish
|
|
||||||
|
|
||||||
let o = JSON.parse(j);
|
|
||||||
o.bar = 'xyzzy';
|
|
||||||
j = JSON.stringify(o);
|
|
||||||
|
|
||||||
let signMaterial = await handlers.handleServerMergePost(j, db, digest, keystore, signer);
|
|
||||||
assert(signMaterial)
|
|
||||||
|
|
||||||
env = Envelope.fromJSON(signMaterial);
|
|
||||||
|
|
||||||
console.log('envvvv', env);
|
|
||||||
|
|
||||||
const signedData = await signData(env.o['digest'], keystore);
|
|
||||||
console.log('signed', signedData);
|
|
||||||
|
|
||||||
o = {
|
|
||||||
'm': env,
|
|
||||||
's': signedData,
|
|
||||||
}
|
|
||||||
j = JSON.stringify(o);
|
|
||||||
console.log(j);
|
|
||||||
|
|
||||||
v = await handlers.handleServerMergePut(j, db, digest, keystore, signer);
|
|
||||||
assert(v);
|
|
||||||
|
|
||||||
j = await handlers.handleNoMergeGet(db, digest, keystore);
|
|
||||||
assert(j); // true-ish
|
|
||||||
o = JSON.parse(j);
|
|
||||||
console.log(o);
|
|
||||||
|
|
||||||
db.close();
|
|
||||||
});
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// await it('server_merge_empty', async () => {
|
|
||||||
// const keystore = await createKeystore();
|
// const keystore = await createKeystore();
|
||||||
// const signer = new PGPSigner(keystore);
|
// const signer = new PGPSigner(keystore);
|
||||||
//
|
//
|
||||||
// const db = await createDatabase(__dirname + '/db.three.sqlite');
|
// const db = await createDatabase(__dirname + '/db.three.sqlite');
|
||||||
//
|
//
|
||||||
// const digest = '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef';
|
// const digest = 'deadbeef';
|
||||||
// let o:any = {
|
// let s = new Syncable(digest, {
|
||||||
// foo: 'bar',
|
// bar: 'baz',
|
||||||
// xyzzy: 42,
|
// });
|
||||||
// }
|
// let env = await wrap(s, signer)
|
||||||
// let j:any = JSON.stringify(o);
|
// let j:any = env.toJSON();
|
||||||
|
//
|
||||||
|
// let v = await handlers.handleClientMergePut(j, db, digest, keystore, signer);
|
||||||
|
// assert(v); // true-ish
|
||||||
|
//
|
||||||
|
// j = await handlers.handleNoMergeGet(db, digest, keystore);
|
||||||
|
// assert(v); // true-ish
|
||||||
|
//
|
||||||
|
// let o = JSON.parse(j);
|
||||||
|
// o.bar = 'xyzzy';
|
||||||
|
// j = JSON.stringify(o);
|
||||||
//
|
//
|
||||||
// let signMaterial = await handlers.handleServerMergePost(j, db, digest, keystore, signer);
|
// let signMaterial = await handlers.handleServerMergePost(j, db, digest, keystore, signer);
|
||||||
// assert(signMaterial)
|
// assert(signMaterial)
|
||||||
//
|
//
|
||||||
// const env = Envelope.fromJSON(signMaterial);
|
// env = Envelope.fromJSON(signMaterial);
|
||||||
//
|
//
|
||||||
// console.log('envvvv', env);
|
// console.log('envvvv', env);
|
||||||
//
|
//
|
||||||
@@ -301,7 +265,7 @@ describe('server', async () => {
|
|||||||
// j = JSON.stringify(o);
|
// j = JSON.stringify(o);
|
||||||
// console.log(j);
|
// console.log(j);
|
||||||
//
|
//
|
||||||
// let v = await handlers.handleServerMergePut(j, db, digest, keystore, signer);
|
// v = await handlers.handleServerMergePut(j, db, digest, keystore, signer);
|
||||||
// assert(v);
|
// assert(v);
|
||||||
//
|
//
|
||||||
// j = await handlers.handleNoMergeGet(db, digest, keystore);
|
// j = await handlers.handleNoMergeGet(db, digest, keystore);
|
||||||
@@ -311,5 +275,88 @@ describe('server', async () => {
|
|||||||
//
|
//
|
||||||
// db.close();
|
// db.close();
|
||||||
// });
|
// });
|
||||||
|
//
|
||||||
|
|
||||||
|
|
||||||
|
await it('server_merge_empty', async () => {
|
||||||
|
const keystore = await createKeystore();
|
||||||
|
const signer = new PGPSigner(keystore);
|
||||||
|
|
||||||
|
const db = await createDatabase(__dirname + '/db.three.sqlite');
|
||||||
|
|
||||||
|
const digest = '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef';
|
||||||
|
let o:any = {
|
||||||
|
foo: 'bar',
|
||||||
|
xyzzy: 42,
|
||||||
|
}
|
||||||
|
let j:any = JSON.stringify(o);
|
||||||
|
|
||||||
|
let signMaterial = await handlers.handleServerMergePost(j, db, digest, keystore, signer);
|
||||||
|
assert(signMaterial)
|
||||||
|
|
||||||
|
const env = Envelope.fromJSON(signMaterial);
|
||||||
|
|
||||||
|
console.log('envvvv', env);
|
||||||
|
|
||||||
|
const signedData = await signData(env.o['digest'], keystore);
|
||||||
|
console.log('signed', signedData);
|
||||||
|
|
||||||
|
o = {
|
||||||
|
'm': env,
|
||||||
|
's': signedData,
|
||||||
|
}
|
||||||
|
j = JSON.stringify(o);
|
||||||
|
console.log(j);
|
||||||
|
|
||||||
|
let v = await handlers.handleServerMergePut(j, db, digest, keystore, signer);
|
||||||
|
assert(v);
|
||||||
|
|
||||||
|
j = await handlers.handleNoMergeGet(db, digest, keystore);
|
||||||
|
assert(j); // true-ish
|
||||||
|
o = JSON.parse(j[0]);
|
||||||
|
console.log(o);
|
||||||
|
|
||||||
|
db.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
await it('immutable_nodigest', async() => {
|
||||||
|
const keystore = await createKeystore();
|
||||||
|
const db = await createDatabase(__dirname + '/db.three.sqlite');
|
||||||
|
|
||||||
|
const s:string = 'foo';
|
||||||
|
let r;
|
||||||
|
r = await handlers.handleImmutablePost(s, db, undefined, keystore, 'text/plain');
|
||||||
|
assert(r[0]);
|
||||||
|
assert(hashOfFoo == r[1]);
|
||||||
|
|
||||||
|
r = await handlers.handleImmutablePost(s, db, undefined, keystore, 'text/plain');
|
||||||
|
assert(!r[0]);
|
||||||
|
assert(hashOfFoo == r[1]);
|
||||||
|
|
||||||
|
const b:Uint8Array = new TextEncoder().encode(s);
|
||||||
|
r = await handlers.handleImmutablePost(b, db, undefined, keystore, 'text/plain');
|
||||||
|
assert(!r[0]);
|
||||||
|
assert(hashOfFoo == r[1]);
|
||||||
|
});
|
||||||
|
|
||||||
|
await it('immutable_digest', async() => {
|
||||||
|
const keystore = await createKeystore();
|
||||||
|
const db = await createDatabase(__dirname + '/db.three.sqlite');
|
||||||
|
|
||||||
|
const s:string = 'foo';
|
||||||
|
const b:Uint8Array = new TextEncoder().encode(s);
|
||||||
|
let r;
|
||||||
|
r = await handlers.handleImmutablePost(b, db, hashOfFoo, keystore, 'application/octet-stream');
|
||||||
|
assert(r[0]);
|
||||||
|
assert(hashOfFoo == r[1]);
|
||||||
|
|
||||||
|
r = await handlers.handleImmutablePost(b, db, hashOfFoo, keystore, 'application/octet-stream');
|
||||||
|
assert(!r[0]);
|
||||||
|
assert(hashOfFoo == r[1]);
|
||||||
|
|
||||||
|
r = await handlers.handleImmutablePost(s, db, hashOfFoo, keystore, 'text/plain');
|
||||||
|
assert(!r[0]);
|
||||||
|
assert(hashOfFoo == r[1]);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import semver
|
|||||||
|
|
||||||
logg = logging.getLogger()
|
logg = logging.getLogger()
|
||||||
|
|
||||||
version = (0, 4, 0, 'alpha.10')
|
version = (0, 4, 0, 'alpha.11')
|
||||||
|
|
||||||
version_object = semver.VersionInfo(
|
version_object = semver.VersionInfo(
|
||||||
major=version[0],
|
major=version[0],
|
||||||
|
|||||||
@@ -1,22 +1,28 @@
|
|||||||
# syntax = docker/dockerfile:1.2
|
ARG DOCKER_REGISTRY="registry.gitlab.com/grassrootseconomics"
|
||||||
FROM registry.gitlab.com/grassrootseconomics/cic-base-images:python-3.8.6-dev-55da5f4e as dev
|
|
||||||
|
FROM $DOCKER_REGISTRY/cic-base-images:python-3.8.6-dev-e8eb2ee2
|
||||||
|
|
||||||
#RUN pip install $pip_extra_index_url_flag cic-base[full_graph]==0.1.2a62
|
#RUN pip install $pip_extra_index_url_flag cic-base[full_graph]==0.1.2a62
|
||||||
|
RUN apt-get install libffi-dev -y
|
||||||
|
|
||||||
|
|
||||||
|
ARG EXTRA_PIP_INDEX_URL=https://pip.grassrootseconomics.net
|
||||||
|
ARG EXTRA_PIP_ARGS=""
|
||||||
|
ARG PIP_INDEX_URL=https://pypi.org/simple
|
||||||
|
|
||||||
ARG EXTRA_INDEX_URL="https://pip.grassrootseconomics.net:8433"
|
|
||||||
ARG GITLAB_PYTHON_REGISTRY="https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple"
|
|
||||||
COPY requirements.txt .
|
COPY requirements.txt .
|
||||||
|
|
||||||
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
||||||
pip install --index-url https://pypi.org/simple \
|
pip install --index-url $PIP_INDEX_URL \
|
||||||
--extra-index-url $GITLAB_PYTHON_REGISTRY --extra-index-url $EXTRA_INDEX_URL \
|
--pre \
|
||||||
|
--extra-index-url $EXTRA_PIP_INDEX_URL $EXTRA_PIP_ARGS \
|
||||||
-r requirements.txt
|
-r requirements.txt
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN python setup.py install
|
RUN python setup.py install
|
||||||
|
|
||||||
COPY docker/*.sh .
|
COPY docker/*.sh ./
|
||||||
RUN chmod +x *.sh
|
RUN chmod +x /root/*.sh
|
||||||
|
|
||||||
# ini files in config directory defines the configurable parameters for the application
|
# ini files in config directory defines the configurable parameters for the application
|
||||||
# they can all be overridden by environment variables
|
# they can all be overridden by environment variables
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
pip install --extra-index-url https://pip.grassrootseconomics.net:8433 \
|
pip install --extra-index-url https://pip.grassrootseconomics.net \
|
||||||
--extra-index-url https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple \
|
--extra-index-url https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple \
|
||||||
-r test_requirements.txt
|
-r test_requirements.txt
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
confini~=0.4.1a1
|
confini>=0.3.6rc4,<0.5.0
|
||||||
africastalking==1.2.3
|
africastalking==1.2.3
|
||||||
SQLAlchemy==1.3.20
|
SQLAlchemy==1.3.20
|
||||||
alembic==1.4.2
|
alembic==1.4.2
|
||||||
psycopg2==2.8.6
|
psycopg2==2.8.6
|
||||||
celery==4.4.7
|
celery==4.4.7
|
||||||
redis==3.5.3
|
redis==3.5.3
|
||||||
|
semver==2.13.0
|
||||||
|
|||||||
22
apps/cic-signer/Dockerfile
Normal file
22
apps/cic-signer/Dockerfile
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
ARG DOCKER_REGISTRY=registry.gitlab.com/grassrootseconomics
|
||||||
|
|
||||||
|
FROM $DOCKER_REGISTRY/cic-base-images:python-3.8.6-dev-e8eb2ee2 as dev
|
||||||
|
|
||||||
|
WORKDIR /root
|
||||||
|
|
||||||
|
RUN apt-get install libffi-dev -y
|
||||||
|
|
||||||
|
COPY requirements.txt .
|
||||||
|
|
||||||
|
ARG EXTRA_PIP_INDEX_URL="https://pip.grassrootseconomics.net"
|
||||||
|
ARG EXTRA_PIP_ARGS=""
|
||||||
|
ARG PIP_INDEX_URL="https://pypi.org/simple"
|
||||||
|
RUN --mount=type=cache,mode=0755,target=/root/.cache/pip \
|
||||||
|
pip install --index-url $PIP_INDEX_URL \
|
||||||
|
--pre \
|
||||||
|
--extra-index-url $EXTRA_PIP_INDEX_URL $EXTRA_PIP_ARGS \
|
||||||
|
-r requirements.txt
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
#RUN chmod +x *.sh
|
||||||
1
apps/cic-signer/requirements.txt
Normal file
1
apps/cic-signer/requirements.txt
Normal file
@@ -0,0 +1 @@
|
|||||||
|
funga-eth[sql]>=0.5.1a1,<0.6.0
|
||||||
@@ -2,18 +2,19 @@
|
|||||||
|
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
from typing import Optional
|
from typing import Union, Optional
|
||||||
|
|
||||||
# third-party imports
|
# third-party imports
|
||||||
from cic_eth.api import Api
|
from cic_eth.api import Api
|
||||||
from cic_eth_aux.erc20_demurrage_token.api import Api as DemurrageApi
|
from cic_eth_aux.erc20_demurrage_token.api import Api as DemurrageApi
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.transaction import from_wei
|
from cic_ussd.account.transaction import from_wei
|
||||||
from cic_ussd.cache import cache_data_key, get_cached_data
|
from cic_ussd.cache import cache_data_key, get_cached_data
|
||||||
from cic_ussd.error import CachedDataNotFoundError
|
from cic_ussd.error import CachedDataNotFoundError
|
||||||
|
|
||||||
logg = logging.getLogger()
|
logg = logging.getLogger(__file__)
|
||||||
|
|
||||||
|
|
||||||
def get_balances(address: str,
|
def get_balances(address: str,
|
||||||
@@ -42,7 +43,7 @@ def get_balances(address: str,
|
|||||||
:return: A list containing balance data if called synchronously. | None
|
:return: A list containing balance data if called synchronously. | None
|
||||||
:rtype: list | None
|
:rtype: list | None
|
||||||
"""
|
"""
|
||||||
logg.debug(f'retrieving balance for address: {address}')
|
logg.debug(f'retrieving {token_symbol} balance for address: {address}')
|
||||||
if asynchronous:
|
if asynchronous:
|
||||||
cic_eth_api = Api(
|
cic_eth_api = Api(
|
||||||
chain_str=chain_str,
|
chain_str=chain_str,
|
||||||
@@ -59,11 +60,13 @@ def get_balances(address: str,
|
|||||||
return balance_request_task.get()
|
return balance_request_task.get()
|
||||||
|
|
||||||
|
|
||||||
def calculate_available_balance(balances: dict) -> float:
|
def calculate_available_balance(balances: dict, decimals: int) -> float:
|
||||||
"""This function calculates an account's balance at a specific point in time by computing the difference from the
|
"""This function calculates an account's balance at a specific point in time by computing the difference from the
|
||||||
outgoing balance and the sum of the incoming and network balances.
|
outgoing balance and the sum of the incoming and network balances.
|
||||||
:param balances: incoming, network and outgoing balances.
|
:param balances: incoming, network and outgoing balances.
|
||||||
:type balances: dict
|
:type balances: dict
|
||||||
|
:param decimals:
|
||||||
|
:type decimals: int
|
||||||
:return: Token value of the available balance.
|
:return: Token value of the available balance.
|
||||||
:rtype: float
|
:rtype: float
|
||||||
"""
|
"""
|
||||||
@@ -72,7 +75,7 @@ def calculate_available_balance(balances: dict) -> float:
|
|||||||
network_balance = balances.get('balance_network')
|
network_balance = balances.get('balance_network')
|
||||||
|
|
||||||
available_balance = (network_balance + incoming_balance) - outgoing_balance
|
available_balance = (network_balance + incoming_balance) - outgoing_balance
|
||||||
return from_wei(value=available_balance)
|
return from_wei(decimals=decimals, value=available_balance)
|
||||||
|
|
||||||
|
|
||||||
def get_adjusted_balance(balance: int, chain_str: str, timestamp: int, token_symbol: str):
|
def get_adjusted_balance(balance: int, chain_str: str, timestamp: int, token_symbol: str):
|
||||||
@@ -93,29 +96,49 @@ def get_adjusted_balance(balance: int, chain_str: str, timestamp: int, token_sym
|
|||||||
return demurrage_api.get_adjusted_balance(token_symbol, balance, timestamp).result
|
return demurrage_api.get_adjusted_balance(token_symbol, balance, timestamp).result
|
||||||
|
|
||||||
|
|
||||||
def get_cached_available_balance(blockchain_address: str) -> float:
|
def get_cached_available_balance(decimals: int, identifier: Union[list, bytes]) -> float:
|
||||||
"""This function attempts to retrieve balance data from the redis cache.
|
"""This function attempts to retrieve balance data from the redis cache.
|
||||||
:param blockchain_address: Ethereum address of an account.
|
:param decimals:
|
||||||
:type blockchain_address: str
|
:type decimals: int
|
||||||
|
:param identifier: An identifier needed to create a unique pointer to a balances resource.
|
||||||
|
:type identifier: bytes | list
|
||||||
:raises CachedDataNotFoundError: No cached balance data could be found.
|
:raises CachedDataNotFoundError: No cached balance data could be found.
|
||||||
:return: Operational balance of an account.
|
:return: Operational balance of an account.
|
||||||
:rtype: float
|
:rtype: float
|
||||||
"""
|
"""
|
||||||
identifier = bytes.fromhex(blockchain_address)
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.BALANCES)
|
||||||
key = cache_data_key(identifier, salt=':cic.balances')
|
|
||||||
cached_balances = get_cached_data(key=key)
|
cached_balances = get_cached_data(key=key)
|
||||||
if cached_balances:
|
if cached_balances:
|
||||||
return calculate_available_balance(json.loads(cached_balances))
|
return calculate_available_balance(balances=json.loads(cached_balances), decimals=decimals)
|
||||||
else:
|
else:
|
||||||
raise CachedDataNotFoundError(f'No cached available balance for address: {blockchain_address}')
|
raise CachedDataNotFoundError(f'No cached available balance at {key}')
|
||||||
|
|
||||||
|
|
||||||
def get_cached_adjusted_balance(identifier: bytes):
|
def get_cached_adjusted_balance(identifier: Union[list, bytes]):
|
||||||
"""
|
"""
|
||||||
:param identifier:
|
:param identifier:
|
||||||
:type identifier:
|
:type identifier:
|
||||||
:return:
|
:return:
|
||||||
:rtype:
|
:rtype:
|
||||||
"""
|
"""
|
||||||
key = cache_data_key(identifier, ':cic.adjusted_balance')
|
key = cache_data_key(identifier, MetadataPointer.BALANCES_ADJUSTED)
|
||||||
return get_cached_data(key)
|
return get_cached_data(key)
|
||||||
|
|
||||||
|
|
||||||
|
def get_account_tokens_balance(blockchain_address: str, chain_str: str, token_symbols_list: list):
|
||||||
|
"""
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:param chain_str:
|
||||||
|
:type chain_str:
|
||||||
|
:param token_symbols_list:
|
||||||
|
:type token_symbols_list:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
for token_symbol in token_symbols_list:
|
||||||
|
get_balances(address=blockchain_address,
|
||||||
|
chain_str=chain_str,
|
||||||
|
token_symbol=token_symbol,
|
||||||
|
asynchronous=True,
|
||||||
|
callback_param=f'{blockchain_address},{token_symbol}')
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ from typing import Optional
|
|||||||
import celery
|
import celery
|
||||||
from chainlib.hash import strip_0x
|
from chainlib.hash import strip_0x
|
||||||
from cic_eth.api import Api
|
from cic_eth.api import Api
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
|
||||||
# local import
|
# local import
|
||||||
from cic_ussd.account.chain import Chain
|
from cic_ussd.account.chain import Chain
|
||||||
@@ -53,7 +54,7 @@ def get_cached_statement(blockchain_address: str) -> bytes:
|
|||||||
:rtype: str
|
:rtype: str
|
||||||
"""
|
"""
|
||||||
identifier = bytes.fromhex(strip_0x(blockchain_address))
|
identifier = bytes.fromhex(strip_0x(blockchain_address))
|
||||||
key = cache_data_key(identifier=identifier, salt=':cic.statement')
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.STATEMENT)
|
||||||
return get_cached_data(key=key)
|
return get_cached_data(key=key)
|
||||||
|
|
||||||
|
|
||||||
@@ -68,7 +69,8 @@ def parse_statement_transactions(statement: list):
|
|||||||
parsed_transactions = []
|
parsed_transactions = []
|
||||||
for transaction in statement:
|
for transaction in statement:
|
||||||
action_tag = transaction.get('action_tag')
|
action_tag = transaction.get('action_tag')
|
||||||
amount = from_wei(transaction.get('token_value'))
|
decimals = transaction.get('token_decimals')
|
||||||
|
amount = from_wei(decimals, transaction.get('token_value'))
|
||||||
direction_tag = transaction.get('direction_tag')
|
direction_tag = transaction.get('direction_tag')
|
||||||
token_symbol = transaction.get('token_symbol')
|
token_symbol = transaction.get('token_symbol')
|
||||||
metadata_id = transaction.get('metadata_id')
|
metadata_id = transaction.get('metadata_id')
|
||||||
|
|||||||
@@ -1,18 +1,115 @@
|
|||||||
# standard imports
|
# standard imports
|
||||||
|
import hashlib
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
from typing import Dict, Optional
|
from typing import Optional, Union
|
||||||
|
|
||||||
# external imports
|
# external imports
|
||||||
from cic_eth.api import Api
|
from cic_eth.api import Api
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
|
from cic_ussd.account.balance import get_cached_available_balance
|
||||||
from cic_ussd.account.chain import Chain
|
from cic_ussd.account.chain import Chain
|
||||||
from cic_ussd.cache import cache_data_key, get_cached_data
|
from cic_ussd.cache import cache_data, cache_data_key, get_cached_data
|
||||||
from cic_ussd.error import SeppukuError
|
from cic_ussd.error import CachedDataNotFoundError, SeppukuError
|
||||||
|
from cic_ussd.metadata.tokens import query_token_info, query_token_metadata
|
||||||
|
from cic_ussd.processor.util import wait_for_cache
|
||||||
|
from cic_ussd.translation import translation_for
|
||||||
|
|
||||||
|
logg = logging.getLogger(__file__)
|
||||||
|
|
||||||
|
|
||||||
logg = logging.getLogger(__name__)
|
def collate_token_metadata(token_info: dict, token_metadata: dict) -> dict:
|
||||||
|
"""
|
||||||
|
:param token_info:
|
||||||
|
:type token_info:
|
||||||
|
:param token_metadata:
|
||||||
|
:type token_metadata:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
logg.debug(f'Collating token info: {token_info} and token metadata: {token_metadata}')
|
||||||
|
description = token_info.get('description')
|
||||||
|
issuer = token_info.get('issuer')
|
||||||
|
location = token_metadata.get('location')
|
||||||
|
contact = token_metadata.get('contact')
|
||||||
|
return {
|
||||||
|
'description': description,
|
||||||
|
'issuer': issuer,
|
||||||
|
'location': location,
|
||||||
|
'contact': contact
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def create_account_tokens_list(blockchain_address: str):
|
||||||
|
"""
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
token_symbols_list = get_cached_token_symbol_list(blockchain_address=blockchain_address)
|
||||||
|
token_list_entries = []
|
||||||
|
if token_symbols_list:
|
||||||
|
logg.debug(f'Token symbols: {token_symbols_list} for account: {blockchain_address}')
|
||||||
|
for token_symbol in token_symbols_list:
|
||||||
|
entry = {}
|
||||||
|
logg.debug(f'Processing token data for: {token_symbol}')
|
||||||
|
key = cache_data_key([bytes.fromhex(blockchain_address), token_symbol.encode('utf-8')], MetadataPointer.TOKEN_DATA)
|
||||||
|
token_data = get_cached_data(key)
|
||||||
|
token_data = json.loads(token_data)
|
||||||
|
logg.debug(f'Retrieved token data: {token_data} for: {token_symbol}')
|
||||||
|
token_name = token_data.get('name')
|
||||||
|
entry['name'] = token_name
|
||||||
|
token_symbol = token_data.get('symbol')
|
||||||
|
entry['symbol'] = token_symbol
|
||||||
|
token_issuer = token_data.get('issuer')
|
||||||
|
entry['issuer'] = token_issuer
|
||||||
|
token_contact = token_data['contact'].get('phone')
|
||||||
|
entry['contact'] = token_contact
|
||||||
|
token_location = token_data.get('location')
|
||||||
|
entry['location'] = token_location
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
|
identifier = [bytes.fromhex(blockchain_address), token_symbol.encode('utf-8')]
|
||||||
|
wait_for_cache(identifier, f'Cached available balance for token: {token_symbol}', MetadataPointer.BALANCES)
|
||||||
|
token_balance = get_cached_available_balance(decimals=decimals, identifier=identifier)
|
||||||
|
entry['balance'] = token_balance
|
||||||
|
token_list_entries.append(entry)
|
||||||
|
account_tokens_list = order_account_tokens_list(token_list_entries, bytes.fromhex(blockchain_address))
|
||||||
|
key = cache_data_key(bytes.fromhex(blockchain_address), MetadataPointer.TOKEN_DATA_LIST)
|
||||||
|
cache_data(key, json.dumps(account_tokens_list))
|
||||||
|
|
||||||
|
|
||||||
|
def get_active_token_symbol(blockchain_address: str):
|
||||||
|
"""
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
identifier = bytes.fromhex(blockchain_address)
|
||||||
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_ACTIVE)
|
||||||
|
active_token_symbol = get_cached_data(key)
|
||||||
|
if not active_token_symbol:
|
||||||
|
raise CachedDataNotFoundError('No active token set.')
|
||||||
|
return active_token_symbol
|
||||||
|
|
||||||
|
|
||||||
|
def get_cached_token_data(blockchain_address: str, token_symbol: str):
|
||||||
|
"""
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:param token_symbol:
|
||||||
|
:type token_symbol:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
identifier = [bytes.fromhex(blockchain_address), token_symbol.encode('utf-8')]
|
||||||
|
key = cache_data_key(identifier, MetadataPointer.TOKEN_DATA)
|
||||||
|
logg.debug(f'Retrieving token data for: {token_symbol} at: {key}')
|
||||||
|
token_data = get_cached_data(key)
|
||||||
|
return json.loads(token_data)
|
||||||
|
|
||||||
|
|
||||||
def get_cached_default_token(chain_str: str) -> Optional[str]:
|
def get_cached_default_token(chain_str: str) -> Optional[str]:
|
||||||
@@ -23,7 +120,7 @@ def get_cached_default_token(chain_str: str) -> Optional[str]:
|
|||||||
:rtype:
|
:rtype:
|
||||||
"""
|
"""
|
||||||
logg.debug(f'Retrieving default token from cache for chain: {chain_str}')
|
logg.debug(f'Retrieving default token from cache for chain: {chain_str}')
|
||||||
key = cache_data_key(identifier=chain_str.encode('utf-8'), salt=':cic.default_token_data')
|
key = cache_data_key(identifier=chain_str.encode('utf-8'), salt=MetadataPointer.TOKEN_DEFAULT)
|
||||||
return get_cached_data(key=key)
|
return get_cached_data(key=key)
|
||||||
|
|
||||||
|
|
||||||
@@ -48,6 +145,132 @@ def get_default_token_symbol():
|
|||||||
raise SeppukuError(f'Could not retrieve default token for: {chain_str}')
|
raise SeppukuError(f'Could not retrieve default token for: {chain_str}')
|
||||||
|
|
||||||
|
|
||||||
|
def get_cached_token_symbol_list(blockchain_address: str) -> Optional[list]:
|
||||||
|
"""
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
key = cache_data_key(identifier=bytes.fromhex(blockchain_address), salt=MetadataPointer.TOKEN_SYMBOLS_LIST)
|
||||||
|
token_symbols_list = get_cached_data(key)
|
||||||
|
if token_symbols_list:
|
||||||
|
return json.loads(token_symbols_list)
|
||||||
|
return token_symbols_list
|
||||||
|
|
||||||
|
|
||||||
|
def get_cached_token_data_list(blockchain_address: str) -> Optional[list]:
|
||||||
|
"""
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
key = cache_data_key(bytes.fromhex(blockchain_address), MetadataPointer.TOKEN_DATA_LIST)
|
||||||
|
token_data_list = get_cached_data(key)
|
||||||
|
if token_data_list:
|
||||||
|
return json.loads(token_data_list)
|
||||||
|
return token_data_list
|
||||||
|
|
||||||
|
|
||||||
|
def handle_token_symbol_list(blockchain_address: str, token_symbol: str):
|
||||||
|
"""
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:param token_symbol:
|
||||||
|
:type token_symbol:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
token_symbol_list = get_cached_token_symbol_list(blockchain_address)
|
||||||
|
if token_symbol_list:
|
||||||
|
if token_symbol not in token_symbol_list:
|
||||||
|
token_symbol_list.append(token_symbol)
|
||||||
|
else:
|
||||||
|
token_symbol_list = [token_symbol]
|
||||||
|
|
||||||
|
identifier = bytes.fromhex(blockchain_address)
|
||||||
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_SYMBOLS_LIST)
|
||||||
|
data = json.dumps(token_symbol_list)
|
||||||
|
cache_data(key, data)
|
||||||
|
|
||||||
|
|
||||||
|
def hashed_token_proof(token_proof: Union[dict, str]) -> str:
|
||||||
|
"""
|
||||||
|
:param token_proof:
|
||||||
|
:type token_proof:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
if isinstance(token_proof, dict):
|
||||||
|
token_proof = json.dumps(token_proof)
|
||||||
|
logg.debug(f'Hashing token proof: {token_proof}')
|
||||||
|
hash_object = hashlib.new("sha256")
|
||||||
|
hash_object.update(token_proof.encode('utf-8'))
|
||||||
|
return hash_object.digest().hex()
|
||||||
|
|
||||||
|
|
||||||
|
def order_account_tokens_list(account_tokens_list: list, identifier: bytes) -> list:
|
||||||
|
"""
|
||||||
|
:param account_tokens_list:
|
||||||
|
:type account_tokens_list:
|
||||||
|
:param identifier:
|
||||||
|
:type identifier:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
ordered_tokens_list = []
|
||||||
|
# get last sent token
|
||||||
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_LAST_SENT)
|
||||||
|
last_sent_token_symbol = get_cached_data(key)
|
||||||
|
|
||||||
|
# get last received token
|
||||||
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_LAST_RECEIVED)
|
||||||
|
last_received_token_symbol = get_cached_data(key)
|
||||||
|
|
||||||
|
last_sent_token_data, remaining_accounts_token_list = remove_from_account_tokens_list(account_tokens_list, last_sent_token_symbol)
|
||||||
|
if last_sent_token_data:
|
||||||
|
ordered_tokens_list.append(last_sent_token_data[0])
|
||||||
|
|
||||||
|
last_received_token_data, remaining_accounts_token_list = remove_from_account_tokens_list(remaining_accounts_token_list, last_received_token_symbol)
|
||||||
|
if last_received_token_data:
|
||||||
|
ordered_tokens_list.append(last_received_token_data[0])
|
||||||
|
|
||||||
|
# order the by balance
|
||||||
|
ordered_by_balance = sorted(remaining_accounts_token_list, key=lambda d: d['balance'], reverse=True)
|
||||||
|
return ordered_tokens_list + ordered_by_balance
|
||||||
|
|
||||||
|
|
||||||
|
def parse_token_list(account_token_list: list):
|
||||||
|
parsed_token_list = []
|
||||||
|
for i in range(len(account_token_list)):
|
||||||
|
token_symbol = account_token_list[i].get('symbol')
|
||||||
|
token_balance = account_token_list[i].get('balance')
|
||||||
|
token_data_repr = f'{i+1}. {token_symbol} {token_balance}'
|
||||||
|
parsed_token_list.append(token_data_repr)
|
||||||
|
return parsed_token_list
|
||||||
|
|
||||||
|
|
||||||
|
def process_token_data(blockchain_address: str, token_symbol: str):
|
||||||
|
"""
|
||||||
|
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:param token_symbol:
|
||||||
|
:type token_symbol:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
logg.debug(f'Processing token data for token: {token_symbol}')
|
||||||
|
identifier = token_symbol.encode('utf-8')
|
||||||
|
query_token_metadata(identifier=identifier)
|
||||||
|
token_info = query_token_info(identifier=identifier)
|
||||||
|
hashed_token_info = hashed_token_proof(token_proof=token_info)
|
||||||
|
query_token_data(blockchain_address=blockchain_address,
|
||||||
|
hashed_proofs=[hashed_token_info],
|
||||||
|
token_symbols=[token_symbol])
|
||||||
|
|
||||||
|
|
||||||
def query_default_token(chain_str: str):
|
def query_default_token(chain_str: str):
|
||||||
"""This function synchronously queries cic-eth for the deployed system's default token.
|
"""This function synchronously queries cic-eth for the deployed system's default token.
|
||||||
:param chain_str: Chain name and network id.
|
:param chain_str: Chain name and network id.
|
||||||
@@ -59,3 +282,60 @@ def query_default_token(chain_str: str):
|
|||||||
cic_eth_api = Api(chain_str=chain_str)
|
cic_eth_api = Api(chain_str=chain_str)
|
||||||
default_token_request_task = cic_eth_api.default_token()
|
default_token_request_task = cic_eth_api.default_token()
|
||||||
return default_token_request_task.get()
|
return default_token_request_task.get()
|
||||||
|
|
||||||
|
|
||||||
|
def query_token_data(blockchain_address: str, hashed_proofs: list, token_symbols: list):
|
||||||
|
""""""
|
||||||
|
logg.debug(f'Retrieving token metadata for tokens: {", ".join(token_symbols)}')
|
||||||
|
api = Api(callback_param=blockchain_address,
|
||||||
|
callback_queue='cic-ussd',
|
||||||
|
chain_str=Chain.spec.__str__(),
|
||||||
|
callback_task='cic_ussd.tasks.callback_handler.token_data_callback')
|
||||||
|
api.tokens(token_symbols=token_symbols, proof=hashed_proofs)
|
||||||
|
|
||||||
|
|
||||||
|
def remove_from_account_tokens_list(account_tokens_list: list, token_symbol: str):
|
||||||
|
"""
|
||||||
|
:param account_tokens_list:
|
||||||
|
:type account_tokens_list:
|
||||||
|
:param token_symbol:
|
||||||
|
:type token_symbol:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
removed_token_data = []
|
||||||
|
for i in range(len(account_tokens_list)):
|
||||||
|
if account_tokens_list[i]['symbol'] == token_symbol:
|
||||||
|
removed_token_data.append(account_tokens_list[i])
|
||||||
|
del account_tokens_list[i]
|
||||||
|
break
|
||||||
|
return removed_token_data, account_tokens_list
|
||||||
|
|
||||||
|
|
||||||
|
def set_active_token(blockchain_address: str, token_symbol: str):
|
||||||
|
"""
|
||||||
|
:param blockchain_address:
|
||||||
|
:type blockchain_address:
|
||||||
|
:param token_symbol:
|
||||||
|
:type token_symbol:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
logg.info(f'Active token set to: {token_symbol}')
|
||||||
|
key = cache_data_key(identifier=bytes.fromhex(blockchain_address), salt=MetadataPointer.TOKEN_ACTIVE)
|
||||||
|
cache_data(key=key, data=token_symbol)
|
||||||
|
|
||||||
|
|
||||||
|
def token_list_set(preferred_language: str, token_data_reprs: list):
|
||||||
|
"""
|
||||||
|
:param preferred_language:
|
||||||
|
:type preferred_language:
|
||||||
|
:param token_data_reprs:
|
||||||
|
:type token_data_reprs:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
if not token_data_reprs:
|
||||||
|
return translation_for('helpers.no_tokens_list', preferred_language)
|
||||||
|
return ''.join(f'{token_data_repr}\n' for token_data_repr in token_data_reprs)
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
# standard import
|
# standard import
|
||||||
import decimal
|
|
||||||
import json
|
|
||||||
import logging
|
import logging
|
||||||
|
from math import trunc
|
||||||
from typing import Dict, Tuple
|
from typing import Dict, Tuple
|
||||||
|
|
||||||
# external import
|
# external import
|
||||||
@@ -9,8 +8,6 @@ from cic_eth.api import Api
|
|||||||
from sqlalchemy.orm.session import Session
|
from sqlalchemy.orm.session import Session
|
||||||
|
|
||||||
# local import
|
# local import
|
||||||
from cic_ussd.account.chain import Chain
|
|
||||||
from cic_ussd.account.tokens import get_cached_default_token
|
|
||||||
from cic_ussd.db.models.account import Account
|
from cic_ussd.db.models.account import Account
|
||||||
from cic_ussd.db.models.base import SessionBase
|
from cic_ussd.db.models.base import SessionBase
|
||||||
from cic_ussd.error import UnknownUssdRecipient
|
from cic_ussd.error import UnknownUssdRecipient
|
||||||
@@ -55,32 +52,32 @@ def aux_transaction_data(preferred_language: str, transaction: dict) -> dict:
|
|||||||
return transaction
|
return transaction
|
||||||
|
|
||||||
|
|
||||||
def from_wei(value: int) -> float:
|
def from_wei(decimals: int, value: int) -> float:
|
||||||
"""This function converts values in Wei to a token in the cic network.
|
"""This function converts values in Wei to a token in the cic network.
|
||||||
|
:param decimals: The decimals required for wei values.
|
||||||
|
:type decimals: int
|
||||||
:param value: Value in Wei
|
:param value: Value in Wei
|
||||||
:type value: int
|
:type value: int
|
||||||
:return: SRF equivalent of value in Wei
|
:return: SRF equivalent of value in Wei
|
||||||
:rtype: float
|
:rtype: float
|
||||||
"""
|
"""
|
||||||
cached_token_data = json.loads(get_cached_default_token(Chain.spec.__str__()))
|
value = float(value) / (10**decimals)
|
||||||
token_decimals: int = cached_token_data.get('decimals')
|
|
||||||
value = float(value) / (10**token_decimals)
|
|
||||||
return truncate(value=value, decimals=2)
|
return truncate(value=value, decimals=2)
|
||||||
|
|
||||||
|
|
||||||
def to_wei(value: int) -> int:
|
def to_wei(decimals: int, value: int) -> int:
|
||||||
"""This functions converts values from a token in the cic network to Wei.
|
"""This functions converts values from a token in the cic network to Wei.
|
||||||
|
:param decimals: The decimals required for wei values.
|
||||||
|
:type decimals: int
|
||||||
:param value: Value in SRF
|
:param value: Value in SRF
|
||||||
:type value: int
|
:type value: int
|
||||||
:return: Wei equivalent of value in SRF
|
:return: Wei equivalent of value in SRF
|
||||||
:rtype: int
|
:rtype: int
|
||||||
"""
|
"""
|
||||||
cached_token_data = json.loads(get_cached_default_token(Chain.spec.__str__()))
|
return int(value * (10**decimals))
|
||||||
token_decimals: int = cached_token_data.get('decimals')
|
|
||||||
return int(value * (10**token_decimals))
|
|
||||||
|
|
||||||
|
|
||||||
def truncate(value: float, decimals: int):
|
def truncate(value: float, decimals: int) -> float:
|
||||||
"""This function truncates a value to a specified number of decimals places.
|
"""This function truncates a value to a specified number of decimals places.
|
||||||
:param value: The value to be truncated.
|
:param value: The value to be truncated.
|
||||||
:type value: float
|
:type value: float
|
||||||
@@ -89,9 +86,8 @@ def truncate(value: float, decimals: int):
|
|||||||
:return: The truncated value.
|
:return: The truncated value.
|
||||||
:rtype: int
|
:rtype: int
|
||||||
"""
|
"""
|
||||||
decimal.getcontext().rounding = decimal.ROUND_DOWN
|
stepper = 10.0**decimals
|
||||||
contextualized_value = decimal.Decimal(value)
|
return trunc(stepper*value) / stepper
|
||||||
return round(contextualized_value, decimals)
|
|
||||||
|
|
||||||
|
|
||||||
def transaction_actors(transaction: dict) -> Tuple[Dict, Dict]:
|
def transaction_actors(transaction: dict) -> Tuple[Dict, Dict]:
|
||||||
@@ -104,14 +100,17 @@ def transaction_actors(transaction: dict) -> Tuple[Dict, Dict]:
|
|||||||
"""
|
"""
|
||||||
destination_token_symbol = transaction.get('destination_token_symbol')
|
destination_token_symbol = transaction.get('destination_token_symbol')
|
||||||
destination_token_value = transaction.get('destination_token_value') or transaction.get('to_value')
|
destination_token_value = transaction.get('destination_token_value') or transaction.get('to_value')
|
||||||
|
destination_token_decimals = transaction.get('destination_token_decimals')
|
||||||
recipient_blockchain_address = transaction.get('recipient')
|
recipient_blockchain_address = transaction.get('recipient')
|
||||||
sender_blockchain_address = transaction.get('sender')
|
sender_blockchain_address = transaction.get('sender')
|
||||||
source_token_symbol = transaction.get('source_token_symbol')
|
source_token_symbol = transaction.get('source_token_symbol')
|
||||||
source_token_value = transaction.get('source_token_value') or transaction.get('from_value')
|
source_token_value = transaction.get('source_token_value') or transaction.get('from_value')
|
||||||
|
source_token_decimals = transaction.get('source_token_decimals')
|
||||||
|
|
||||||
recipient_transaction_data = {
|
recipient_transaction_data = {
|
||||||
"token_symbol": destination_token_symbol,
|
"token_symbol": destination_token_symbol,
|
||||||
"token_value": destination_token_value,
|
"token_value": destination_token_value,
|
||||||
|
"token_decimals": destination_token_decimals,
|
||||||
"blockchain_address": recipient_blockchain_address,
|
"blockchain_address": recipient_blockchain_address,
|
||||||
"role": "recipient",
|
"role": "recipient",
|
||||||
}
|
}
|
||||||
@@ -119,6 +118,7 @@ def transaction_actors(transaction: dict) -> Tuple[Dict, Dict]:
|
|||||||
"blockchain_address": sender_blockchain_address,
|
"blockchain_address": sender_blockchain_address,
|
||||||
"token_symbol": source_token_symbol,
|
"token_symbol": source_token_symbol,
|
||||||
"token_value": source_token_value,
|
"token_value": source_token_value,
|
||||||
|
"token_decimals": source_token_decimals,
|
||||||
"role": "sender",
|
"role": "sender",
|
||||||
}
|
}
|
||||||
return recipient_transaction_data, sender_transaction_data
|
return recipient_transaction_data, sender_transaction_data
|
||||||
@@ -166,14 +166,16 @@ class OutgoingTransaction:
|
|||||||
self.from_address = from_address
|
self.from_address = from_address
|
||||||
self.to_address = to_address
|
self.to_address = to_address
|
||||||
|
|
||||||
def transfer(self, amount: int, token_symbol: str):
|
def transfer(self, amount: int, decimals: int, token_symbol: str):
|
||||||
"""This function initiates standard transfers between one account to another
|
"""This function initiates standard transfers between one account to another
|
||||||
:param amount: The amount of tokens to be sent
|
:param amount: The amount of tokens to be sent
|
||||||
:type amount: int
|
:type amount: int
|
||||||
|
:param decimals: The decimals for the token being transferred.
|
||||||
|
:type decimals: int
|
||||||
:param token_symbol: ERC20 token symbol of token to send
|
:param token_symbol: ERC20 token symbol of token to send
|
||||||
:type token_symbol: str
|
:type token_symbol: str
|
||||||
"""
|
"""
|
||||||
self.cic_eth_api.transfer(from_address=self.from_address,
|
self.cic_eth_api.transfer(from_address=self.from_address,
|
||||||
to_address=self.to_address,
|
to_address=self.to_address,
|
||||||
value=to_wei(value=amount),
|
value=to_wei(decimals=decimals, value=amount),
|
||||||
token_symbol=token_symbol)
|
token_symbol=token_symbol)
|
||||||
|
|||||||
@@ -1,11 +1,13 @@
|
|||||||
# standard imports
|
# standard imports
|
||||||
import hashlib
|
import hashlib
|
||||||
import logging
|
import logging
|
||||||
|
from typing import Union
|
||||||
|
|
||||||
# third-party imports
|
# external imports
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
from redis import Redis
|
from redis import Redis
|
||||||
|
|
||||||
logg = logging.getLogger()
|
logg = logging.getLogger(__file__)
|
||||||
|
|
||||||
|
|
||||||
class Cache:
|
class Cache:
|
||||||
@@ -38,7 +40,7 @@ def get_cached_data(key: str):
|
|||||||
return cache.get(name=key)
|
return cache.get(name=key)
|
||||||
|
|
||||||
|
|
||||||
def cache_data_key(identifier: bytes, salt: str):
|
def cache_data_key(identifier: Union[list, bytes], salt: MetadataPointer):
|
||||||
"""
|
"""
|
||||||
:param identifier:
|
:param identifier:
|
||||||
:type identifier:
|
:type identifier:
|
||||||
@@ -48,6 +50,10 @@ def cache_data_key(identifier: bytes, salt: str):
|
|||||||
:rtype:
|
:rtype:
|
||||||
"""
|
"""
|
||||||
hash_object = hashlib.new("sha256")
|
hash_object = hashlib.new("sha256")
|
||||||
hash_object.update(identifier)
|
if isinstance(identifier, list):
|
||||||
hash_object.update(salt.encode(encoding="utf-8"))
|
for identity in identifier:
|
||||||
|
hash_object.update(identity)
|
||||||
|
else:
|
||||||
|
hash_object.update(identifier)
|
||||||
|
hash_object.update(salt.value.encode(encoding="utf-8"))
|
||||||
return hash_object.digest().hex()
|
return hash_object.digest().hex()
|
||||||
|
|||||||
@@ -24,6 +24,8 @@ def upgrade():
|
|||||||
sa.Column('preferred_language', sa.String(), nullable=True),
|
sa.Column('preferred_language', sa.String(), nullable=True),
|
||||||
sa.Column('password_hash', sa.String(), nullable=True),
|
sa.Column('password_hash', sa.String(), nullable=True),
|
||||||
sa.Column('failed_pin_attempts', sa.Integer(), nullable=False),
|
sa.Column('failed_pin_attempts', sa.Integer(), nullable=False),
|
||||||
|
sa.Column('guardians', sa.String(), nullable=True),
|
||||||
|
sa.Column('guardian_quora', sa.Integer(), nullable=False),
|
||||||
sa.Column('status', sa.Integer(), nullable=False),
|
sa.Column('status', sa.Integer(), nullable=False),
|
||||||
sa.Column('created', sa.DateTime(), nullable=False),
|
sa.Column('created', sa.DateTime(), nullable=False),
|
||||||
sa.Column('updated', sa.DateTime(), nullable=False),
|
sa.Column('updated', sa.DateTime(), nullable=False),
|
||||||
|
|||||||
@@ -3,6 +3,9 @@ import json
|
|||||||
|
|
||||||
# external imports
|
# external imports
|
||||||
from cic_eth.api import Api
|
from cic_eth.api import Api
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
from sqlalchemy import Column, Integer, String
|
||||||
|
from sqlalchemy.orm.session import Session
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.metadata import get_cached_preferred_language, parse_account_metadata
|
from cic_ussd.account.metadata import get_cached_preferred_language, parse_account_metadata
|
||||||
@@ -11,8 +14,9 @@ from cic_ussd.db.enum import AccountStatus
|
|||||||
from cic_ussd.db.models.base import SessionBase
|
from cic_ussd.db.models.base import SessionBase
|
||||||
from cic_ussd.db.models.task_tracker import TaskTracker
|
from cic_ussd.db.models.task_tracker import TaskTracker
|
||||||
from cic_ussd.encoder import check_password_hash, create_password_hash
|
from cic_ussd.encoder import check_password_hash, create_password_hash
|
||||||
from sqlalchemy import Column, Integer, String
|
from cic_ussd.phone_number import Support
|
||||||
from sqlalchemy.orm.session import Session
|
|
||||||
|
support_phone = Support.phone_number
|
||||||
|
|
||||||
|
|
||||||
class Account(SessionBase):
|
class Account(SessionBase):
|
||||||
@@ -28,12 +32,16 @@ class Account(SessionBase):
|
|||||||
failed_pin_attempts = Column(Integer)
|
failed_pin_attempts = Column(Integer)
|
||||||
status = Column(Integer)
|
status = Column(Integer)
|
||||||
preferred_language = Column(String)
|
preferred_language = Column(String)
|
||||||
|
guardians = Column(String)
|
||||||
|
guardian_quora = Column(Integer)
|
||||||
|
|
||||||
def __init__(self, blockchain_address, phone_number):
|
def __init__(self, blockchain_address, phone_number):
|
||||||
self.blockchain_address = blockchain_address
|
self.blockchain_address = blockchain_address
|
||||||
self.phone_number = phone_number
|
self.phone_number = phone_number
|
||||||
self.password_hash = None
|
self.password_hash = None
|
||||||
self.failed_pin_attempts = 0
|
self.failed_pin_attempts = 0
|
||||||
|
# self.guardians = f'{support_phone}' if support_phone else None
|
||||||
|
self.guardian_quora = 1
|
||||||
self.status = AccountStatus.PENDING.value
|
self.status = AccountStatus.PENDING.value
|
||||||
|
|
||||||
def __repr__(self):
|
def __repr__(self):
|
||||||
@@ -44,6 +52,28 @@ class Account(SessionBase):
|
|||||||
self.failed_pin_attempts = 0
|
self.failed_pin_attempts = 0
|
||||||
self.status = AccountStatus.ACTIVE.value
|
self.status = AccountStatus.ACTIVE.value
|
||||||
|
|
||||||
|
def add_guardian(self, phone_number: str):
|
||||||
|
set_guardians = phone_number
|
||||||
|
if self.guardians:
|
||||||
|
set_guardians = self.guardians.split(',')
|
||||||
|
set_guardians.append(phone_number)
|
||||||
|
','.join(set_guardians)
|
||||||
|
self.guardians = set_guardians
|
||||||
|
|
||||||
|
def remove_guardian(self, phone_number: str):
|
||||||
|
set_guardians = self.guardians.split(',')
|
||||||
|
set_guardians.remove(phone_number)
|
||||||
|
if len(set_guardians) > 1:
|
||||||
|
self.guardians = ','.join(set_guardians)
|
||||||
|
else:
|
||||||
|
self.guardians = set_guardians[0]
|
||||||
|
|
||||||
|
def get_guardians(self) -> list:
|
||||||
|
return self.guardians.split(',') if self.guardians else []
|
||||||
|
|
||||||
|
def set_guardian_quora(self, quora: int):
|
||||||
|
self.guardian_quora = quora
|
||||||
|
|
||||||
def create_password(self, password):
|
def create_password(self, password):
|
||||||
"""This method takes a password value and hashes the value before assigning it to the corresponding
|
"""This method takes a password value and hashes the value before assigning it to the corresponding
|
||||||
`hashed_password` attribute in the user record.
|
`hashed_password` attribute in the user record.
|
||||||
@@ -109,7 +139,7 @@ class Account(SessionBase):
|
|||||||
:rtype: str
|
:rtype: str
|
||||||
"""
|
"""
|
||||||
identifier = bytes.fromhex(self.blockchain_address)
|
identifier = bytes.fromhex(self.blockchain_address)
|
||||||
key = cache_data_key(identifier, ':cic.person')
|
key = cache_data_key(identifier, MetadataPointer.PERSON)
|
||||||
account_metadata = get_cached_data(key)
|
account_metadata = get_cached_data(key)
|
||||||
if not account_metadata:
|
if not account_metadata:
|
||||||
return self.phone_number
|
return self.phone_number
|
||||||
|
|||||||
@@ -287,7 +287,132 @@
|
|||||||
"display_key": "ussd.kenya.dob_edit_pin_authorization",
|
"display_key": "ussd.kenya.dob_edit_pin_authorization",
|
||||||
"name": "dob_edit_pin_authorization",
|
"name": "dob_edit_pin_authorization",
|
||||||
"parent": "metadata_management"
|
"parent": "metadata_management"
|
||||||
|
},
|
||||||
|
"49": {
|
||||||
|
"description": "Menu to display first set of tokens in the account's token list.",
|
||||||
|
"display_key": "ussd.kenya.first_account_tokens_set",
|
||||||
|
"name": "first_account_tokens_set",
|
||||||
|
"parent": null
|
||||||
|
},
|
||||||
|
"50": {
|
||||||
|
"description": "Menu to display middle set of tokens in the account's token list.",
|
||||||
|
"display_key": "ussd.kenya.middle_account_tokens_set",
|
||||||
|
"name": "middle_account_tokens_set",
|
||||||
|
"parent": null
|
||||||
|
},
|
||||||
|
"51": {
|
||||||
|
"description": "Menu to display last set of tokens in the account's token list.",
|
||||||
|
"display_key": "ussd.kenya.last_account_tokens_set",
|
||||||
|
"name": "last_account_tokens_set",
|
||||||
|
"parent": null
|
||||||
|
},
|
||||||
|
"52": {
|
||||||
|
"description": "Pin entry menu for setting an active token.",
|
||||||
|
"display_key": "ussd.kenya.token_selection_pin_authorization",
|
||||||
|
"name": "token_selection_pin_authorization",
|
||||||
|
"parent": null
|
||||||
|
},
|
||||||
|
"53": {
|
||||||
|
"description": "Exit following a successful active token setting.",
|
||||||
|
"display_key": "ussd.kenya.exit_successful_token_selection",
|
||||||
|
"name": "exit_successful_token_selection",
|
||||||
|
"parent": null
|
||||||
|
},
|
||||||
|
"54": {
|
||||||
|
"description": "Pin management menu for operations related to an account's pin.",
|
||||||
|
"display_key": "ussd.kenya.pin_management",
|
||||||
|
"name": "pin_management",
|
||||||
|
"parent": "start"
|
||||||
|
},
|
||||||
|
"55": {
|
||||||
|
"description": "Phone number entry for account whose pin is being reset.",
|
||||||
|
"display_key": "ussd.kenya.reset_guarded_pin",
|
||||||
|
"name": "reset_guarded_pin",
|
||||||
|
"parent": "pin_management"
|
||||||
|
},
|
||||||
|
"56": {
|
||||||
|
"description": "Pin entry for initiating request to reset an account's pin.",
|
||||||
|
"display_key": "ussd.kenya.reset_guarded_pin_authorization",
|
||||||
|
"name": "reset_guarded_pin_authorization",
|
||||||
|
"parent": "pin_management"
|
||||||
|
},
|
||||||
|
"57": {
|
||||||
|
"description": "Exit menu following successful pin reset initiation.",
|
||||||
|
"display_key": "ussd.kenya.exit_pin_reset_initiated_success",
|
||||||
|
"name": "exit_pin_reset_initiated_success",
|
||||||
|
"parent": "pin_management"
|
||||||
|
},
|
||||||
|
"58": {
|
||||||
|
"description": "Exit menu in the event that an account is not a set guardian.",
|
||||||
|
"display_key": "ussd.kenya.exit_not_authorized_for_pin_reset",
|
||||||
|
"name": "exit_not_authorized_for_pin_reset",
|
||||||
|
"parent": "pin_management"
|
||||||
|
},
|
||||||
|
"59": {
|
||||||
|
"description": "Pin guard menu for handling guardianship operations.",
|
||||||
|
"display_key": "ussd.kenya.guard_pin",
|
||||||
|
"name": "guard_pin",
|
||||||
|
"parent": "pin_management"
|
||||||
|
},
|
||||||
|
"60": {
|
||||||
|
"description": "Pin entry to display a list of set guardians.",
|
||||||
|
"display_key": "ussd.kenya.guardian_list_pin_authorization",
|
||||||
|
"name": "guardian_list_pin_authorization",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"61": {
|
||||||
|
"description": "Menu to display list of set guardians.",
|
||||||
|
"display_key": "ussd.kenya.guardian_list",
|
||||||
|
"name": "guardian_list",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"62": {
|
||||||
|
"description": "Phone number entry to add an account as a guardian to reset pin.",
|
||||||
|
"display_key": "ussd.kenya.add_guardian",
|
||||||
|
"name": "add_guardian",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"63": {
|
||||||
|
"description": "Pin entry to confirm addition of an account as a guardian.",
|
||||||
|
"display_key": "ussd.kenya.add_guardian_pin_authorization",
|
||||||
|
"name": "add_guardian_pin_authorization",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"64": {
|
||||||
|
"description": "Exit menu when an account is successfully added as pin reset guardian.",
|
||||||
|
"display_key": "ussd.kenya.exit_guardian_addition_success",
|
||||||
|
"name": "exit_guardian_addition_success",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"65": {
|
||||||
|
"description": "Phone number entry to remove an account as a guardian to reset pin.",
|
||||||
|
"display_key": "ussd.kenya.remove_guardian",
|
||||||
|
"name": "remove_guardian",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"66": {
|
||||||
|
"description": "Pin entry to confirm removal of an account as a guardian.",
|
||||||
|
"display_key": "ussd.kenya.remove_guardian_pin_authorization",
|
||||||
|
"name": "remove_guardian_pin_authorization",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"67": {
|
||||||
|
"description": "Exit menu when an account is successfully removed as pin reset guardian.",
|
||||||
|
"display_key": "ussd.kenya.exit_guardian_removal_success",
|
||||||
|
"name": "exit_guardian_removal_success",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"68": {
|
||||||
|
"description": "Exit menu when invalid phone number entry for guardian addition. ",
|
||||||
|
"display_key": "ussd.kenya.exit_invalid_guardian_addition",
|
||||||
|
"name": "exit_invalid_guardian_addition",
|
||||||
|
"parent": "guard_pin"
|
||||||
|
},
|
||||||
|
"69": {
|
||||||
|
"description": "Exit menu when invalid phone number entry for guardian removal. ",
|
||||||
|
"display_key": "ussd.kenya.exit_invalid_guardian_removal",
|
||||||
|
"name": "exit_invalid_guardian_removal",
|
||||||
|
"parent": "guard_pin"
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -13,7 +13,7 @@ logg = logging.getLogger(__file__)
|
|||||||
|
|
||||||
|
|
||||||
class UssdMetadataHandler(MetadataRequestsHandler):
|
class UssdMetadataHandler(MetadataRequestsHandler):
|
||||||
def __init__(self, cic_type: MetadataPointer, identifier: bytes):
|
def __init__(self, identifier: bytes, cic_type: MetadataPointer = None):
|
||||||
super().__init__(cic_type, identifier)
|
super().__init__(cic_type, identifier)
|
||||||
|
|
||||||
def cache_metadata(self, data: str):
|
def cache_metadata(self, data: str):
|
||||||
|
|||||||
54
apps/cic-ussd/cic_ussd/metadata/tokens.py
Normal file
54
apps/cic-ussd/cic_ussd/metadata/tokens.py
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
# standard imports
|
||||||
|
from typing import Dict, Optional
|
||||||
|
|
||||||
|
# external imports
|
||||||
|
import json
|
||||||
|
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
|
||||||
|
# local imports
|
||||||
|
from .base import UssdMetadataHandler
|
||||||
|
from cic_ussd.cache import cache_data
|
||||||
|
from cic_ussd.error import MetadataNotFoundError
|
||||||
|
|
||||||
|
|
||||||
|
class TokenMetadata(UssdMetadataHandler):
|
||||||
|
def __init__(self, identifier: bytes, **kwargs):
|
||||||
|
super(TokenMetadata, self).__init__(identifier=identifier, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
def token_metadata_handler(metadata_client: TokenMetadata) -> Optional[Dict]:
|
||||||
|
"""
|
||||||
|
:param metadata_client:
|
||||||
|
:type metadata_client:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
result = metadata_client.query()
|
||||||
|
token_metadata = result.json()
|
||||||
|
if not token_metadata:
|
||||||
|
raise MetadataNotFoundError(f'No metadata found at: {metadata_client.metadata_pointer} for: {metadata_client.identifier.decode("utf-8")}')
|
||||||
|
cache_data(metadata_client.metadata_pointer, json.dumps(token_metadata))
|
||||||
|
return token_metadata
|
||||||
|
|
||||||
|
|
||||||
|
def query_token_metadata(identifier: bytes):
|
||||||
|
"""
|
||||||
|
:param identifier:
|
||||||
|
:type identifier:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
token_metadata_client = TokenMetadata(identifier=identifier, cic_type=MetadataPointer.TOKEN_META_SYMBOL)
|
||||||
|
return token_metadata_handler(token_metadata_client)
|
||||||
|
|
||||||
|
|
||||||
|
def query_token_info(identifier: bytes):
|
||||||
|
"""
|
||||||
|
:param identifier:
|
||||||
|
:type identifier:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
token_info_client = TokenMetadata(identifier=identifier, cic_type=MetadataPointer.TOKEN_PROOF_SYMBOL)
|
||||||
|
return token_metadata_handler(token_info_client)
|
||||||
@@ -5,7 +5,6 @@ from typing import Optional
|
|||||||
import phonenumbers
|
import phonenumbers
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.db.models.account import Account
|
|
||||||
|
|
||||||
|
|
||||||
class E164Format:
|
class E164Format:
|
||||||
|
|||||||
@@ -5,9 +5,11 @@ from datetime import datetime, timedelta
|
|||||||
|
|
||||||
# external imports
|
# external imports
|
||||||
import i18n.config
|
import i18n.config
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.balance import (calculate_available_balance,
|
from cic_ussd.account.balance import (calculate_available_balance,
|
||||||
|
get_account_tokens_balance,
|
||||||
get_adjusted_balance,
|
get_adjusted_balance,
|
||||||
get_balances,
|
get_balances,
|
||||||
get_cached_adjusted_balance,
|
get_cached_adjusted_balance,
|
||||||
@@ -20,13 +22,20 @@ from cic_ussd.account.statement import (
|
|||||||
query_statement,
|
query_statement,
|
||||||
statement_transaction_set
|
statement_transaction_set
|
||||||
)
|
)
|
||||||
from cic_ussd.account.tokens import get_default_token_symbol
|
from cic_ussd.account.tokens import (create_account_tokens_list,
|
||||||
|
get_active_token_symbol,
|
||||||
|
get_cached_token_data,
|
||||||
|
get_cached_token_symbol_list,
|
||||||
|
get_cached_token_data_list,
|
||||||
|
parse_token_list,
|
||||||
|
token_list_set)
|
||||||
from cic_ussd.account.transaction import from_wei, to_wei
|
from cic_ussd.account.transaction import from_wei, to_wei
|
||||||
from cic_ussd.cache import cache_data_key, cache_data
|
from cic_ussd.cache import cache_data_key, cache_data
|
||||||
from cic_ussd.db.models.account import Account
|
from cic_ussd.db.models.account import Account
|
||||||
from cic_ussd.metadata import PersonMetadata
|
from cic_ussd.metadata import PersonMetadata
|
||||||
from cic_ussd.phone_number import Support
|
from cic_ussd.phone_number import Support
|
||||||
from cic_ussd.processor.util import parse_person_metadata
|
from cic_ussd.processor.util import parse_person_metadata
|
||||||
|
from cic_ussd.session.ussd_session import save_session_data
|
||||||
from cic_ussd.translation import translation_for
|
from cic_ussd.translation import translation_for
|
||||||
from sqlalchemy.orm.session import Session
|
from sqlalchemy.orm.session import Session
|
||||||
|
|
||||||
@@ -47,22 +56,27 @@ class MenuProcessor:
|
|||||||
:return:
|
:return:
|
||||||
:rtype:
|
:rtype:
|
||||||
"""
|
"""
|
||||||
available_balance = get_cached_available_balance(self.account.blockchain_address)
|
|
||||||
adjusted_balance = get_cached_adjusted_balance(self.identifier)
|
adjusted_balance = get_cached_adjusted_balance(self.identifier)
|
||||||
token_symbol = get_default_token_symbol()
|
token_symbol = get_active_token_symbol(self.account.blockchain_address)
|
||||||
|
token_data = get_cached_token_data(self.account.blockchain_address, token_symbol)
|
||||||
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
if not preferred_language:
|
if not preferred_language:
|
||||||
preferred_language = i18n.config.get('fallback')
|
preferred_language = i18n.config.get('fallback')
|
||||||
with_available_balance = f'{self.display_key}.available_balance'
|
with_available_balance = f'{self.display_key}.available_balance'
|
||||||
with_fees = f'{self.display_key}.with_fees'
|
with_fees = f'{self.display_key}.with_fees'
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
|
available_balance = get_cached_available_balance(decimals, [self.identifier, token_symbol.encode('utf-8')])
|
||||||
if not adjusted_balance:
|
if not adjusted_balance:
|
||||||
return translation_for(key=with_available_balance,
|
return translation_for(key=with_available_balance,
|
||||||
preferred_language=preferred_language,
|
preferred_language=preferred_language,
|
||||||
available_balance=available_balance,
|
available_balance=available_balance,
|
||||||
token_symbol=token_symbol)
|
token_symbol=token_symbol)
|
||||||
|
|
||||||
adjusted_balance = json.loads(adjusted_balance)
|
adjusted_balance = json.loads(adjusted_balance)
|
||||||
tax_wei = to_wei(int(available_balance)) - int(adjusted_balance)
|
|
||||||
tax = from_wei(int(tax_wei))
|
tax_wei = to_wei(decimals, int(available_balance)) - int(adjusted_balance)
|
||||||
|
tax = from_wei(decimals, int(tax_wei))
|
||||||
return translation_for(key=with_fees,
|
return translation_for(key=with_fees,
|
||||||
preferred_language=preferred_language,
|
preferred_language=preferred_language,
|
||||||
available_balance=available_balance,
|
available_balance=available_balance,
|
||||||
@@ -75,21 +89,25 @@ class MenuProcessor:
|
|||||||
:rtype:
|
:rtype:
|
||||||
"""
|
"""
|
||||||
cached_statement = get_cached_statement(self.account.blockchain_address)
|
cached_statement = get_cached_statement(self.account.blockchain_address)
|
||||||
statement = json.loads(cached_statement)
|
transaction_sets = []
|
||||||
statement_transactions = parse_statement_transactions(statement)
|
if cached_statement:
|
||||||
transaction_sets = [statement_transactions[tx:tx + 3] for tx in range(0, len(statement_transactions), 3)]
|
statement = json.loads(cached_statement)
|
||||||
|
statement_transactions = parse_statement_transactions(statement)
|
||||||
|
transaction_sets = [statement_transactions[tx:tx + 3] for tx in range(0, len(statement_transactions), 3)]
|
||||||
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
if not preferred_language:
|
if not preferred_language:
|
||||||
preferred_language = i18n.config.get('fallback')
|
preferred_language = i18n.config.get('fallback')
|
||||||
first_transaction_set = []
|
no_transaction_history = statement_transaction_set(preferred_language, transaction_sets)
|
||||||
middle_transaction_set = []
|
first_transaction_set = no_transaction_history
|
||||||
last_transaction_set = []
|
middle_transaction_set = no_transaction_history
|
||||||
|
last_transaction_set = no_transaction_history
|
||||||
if transaction_sets:
|
if transaction_sets:
|
||||||
first_transaction_set = statement_transaction_set(preferred_language, transaction_sets[0])
|
first_transaction_set = statement_transaction_set(preferred_language, transaction_sets[0])
|
||||||
if len(transaction_sets) >= 2:
|
if len(transaction_sets) >= 2:
|
||||||
middle_transaction_set = statement_transaction_set(preferred_language, transaction_sets[1])
|
middle_transaction_set = statement_transaction_set(preferred_language, transaction_sets[1])
|
||||||
if len(transaction_sets) >= 3:
|
if len(transaction_sets) >= 3:
|
||||||
last_transaction_set = statement_transaction_set(preferred_language, transaction_sets[2])
|
last_transaction_set = statement_transaction_set(preferred_language, transaction_sets[2])
|
||||||
|
|
||||||
if self.display_key == 'ussd.kenya.first_transaction_set':
|
if self.display_key == 'ussd.kenya.first_transaction_set':
|
||||||
return translation_for(
|
return translation_for(
|
||||||
self.display_key, preferred_language, first_transaction_set=first_transaction_set
|
self.display_key, preferred_language, first_transaction_set=first_transaction_set
|
||||||
@@ -103,7 +121,63 @@ class MenuProcessor:
|
|||||||
self.display_key, preferred_language, last_transaction_set=last_transaction_set
|
self.display_key, preferred_language, last_transaction_set=last_transaction_set
|
||||||
)
|
)
|
||||||
|
|
||||||
def help(self):
|
def add_guardian_pin_authorization(self):
|
||||||
|
guardian_information = self.guardian_metadata()
|
||||||
|
return self.pin_authorization(guardian_information=guardian_information)
|
||||||
|
|
||||||
|
def guardian_list(self):
|
||||||
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
set_guardians = self.account.get_guardians()
|
||||||
|
if set_guardians:
|
||||||
|
guardians_list = ''
|
||||||
|
guardians_list_header = translation_for('helpers.guardians_list_header', preferred_language)
|
||||||
|
for phone_number in set_guardians:
|
||||||
|
guardian = Account.get_by_phone_number(phone_number, self.session)
|
||||||
|
guardian_information = guardian.standard_metadata_id()
|
||||||
|
guardians_list += f'{guardian_information}\n'
|
||||||
|
guardians_list = guardians_list_header + '\n' + guardians_list
|
||||||
|
else:
|
||||||
|
guardians_list = translation_for('helpers.no_guardians_list', preferred_language)
|
||||||
|
return translation_for(self.display_key, preferred_language, guardians_list=guardians_list)
|
||||||
|
|
||||||
|
def account_tokens(self) -> str:
|
||||||
|
cached_token_data_list = get_cached_token_data_list(self.account.blockchain_address)
|
||||||
|
token_data_list = parse_token_list(cached_token_data_list)
|
||||||
|
token_list_sets = [token_data_list[tds:tds + 3] for tds in range(0, len(token_data_list), 3)]
|
||||||
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
no_token_list = token_list_set(preferred_language, [])
|
||||||
|
first_account_tokens_set = no_token_list
|
||||||
|
middle_account_tokens_set = no_token_list
|
||||||
|
last_account_tokens_set = no_token_list
|
||||||
|
if token_list_sets:
|
||||||
|
data = {
|
||||||
|
'account_tokens_list': cached_token_data_list
|
||||||
|
}
|
||||||
|
save_session_data(data=data, queue='cic-ussd', session=self.session, ussd_session=self.ussd_session)
|
||||||
|
first_account_tokens_set = token_list_set(preferred_language, token_list_sets[0])
|
||||||
|
|
||||||
|
if len(token_list_sets) >= 2:
|
||||||
|
middle_account_tokens_set = token_list_set(preferred_language, token_list_sets[1])
|
||||||
|
if len(token_list_sets) >= 3:
|
||||||
|
last_account_tokens_set = token_list_set(preferred_language, token_list_sets[2])
|
||||||
|
if self.display_key == 'ussd.kenya.first_account_tokens_set':
|
||||||
|
return translation_for(
|
||||||
|
self.display_key, preferred_language, first_account_tokens_set=first_account_tokens_set
|
||||||
|
)
|
||||||
|
if self.display_key == 'ussd.kenya.middle_account_tokens_set':
|
||||||
|
return translation_for(
|
||||||
|
self.display_key, preferred_language, middle_account_tokens_set=middle_account_tokens_set
|
||||||
|
)
|
||||||
|
if self.display_key == 'ussd.kenya.last_account_tokens_set':
|
||||||
|
return translation_for(
|
||||||
|
self.display_key, preferred_language, last_account_tokens_set=last_account_tokens_set
|
||||||
|
)
|
||||||
|
|
||||||
|
def help(self) -> str:
|
||||||
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
if not preferred_language:
|
if not preferred_language:
|
||||||
preferred_language = i18n.config.get('fallback')
|
preferred_language = i18n.config.get('fallback')
|
||||||
@@ -154,30 +228,48 @@ class MenuProcessor:
|
|||||||
f'{self.display_key}.retry', preferred_language, retry_pin_entry=retry_pin_entry
|
f'{self.display_key}.retry', preferred_language, retry_pin_entry=retry_pin_entry
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def guarded_account_metadata(self):
|
||||||
|
guarded_account_phone_number = self.ussd_session.get('data').get('guarded_account_phone_number')
|
||||||
|
guarded_account = Account.get_by_phone_number(guarded_account_phone_number, self.session)
|
||||||
|
return guarded_account.standard_metadata_id()
|
||||||
|
|
||||||
|
def guardian_metadata(self):
|
||||||
|
guardian_phone_number = self.ussd_session.get('data').get('guardian_phone_number')
|
||||||
|
guardian = Account.get_by_phone_number(guardian_phone_number, self.session)
|
||||||
|
return guardian.standard_metadata_id()
|
||||||
|
|
||||||
|
def reset_guarded_pin_authorization(self):
|
||||||
|
guarded_account_information = self.guarded_account_metadata()
|
||||||
|
return self.pin_authorization(guarded_account_information=guarded_account_information)
|
||||||
|
|
||||||
def start_menu(self):
|
def start_menu(self):
|
||||||
"""
|
"""
|
||||||
:return:
|
:return:
|
||||||
:rtype:
|
:rtype:
|
||||||
"""
|
"""
|
||||||
chain_str = Chain.spec.__str__()
|
chain_str = Chain.spec.__str__()
|
||||||
token_symbol = get_default_token_symbol()
|
token_symbol = get_active_token_symbol(self.account.blockchain_address)
|
||||||
|
token_data = get_cached_token_data(self.account.blockchain_address, token_symbol)
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
blockchain_address = self.account.blockchain_address
|
blockchain_address = self.account.blockchain_address
|
||||||
balances = get_balances(blockchain_address, chain_str, token_symbol, False)[0]
|
balances = get_balances(blockchain_address, chain_str, token_symbol, False)[0]
|
||||||
key = cache_data_key(self.identifier, ':cic.balances')
|
key = cache_data_key([self.identifier, token_symbol.encode('utf-8')], MetadataPointer.BALANCES)
|
||||||
cache_data(key, json.dumps(balances))
|
cache_data(key, json.dumps(balances))
|
||||||
available_balance = calculate_available_balance(balances)
|
available_balance = calculate_available_balance(balances, decimals)
|
||||||
now = datetime.now()
|
now = datetime.now()
|
||||||
if (now - self.account.created).days >= 30:
|
if (now - self.account.created).days >= 30:
|
||||||
if available_balance <= 0:
|
if available_balance <= 0:
|
||||||
logg.info(f'Not retrieving adjusted balance, available balance: {available_balance} is insufficient.')
|
logg.info(f'Not retrieving adjusted balance, available balance: {available_balance} is insufficient.')
|
||||||
else:
|
else:
|
||||||
timestamp = int((now - timedelta(30)).timestamp())
|
timestamp = int((now - timedelta(30)).timestamp())
|
||||||
adjusted_balance = get_adjusted_balance(to_wei(int(available_balance)), chain_str, timestamp, token_symbol)
|
adjusted_balance = get_adjusted_balance(to_wei(decimals, int(available_balance)), chain_str, timestamp, token_symbol)
|
||||||
key = cache_data_key(self.identifier, ':cic.adjusted_balance')
|
key = cache_data_key([self.identifier, token_symbol.encode('utf-8')], MetadataPointer.BALANCES_ADJUSTED)
|
||||||
cache_data(key, json.dumps(adjusted_balance))
|
cache_data(key, json.dumps(adjusted_balance))
|
||||||
|
|
||||||
query_statement(blockchain_address)
|
query_statement(blockchain_address)
|
||||||
|
token_symbols_list = get_cached_token_symbol_list(blockchain_address)
|
||||||
|
get_account_tokens_balance(blockchain_address, chain_str, token_symbols_list)
|
||||||
|
create_account_tokens_list(blockchain_address)
|
||||||
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
if not preferred_language:
|
if not preferred_language:
|
||||||
preferred_language = i18n.config.get('fallback')
|
preferred_language = i18n.config.get('fallback')
|
||||||
@@ -185,6 +277,20 @@ class MenuProcessor:
|
|||||||
self.display_key, preferred_language, account_balance=available_balance, account_token_name=token_symbol
|
self.display_key, preferred_language, account_balance=available_balance, account_token_name=token_symbol
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def token_selection_pin_authorization(self) -> str:
|
||||||
|
"""
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
selected_token = self.ussd_session.get('data').get('selected_token')
|
||||||
|
token_name = selected_token.get('name')
|
||||||
|
token_symbol = selected_token.get('symbol')
|
||||||
|
token_issuer = selected_token.get('issuer')
|
||||||
|
token_contact = selected_token.get('contact')
|
||||||
|
token_location = selected_token.get('location')
|
||||||
|
token_data = f'{token_name} ({token_symbol})\n{token_issuer}\n{token_contact}\n{token_location}\n'
|
||||||
|
return self.pin_authorization(token_data=token_data)
|
||||||
|
|
||||||
def transaction_pin_authorization(self) -> str:
|
def transaction_pin_authorization(self) -> str:
|
||||||
"""
|
"""
|
||||||
:return:
|
:return:
|
||||||
@@ -194,36 +300,81 @@ class MenuProcessor:
|
|||||||
recipient = Account.get_by_phone_number(recipient_phone_number, self.session)
|
recipient = Account.get_by_phone_number(recipient_phone_number, self.session)
|
||||||
tx_recipient_information = recipient.standard_metadata_id()
|
tx_recipient_information = recipient.standard_metadata_id()
|
||||||
tx_sender_information = self.account.standard_metadata_id()
|
tx_sender_information = self.account.standard_metadata_id()
|
||||||
token_symbol = get_default_token_symbol()
|
token_symbol = get_active_token_symbol(self.account.blockchain_address)
|
||||||
|
token_data = get_cached_token_data(self.account.blockchain_address, token_symbol)
|
||||||
user_input = self.ussd_session.get('data').get('transaction_amount')
|
user_input = self.ussd_session.get('data').get('transaction_amount')
|
||||||
transaction_amount = to_wei(value=int(user_input))
|
decimals = token_data.get('decimals')
|
||||||
|
transaction_amount = to_wei(decimals=decimals, value=int(user_input))
|
||||||
return self.pin_authorization(
|
return self.pin_authorization(
|
||||||
recipient_information=tx_recipient_information,
|
recipient_information=tx_recipient_information,
|
||||||
transaction_amount=from_wei(transaction_amount),
|
transaction_amount=from_wei(decimals, transaction_amount),
|
||||||
token_symbol=token_symbol,
|
token_symbol=token_symbol,
|
||||||
sender_information=tx_sender_information
|
sender_information=tx_sender_information
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def exit_guardian_addition_success(self) -> str:
|
||||||
|
guardian_information = self.guardian_metadata()
|
||||||
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
return translation_for(self.display_key,
|
||||||
|
preferred_language,
|
||||||
|
guardian_information=guardian_information)
|
||||||
|
|
||||||
|
def exit_guardian_removal_success(self):
|
||||||
|
guardian_information = self.guardian_metadata()
|
||||||
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
return translation_for(self.display_key,
|
||||||
|
preferred_language,
|
||||||
|
guardian_information=guardian_information)
|
||||||
|
|
||||||
|
def exit_invalid_guardian_addition(self):
|
||||||
|
failure_reason = self.ussd_session.get('data').get('failure_reason')
|
||||||
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
return translation_for(self.display_key, preferred_language, error_exit=failure_reason)
|
||||||
|
|
||||||
|
def exit_invalid_guardian_removal(self):
|
||||||
|
failure_reason = self.ussd_session.get('data').get('failure_reason')
|
||||||
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
return translation_for(self.display_key, preferred_language, error_exit=failure_reason)
|
||||||
|
|
||||||
|
def exit_pin_reset_initiated_success(self):
|
||||||
|
guarded_account_information = self.guarded_account_metadata()
|
||||||
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
return translation_for(self.display_key,
|
||||||
|
preferred_language,
|
||||||
|
guarded_account_information=guarded_account_information)
|
||||||
|
|
||||||
def exit_insufficient_balance(self):
|
def exit_insufficient_balance(self):
|
||||||
"""
|
"""
|
||||||
:return:
|
:return:
|
||||||
:rtype:
|
:rtype:
|
||||||
"""
|
"""
|
||||||
available_balance = get_cached_available_balance(self.account.blockchain_address)
|
|
||||||
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
if not preferred_language:
|
if not preferred_language:
|
||||||
preferred_language = i18n.config.get('fallback')
|
preferred_language = i18n.config.get('fallback')
|
||||||
session_data = self.ussd_session.get('data')
|
session_data = self.ussd_session.get('data')
|
||||||
|
token_symbol = get_active_token_symbol(self.account.blockchain_address)
|
||||||
|
token_data = get_cached_token_data(self.account.blockchain_address, token_symbol)
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
|
available_balance = get_cached_available_balance(decimals, [self.identifier, token_symbol.encode('utf-8')])
|
||||||
transaction_amount = session_data.get('transaction_amount')
|
transaction_amount = session_data.get('transaction_amount')
|
||||||
transaction_amount = to_wei(value=int(transaction_amount))
|
transaction_amount = to_wei(decimals=decimals, value=int(transaction_amount))
|
||||||
token_symbol = get_default_token_symbol()
|
|
||||||
recipient_phone_number = self.ussd_session.get('data').get('recipient_phone_number')
|
recipient_phone_number = self.ussd_session.get('data').get('recipient_phone_number')
|
||||||
recipient = Account.get_by_phone_number(recipient_phone_number, self.session)
|
recipient = Account.get_by_phone_number(recipient_phone_number, self.session)
|
||||||
tx_recipient_information = recipient.standard_metadata_id()
|
tx_recipient_information = recipient.standard_metadata_id()
|
||||||
return translation_for(
|
return translation_for(
|
||||||
self.display_key,
|
self.display_key,
|
||||||
preferred_language,
|
preferred_language,
|
||||||
amount=from_wei(transaction_amount),
|
amount=from_wei(decimals, transaction_amount),
|
||||||
token_symbol=token_symbol,
|
token_symbol=token_symbol,
|
||||||
recipient_information=tx_recipient_information,
|
recipient_information=tx_recipient_information,
|
||||||
token_balance=available_balance
|
token_balance=available_balance
|
||||||
@@ -241,6 +392,14 @@ class MenuProcessor:
|
|||||||
preferred_language = i18n.config.get('fallback')
|
preferred_language = i18n.config.get('fallback')
|
||||||
return translation_for('ussd.kenya.exit_pin_blocked', preferred_language, support_phone=Support.phone_number)
|
return translation_for('ussd.kenya.exit_pin_blocked', preferred_language, support_phone=Support.phone_number)
|
||||||
|
|
||||||
|
def exit_successful_token_selection(self) -> str:
|
||||||
|
selected_token = self.ussd_session.get('data').get('selected_token')
|
||||||
|
token_symbol = selected_token.get('symbol')
|
||||||
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
return translation_for(self.display_key,preferred_language,token_symbol=token_symbol)
|
||||||
|
|
||||||
def exit_successful_transaction(self):
|
def exit_successful_transaction(self):
|
||||||
"""
|
"""
|
||||||
:return:
|
:return:
|
||||||
@@ -250,8 +409,10 @@ class MenuProcessor:
|
|||||||
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
preferred_language = get_cached_preferred_language(self.account.blockchain_address)
|
||||||
if not preferred_language:
|
if not preferred_language:
|
||||||
preferred_language = i18n.config.get('fallback')
|
preferred_language = i18n.config.get('fallback')
|
||||||
transaction_amount = to_wei(amount)
|
token_symbol = get_active_token_symbol(self.account.blockchain_address)
|
||||||
token_symbol = get_default_token_symbol()
|
token_data = get_cached_token_data(self.account.blockchain_address, token_symbol)
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
|
transaction_amount = to_wei(decimals, amount)
|
||||||
recipient_phone_number = self.ussd_session.get('data').get('recipient_phone_number')
|
recipient_phone_number = self.ussd_session.get('data').get('recipient_phone_number')
|
||||||
recipient = Account.get_by_phone_number(phone_number=recipient_phone_number, session=self.session)
|
recipient = Account.get_by_phone_number(phone_number=recipient_phone_number, session=self.session)
|
||||||
tx_recipient_information = recipient.standard_metadata_id()
|
tx_recipient_information = recipient.standard_metadata_id()
|
||||||
@@ -259,7 +420,7 @@ class MenuProcessor:
|
|||||||
return translation_for(
|
return translation_for(
|
||||||
self.display_key,
|
self.display_key,
|
||||||
preferred_language,
|
preferred_language,
|
||||||
transaction_amount=from_wei(transaction_amount),
|
transaction_amount=from_wei(decimals, transaction_amount),
|
||||||
token_symbol=token_symbol,
|
token_symbol=token_symbol,
|
||||||
recipient_information=tx_recipient_information,
|
recipient_information=tx_recipient_information,
|
||||||
sender_information=tx_sender_information
|
sender_information=tx_sender_information
|
||||||
@@ -293,15 +454,42 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio
|
|||||||
if menu_name == 'transaction_pin_authorization':
|
if menu_name == 'transaction_pin_authorization':
|
||||||
return menu_processor.transaction_pin_authorization()
|
return menu_processor.transaction_pin_authorization()
|
||||||
|
|
||||||
|
if menu_name == 'token_selection_pin_authorization':
|
||||||
|
return menu_processor.token_selection_pin_authorization()
|
||||||
|
|
||||||
if menu_name == 'exit_insufficient_balance':
|
if menu_name == 'exit_insufficient_balance':
|
||||||
return menu_processor.exit_insufficient_balance()
|
return menu_processor.exit_insufficient_balance()
|
||||||
|
|
||||||
|
if menu_name == 'exit_invalid_guardian_addition':
|
||||||
|
return menu_processor.exit_invalid_guardian_addition()
|
||||||
|
|
||||||
|
if menu_name == 'exit_invalid_guardian_removal':
|
||||||
|
return menu_processor.exit_invalid_guardian_removal()
|
||||||
|
|
||||||
if menu_name == 'exit_successful_transaction':
|
if menu_name == 'exit_successful_transaction':
|
||||||
return menu_processor.exit_successful_transaction()
|
return menu_processor.exit_successful_transaction()
|
||||||
|
|
||||||
|
if menu_name == 'exit_guardian_addition_success':
|
||||||
|
return menu_processor.exit_guardian_addition_success()
|
||||||
|
|
||||||
|
if menu_name == 'exit_guardian_removal_success':
|
||||||
|
return menu_processor.exit_guardian_removal_success()
|
||||||
|
|
||||||
|
if menu_name == 'exit_pin_reset_initiated_success':
|
||||||
|
return menu_processor.exit_pin_reset_initiated_success()
|
||||||
|
|
||||||
if menu_name == 'account_balances':
|
if menu_name == 'account_balances':
|
||||||
return menu_processor.account_balances()
|
return menu_processor.account_balances()
|
||||||
|
|
||||||
|
if menu_name == 'guardian_list':
|
||||||
|
return menu_processor.guardian_list()
|
||||||
|
|
||||||
|
if menu_name == 'add_guardian_pin_authorization':
|
||||||
|
return menu_processor.add_guardian_pin_authorization()
|
||||||
|
|
||||||
|
if menu_name == 'reset_guarded_pin_authorization':
|
||||||
|
return menu_processor.reset_guarded_pin_authorization()
|
||||||
|
|
||||||
if 'pin_authorization' in menu_name:
|
if 'pin_authorization' in menu_name:
|
||||||
return menu_processor.pin_authorization()
|
return menu_processor.pin_authorization()
|
||||||
|
|
||||||
@@ -311,6 +499,9 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio
|
|||||||
if 'transaction_set' in menu_name:
|
if 'transaction_set' in menu_name:
|
||||||
return menu_processor.account_statement()
|
return menu_processor.account_statement()
|
||||||
|
|
||||||
|
if 'account_tokens_set' in menu_name:
|
||||||
|
return menu_processor.account_tokens()
|
||||||
|
|
||||||
if menu_name == 'display_user_metadata':
|
if menu_name == 'display_user_metadata':
|
||||||
return menu_processor.person_metadata()
|
return menu_processor.person_metadata()
|
||||||
|
|
||||||
@@ -320,6 +511,9 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio
|
|||||||
if menu_name == 'exit_pin_blocked':
|
if menu_name == 'exit_pin_blocked':
|
||||||
return menu_processor.exit_pin_blocked()
|
return menu_processor.exit_pin_blocked()
|
||||||
|
|
||||||
|
if menu_name == 'exit_successful_token_selection':
|
||||||
|
return menu_processor.exit_successful_token_selection()
|
||||||
|
|
||||||
preferred_language = get_cached_preferred_language(account.blockchain_address)
|
preferred_language = get_cached_preferred_language(account.blockchain_address)
|
||||||
|
|
||||||
return translation_for(display_key, preferred_language)
|
return translation_for(display_key, preferred_language)
|
||||||
|
|||||||
@@ -1,15 +1,22 @@
|
|||||||
# standard imports
|
# standard imports
|
||||||
import datetime
|
import datetime
|
||||||
import json
|
import json
|
||||||
|
import logging
|
||||||
|
import time
|
||||||
|
from typing import Union
|
||||||
|
|
||||||
# external imports
|
# external imports
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
from cic_types.models.person import get_contact_data_from_vcard
|
from cic_types.models.person import get_contact_data_from_vcard
|
||||||
from tinydb.table import Document
|
from tinydb.table import Document
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
|
from cic_ussd.cache import cache_data_key, get_cached_data
|
||||||
from cic_ussd.menu.ussd_menu import UssdMenu
|
from cic_ussd.menu.ussd_menu import UssdMenu
|
||||||
from cic_ussd.translation import translation_for
|
from cic_ussd.translation import translation_for
|
||||||
|
|
||||||
|
logg = logging.getLogger(__file__)
|
||||||
|
|
||||||
|
|
||||||
def latest_input(user_input: str) -> str:
|
def latest_input(user_input: str) -> str:
|
||||||
"""
|
"""
|
||||||
@@ -76,3 +83,66 @@ def resume_last_ussd_session(last_state: str) -> Document:
|
|||||||
if last_state in non_reusable_states:
|
if last_state in non_reusable_states:
|
||||||
return UssdMenu.find_by_name('start')
|
return UssdMenu.find_by_name('start')
|
||||||
return UssdMenu.find_by_name(last_state)
|
return UssdMenu.find_by_name(last_state)
|
||||||
|
|
||||||
|
|
||||||
|
def wait_for_cache(identifier: Union[list, bytes], resource_name: str, salt: MetadataPointer, interval: int = 1, max_retry: int = 5):
|
||||||
|
"""
|
||||||
|
:param identifier:
|
||||||
|
:type identifier:
|
||||||
|
:param interval:
|
||||||
|
:type interval:
|
||||||
|
:param resource_name:
|
||||||
|
:type resource_name:
|
||||||
|
:param salt:
|
||||||
|
:type salt:
|
||||||
|
:param max_retry:
|
||||||
|
:type max_retry:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
key = cache_data_key(identifier=identifier, salt=salt)
|
||||||
|
resource = get_cached_data(key)
|
||||||
|
counter = 0
|
||||||
|
while resource is None:
|
||||||
|
logg.debug(f'Waiting for: {resource_name} at: {key}. Checking after: {interval} ...')
|
||||||
|
time.sleep(interval)
|
||||||
|
counter += 1
|
||||||
|
resource = get_cached_data(key)
|
||||||
|
if resource is not None:
|
||||||
|
logg.debug(f'{resource_name} now available.')
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
if counter == max_retry:
|
||||||
|
logg.debug(f'Could not find: {resource_name} within: {max_retry}')
|
||||||
|
break
|
||||||
|
|
||||||
|
|
||||||
|
def wait_for_session_data(resource_name: str, session_data_key: str, ussd_session: dict, interval: int = 1, max_retry: int = 5):
|
||||||
|
"""
|
||||||
|
:param interval:
|
||||||
|
:type interval:
|
||||||
|
:param resource_name:
|
||||||
|
:type resource_name:
|
||||||
|
:param session_data_key:
|
||||||
|
:type session_data_key:
|
||||||
|
:param ussd_session:
|
||||||
|
:type ussd_session:
|
||||||
|
:param max_retry:
|
||||||
|
:type max_retry:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
session_data = ussd_session.get('data').get(session_data_key)
|
||||||
|
counter = 0
|
||||||
|
while session_data is None:
|
||||||
|
logg.debug(f'Waiting for: {resource_name}. Checking after: {interval} ...')
|
||||||
|
time.sleep(interval)
|
||||||
|
counter += 1
|
||||||
|
session_data = ussd_session.get('data').get(session_data_key)
|
||||||
|
if session_data is not None:
|
||||||
|
logg.debug(f'{resource_name} now available.')
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
if counter == max_retry:
|
||||||
|
logg.debug(f'Could not find: {resource_name} within: {max_retry}')
|
||||||
|
break
|
||||||
|
|||||||
@@ -63,7 +63,6 @@ elif ssl == 0:
|
|||||||
else:
|
else:
|
||||||
ssl = True
|
ssl = True
|
||||||
|
|
||||||
valid_service_codes = config.get('USSD_SERVICE_CODE').split(",")
|
|
||||||
def main():
|
def main():
|
||||||
|
|
||||||
# TODO: improve url building
|
# TODO: improve url building
|
||||||
@@ -79,7 +78,7 @@ def main():
|
|||||||
session = uuid.uuid4().hex
|
session = uuid.uuid4().hex
|
||||||
data = {
|
data = {
|
||||||
'sessionId': session,
|
'sessionId': session,
|
||||||
'serviceCode': valid_service_codes[0],
|
'serviceCode': config.get('USSD_SERVICE_CODE'),
|
||||||
'phoneNumber': args.phone,
|
'phoneNumber': args.phone,
|
||||||
'text': "",
|
'text': "",
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,14 +10,14 @@ import i18n
|
|||||||
import redis
|
import redis
|
||||||
from chainlib.chain import ChainSpec
|
from chainlib.chain import ChainSpec
|
||||||
from confini import Config
|
from confini import Config
|
||||||
|
from cic_types.ext.metadata import Metadata
|
||||||
|
from cic_types.ext.metadata.signer import Signer
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.chain import Chain
|
from cic_ussd.account.chain import Chain
|
||||||
from cic_ussd.cache import Cache
|
from cic_ussd.cache import Cache
|
||||||
from cic_ussd.db import dsn_from_config
|
from cic_ussd.db import dsn_from_config
|
||||||
from cic_ussd.db.models.base import SessionBase
|
from cic_ussd.db.models.base import SessionBase
|
||||||
from cic_ussd.metadata.signer import Signer
|
|
||||||
from cic_ussd.metadata.base import Metadata
|
|
||||||
from cic_ussd.phone_number import Support
|
from cic_ussd.phone_number import Support
|
||||||
from cic_ussd.session.ussd_session import UssdSession as InMemoryUssdSession
|
from cic_ussd.session.ussd_session import UssdSession as InMemoryUssdSession
|
||||||
from cic_ussd.validator import validate_presence
|
from cic_ussd.validator import validate_presence
|
||||||
@@ -87,11 +87,8 @@ Signer.key_file_path = key_file_path
|
|||||||
i18n.load_path.append(config.get('LOCALE_PATH'))
|
i18n.load_path.append(config.get('LOCALE_PATH'))
|
||||||
i18n.set('fallback', config.get('LOCALE_FALLBACK'))
|
i18n.set('fallback', config.get('LOCALE_FALLBACK'))
|
||||||
|
|
||||||
chain_spec = ChainSpec(
|
chain_spec = ChainSpec.from_chain_str(config.get('CHAIN_SPEC'))
|
||||||
common_name=config.get('CIC_COMMON_NAME'),
|
|
||||||
engine=config.get('CIC_ENGINE'),
|
|
||||||
network_id=config.get('CIC_NETWORK_ID')
|
|
||||||
)
|
|
||||||
|
|
||||||
Chain.spec = chain_spec
|
Chain.spec = chain_spec
|
||||||
Support.phone_number = config.get('OFFICE_SUPPORT_PHONE')
|
Support.phone_number = config.get('OFFICE_SUPPORT_PHONE')
|
||||||
|
|||||||
@@ -12,6 +12,9 @@ import i18n
|
|||||||
import redis
|
import redis
|
||||||
from chainlib.chain import ChainSpec
|
from chainlib.chain import ChainSpec
|
||||||
from confini import Config
|
from confini import Config
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
from cic_types.ext.metadata import Metadata
|
||||||
|
from cic_types.ext.metadata.signer import Signer
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.chain import Chain
|
from cic_ussd.account.chain import Chain
|
||||||
@@ -25,8 +28,6 @@ from cic_ussd.files.local_files import create_local_file_data_stores, json_file_
|
|||||||
from cic_ussd.http.requests import get_request_endpoint, get_request_method
|
from cic_ussd.http.requests import get_request_endpoint, get_request_method
|
||||||
from cic_ussd.http.responses import with_content_headers
|
from cic_ussd.http.responses import with_content_headers
|
||||||
from cic_ussd.menu.ussd_menu import UssdMenu
|
from cic_ussd.menu.ussd_menu import UssdMenu
|
||||||
from cic_ussd.metadata.base import Metadata
|
|
||||||
from cic_ussd.metadata.signer import Signer
|
|
||||||
from cic_ussd.phone_number import process_phone_number, Support, E164Format
|
from cic_ussd.phone_number import process_phone_number, Support, E164Format
|
||||||
from cic_ussd.processor.ussd import handle_menu_operations
|
from cic_ussd.processor.ussd import handle_menu_operations
|
||||||
from cic_ussd.runnable.server_base import exportable_parser, logg
|
from cic_ussd.runnable.server_base import exportable_parser, logg
|
||||||
@@ -96,11 +97,7 @@ celery.Celery(backend=config.get('CELERY_RESULT_URL'), broker=config.get('CELERY
|
|||||||
states = json_file_parser(filepath=config.get('MACHINE_STATES'))
|
states = json_file_parser(filepath=config.get('MACHINE_STATES'))
|
||||||
transitions = json_file_parser(filepath=config.get('MACHINE_TRANSITIONS'))
|
transitions = json_file_parser(filepath=config.get('MACHINE_TRANSITIONS'))
|
||||||
|
|
||||||
chain_spec = ChainSpec(
|
chain_spec = ChainSpec.from_chain_str(config.get('CHAIN_SPEC'))
|
||||||
common_name=config.get('CIC_COMMON_NAME'),
|
|
||||||
engine=config.get('CIC_ENGINE'),
|
|
||||||
network_id=config.get('CIC_NETWORK_ID')
|
|
||||||
)
|
|
||||||
|
|
||||||
Chain.spec = chain_spec
|
Chain.spec = chain_spec
|
||||||
UssdStateMachine.states = states
|
UssdStateMachine.states = states
|
||||||
@@ -113,7 +110,7 @@ default_token_data = query_default_token(chain_str)
|
|||||||
|
|
||||||
# cache default token for re-usability
|
# cache default token for re-usability
|
||||||
if default_token_data:
|
if default_token_data:
|
||||||
cache_key = cache_data_key(chain_str.encode('utf-8'), ':cic.default_token_data')
|
cache_key = cache_data_key(chain_str.encode('utf-8'), MetadataPointer.TOKEN_DEFAULT)
|
||||||
cache_data(key=cache_key, data=json.dumps(default_token_data))
|
cache_data(key=cache_key, data=json.dumps(default_token_data))
|
||||||
else:
|
else:
|
||||||
raise InitializationError(f'Default token data for: {chain_str} not found.')
|
raise InitializationError(f'Default token data for: {chain_str} not found.')
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ from cic_ussd.cache import Cache
|
|||||||
from cic_ussd.db.models.base import SessionBase
|
from cic_ussd.db.models.base import SessionBase
|
||||||
from cic_ussd.db.models.ussd_session import UssdSession as DbUssdSession
|
from cic_ussd.db.models.ussd_session import UssdSession as DbUssdSession
|
||||||
|
|
||||||
logg = logging.getLogger()
|
logg = logging.getLogger(__file__)
|
||||||
|
|
||||||
|
|
||||||
class UssdSession:
|
class UssdSession:
|
||||||
@@ -239,11 +239,16 @@ def save_session_data(queue: Optional[str], session: Session, data: dict, ussd_s
|
|||||||
:param ussd_session: A ussd session passed to the state machine.
|
:param ussd_session: A ussd session passed to the state machine.
|
||||||
:type ussd_session: UssdSession
|
:type ussd_session: UssdSession
|
||||||
"""
|
"""
|
||||||
|
logg.debug(f'Saving: {data} session data to: {ussd_session}')
|
||||||
cache = Cache.store
|
cache = Cache.store
|
||||||
external_session_id = ussd_session.get('external_session_id')
|
external_session_id = ussd_session.get('external_session_id')
|
||||||
existing_session_data = ussd_session.get('data')
|
existing_session_data = ussd_session.get('data')
|
||||||
if existing_session_data:
|
if existing_session_data:
|
||||||
data = {**existing_session_data, **data}
|
# replace session data entry
|
||||||
|
keys = data.keys()
|
||||||
|
for key in keys:
|
||||||
|
existing_session_data[key] = data[key]
|
||||||
|
data = existing_session_data
|
||||||
in_redis_ussd_session = cache.get(external_session_id)
|
in_redis_ussd_session = cache.get(external_session_id)
|
||||||
in_redis_ussd_session = json.loads(in_redis_ussd_session)
|
in_redis_ussd_session = json.loads(in_redis_ussd_session)
|
||||||
create_or_update_session(
|
create_or_update_session(
|
||||||
|
|||||||
@@ -81,6 +81,18 @@ def menu_six_selected(state_machine_data: Tuple[str, dict, Account, Session]) ->
|
|||||||
return user_input == '6'
|
return user_input == '6'
|
||||||
|
|
||||||
|
|
||||||
|
def menu_nine_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> 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, account, session = state_machine_data
|
||||||
|
return user_input == '9'
|
||||||
|
|
||||||
|
|
||||||
def menu_zero_zero_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
def menu_zero_zero_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
||||||
"""
|
"""
|
||||||
This function checks that user input matches a string with value '00'
|
This function checks that user input matches a string with value '00'
|
||||||
@@ -93,6 +105,30 @@ def menu_zero_zero_selected(state_machine_data: Tuple[str, dict, Account, Sessio
|
|||||||
return user_input == '00'
|
return user_input == '00'
|
||||||
|
|
||||||
|
|
||||||
|
def menu_eleven_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
||||||
|
"""
|
||||||
|
This function checks that user input matches a string with value '11'
|
||||||
|
: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 '99'
|
||||||
|
:rtype: bool
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
return user_input == '11'
|
||||||
|
|
||||||
|
|
||||||
|
def menu_twenty_two_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
||||||
|
"""
|
||||||
|
This function checks that user input matches a string with value '22'
|
||||||
|
: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 '99'
|
||||||
|
:rtype: bool
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
return user_input == '22'
|
||||||
|
|
||||||
|
|
||||||
def menu_ninety_nine_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
def menu_ninety_nine_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
||||||
"""
|
"""
|
||||||
This function checks that user input matches a string with value '99'
|
This function checks that user input matches a string with value '99'
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ user's pin.
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
# standard imports
|
# standard imports
|
||||||
import json
|
|
||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
from typing import Tuple
|
from typing import Tuple
|
||||||
@@ -16,6 +15,7 @@ from cic_ussd.db.models.account import Account
|
|||||||
from cic_ussd.db.models.base import SessionBase
|
from cic_ussd.db.models.base import SessionBase
|
||||||
from cic_ussd.db.enum import AccountStatus
|
from cic_ussd.db.enum import AccountStatus
|
||||||
from cic_ussd.encoder import create_password_hash, check_password_hash
|
from cic_ussd.encoder import create_password_hash, check_password_hash
|
||||||
|
from cic_ussd.processor.util import wait_for_session_data
|
||||||
from cic_ussd.session.ussd_session import create_or_update_session, persist_ussd_session
|
from cic_ussd.session.ussd_session import create_or_update_session, persist_ussd_session
|
||||||
|
|
||||||
|
|
||||||
@@ -31,11 +31,8 @@ def is_valid_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool
|
|||||||
:rtype: bool
|
:rtype: bool
|
||||||
"""
|
"""
|
||||||
user_input, ussd_session, account, session = state_machine_data
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
pin_is_valid = False
|
|
||||||
matcher = r'^\d{4}$'
|
matcher = r'^\d{4}$'
|
||||||
if re.match(matcher, user_input):
|
return bool(re.match(matcher, user_input))
|
||||||
pin_is_valid = True
|
|
||||||
return pin_is_valid
|
|
||||||
|
|
||||||
|
|
||||||
def is_authorized_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
def is_authorized_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
||||||
@@ -68,7 +65,7 @@ def save_initial_pin_to_session_data(state_machine_data: Tuple[str, dict, Accoun
|
|||||||
:param state_machine_data: A tuple containing user input, a ussd session and user object.
|
:param state_machine_data: A tuple containing user input, a ussd session and user object.
|
||||||
:type state_machine_data: tuple
|
:type state_machine_data: tuple
|
||||||
"""
|
"""
|
||||||
user_input, ussd_session, user, session = state_machine_data
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
initial_pin = create_password_hash(user_input)
|
initial_pin = create_password_hash(user_input)
|
||||||
if ussd_session.get('data'):
|
if ussd_session.get('data'):
|
||||||
data = ussd_session.get('data')
|
data = ussd_session.get('data')
|
||||||
@@ -97,7 +94,8 @@ def pins_match(state_machine_data: Tuple[str, dict, Account, Session]) -> bool:
|
|||||||
:return: A match between two pin values.
|
:return: A match between two pin values.
|
||||||
:rtype: bool
|
:rtype: bool
|
||||||
"""
|
"""
|
||||||
user_input, ussd_session, user, session = state_machine_data
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
wait_for_session_data('Initial pin', session_data_key='initial_pin', ussd_session=ussd_session)
|
||||||
initial_pin = ussd_session.get('data').get('initial_pin')
|
initial_pin = ussd_session.get('data').get('initial_pin')
|
||||||
return check_password_hash(user_input, initial_pin)
|
return check_password_hash(user_input, initial_pin)
|
||||||
|
|
||||||
@@ -107,11 +105,12 @@ def complete_pin_change(state_machine_data: Tuple[str, dict, Account, Session]):
|
|||||||
:param state_machine_data: A tuple containing user input, a ussd session and user object.
|
:param state_machine_data: A tuple containing user input, a ussd session and user object.
|
||||||
:type state_machine_data: tuple
|
:type state_machine_data: tuple
|
||||||
"""
|
"""
|
||||||
user_input, ussd_session, user, session = state_machine_data
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
session = SessionBase.bind_session(session=session)
|
session = SessionBase.bind_session(session=session)
|
||||||
|
wait_for_session_data('Initial pin', session_data_key='initial_pin', ussd_session=ussd_session)
|
||||||
password_hash = ussd_session.get('data').get('initial_pin')
|
password_hash = ussd_session.get('data').get('initial_pin')
|
||||||
user.password_hash = password_hash
|
account.password_hash = password_hash
|
||||||
session.add(user)
|
session.add(account)
|
||||||
session.flush()
|
session.flush()
|
||||||
SessionBase.release_session(session=session)
|
SessionBase.release_session(session=session)
|
||||||
|
|
||||||
@@ -134,6 +133,6 @@ def is_valid_new_pin(state_machine_data: Tuple[str, dict, Account, Session]) ->
|
|||||||
:return: A match between two pin values.
|
:return: A match between two pin values.
|
||||||
:rtype: bool
|
:rtype: bool
|
||||||
"""
|
"""
|
||||||
user_input, ussd_session, user, session = state_machine_data
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
is_old_pin = user.verify_password(password=user_input)
|
is_old_pin = account.verify_password(password=user_input)
|
||||||
return is_valid_pin(state_machine_data=state_machine_data) and not is_old_pin
|
return is_valid_pin(state_machine_data=state_machine_data) and not is_old_pin
|
||||||
|
|||||||
200
apps/cic-ussd/cic_ussd/state_machine/logic/pin_guard.py
Normal file
200
apps/cic-ussd/cic_ussd/state_machine/logic/pin_guard.py
Normal file
@@ -0,0 +1,200 @@
|
|||||||
|
# standard imports
|
||||||
|
import logging
|
||||||
|
from typing import Tuple
|
||||||
|
|
||||||
|
# external imports
|
||||||
|
import celery
|
||||||
|
import i18n
|
||||||
|
from phonenumbers.phonenumberutil import NumberParseException
|
||||||
|
from sqlalchemy.orm.session import Session
|
||||||
|
|
||||||
|
# local imports
|
||||||
|
from cic_ussd.account.metadata import get_cached_preferred_language
|
||||||
|
from cic_ussd.db.models.account import Account
|
||||||
|
from cic_ussd.db.models.base import SessionBase
|
||||||
|
from cic_ussd.phone_number import process_phone_number, E164Format
|
||||||
|
from cic_ussd.session.ussd_session import save_session_data
|
||||||
|
from cic_ussd.translation import translation_for
|
||||||
|
|
||||||
|
|
||||||
|
logg = logging.getLogger(__file__)
|
||||||
|
|
||||||
|
|
||||||
|
def save_guardian_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
session_data = ussd_session.get('data') or {}
|
||||||
|
guardian_phone_number = process_phone_number(phone_number=user_input, region=E164Format.region)
|
||||||
|
session_data['guardian_phone_number'] = guardian_phone_number
|
||||||
|
save_session_data('cic-ussd', session, session_data, ussd_session)
|
||||||
|
|
||||||
|
|
||||||
|
def save_guarded_account_session_data(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
session_data = ussd_session.get('data') or {}
|
||||||
|
guarded_account_phone_number = process_phone_number(phone_number=user_input, region=E164Format.region)
|
||||||
|
session_data['guarded_account_phone_number'] = guarded_account_phone_number
|
||||||
|
save_session_data('cic-ussd', session, session_data, ussd_session)
|
||||||
|
|
||||||
|
|
||||||
|
def retrieve_person_metadata(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
guardian_phone_number = process_phone_number(user_input, E164Format.region)
|
||||||
|
guardian = Account.get_by_phone_number(guardian_phone_number, session)
|
||||||
|
blockchain_address = guardian.blockchain_address
|
||||||
|
s_query_person_metadata = celery.signature(
|
||||||
|
'cic_ussd.tasks.metadata.query_person_metadata', [blockchain_address], queue='cic-ussd')
|
||||||
|
s_query_person_metadata.apply_async()
|
||||||
|
|
||||||
|
|
||||||
|
def is_valid_guardian_addition(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
try:
|
||||||
|
phone_number = process_phone_number(user_input, E164Format.region)
|
||||||
|
except NumberParseException:
|
||||||
|
phone_number = None
|
||||||
|
|
||||||
|
preferred_language = get_cached_preferred_language(account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
|
||||||
|
is_valid_account = Account.get_by_phone_number(phone_number, session) is not None
|
||||||
|
is_initiator = phone_number == account.phone_number
|
||||||
|
is_existent_guardian = phone_number in account.get_guardians()
|
||||||
|
|
||||||
|
failure_reason = ''
|
||||||
|
if not is_valid_account:
|
||||||
|
failure_reason = translation_for('helpers.error.no_matching_account', preferred_language)
|
||||||
|
|
||||||
|
if is_initiator:
|
||||||
|
failure_reason = translation_for('helpers.error.is_initiator', preferred_language)
|
||||||
|
|
||||||
|
if is_existent_guardian:
|
||||||
|
failure_reason = translation_for('helpers.error.is_existent_guardian', preferred_language)
|
||||||
|
|
||||||
|
if failure_reason:
|
||||||
|
session_data = ussd_session.get('data') or {}
|
||||||
|
session_data['failure_reason'] = failure_reason
|
||||||
|
save_session_data('cic-ussd', session, session_data, ussd_session)
|
||||||
|
|
||||||
|
return phone_number is not None and is_valid_account and not is_existent_guardian and not is_initiator
|
||||||
|
|
||||||
|
|
||||||
|
def add_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
guardian_phone_number = ussd_session.get('data').get('guardian_phone_number')
|
||||||
|
account.add_guardian(guardian_phone_number)
|
||||||
|
session.add(account)
|
||||||
|
session.flush()
|
||||||
|
SessionBase.release_session(session=session)
|
||||||
|
|
||||||
|
|
||||||
|
def is_set_pin_guardian(account: Account, checked_number: str, preferred_language: str, session: Session, ussd_session: dict):
|
||||||
|
""""""
|
||||||
|
failure_reason = ''
|
||||||
|
set_guardians = []
|
||||||
|
if account:
|
||||||
|
set_guardians = account.get_guardians()
|
||||||
|
else:
|
||||||
|
failure_reason = translation_for('helpers.error.no_matching_account', preferred_language)
|
||||||
|
|
||||||
|
is_set_guardian = checked_number in set_guardians
|
||||||
|
is_initiator = checked_number == account.phone_number
|
||||||
|
|
||||||
|
if not is_set_guardian:
|
||||||
|
failure_reason = translation_for('helpers.error.is_not_existent_guardian', preferred_language)
|
||||||
|
|
||||||
|
if is_initiator:
|
||||||
|
failure_reason = translation_for('helpers.error.is_initiator', preferred_language)
|
||||||
|
|
||||||
|
if failure_reason:
|
||||||
|
session_data = ussd_session.get('data') or {}
|
||||||
|
session_data['failure_reason'] = failure_reason
|
||||||
|
save_session_data('cic-ussd', session, session_data, ussd_session)
|
||||||
|
|
||||||
|
return is_set_guardian and not is_initiator
|
||||||
|
|
||||||
|
|
||||||
|
def is_dialers_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
phone_number = process_phone_number(phone_number=user_input, region=E164Format.region)
|
||||||
|
preferred_language = get_cached_preferred_language(account.blockchain_address)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
return is_set_pin_guardian(account, phone_number, preferred_language, session, ussd_session)
|
||||||
|
|
||||||
|
|
||||||
|
def is_others_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
preferred_language = get_cached_preferred_language(account.blockchain_address)
|
||||||
|
phone_number = process_phone_number(phone_number=user_input, region=E164Format.region)
|
||||||
|
guarded_account = Account.get_by_phone_number(phone_number, session)
|
||||||
|
if not preferred_language:
|
||||||
|
preferred_language = i18n.config.get('fallback')
|
||||||
|
return is_set_pin_guardian(guarded_account, account.phone_number, preferred_language, session, ussd_session)
|
||||||
|
|
||||||
|
|
||||||
|
def remove_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
guardian_phone_number = ussd_session.get('data').get('guardian_phone_number')
|
||||||
|
account.remove_guardian(guardian_phone_number)
|
||||||
|
session.add(account)
|
||||||
|
session.flush()
|
||||||
|
SessionBase.release_session(session=session)
|
||||||
|
|
||||||
|
|
||||||
|
def initiate_pin_reset(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
session_data = ussd_session.get('data')
|
||||||
|
quorum_count = session_data['quorum_count'] if session_data.get('quorum_count') else 0
|
||||||
|
quorum_count += 1
|
||||||
|
session_data['quorum_count'] = quorum_count
|
||||||
|
save_session_data('cic-ussd', session, session_data, ussd_session)
|
||||||
|
guarded_account_phone_number = session_data.get('guarded_account_phone_number')
|
||||||
|
guarded_account = Account.get_by_phone_number(guarded_account_phone_number, session)
|
||||||
|
if quorum_count >= guarded_account.guardian_quora:
|
||||||
|
guarded_account.reset_pin(session)
|
||||||
|
logg.debug(f'Reset initiated for: {guarded_account.phone_number}')
|
||||||
|
session_data['quorum_count'] = 0
|
||||||
|
save_session_data('cic-ussd', session, session_data, ussd_session)
|
||||||
@@ -6,7 +6,7 @@ from sqlalchemy.orm.session import Session
|
|||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.metadata import get_cached_preferred_language
|
from cic_ussd.account.metadata import get_cached_preferred_language
|
||||||
from cic_ussd.account.tokens import get_default_token_symbol
|
from cic_ussd.account.tokens import get_active_token_symbol
|
||||||
from cic_ussd.db.models.account import Account
|
from cic_ussd.db.models.account import Account
|
||||||
from cic_ussd.notifications import Notifier
|
from cic_ussd.notifications import Notifier
|
||||||
from cic_ussd.phone_number import Support
|
from cic_ussd.phone_number import Support
|
||||||
@@ -18,7 +18,7 @@ def upsell_unregistered_recipient(state_machine_data: Tuple[str, dict, Account,
|
|||||||
notifier = Notifier()
|
notifier = Notifier()
|
||||||
phone_number = ussd_session.get('data')['recipient_phone_number']
|
phone_number = ussd_session.get('data')['recipient_phone_number']
|
||||||
preferred_language = get_cached_preferred_language(account.blockchain_address)
|
preferred_language = get_cached_preferred_language(account.blockchain_address)
|
||||||
token_symbol = get_default_token_symbol()
|
token_symbol = get_active_token_symbol(account.blockchain_address)
|
||||||
tx_sender_information = account.standard_metadata_id()
|
tx_sender_information = account.standard_metadata_id()
|
||||||
notifier.send_sms_notification('sms.upsell_unregistered_recipient',
|
notifier.send_sms_notification('sms.upsell_unregistered_recipient',
|
||||||
phone_number,
|
phone_number,
|
||||||
|
|||||||
69
apps/cic-ussd/cic_ussd/state_machine/logic/tokens.py
Normal file
69
apps/cic-ussd/cic_ussd/state_machine/logic/tokens.py
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
# standard imports
|
||||||
|
from typing import Tuple
|
||||||
|
|
||||||
|
# external imports
|
||||||
|
from sqlalchemy.orm.session import Session
|
||||||
|
|
||||||
|
# local imports
|
||||||
|
from cic_ussd.account.tokens import set_active_token
|
||||||
|
from cic_ussd.db.models.account import Account
|
||||||
|
from cic_ussd.processor.util import wait_for_session_data
|
||||||
|
from cic_ussd.session.ussd_session import save_session_data
|
||||||
|
|
||||||
|
|
||||||
|
def is_valid_token_selection(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
session_data = ussd_session.get('data')
|
||||||
|
account_tokens_list = session_data.get('account_tokens_list')
|
||||||
|
if not account_tokens_list:
|
||||||
|
wait_for_session_data('Account token list', session_data_key='account_tokens_list', ussd_session=ussd_session)
|
||||||
|
if user_input not in ['00', '22']:
|
||||||
|
try:
|
||||||
|
user_input = int(user_input)
|
||||||
|
return user_input <= len(account_tokens_list)
|
||||||
|
except ValueError:
|
||||||
|
user_input = user_input.upper()
|
||||||
|
return any(token_data['symbol'] == user_input for token_data in account_tokens_list)
|
||||||
|
|
||||||
|
|
||||||
|
def process_token_selection(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
account_tokens_list = ussd_session.get('data').get('account_tokens_list')
|
||||||
|
try:
|
||||||
|
user_input = int(user_input)
|
||||||
|
selected_token = account_tokens_list[user_input-1]
|
||||||
|
except ValueError:
|
||||||
|
user_input = user_input.upper()
|
||||||
|
selected_token = next(token_data for token_data in account_tokens_list if token_data['symbol'] == user_input)
|
||||||
|
data = {
|
||||||
|
'selected_token': selected_token
|
||||||
|
}
|
||||||
|
save_session_data(queue='cic-ussd', session=session, data=data, ussd_session=ussd_session)
|
||||||
|
|
||||||
|
|
||||||
|
def set_selected_active_token(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
|
"""
|
||||||
|
:param state_machine_data:
|
||||||
|
:type state_machine_data:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
|
wait_for_session_data(resource_name='Selected token', session_data_key='selected_token', ussd_session=ussd_session)
|
||||||
|
selected_token = ussd_session.get('data').get('selected_token')
|
||||||
|
token_symbol = selected_token.get('symbol')
|
||||||
|
set_active_token(blockchain_address=account.blockchain_address, token_symbol=token_symbol)
|
||||||
|
|
||||||
|
|
||||||
@@ -5,18 +5,17 @@ from typing import Tuple
|
|||||||
# third party imports
|
# third party imports
|
||||||
import celery
|
import celery
|
||||||
from phonenumbers.phonenumberutil import NumberParseException
|
from phonenumbers.phonenumberutil import NumberParseException
|
||||||
|
from sqlalchemy.orm.session import Session
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.balance import get_cached_available_balance
|
from cic_ussd.account.balance import get_cached_available_balance
|
||||||
from cic_ussd.account.chain import Chain
|
from cic_ussd.account.chain import Chain
|
||||||
from cic_ussd.account.tokens import get_default_token_symbol
|
from cic_ussd.account.tokens import get_active_token_symbol, get_cached_token_data
|
||||||
from cic_ussd.account.transaction import OutgoingTransaction
|
from cic_ussd.account.transaction import OutgoingTransaction
|
||||||
from cic_ussd.db.enum import AccountStatus
|
|
||||||
from cic_ussd.db.models.account import Account
|
from cic_ussd.db.models.account import Account
|
||||||
from cic_ussd.db.models.base import SessionBase
|
|
||||||
from cic_ussd.phone_number import process_phone_number, E164Format
|
from cic_ussd.phone_number import process_phone_number, E164Format
|
||||||
from cic_ussd.session.ussd_session import save_session_data
|
from cic_ussd.session.ussd_session import save_session_data
|
||||||
from sqlalchemy.orm.session import Session
|
|
||||||
|
|
||||||
logg = logging.getLogger(__file__)
|
logg = logging.getLogger(__file__)
|
||||||
|
|
||||||
@@ -63,7 +62,11 @@ def has_sufficient_balance(state_machine_data: Tuple[str, dict, Account, Session
|
|||||||
:rtype: bool
|
:rtype: bool
|
||||||
"""
|
"""
|
||||||
user_input, ussd_session, account, session = state_machine_data
|
user_input, ussd_session, account, session = state_machine_data
|
||||||
return int(user_input) <= get_cached_available_balance(account.blockchain_address)
|
identifier = bytes.fromhex(account.blockchain_address)
|
||||||
|
token_symbol = get_active_token_symbol(account.blockchain_address)
|
||||||
|
token_data = get_cached_token_data(account.blockchain_address, token_symbol)
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
|
return int(user_input) <= get_cached_available_balance(decimals, [identifier, token_symbol.encode('utf-8')])
|
||||||
|
|
||||||
|
|
||||||
def save_recipient_phone_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]):
|
def save_recipient_phone_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]):
|
||||||
@@ -122,9 +125,10 @@ def process_transaction_request(state_machine_data: Tuple[str, dict, Account, Se
|
|||||||
to_address = recipient.blockchain_address
|
to_address = recipient.blockchain_address
|
||||||
from_address = account.blockchain_address
|
from_address = account.blockchain_address
|
||||||
amount = int(ussd_session.get('data').get('transaction_amount'))
|
amount = int(ussd_session.get('data').get('transaction_amount'))
|
||||||
token_symbol = get_default_token_symbol()
|
token_symbol = get_active_token_symbol(account.blockchain_address)
|
||||||
|
token_data = get_cached_token_data(account.blockchain_address, token_symbol)
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
outgoing_tx_processor = OutgoingTransaction(chain_str=chain_str,
|
outgoing_tx_processor = OutgoingTransaction(chain_str=chain_str,
|
||||||
from_address=from_address,
|
from_address=from_address,
|
||||||
to_address=to_address)
|
to_address=to_address)
|
||||||
outgoing_tx_processor.transfer(amount=amount, token_symbol=token_symbol)
|
outgoing_tx_processor.transfer(amount=amount, decimals=decimals, token_symbol=token_symbol)
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
# standard imports
|
# standard imports
|
||||||
|
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
|
|
||||||
# third-party imports
|
# external imports
|
||||||
import celery
|
import celery
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.balance import get_balances, calculate_available_balance
|
from cic_ussd.account.balance import get_balances, calculate_available_balance
|
||||||
@@ -13,8 +15,15 @@ from cic_ussd.cache import Cache, cache_data, cache_data_key, get_cached_data
|
|||||||
from cic_ussd.account.chain import Chain
|
from cic_ussd.account.chain import Chain
|
||||||
from cic_ussd.db.models.base import SessionBase
|
from cic_ussd.db.models.base import SessionBase
|
||||||
from cic_ussd.db.models.account import Account
|
from cic_ussd.db.models.account import Account
|
||||||
|
from cic_ussd.processor.util import wait_for_cache
|
||||||
from cic_ussd.account.statement import filter_statement_transactions
|
from cic_ussd.account.statement import filter_statement_transactions
|
||||||
from cic_ussd.account.transaction import transaction_actors
|
from cic_ussd.account.transaction import transaction_actors
|
||||||
|
from cic_ussd.account.tokens import (collate_token_metadata,
|
||||||
|
get_cached_token_data,
|
||||||
|
get_default_token_symbol,
|
||||||
|
handle_token_symbol_list,
|
||||||
|
process_token_data,
|
||||||
|
set_active_token)
|
||||||
from cic_ussd.error import AccountCreationDataNotFound
|
from cic_ussd.error import AccountCreationDataNotFound
|
||||||
from cic_ussd.tasks.base import CriticalSQLAlchemyTask
|
from cic_ussd.tasks.base import CriticalSQLAlchemyTask
|
||||||
|
|
||||||
@@ -56,6 +65,9 @@ def account_creation_callback(self, result: str, url: str, status_code: int):
|
|||||||
session.close()
|
session.close()
|
||||||
logg.debug(f'recorded account with identifier: {result}')
|
logg.debug(f'recorded account with identifier: {result}')
|
||||||
|
|
||||||
|
token_symbol = get_default_token_symbol()
|
||||||
|
set_active_token(blockchain_address=result, token_symbol=token_symbol)
|
||||||
|
|
||||||
queue = self.request.delivery_info.get('routing_key')
|
queue = self.request.delivery_info.get('routing_key')
|
||||||
s_phone_pointer = celery.signature(
|
s_phone_pointer = celery.signature(
|
||||||
'cic_ussd.tasks.metadata.add_phone_pointer', [result, phone_number], queue=queue
|
'cic_ussd.tasks.metadata.add_phone_pointer', [result, phone_number], queue=queue
|
||||||
@@ -86,8 +98,16 @@ def balances_callback(result: list, param: str, status_code: int):
|
|||||||
raise ValueError(f'Unexpected status code: {status_code}.')
|
raise ValueError(f'Unexpected status code: {status_code}.')
|
||||||
|
|
||||||
balances = result[0]
|
balances = result[0]
|
||||||
identifier = bytes.fromhex(param)
|
identifier = []
|
||||||
key = cache_data_key(identifier, ':cic.balances')
|
param = param.split(',')
|
||||||
|
for identity in param:
|
||||||
|
try:
|
||||||
|
i = bytes.fromhex(identity)
|
||||||
|
identifier.append(i)
|
||||||
|
except ValueError:
|
||||||
|
i = identity.encode('utf-8')
|
||||||
|
identifier.append(i)
|
||||||
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.BALANCES)
|
||||||
cache_data(key, json.dumps(balances))
|
cache_data(key, json.dumps(balances))
|
||||||
|
|
||||||
|
|
||||||
@@ -120,6 +140,38 @@ def statement_callback(self, result, param: str, status_code: int):
|
|||||||
generate(param, queue, sender_transaction)
|
generate(param, queue, sender_transaction)
|
||||||
|
|
||||||
|
|
||||||
|
@celery_app.task
|
||||||
|
def token_data_callback(result: dict, param: str, status_code: int):
|
||||||
|
"""
|
||||||
|
:param result:
|
||||||
|
:type result:
|
||||||
|
:param param:
|
||||||
|
:type param:
|
||||||
|
:param status_code:
|
||||||
|
:type status_code:
|
||||||
|
:return:
|
||||||
|
:rtype:
|
||||||
|
"""
|
||||||
|
|
||||||
|
if status_code != 0:
|
||||||
|
raise ValueError(f'Unexpected status code: {status_code}.')
|
||||||
|
|
||||||
|
token = result[0]
|
||||||
|
token_symbol = token.get('symbol')
|
||||||
|
identifier = token_symbol.encode('utf-8')
|
||||||
|
token_meta_key = cache_data_key(identifier, MetadataPointer.TOKEN_META_SYMBOL)
|
||||||
|
token_info_key = cache_data_key(identifier, MetadataPointer.TOKEN_PROOF_SYMBOL)
|
||||||
|
token_meta = get_cached_data(token_meta_key)
|
||||||
|
token_meta = json.loads(token_meta)
|
||||||
|
token_info = get_cached_data(token_info_key)
|
||||||
|
token_info = json.loads(token_info)
|
||||||
|
token_data = collate_token_metadata(token_info=token_info, token_metadata=token_meta)
|
||||||
|
token_data = {**token_data, **token}
|
||||||
|
token_data_key = cache_data_key([bytes.fromhex(param), identifier], MetadataPointer.TOKEN_DATA)
|
||||||
|
cache_data(token_data_key, json.dumps(token_data))
|
||||||
|
handle_token_symbol_list(blockchain_address=param, token_symbol=token_symbol)
|
||||||
|
|
||||||
|
|
||||||
@celery_app.task(bind=True)
|
@celery_app.task(bind=True)
|
||||||
def transaction_balances_callback(self, result: list, param: dict, status_code: int):
|
def transaction_balances_callback(self, result: list, param: dict, status_code: int):
|
||||||
"""
|
"""
|
||||||
@@ -136,10 +188,15 @@ def transaction_balances_callback(self, result: list, param: dict, status_code:
|
|||||||
"""
|
"""
|
||||||
if status_code != 0:
|
if status_code != 0:
|
||||||
raise ValueError(f'Unexpected status code: {status_code}.')
|
raise ValueError(f'Unexpected status code: {status_code}.')
|
||||||
|
|
||||||
balances_data = result[0]
|
balances_data = result[0]
|
||||||
available_balance = calculate_available_balance(balances_data)
|
|
||||||
transaction = param
|
transaction = param
|
||||||
|
token_symbol = transaction.get('token_symbol')
|
||||||
|
blockchain_address = transaction.get('blockchain_address')
|
||||||
|
identifier = [bytes.fromhex(blockchain_address), token_symbol.encode('utf-8')]
|
||||||
|
wait_for_cache(identifier, f'Cached token data for: {token_symbol}', MetadataPointer.TOKEN_DATA)
|
||||||
|
token_data = get_cached_token_data(blockchain_address, token_symbol)
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
|
available_balance = calculate_available_balance(balances_data, decimals)
|
||||||
transaction['available_balance'] = available_balance
|
transaction['available_balance'] = available_balance
|
||||||
queue = self.request.delivery_info.get('routing_key')
|
queue = self.request.delivery_info.get('routing_key')
|
||||||
|
|
||||||
@@ -173,6 +230,8 @@ def transaction_callback(result: dict, param: str, status_code: int):
|
|||||||
source_token_symbol = result.get('source_token_symbol')
|
source_token_symbol = result.get('source_token_symbol')
|
||||||
source_token_value = result.get('source_token_value')
|
source_token_value = result.get('source_token_value')
|
||||||
|
|
||||||
|
process_token_data(blockchain_address=recipient_blockchain_address, token_symbol=destination_token_symbol)
|
||||||
|
|
||||||
recipient_metadata = {
|
recipient_metadata = {
|
||||||
"alt_blockchain_address": sender_blockchain_address,
|
"alt_blockchain_address": sender_blockchain_address,
|
||||||
"blockchain_address": recipient_blockchain_address,
|
"blockchain_address": recipient_blockchain_address,
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import logging
|
|||||||
import celery
|
import celery
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
|
from cic_ussd.account.tokens import get_cached_token_data
|
||||||
from cic_ussd.account.transaction import from_wei
|
from cic_ussd.account.transaction import from_wei
|
||||||
from cic_ussd.notifications import Notifier
|
from cic_ussd.notifications import Notifier
|
||||||
from cic_ussd.phone_number import Support
|
from cic_ussd.phone_number import Support
|
||||||
@@ -25,11 +26,15 @@ def transaction(notification_data: dict):
|
|||||||
"""
|
"""
|
||||||
role = notification_data.get('role')
|
role = notification_data.get('role')
|
||||||
token_value = notification_data.get('token_value')
|
token_value = notification_data.get('token_value')
|
||||||
amount = token_value if token_value == 0 else from_wei(token_value)
|
token_symbol = notification_data.get('token_symbol')
|
||||||
|
blockchain_address = notification_data.get('blockchain_address')
|
||||||
|
token_data = get_cached_token_data(blockchain_address, token_symbol)
|
||||||
|
decimals = token_data.get('decimals')
|
||||||
|
amount = token_value if token_value == 0 else from_wei(decimals, token_value)
|
||||||
balance = notification_data.get('available_balance')
|
balance = notification_data.get('available_balance')
|
||||||
phone_number = notification_data.get('phone_number')
|
phone_number = notification_data.get('phone_number')
|
||||||
preferred_language = notification_data.get('preferred_language')
|
preferred_language = notification_data.get('preferred_language')
|
||||||
token_symbol = notification_data.get('token_symbol')
|
|
||||||
alt_metadata_id = notification_data.get('alt_metadata_id')
|
alt_metadata_id = notification_data.get('alt_metadata_id')
|
||||||
metadata_id = notification_data.get('metadata_id')
|
metadata_id = notification_data.get('metadata_id')
|
||||||
transaction_type = notification_data.get('transaction_type')
|
transaction_type = notification_data.get('transaction_type')
|
||||||
|
|||||||
@@ -2,9 +2,10 @@
|
|||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
# third-party imports
|
# external imports
|
||||||
import celery
|
import celery
|
||||||
import i18n
|
import i18n
|
||||||
|
from cic_types.condiments import MetadataPointer
|
||||||
|
|
||||||
# local imports
|
# local imports
|
||||||
from cic_ussd.account.metadata import get_cached_preferred_language
|
from cic_ussd.account.metadata import get_cached_preferred_language
|
||||||
@@ -46,10 +47,11 @@ def cache_statement(parsed_transaction: dict, querying_party: str):
|
|||||||
statement_transactions = []
|
statement_transactions = []
|
||||||
if cached_statement:
|
if cached_statement:
|
||||||
statement_transactions = json.loads(cached_statement)
|
statement_transactions = json.loads(cached_statement)
|
||||||
statement_transactions.append(parsed_transaction)
|
if parsed_transaction not in statement_transactions:
|
||||||
|
statement_transactions.append(parsed_transaction)
|
||||||
data = json.dumps(statement_transactions)
|
data = json.dumps(statement_transactions)
|
||||||
identifier = bytes.fromhex(querying_party)
|
identifier = bytes.fromhex(querying_party)
|
||||||
key = cache_data_key(identifier, ':cic.statement')
|
key = cache_data_key(identifier, MetadataPointer.STATEMENT)
|
||||||
cache_data(key, data)
|
cache_data(key, data)
|
||||||
|
|
||||||
|
|
||||||
@@ -73,6 +75,14 @@ def parse_transaction(transaction: dict) -> dict:
|
|||||||
role = transaction.get('role')
|
role = transaction.get('role')
|
||||||
alt_blockchain_address = transaction.get('alt_blockchain_address')
|
alt_blockchain_address = transaction.get('alt_blockchain_address')
|
||||||
blockchain_address = transaction.get('blockchain_address')
|
blockchain_address = transaction.get('blockchain_address')
|
||||||
|
identifier = bytes.fromhex(blockchain_address)
|
||||||
|
token_symbol = transaction.get('token_symbol')
|
||||||
|
if role == 'recipient':
|
||||||
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_LAST_RECEIVED)
|
||||||
|
cache_data(key, token_symbol)
|
||||||
|
if role == 'sender':
|
||||||
|
key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_LAST_SENT)
|
||||||
|
cache_data(key, token_symbol)
|
||||||
account = validate_transaction_account(blockchain_address, role, session)
|
account = validate_transaction_account(blockchain_address, role, session)
|
||||||
alt_account = session.query(Account).filter_by(blockchain_address=alt_blockchain_address).first()
|
alt_account = session.query(Account).filter_by(blockchain_address=alt_blockchain_address).first()
|
||||||
if alt_account:
|
if alt_account:
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# standard imports
|
# standard imports
|
||||||
import semver
|
import semver
|
||||||
|
|
||||||
version = (0, 3, 1, 'alpha.5')
|
version = (0, 3, 1, 'alpha.6')
|
||||||
|
|
||||||
version_object = semver.VersionInfo(
|
version_object = semver.VersionInfo(
|
||||||
major=version[0],
|
major=version[0],
|
||||||
|
|||||||
2
apps/cic-ussd/config/chain.ini
Normal file
2
apps/cic-ussd/config/chain.ini
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
[chain]
|
||||||
|
spec =
|
||||||
@@ -1,5 +1,2 @@
|
|||||||
[cic]
|
[cic]
|
||||||
engine = evm
|
|
||||||
common_name = bloxberg
|
|
||||||
network_id = 8996
|
|
||||||
meta_url = http://localhost:63380
|
meta_url = http://localhost:63380
|
||||||
|
|||||||
2
apps/cic-ussd/config/test/chain.ini
Normal file
2
apps/cic-ussd/config/test/chain.ini
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
[chain]
|
||||||
|
spec = 'evm:foo:1:bar'
|
||||||
@@ -1,5 +1,2 @@
|
|||||||
[cic]
|
[cic]
|
||||||
engine = evm
|
|
||||||
common_name = bloxberg
|
|
||||||
network_id = 8996
|
|
||||||
meta_url = http://test-meta.io
|
meta_url = http://test-meta.io
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user