Celo Network Tokens Analytics Dapp

README.md

@@ -1,169 +1,88 @@
-# ⚡ Build with Celo Hackathon ⚡ 
 
-Build with Celo Hackathon is a three (3) phase hackathon event focused on Regenerative Finance (#ReFi) within DAOs, NFTs, Gaming (GameFi), Social Impact (SocialFI) and developer tooling/infrastructure on the Celo platform.
-
-## Hackathon Facilitation
-Celo selected Hackerearth to facilitate the hackathon expereince. To learn more information about the Build on Celo hackathon event and register, navigate to Hackerearth Build on Celo hackathon site: [link](https://build-with-celo.hackerearth.com/)
-
-## Hackathon Tracks: 
-
- - __DAO Track:__ 
-    - Build decentralized web applications facilitating DAOs within ReFi, ReFi DAO Tools, and ReFi DAO Infrastructure.
- - __NFT, Gaming and Creator Track:__ 
- 	- Build an application incorporating ReFi, ReFi creators tools, and ReFi creators infrastructure
- - __Social Impact Track:__ 
- 	- Build a decentralized web applications focused on social impact within ReFi, Social impact ReFi Tools, and Social impact ReFi Infrastructure
-
-## Timeline
-
-#### Github commit schedule:
-
-- 9/26 - Idea submission open until 9/26
-
-- 9/19 - Fork this repo
-- 9/23 - Change README
-- 9/30 - At least 3 commits
-- 10/7 - At least 3 commits
-- 10/14 - At least 3 commits
-- 10/21 - At least 3 commits
-- 10/28 - At least 3 commits
-- 11/4 - At least 3 commits
-
-Three (3) phase hackathon event starting August 26th, 2022.
-### Phase 1: Idea
- - Hackathon Phase 1 Kick-off - August 26th, 2022
- - Project Idea Submissions Due - September 26, 2022
- - Idea Submissions Evaluated on rolling basis
-
-### Phase 2: Hack/build MVP
- - Hackathon Phase 2 Kick off - September 19th, 2022
- - Project Submissions Due - November 6th, 2022
- - Evaluations - November 7th - December 4th, 2022
-
-### Phase 3: Iterate & Pitch with Celo
- - Hackathon Phase 3 Kick off - TBD 
-
-## Process
-**Hackathon participants will need to:**
-
- 1. [Fork this repo](#hackathon-repo-process)
- 2. Utilize [HackerEarth](https://build-with-celo.hackerearth.com/) to:
-	 - Manage and collaborate with your team
-	 - Submit your project for final evaluation
-
-## Hackathon Repo Process
-
- 1. Fork this repo
-    - Press the Fork button
- 2. Create project branch
- 3. Make your changes within new branch!
-	 - Copy the folder named **Project_Name**
-	 - Rename the copied folder with your project name
-	 - Modify project details within your project folder **Readme.md**
-		- Project Name
-		- Brief Description
-		- Team members & roles
-		- Hackathon track
-		- Project details
-			- Demonstartion video _(*Phase 2 & 3, Required)_
-			- Requirements _(*Phase 2 & 3, Required)_
-			- Instructions to build & test _(*Phase 2 & 3, Required)_
-
- 4. Add, commit, and push the changes
-	 - Add the files you've changed and commit them with a descriptive message.
- 5. Submit your pull request _(*Phase 2 & 3, Required)_
-    -  Submit to the maintainers for approval. Head over to the original repositories Pull Requests tab, you should see an automatic suggestion from GitHub to create a pull request from your new branch.
-    -  Utilize your project name as the title for your initial pull Requests
-    -  Provide a brief project description within the pull request comment
-
-***Congrats, your officially a Build with Celo Hackathon participant!***
-
-
-## Developer tools and resources
-
-This section contains information about some of the key tools and resources that will help developers start building applications on Celo.
-
-For a comprehensive list of resources and information, review [Celo Docs.](https://docs.celo.org/)
-
-### QUICK START GUIDES
-
-View the [Developer Code Examples page](https://docs.celo.org/developer#quickstart) to get started using the Celo SDKs with guided coding exercises.
-
-### Tutorials
-- [Tutorial - Celo Developer Blog](https://docs.celo.org/blog)
-
-### TOOLS
-
-#### Boilerplates
-- [celo-composer](https://github.com/celo-org/celo-composer#celo-composer)
-	- Celo Composer allows you to quickly build, deploy, and iterate on decentralized applications using Celo. It provides a number of frameworks, examples, and Celo specific functionality to help you get started with your next dApp.
-
-#### SDKs
-
--   [ContractKit](https://docs.celo.org/developer/contractkit#what-is-contractkit)
-	-   Javascript package of Celo blockchain utilities
-	-   Manage connections to the Celo blockchain, accounts, send transactions, interact with smart contracts, etc.
-	-   A set of wrappers around the core protocol smart contracts to easily connect with contracts related to governance, validators, on-chain exchange, etc.
-	-   Includes [web3.js](https://web3js.readthedocs.io/en/v1.2.4/)
--   [Celo Ethers.js Wrapper](https://github.com/celo-tools/celo-ethers-wrapper) (experimental)
-	-   A minimal wrapper to make [ethers.js](https://docs.ethers.io/v5/) compatible with the Celo network
--   [use-react](https://github.com/celo-org/react-celo)
-	- The easiest way to access Celo in your React applications 🔥. react-celo is a React hook for managing access to Celo with a built-in headless modal system for connecting to your users wallet of choice.
-	- Now your DApp can be made available to everyone in the Celo ecosystem, from Valora users to self custodied Ledger users.
-	- By default react-celo is styled so that you can drop it into your application and go, however it's fully customisable so you can maintain a consistent UX throughout your application.
--   [DappKit](https://docs.celo.org/developer-guide/dappkit)
-	-   Easily connect to the [Valora](http://valoraapp.com/) wallet with your React Native mobile application
-	-   Valora manages user account, private keys and transaction signing, so you can focus on building your dapp
-	-   Learn more and see the code with the [Dappkit truffle box](https://github.com/critesjosh/celo-dappkit)
--   [Python SDK](https://github.com/blaize-tech/celo-sdk-py)
--   [Java SDK](https://github.com/blaize-tech/celo-sdk-java)
-	- [Android with Java SDK](https://github.com/bcamacho/celo-android-java-sdk-test-example)
-- [iOS SDK](https://github.com/heymateag/celoiossdk)
-
-
-
-#### Infrastructure
-
--   [Valora](https://valoraapp.com/) provides a clean, intuitive UI where users can send transactions and interact with smart contracts
--   [Forno](https://stackedit.io/developer-guide/forno)
--   Node access service so you can connect your dapp to the Celo blockchain without having to run node infrastructure
--   [ODIS](https://stackedit.io/developer-resources/contractkit/odis.md)
--   Oblivious decentralized identity service
--   Lightweight identity layer that makes it easy to send cryptocurrency to a phone number
--   Blockscout block explorers
--   [Alfajores testnet](http://alfajores-blockscout.celo-testnet.org/) & [mainnet](http://explorer.celo.org/)
--   [Stats.celo.org](http://stats.celo.org/) to check network activity and health
-
-
-#### Networks
+## Project Name
 
--   [Alfajores Testnet](https://docs.celo.org/getting-started/alfajores-testnet)
--   [Faucet](https://celo.org/developers/faucet) for free testnet CELO and cUSD
--   [Forno](https://docs.celo.org/developer-guide/forno) supports connections to alfajores
--   Requires Alfajores Celo wallet for mobile device testing (please request, support@clabs.co)
--   [Baklava testnet](https://docs.celo.org/getting-started/baklava-testnet) for validators and testing protocol changes
+Celo Network Tokens Analytics Dapp
 
+### Team name
+DappLooker
 
-#### Ethereum Tools
+#### Hackathon Track
 
--   Similarities between Celo and Ethereum means you can use many of the most popular Ethereum developer tools.
--   Celo supports the EVM, so tools for writing smart contracts in Solidity (or any language that compiles to EVM bytecode) are compatible with Celo
--   ERC20, NFT (ERC721) and other smart contract interface standards are supported, see [Celo for Ethereum Developers](https://docs.celo.org/developer-guide/celo-for-eth-devs)
-- [Truffle](https://www.trufflesuite.com/)
-- [OpenZeppelin](https://openzeppelin.com/)
-- [Remix](https://remix.ethereum.org/)
+Implement Celo Network Tokens Analytics Dapp to Track Performance Metrics.
 
-#### Ongoing projects
+##### Region location
+India
 
--   [Community projects](https://docs.celo.org/developer-guide/celo-dapp-gallery)
--   [Grant recipients](https://celo.org/experience/grants/directory)
+##### Team Members
+- Abhay - Blockchain Engineer
+- Hitesh - Data Engineer
 
-#### Web wallets
-  -  [celowallet.app](https://celowallet.app/)
-  -  [Celo Terminal](https://github.com/zviadm/celoterminal/)
+#### Project Description
 
+- Implemented Celo Network Tokens subgraph
 
-#### Community
+Subgraph is indexing transactions data of Celo network token contracts. Subgraph is then queried to display key performance metrics and KPIs.
+The subgraph contains entities for below token contracts:
 
--   Join our [Discord](https://chat.celo.org/)
--   [Discourse Forum](https://forum.celo.org/)
+    - Celo(ERC20): 0x471EcE3750Da237f93B8E339c536989b8978a438
+
+    - cUSD: 0x765DE816845861e75A25fCA122bb6898B8B1282a
+
+    - cEUR: 0xD8763CBa276a3738E6DE85b4b3bF5FDed6D6cA73**
+
+    - cREAL: **0xe8537a3d056DA446677B9E9d6c5dB704EaAb4787**
+
+    - stCELO: **0xa97be82bee72a809fe4b3ad158535879028babcb**
+
+- Implemented Analytics Dapp by querying data from subgraph
+    The analytics Dapp tracks below performance metrics:
+
+        - Celo Tokens TVL
+        - Unique Users with atleast 1 Transaction
+        - Daily TVL
+        - Weekly Transaction Volume
+        - Weekly Gas Consumed
+
+#### Summary
+
+Implemented below functionalities in the project:
+- Implement Analytics Dapp
+- Implement Celo Network Tokens subgraph
+
+Below Performance Metrics are tracked:
+
+- **Token details and Number of users per token**
+
+    <img width="1440" alt="Token Details" src="https://raw.githubusercontent.com/abhayait/build-with-celo-hackathon/main/celo-tokens-analytics-dapp/images/token%20-details.png">
+
+- **Daily Transaction Volume**
+
+    <img width="1440" alt="Daily TVL" src="https://raw.githubusercontent.com/abhayait/build-with-celo-hackathon/main/celo-tokens-analytics-dapp/images/daily-tvl.png">
+
+- **Weekly Transaction Volume**
+
+   <img width="1440" alt="Weekly Transaction Volume" src="https://raw.githubusercontent.com/abhayait/build-with-celo-hackathon/main/celo-tokens-analytics-dapp/images/weekly-tx-volume.png">
+
+
+- **Weekly Gas Consumed.**
+
+    <img width="1440" alt="Weekly Gas Consumed" src="https://raw.githubusercontent.com/abhayait/build-with-celo-hackathon/main/celo-tokens-analytics-dapp/images/weekly-gas-consumed.png">
+
+
+#### URLs
+Celo Network Tokens Subgraph - https://thegraph.com/hosted-service/subgraph/dapplooker/celo-tokens-analytics-subgraph
+
+Celo Network Tokens Analytics Dapp - https://analytics.dapplooker.com/public/dashboard/f97e8ce0-4b76-4ce4-9a89-ef3aaf9642f6
+
+#### Presentation
+Celo Network Tokens Subgraph - https://thegraph.com/hosted-service/subgraph/dapplooker/celo-tokens-analytics-subgraph
+
+Celo Network Tokens Analytics Dapp - https://analytics.dapplooker.com/public/dashboard/f97e8ce0-4b76-4ce4-9a89-ef3aaf9642f6
+
+#### Next Steps
+- Integrate more Celo network tokens
+- Detailed analytics Dapp for each token
+- Set Alerts on token transactions
+
+#### License
+This repository includes an [unlicensed](http://unlicense.org/) statement though you may want to [choose a different license](https://choosealicense.com/).