mirror of https://github.com/status-im/S-Pesa.git
initial commit
This commit is contained in:
commit
8b090be114
|
@ -0,0 +1,24 @@
|
|||
/nimcache
|
||||
|
||||
# Executables shall be put in an ignored build/ directory
|
||||
/build
|
||||
|
||||
# Nimble packages
|
||||
/vendor/.nimble
|
||||
|
||||
# ntags/ctags output
|
||||
/tags
|
||||
|
||||
# Ignore dynamic, static libs and libtool archive files
|
||||
*.so
|
||||
*.dylib
|
||||
*.a
|
||||
*.la
|
||||
*.exe
|
||||
*.dll
|
||||
|
||||
VMTests.md
|
||||
/debug*.json
|
||||
/block*.json
|
||||
|
||||
/SPesa
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2018 Status Research & Development GmbH
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Status Research & Development GmbH
|
||||
|
||||
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.
|
|
@ -0,0 +1,113 @@
|
|||
<!-- <p align="center"><img src="https://raw.githubusercontent.com/status-im/spesa/master/docs/spesa.png"></p> -->
|
||||
<h1 align="center">S-PESA</h1>
|
||||
<h2 align="center">Smart Pesa - a USSD/SMS Interface to Smart Contracts, #defi & Decentralised Applications.</h2>
|
||||
<h3>(A Status Client for Feature Phones)</h3>
|
||||
|
||||
Smart Pesa is a USSD/SMS Interface to Smart Contracts, #defi & Decentralised Applications
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Purpose](#purpose)
|
||||
- [Features](#features)
|
||||
- [Who is it for?](#who-is-it-for)
|
||||
- [What S-PESA isn't](#what-s-pesa-isnt)
|
||||
- [Where does this tool come from?](#where-does-this-tool-come-from)
|
||||
- [Get started](#get-started)
|
||||
- [Requirements](#requirements)
|
||||
- [Contribute](#contribute)
|
||||
- [As a community](#as-a-community)
|
||||
- [Contribute as a developer](#contribute-as-a-developer)
|
||||
- [Principles, vision, goals](#principles-vision-goals)
|
||||
- [Principles](#principles)
|
||||
- [Vision](#vision)
|
||||
- [Goals](#goals)
|
||||
- [Todo](#todo)
|
||||
- [License](#license)
|
||||
|
||||
## Introduction
|
||||
|
||||
TODO
|
||||
|
||||
### Purpose
|
||||
|
||||
To allow coordination of source code and binary releases among a group of actors you don't know.
|
||||
|
||||
### Features
|
||||
|
||||
- TODO
|
||||
|
||||
### Who is it for?
|
||||
|
||||
TODO
|
||||
|
||||
### What S-PESA isn't
|
||||
|
||||
- TODO
|
||||
|
||||
### Where does this tool come from?
|
||||
|
||||
TODO
|
||||
|
||||
## Get started
|
||||
|
||||
`nimble build`
|
||||
|
||||
### Requirements
|
||||
|
||||
- Nim 0.19 or above
|
||||
- Git
|
||||
- An Ethereum Node
|
||||
- Redis Server
|
||||
|
||||
## Contribute
|
||||
|
||||
Do you want to help? That's awesome. Here are simple things you can do.
|
||||
|
||||
### As a community
|
||||
|
||||
* Unlike Fight Club, the best way to help is **to actually talk about the project** as much as you can (blog post, articles, Twitter, Facebook).
|
||||
* You can answer questions in [the issue tracker](https://github.com/status-im/S-PESA/issues) to help other community members.
|
||||
|
||||
## Contribute as a developer
|
||||
|
||||
* Read our [Contribution Guide](/CONTRIBUTING.md).
|
||||
* Install the developer version locally so you can start contributing [instructions](/docs/contribute/index.md).
|
||||
* Look for [issues labelled bugs](https://github.com/status-im/S-PESA/issues?q=is%3Aopen+is%3Aissue+label%3Abug) if you are looking to have an immediate impact on the project.
|
||||
* Look for [issues labelled Help wanted](https://github.com/status-im/S-PESA/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) These are issues that you can solve relatively easily.
|
||||
* Look for [issues labelled Good first issue](https://github.com/status-im/S-PESA/labels/good%20first%20issue) These issues are for people who want to contribute, but try to work on a small feature first.
|
||||
* If you are an advanced developer, you can try to tackle [issues labelled feature requests](https://github.com/status-im/SPesa/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature+request%22). Beware though - they are harder to do and will require a lot of back and forth with the repository administrator in order to make sure we are going to the right direction with the product.
|
||||
|
||||
We welcome contributions of all kinds from anyone.
|
||||
|
||||
## Principles, vision, goals
|
||||
|
||||
Software are cultural artefacts, and as such I want to embed in them the ability to uphold [human rights](http://www.un.org/en/universal-declaration-human-rights/).
|
||||
|
||||
### Principles
|
||||
|
||||
You can read [Status' Principles here](https://our.status.im/our-principles/).
|
||||
|
||||
* Liberty
|
||||
* Censorship resistance
|
||||
* Security
|
||||
* Privacy
|
||||
* Transparency
|
||||
* Openness
|
||||
* Decentralization
|
||||
* Inclusivity
|
||||
* Continuance
|
||||
* Resourcefulness
|
||||
|
||||
### Vision
|
||||
|
||||
S-PESA's vision is **TODO**.
|
||||
|
||||
### Goals
|
||||
|
||||
- TODO
|
||||
|
||||
### Todo
|
||||
- TODO
|
||||
|
||||
## License
|
||||
|
||||
This software is released licensed under [MIT](/LICENSE-MIT) or [Apache 2.0](/LICENSE-APACHEv2).
|
|
@ -0,0 +1,18 @@
|
|||
mode = ScriptMode.Verbose
|
||||
|
||||
version = "0.0.1"
|
||||
author = "Status Research & Development GmbH"
|
||||
description = "Smart Pesa - a USSD/SMS Interface for Smart Contracts, #defi & Decentralised Applications. \nA Status Client for Feature Phones"
|
||||
license = "MIT or Apache License 2.0"
|
||||
srcDir = "src"
|
||||
bin = @["SPesa"]
|
||||
|
||||
|
||||
|
||||
# Dependencies
|
||||
|
||||
requires "nim >= 0.20.2"
|
||||
requires "redis >= 0.3.0" # Session State?
|
||||
requires "httpbeast >= 0.2.2"
|
||||
requires "compiler >= 0.20.2" # NimScript DApplets, https://github.com/Serenitor/embeddedNimScript
|
||||
# nimble install https://github.com/status-im/nim-web3@#master ?
|
|
@ -0,0 +1 @@
|
|||
TODO
|
|
@ -0,0 +1,52 @@
|
|||
import options, asyncdispatch, tables, strutils
|
||||
import httpbeast, uri
|
||||
from sequtils import mapIt
|
||||
|
||||
|
||||
# TODO: handle USSD HTTP POST
|
||||
# TODO: array access menu system
|
||||
# TODO: pin-based registration system (key gen and encrypt with truncated hash of phone number and pin?)
|
||||
# TODO: PoC Send/Receive
|
||||
|
||||
# http://blog.microsave.net/2015/09/15/designing-an-effective-user-interface-for-ussd-part2/
|
||||
# "Geography" specific main menu
|
||||
# Limited unbundled main menu
|
||||
# Nesting only complementary options
|
||||
# Customised menu based on usage history
|
||||
# Using familiar terms
|
||||
|
||||
|
||||
# https://build.at-labs.io/docs/ussd%2Foverview
|
||||
# sessionId
|
||||
# String A unique value generated when the session starts and sent every time a mobile subscriber response has been received.
|
||||
# phoneNumber
|
||||
# String The number of the mobile subscriber interacting with your ussd application.
|
||||
# networkCode
|
||||
# String The telco of the phoneNumber interacting with your ussd application.
|
||||
# serviceCode
|
||||
# String This is your USSD code. Please note that it doesn’t show your channel on shared USSD codes.
|
||||
# text
|
||||
# String This shows the user input. It is an empty string in the first notification of a session. After that, it concatenates all the user input within the session with a * until the session ends.
|
||||
|
||||
|
||||
# var
|
||||
# menu = { 0: "Send Money",
|
||||
# 1: "Withdraw Cash",
|
||||
# 1: "My Account",
|
||||
# }.toTable
|
||||
|
||||
# # proc register() =
|
||||
# # TODO
|
||||
|
||||
proc onRequest(req: Request): Future[void] =
|
||||
if req.httpMethod == some(HttpPost):
|
||||
let
|
||||
uri = parseUri(req.body.get())
|
||||
params = uri.query.split('&').mapIt($(it.split('=')))
|
||||
req.send("Hello")
|
||||
else:
|
||||
req.send(Http404)
|
||||
|
||||
when isMainModule:
|
||||
run(onRequest)
|
||||
|
Loading…
Reference in New Issue