Version 1.0.0

• Link to working Dapp (Please make sure you signed into metamask - Rinkeby network and have some test ether. You can get some here - https://faucet.rinkeby.io/)

1. Installation

2. Documentation

   • Scope and Overview
   • Assumptions
   • Additional Mechanisms
   • How To Use
   • Tech Stack and Tools
   • Smart Contract Architecture
   • Progress
   • Improvements

3. Thanks

4. Copyright and license

- git clone https://github.com/Christopher-I/UNICEFConnectKids
- cd UNICEFConnectKids
- npm run i
- $ npm run dev

Goal: Create a dapp that manages internet connectivity and transactions for schools across the world in a fair, transparent and self-sustaining approach.

• Country: Nigeria.

• Participants: The General Public / Donors, ISPs and Schools.

• Sample Size : 3 schools and 3 ISPs.

• Important Variables

  • Cycle Period : An agreed period of time between the ISP and school, during this time the ISP provides internet service to a school. At the end of this period, the ISP is graded on their service perfomance and either compensated in crypto or a new service provider is automatically chosen by a smart contract function.

  • Amount Needed to Fund Additional School: To minimize internet service interuptions in schools. X amount of cypto needs to accumulate in a smart contract before a new ISP agreemenent is automatically triggered. For example, to engange a new ISP 6 months of minimum funding should be available before an ISP is engaged.

  • School Prioritazation Factors: How does the Dapp know which school to connect next if funds are available? In the current version of this Dapp population is used as the determining factor, future iterations will account for other factors such as location and target more resource poor areas.

• All important variables listed in the scope and overview section can temporarily be manipulated from an Admin console . After further testing and gathering reliable information, these variables can be hard coded into the smart contracts.

• Payments to ISPs are in ETH(Wei).

• To build a truly self-sustaining Dapp, ISPs and schools will need to digitally sign a terms and conditions agreement that the Dapp requires to make decisions such as prioritizing schools for service provision or terminating the contract of a poorly performing ISP.

• Data Source: All data connectivity information and crypto-currency transctions used in Dapp are retrieved from the ethereum blockchain.

• Connectivity information such as upload/download speeds are received via a solidity smart contract from ISPs and Schools.

• An average mean upload /download speed and data size provision are sent every day from the schools and ISPs.

• One ISP at a time is responsible for providing connectivity to all schools within a country(future iterations will allow multiple ISPs to manage different schools within a country).

• ISPs and Schools apply to be part of the Dapp and are approved by an admin (to prevent spamming of the network and ensure all participants are real).

• Participants can use metamask, future iterations allow any one with a web browser to access the platform without the need of a wallet.

• Transactions and daily connectivity data is stored on the ethereum blockchain.

• Dapp automatically manages the selection of ISP providers and the prioritization of schools to receive service.

• An ISP can dispute a report of its performance.

• On initial launch, by default the country manager smart contract picks the first school and ISP applicants and then at the end of the first cycle period, ISP providers are chosen based on merit and schools based on population. This is designed this way to encourage early adoption of the Dapp.

• At the end of every cycle period 'X days', an ETH alarm clock (https://www.ethereum-alarm-clock.com/) automatically triggers certain solidity functions to compute the average daily performace of the ISP provider and subsequently pays the ISP provider based on their perfomance (number of days they achieved the minimum service requirements) OR switch to a different provider if the ISP was unable to meet the minimum requirement at the end of the cycle.

• The current ISP provider is chosen by a bidding system via a smart contract based on quality of service it promises to provide( faster download/upload speeds) and its previous history of performance. This way the best service providers over time will have a bidding advantage.

• After every succesful grade at the end of cycle, ISP receive 'consistency points' which are a positive factor when bidding for future ISP opportunities.

Quick Instructional Video

OR

• Wallet Settings : This Dapp was designed to work with metamask, so please sign into metamask and ensure you are on the Rinkeby Network.

• Start

  • Clone this repo. Then navigate to the root directory of repo.
  • $ npm i

• Deploy a new contract to Rinkeby

  • $ cd ethereum
  • $ node compile && node deploy
  • Copy main contract address that will be displayed on command line.
  • $ touch ListofSmartCOntractAddresses
  • Paste main contract address into variable called Main Contract Address ALSO paste your address into the owner address variable, this will be used to access all the smart contracts during the test phase.

• Deploy a new country manager

  • return to the root folder of the repo
  • $ npm run dev
  • open http://localhost:3000/ in your browser
  • Click Log In button at the top right of the menu bar and then click ok when prompted for user name/password(no need to enter any information). You should be automatically redirected to the admin console.
  • In the section labelled "Add New Country Manager", enter the name of the country(Nigeria) you wish to create and click register. Copy the newly deployed country contract address which will be displayed on the screen below the register button.
  • $ cd ethereum && touch ListofSmartContractAddressses.
  • paste the address into the variable called "country manager address".

• Deploy a new school/ISP contract

  • open http://localhost:3000/ in your browser

  • Click apply as School / ISP and completely fill all the information in the forms. It is recommended you use the following school names and locations below as they are already preconfigured to display on the map and are also real schools in Nigeria that are a part of the Unicef program - http://school-mapping.azurewebsites.net/

    • Name: "Holy Trinity Primary School", Population: "enter a number", Location: "Lagos", OwnersAddress: "enter your eth address or any prefrred eth address"

    • Name: "Garam Primary School", Population:"enter a number", Location:"Kaduna",OwnersAddress:"enter your eth address or any prefrred eth address"

    • Name: "Glisten Academy", Population:"enter a number", Location:"Abuja",OwnersAddress:"enter your eth address or any prefrred eth address"

  • Click register, and the newly deployed schools address will display at bottom of the screen. Return to overview page by clicking the home buttom at the top right corner in the menu. You should all see all the newly created ISP and school information displayed.

• Make donation

  • In the overview page, enter and amount into the donation section and click enter and a successful transaction, the transaction information will be displayed in the accounting table on the same page.

• View Connectivity

  • Click on on details on the right-most side of the School tab on the home page.

• Blockchain protocol - Ethereum(Rinkeby Network).

• Front End - JavaScript, React, Html, CSS.

• Back End - Solidity, Node.js, NextJs.

• Other Libraries and Tools - ETH Timer, Truffle, Web3.

• The Ethereum Alarm Clock is a service that allows scheduling transactions to be executed at a later time on the ethereum blockchain- Eth alarm clock website. This will be used to safely make calls to the smart contracts at the end of each cycle.

• Main Smart Contract: It oversees the creation and managment of 'country manager' smart contracts and sets important overeaching varaibles such as cycle period and minimum perfomance requirement of ISPs.

• Country Manager Contract: It oversees the creation and management of ISP and school smart contracts. It also keeps a record of all financial and data connectivity information within a country.

• School Contract : Defines the identity of each school on the platform and sends connectivity information to its overseeing country manager smart contract. This contract owner can also be an IOT device.

• ISP Contract : Defines the identity of each ISP on the platform and sends connectivity information to its overseeing country manager smart contract. It also receives funds sent by smart contracts at the end of each cycle. The controller of this contract should be a representative of the ISP.

• Working back and front end.

• Back and front end connected.

• Details:

  • Users can see a list of countries

  • Users can select a specific country and view the schools related to the selected item.

  • Users can view the schools that are connected and not connected for that country.

  • Users can see the status of that country (e.g. if donors have provided funding, if ISPs are engaged, number of schools connected and not connected etc.)

  • Users can create and upload new ISP and school application metadata .

  • Users can view connectivity information on a map.

  • Admin can create new country manager smart contracts.

  • Users can view a chart of daily ISP service performance.

  • Users can send donations and view transparent record of all transactions that can be easily verified on etherscan.

• Refine smart contract algorithm that automatically switches between different ISP providers based on their offer and reputation.

• Refine algorithm to prioritize next school connectivity selection based on additional factors such as location.

• Create a viable option of accessing Dapp from an internet browser without a wallet or metamask. That way more participants can be use the platform.

• Limit accessibility(from public to restricted) of relevent smart contract functions after further testing

• Create dispute management function for cases where ISPs and school provide largely varying data.

• Create a UI mechanism to easily onboard new schools on map based on their location.

• Add more countries and schools to platform.

• Include the option of allowing different ISPs to bid on different schools within a country.

• Improve Admin page to include the option of accepting applications from schools and ISPs.

• Hook-in ETH timer.

• Include security measures to protect all participants in case of a future vulnerability to Dapp.

• Improve smart contract upgradability without compromising user experience, safety and performance.

• Add login pages for ISPs and school to manage their application status. ISPs to place bids on different schools.

• Integrate redux to manage state.

A big thank you to UNICEF and gitcoin for providing this opportunity to create a Dapp that can benefit communities across that world that are in need of assistance. The project created with a lot passion for its cause and I hope we can continue the great work!

Copyright (c) 2019 Christopher Igbojekwe