From 323edcae6876940b6a268c22be863645816473db Mon Sep 17 00:00:00 2001 From: itzelot01 Date: Tue, 9 Jan 2024 23:05:00 +0000 Subject: [PATCH] DECA Protcol roadmap 2024 draft --- README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++ assets/diagram1.svg | 1 + models/diagram1.uml | 22 +++++++++++++ 3 files changed, 100 insertions(+) create mode 100644 README.md create mode 100644 assets/diagram1.svg create mode 100644 models/diagram1.uml diff --git a/README.md b/README.md new file mode 100644 index 0000000..1bfc118 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +# DECA Architecture + +## Abstract +The project development will be done modularly and will be splitted into +multiple subprojects which require the proper research and development.The +Goal is to develop all the architecture require for the [DECA Protocol](https://docs.google.com/presentation/d/1H4V5X0X-9jnulwmmQBKk7PiStqKoPh_t_h7F0R3kLw0/edit#slide=id.p) + +## Project Overview + +### General Diagrams + + +### Development + +- [ ] Module 0: Modify tunk to be IPFS compatible (Possibly use CAR) +- [ ] Module 1: YEW DAPP that connects to HELIA (Typescript) +- [ ] Module 2: YEW DAPP that connects to the DECA Contract using Ethers-web3 +- [ ] Module 3: YEW DAPP that includes and updated version of OrbitDB and extracts data from Ethers-Web3(Depends on 1,2) +- [ ] Module 4: Fleek YEW integration with Docker (for the IPNS/DNS and CI/CD). +- [ ] Module 7: ERC1155 Development and testing (cctokens, DECA2, SBt) +- [ ] Module 8: DAO (Vaults, ranking/quadratic voting, whitelist, etc) +- [ ] Module 9: Liquidity Pools DeFi +- [ ] Module 10: Lending DeFi +- [ ] Module 11: Integration(requires from 1-8) + +### Research + +- [ ] Module 5: Architecture specifications for DECA Protocol (R&D, Class Diagrams). +- [ ] Module 6: Tokenomics Ultrasound Model (Research and Dev) + +### Security Testing + +- [ ] Module 11: Security Audit + +### Future R&D +- [ ] Use Cases. +- [ ] Payto DAO (SmartWallet) +- [ ] Zero Knowledge Proof Carbon Offset (Privacy and Fungibility). + + +## General Module Description + +### Module 0 + +#### what, why, how. + +Goal is to self build and decentralize the website and assets of the yew project. + +* [CAR library](https://github.com/web3-storage/ipfs-car)[^1] +* [CAR Reference](https://ipld.io/specs/transport/car/)[^2] + + +### Module 1 + +. +. +. +### Module 7 + +![dig1](./assets/diagram1.svg) +> dig1. Shows the front end DAPP architecture for SBT + +### Module n + + + +> Important Note: all modules should be tested in a decentralized environment + + + + +## References +[^1]: https://github.com/web3-storage/ipfs-car +[^2]: https://ipld.io/specs/transport/car/ + + + diff --git a/assets/diagram1.svg b/assets/diagram1.svg new file mode 100644 index 0000000..829e61c --- /dev/null +++ b/assets/diagram1.svg @@ -0,0 +1 @@ +YEW DAPPEthereumIPFSFetch NFTs URISDisplay NFTsEthers-webFetch Assets from EthersURIPin All IPFS AssetsHeliaERC721NFTs Image AssetsURI Properties AssetsYEW Assets \ No newline at end of file diff --git a/models/diagram1.uml b/models/diagram1.uml new file mode 100644 index 0000000..b79d9c7 --- /dev/null +++ b/models/diagram1.uml @@ -0,0 +1,22 @@ +@startuml +package "YEW DAPP" { + [Fetch NFTs URIS] -d-> [Display NFTs] + [Ethers-web] -u-> [Fetch NFTs URIS] + [Fetch Assets from EthersURI] -d-> [Display NFTs] + [Pin All IPFS Assets] -u-> [Fetch Assets from EthersURI] + [Pin All IPFS Assets] <-d- [Helia] +} + +cloud "Ethereum" { + [ERC721] +} + +cloud "IPFS"{ + [NFTs Image Assets] + [URI Properties Assets] + [YEW Assets] +} + +[Helia] <-d- [IPFS] +[Ethers-web] -d-> [Ethereum] +@enduml