From e0776200b91d4561eb78b4dd93792494638b3ebf Mon Sep 17 00:00:00 2001 From: Coinmandeer <62942796+coinmandeer@users.noreply.github.com> Date: Sun, 8 Oct 2023 06:18:48 +0200 Subject: [PATCH] Update README.md Added variables basic descriptions --- README.md | 149 +++++++++++++++++++++++++++--------------------------- 1 file changed, 74 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 8eb28433..325dcb8f 100644 --- a/README.md +++ b/README.md @@ -14,80 +14,79 @@ Open Data Commons Open Database License (ODbL) | type | object | - | | | id | string | x | | | name | string | x | name of the project | -| categories | array | x | defined by web3privacy categories | -| ecosystem | string | | Cosmos, Ethereum | -| product_readiness | string | | | +| categories | array | x | defined by web3privacy research | +| ecosystem | string | | Build on network (ex. Cosmos, Ethereum) | +| product_readiness | string | | State of development (ex. Alpha, Beta, Mainnet, Testnet | | security | string | | | -| have_token | boolean | | | -| token_link | string uri | | | -| tokens | array | | | -| description | string | | | -| project_type | string | | Lending, Trading, Staking, Yield, Transfer, Payment, Mixer, Data storage | -| product_launch_day | string | | | -| technology type | string | | ZK, Layer0, STARKS... | -| technology name | string | | Ultramixing-protocol | -| technology features | array | | Positive (Private, Non-traceable,...) / Negative (Unverifiable) | -| links web | string uri | | infrastructure | -| links twitter | string uri | | social link | -| links discord | string uri | | social link | -| links twitter | string uri | | | -| links blog | string uri | | validation | -| links facebook | string uri | | social link | -| links bloc_explorer | string uri | | infrastructure | -| links whitepaper | string uri | | infrastructure | -| links github | string uri | | infrastructure | -| links docs | string uri | | infrastructure | -| links changelog | string uri | | infrastructure | -| links forum | string uri | | infrastructure | -| links snapshot | string | | | -| links lens | string | | | -| links farcaster | string | | | -| links rss_feed | string uri | | validation | -| blockchain_features p2p | boolean | | | -| blockchain_features encryption | string | | 256bit, ... | -| blockchain_features network | string | | | -| blockchain_features upgradability enabled | boolean | | | -| blockchain_features upgradability type | string | | | -| blockchain_features upgradability admin_keys | string | | 5 in Multisign | -| licenses | string | | MIT Licence, Copyright, Commons | -| privacy_policy defined | boolean | | | -| privacy_policy link | string uri | | | -| privacy_policy data_usage | string | | Page Numbers?, How are they using your data?, Selling/Giving data? | -| team anonymous | boolean | | | -| team teammembers name | string | | | -| team teammembers role | string | | | -| team teammembers link | string uri | | | -| team company name | string | | | -| team company link | string uri | | | -| team company contacts | string | | | -| storage decentralized | boolean | | | -| traceability tracked_data | string | | IP, Email, Phone, Address, ... | -| traceability kyc | boolean | | | -| traceability sign_in_type_requirments | string | | Wallet, Email, Gitcoin Pass | -| third_party_dependency | string | | Name, Link, Description, Dependency purpose | -| compliance | string | | OFAC, FBI, MasterBlacklist,... | -| audits name | string | | | -| audits company | string | | | -| audits logo | string | | | -| audits link | string uri | | | -| audits time | string | | | -| social_trust | string | | | -| technical_spof | string | | | -| history title | string | | | -| history event_type | string | | | -| history description | string | | | -| history time | string | | | -| history link | string uri | | | -| client_diversability name | string | | | -| client_diversability link | string uri | | | -| default_privacy | boolean | | | -| funding name | string | | | -| funding type | string | | | -| funding link | string uri | | | -| funding value | string | | | -| funding time | string | | | -| project_status live_status | boolean | | | -| project_status version | string | | | -| project_status testnet | boolean | | | -| project_status mainnet | boolean | | | +| have_token | boolean | | Does project have token? | +| token_link | string uri | | Link to token contract | +| tokens | array | | Projects native tokens (ex. TORN, SCRT) | +| description | string | | Short description of project features and mission | +| project_type | string | | Definition of project main purpose (ex. ZK Pool mixer, Privacy transactions) | +| product_launch_day | string | | Date of project announcement | +| technology type | string | | Category of privacy tech (ex. ZK, PHE) | +| technology name | string | | Name of privacy tech (ex. Ultramix3000, ZK-EVM) | +| technology features | array | | Main aspects of private tech used (ex. Non-traceable, Account Abstraction) | +| links web | string uri | | Official projects website| +| links twitter | string uri | | Projects Twitter | +| links discord | string uri | | Projects Discord | +| links blog | string uri | | Projects Blog (ex. Medium) | +| links facebook | string uri | | Projects Facebook | +| links bloc_explorer | string uri | | Projects or Network Blockexplorer | +| links whitepaper | string uri | | Link to whitepaper | +| links github | string uri | | Link to Github | +| links docs | string uri | | Link to documentation | +| links changelog | string uri | | Link to changelog | +| links forum | string uri | | Link to forum (ex. Discourse) | +| links snapshot | string | | Link to Snapshot +| links lens | string | | Projects Lens link | +| links farcaster | string | | Projects Farcaster | +| links rss_feed | string uri | | Link to stream of articles related to project | +| blockchain_features p2p | boolean | | Is project Peer to Peer based or is enabling such feature? | +| blockchain_features encryption | string | | Encryption algo (ex. 256bit, SHA) | +| blockchain_features network | string | | Networks securing assets | +| blockchain_features upgradability enabled | boolean | | Is project upgradable or immutable? | +| blockchain_features upgradability type | string | | Upgradability type (ex. Governance, Admin keys) | +| blockchain_features upgradability admin_keys | string | | Upgradability condition definition (ex. Multisign of 5, 80% consensus) | +| licenses | string | | (ex. MIT Licence, GGML) | +| privacy_policy defined | boolean | | Is there document defining privacy policies? | +| privacy_policy link | string uri | | Link to privacy policy | +| privacy_policy data_usage | string | | How is project using your data? (ex. Selling data, Analytics) | +| team anonymous | boolean | | Is project developed by anon team? | +| team teammembers name | string | | Member name | +| team teammembers role | string | | Member role | +| team teammembers link | string uri | | Member social link | +| team company name | string | | Name of dev company | +| team company link | string uri | | Official link dev company | +| team company contacts | string | | Official mail/phone of dev company | +| storage decentralized | boolean | | Is any part of used data stored decentraly? | +| traceability tracked_data | string | | What data is project tracking (ex. Address, Name, Phone, IP) | +| traceability kyc | boolean | | Is there KYC required for product usage? | +| traceability sign_in_type_requirments | string | | What Sign-in informations are required to use project (ex. Wallet, Email, Gitcoin Pass) | +| third_party_dependency | string | | What third-party technological dependencies project have? (ex. Uniswap hack, USDC stability) | +| compliance | string | | Does project comply with any official blacklists? (ex. OFAC, Hacker_wallet_list) | +| audits name | string | | Name of project audit | +| audits company | string | | Company that processed project audit | +| audits logo | string | | Logo of audit company | +| audits link | string uri | | Official link to audit company website | +| audits time | string | | Date of audit | +| social_trust | string | | Is there any social dependency that project have (ex. Governance, CEO, Community) | +| technical_spof | string | | Is there any technical single point of failture? (ex. Pool hack, Bridge malfuction) | +| history title | string | | Title of event/news related to project | +| history event_type | string | | Type of event (ex. Product release, Hack announcement) | +| history description | string | | Description of event | +| history time | string | | Time of event | +| history link | string uri | | Link to more informations about event | +| client_diversability name | string | | Name of client (ex. Wallet name, Bridge name) implementing project | +| client_diversability link | string uri | | Link to clients website | +| default_privacy | boolean | | Do I need to turn privacy on, or is applied by default? | +| funding name | string | | Name of Investor | +| funding type | string | | Type of investment | +| funding link | string uri | | Link for more information about investment | +| funding value | string | | Value of investment | +| funding time | string | | Date of investment | +| project_status live_status | boolean | | Is it functioning right now? | +| project_status version | string | | Name of latest version | +| project_status testnet | boolean | | Does project have running testnet? | +| project_status mainnet | boolean | | Is mainnet running? |