cic-docs/README.md

96 lines
8.4 KiB
Markdown
Raw Normal View History

2020-01-15 11:57:44 +01:00
## Community Inclusion Currencies (CICs) Documentation
2020-05-17 09:06:15 +02:00
Community Inclusion Currency (CIC) technology seeks to give organizations and communities the ability to issue, use and manage CICs in order to build resilient and connected economies.
2020-11-04 13:19:36 +01:00
## General Documentation
2020-05-26 16:54:29 +02:00
+ [White Paper](https://gitlab.com/grassrootseconomics/cic-docs/-/blob/master/CIC-White-Paper.pdf)
2020-06-13 10:20:33 +02:00
+ [Training Materials](https://docs.google.com/document/d/1CI-Xz9R3FgZ70uWgq81U5uwfaYrm9f6Ji4f7dL2-V90/edit?usp=sharing)
2020-05-15 11:12:01 +02:00
+ [Frequently Asked Questions](https://docs.google.com/document/d/1qtlOEL4pqW1vOL893BaXH9OqRSAO3k0q2eWbVIkxEvU/edit?usp=sharing)
+ [Blog](https://www.grassrootseconomics.org/blog)
+ [MOOC](https://www.grassrootseconomics.org/mooc) - Very old (paper based systems)
2020-05-15 11:12:01 +02:00
+ [Village Market Simulator series](https://www.youtube.com/playlist?list=PLPUExzwZAUpbEInJy_8Wj_c_mDsw7-qXe)
2020-06-13 10:20:33 +02:00
+ [Transaction Data CSVs](https://www.grassrootseconomics.org/research): Transaction Datasets and Research
+ [Live Data Dashboard](https://dashboard.sarafu.network)
2020-07-27 10:42:13 +02:00
+ [Animated Explainer Video](https://www.youtube.com/watch?v=vJL9-FFleow)
2020-05-14 11:56:02 +02:00
## Open source code
2020-11-04 13:46:13 +01:00
+ [Code Reposity Overview](https://gitlab.com/grassrootseconomics/cic-platform/-/wikis/BLOXBERG-component-overview)
2020-06-13 10:20:33 +02:00
+ [Managment Platform](https://gitlab.com/grassrootseconomics/cic-platform)
2020-05-15 11:12:01 +02:00
+ [Dashboard](https://github.com/GrassrootsEconomics/Accdash) [Dashboard API](https://github.com/GrassrootsEconomics/Accap)
+ [Blockchain Smart Contract](https://github.com/bancorprotocol/contracts)
2020-05-14 11:56:02 +02:00
## CIC full system vision ##
2020-05-15 11:12:01 +02:00
* Blockchain
2020-11-03 14:45:33 +01:00
* Currently: We are on a public blockchain (Layer 2 side chain)
* Goal: To ensure decentralization, censor proofing and fair gas prices we plan to setup a validation node on this chain and look into possible Humanitarian Blockchains like bloxberg.org.
2020-05-14 11:56:02 +02:00
* Blockchain Contracts
2020-11-03 14:45:33 +01:00
* Bridge - in order to move between the side chains (Layer 2) and the Ethereum main net we need a bridge
* Currently: We have no connections to Ethereum Mainnet
2020-05-14 11:56:02 +02:00
* Goal: To have options to bridge to a variety of potential reserves
2020-06-13 10:32:33 +02:00
* Bonding Curves - Enable us to add collateral (aka Reserves to CICs) as well as connect CICs to each other in a safe way.
2020-05-17 09:06:15 +02:00
* Currently: Bancor Protocol v1 - [Blockchain Smart Contract](https://github.com/bancorprotocol/contracts)
* Contract Deployment (Currency Creation service)
2020-05-14 11:56:02 +02:00
* Currently: We currently deploy the Bancor Contract suite manually via Command line
2020-11-03 14:45:33 +01:00
* Goal: A web based interface for organizations and communities to create their own tokens
2020-06-13 09:57:50 +02:00
* CIC Token Creation system
* Currently: Manual contract deployment (command line)
* Registered organizations can submit an application to be an issuer, they must have:
* an audited and legally binding backing commitment signed by local government to back the total amount of a CIC .
2020-11-03 14:45:33 +01:00
* A collateral fund of Sarafu tokens equal to 100% of the tokens they want to create.
* These new CIC tokens are created and the converter contract is given the sole ability to create and destroy them based on a bonding curve equation THe converter also holds the collateral (reserve or pool) of Sarafu
2020-06-13 09:57:50 +02:00
* Cloud server - is where we host all of our systems, Platform, Dashboard, future blockchain node.
* Currently: We are using AWS for instances and data storgage along with postgress databases - Transactions are done here first then synced with blockchain
* Goal: Moving toward a webased wallet and cloud storage
2020-05-14 11:56:02 +02:00
* Dashboard
2020-06-13 09:57:50 +02:00
* Currently: [Our dashboard](https://dashboard.sarafu.network) uses a D3 javascript we also have an internal dashboard for CIC platform administrators.
* We are pulling data from an internal postgres database on the CIC Mgmt Platform as well as blockchain transaction data from BlockScout
2020-05-14 11:56:02 +02:00
* Goal: To have system related information available to field officers and users on Android phones and to pull data from our own blockchain node.
2020-06-13 09:57:50 +02:00
* To allow donors to give directly and measure the impact of their giving
* To visualize trade and the health of economies and communities
2020-05-14 11:56:02 +02:00
* Simulations
2020-06-13 09:57:50 +02:00
* Currently: We started with a home grown Village Market Simulator and are currently are developing and using a cadCAD based [modeling](https://gitlab.com/grassrootseconomics/cic-modeling) simulation built by BlockScience
2020-05-14 11:56:02 +02:00
* Goal: To build on this simulation to validate and stress test economic models and to provide predictive analysis based on data
* Marketplace
2020-06-13 09:57:50 +02:00
* Currently: Mostly word of mouth but Grassroots Economics provides limited signage to users and marketing of products in the network is done by word of mouth, SMS messaging and a phone support team.
* Goal: A web based interface for organizations and communities to share projects, event offers and wants using CICs
2020-05-14 11:56:02 +02:00
* CIC Management Platform
* Currently: System admins (GE staff) are able to assist users to reset pins, reverse transactions, create new users. The system is build on React and Flask in Python and uses postgres for data stroage.
2020-06-13 10:32:33 +02:00
* Goal: Stabilization of the platform and synchronization to blockchain, and eventual migration to a webBased wallet system with cloud storage with minimal need.
2020-05-14 11:56:02 +02:00
* Wallet:
2020-06-13 09:47:00 +02:00
* Currently: Users connect via USSD through AfricasTalking to connect with their wallet on the CIC Mgmt Platform, private keys are held by Grassroots Economics for these phones
2020-05-14 11:56:02 +02:00
* Goal:
2020-06-13 09:47:00 +02:00
* WebApp
* Non custodial
* Social account recovery
* Cloud data storage (Swarm/IPFS) - opt in data, with an option sharing and for 3rd party validation
* Market Place linkages
* Auto-conversion so you only have one (CIC) token (your community token) - all other tokens auto convert
* CIC aware
* you can change your home token to another
* You can see the stats of any CIC you want to trade with or change to
* You can see the effect of cashing in and cashing out on the CIC
* Payment Rails
* Ability to add National currency (Mpesa) in order to create/buy more CIC
* Ability to liquidate a CIC for National Currency (Mpesa)
* Fiat On-ramp / off-ramp - In order to enable users and donors to interact with CICs we need a way to move fiat on and off the blockchain
2020-06-13 10:32:33 +02:00
* Currently: the float account is in no way linked to blockchain and handled manually (bank transfers)
2020-06-13 09:47:00 +02:00
* We currently move Fiat (USD/EUR) on an off the blockchains we use via exchanges such as BitCoinSwiss and local cryptos connected to Banks as well as eMoney
* You can send Mpesa (eMoney) to our lipa na Mpesa account GE sees that and sends back tokens
2020-06-13 09:57:50 +02:00
* You can also send tokens to GE and GE sends back Mpesa from the float account (this currently very restricted)
* Goal: To make credit card another other payment on and offramps available and streamline our fiat to token processes ... blockchain integration
2020-11-03 14:45:33 +01:00
* Exchange Rates will be variable based on the CIC → KSH rate (depends on amount of collateral) Spot price: P = R/S (R= reserve S = Supply) but they will also take into account transfer fees.
* Blockchain interaction (once bridged)
* Anyone who can obtain or create any reserve token and send it directly to any CIC converter blockchain contract. They will mint an amount of that CIC based on the bonding curve equation.
* Anyone can also send a CIC to the same contract to liquidate it and pull out the reserve token.
2020-05-14 11:56:02 +02:00
* ID System -
* Currently: Each user has a sim card and the Telecom provides KYC services - users are asked a pin number to access the account on USSD
2020-06-13 09:57:50 +02:00
* Goal: Creating a more robust ID system for users with and without sim cards. Possibly adding brightID social ID - like technologies with confidence scoring or 3rd party biometrics
2020-06-13 10:32:33 +02:00
* Non custodial data ownership on cloud where users can specify what data tehy want to make avalible
2020-05-17 09:06:15 +02:00
* Rewards and Incentives - [see specifications](./spec/001_platform_incentives.md)
2020-05-14 11:56:02 +02:00
* Currently: These incentive systems are a mixture of manual and CIC Mgmt Platform base, such as initial user air drop, referral bonuses and holding fees.
2020-11-03 14:45:33 +01:00
* Currently: We are using a CIC by the name of Sarafu that is backed by Grassroots Economics' (donor funds). Users get a Sarafu for free and groups will be able to create their own CICs by placing Sarafu as reserve.
2020-05-14 11:56:02 +02:00
* Goal: Any org developing a CIC can easily establish various rules and policies
2020-06-13 09:57:50 +02:00
* Training Materials:
2020-06-13 10:32:33 +02:00
* Currently: We are developing curriculum, games and materials for training communities and CIC issuers
2020-05-14 11:56:02 +02:00