web3privacy/explorer-data
1
0
Fork 0
mirror of https://github.com/web3privacy/explorer-data.git synced 2024-10-15 12:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source 
Upgraded data repository scheme and description. 
Reduction of redundant variables.

ADDED

logos
opensource
viewing key
dissapearing_tx
frontend_anonymity
identity integration
connected_tx
data masking
asset custody type
educational_links
assets_used
fee
sunset



REMOVED

- revealed recipient
- revealed_sender
- revealed amount
- reversabblity condition
- Product readyness 
- security
- have token
- team_company_name
- team _ company_link
- Team_company_link
- Team_company_contacts
-| blockchain_features network
This commit is contained in:
Coinmandeer 2024-01-12 21:10:08 +01:00 committed by GitHub
parent 611a89ed69
commit 226d69907c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 164 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

237
README.md
View file

@ -1,92 +1,179 @@
# Web3Privacy Now Data Repository
Structured database for Web3Privacy Now.
List of variables used for Privacy Explorer (https://explorer.web3privacy.info)
Feel free to submit any suggestions or changes to this scheme.
You can create/edit projects by making changes in index.yaml file, which you can find in project folder inside /src/projects/
Upload project logo in root of project directory to be automatically included.
# Database
https://data.web3privacy.info/
# Schema specification
# Project description
| Field | Type | Required | Description |
|------------------------|-----------------------|----------|-------------|
| id | string | x | |
| name | string | x | Name of the project |
| categories | array | x | Categories defined by web3privacy research |
| ecosystem | string | | Build on network (e.g., Cosmos, Ethereum) |
| product_readiness | string | | State of development (e.g., Alpha, Beta, Mainnet, Testnet) |
| security | string | | Security details |
| have_token | boolean | | Does the project have a token? |
| token_link | string uri | | Link to the token contract |
| tokens | array | | Native tokens of the project (e.g., TORN, SCRT) |
| id | string | x | Unique project identifier |
| name | string | x | Name of project |
| categories | array | x | Categories are defined in explorer-data/schema/category.yaml |
| logos | array | | Links to project logo (Note: Upload logos into root folder of project) |
| ecosystem | string | | What is projects native networks? (ex. Ethereum, Arbitrum, Cosmos,...) |
| | | | |
| | | | |
| | | | |
| project_type | string | | Main usecases of project (ex. ZK Pool mixer, Privacy transactions) |
| description | string | | Short description of project features and mission |
| project_type | string | | Main purpose of the project (e.g., ZK Pool mixer, Privacy transactions) |
| product_launch_day | string | | Date of the project announcement |
| technology type | string | | Category of privacy tech (e.g., ZK, PHE) |
| technology name | string | | Name of privacy tech (e.g., Ultramix3000, ZK-EVM) |
| technology features | array | | Key aspects of the privacy tech used (e.g., Non-traceable, Account Abstraction) |
| links web | string uri | | Official project website |
| links twitter | string uri | | Project's Twitter profile |
| links discord | string uri | | Project's Discord server |
| links blog | string uri | | Project's Blog (e.g., Medium) |
| links facebook | string uri | | Project's Facebook page |
| links bloc_explorer | string uri | | Project's or Network's Block Explorer |
| links whitepaper | string uri | | Link to the project's whitepaper |
| links github | string uri | | Link to the project's GitHub repository |
| links docs | string uri | | Link to project documentation |
| links changelog | string uri | | Link to changelog |
| links forum | string uri | | Link to project forum (e.g., Discourse) |
| links snapshot | string | | Link to Snapshot |
| links lens | string | | Link to project's Lens |
| links farcaster | string | | Link to Farcaster |
| links rss_feed | string uri | | Link to a stream of articles related to the project |
| blockchain_features p2p | boolean | | Is the project Peer to Peer-based or enabling such a feature? |
| blockchain_features encryption | string | | Encryption algorithm (e.g., 256-bit, SHA) |
| blockchain_features network | string | | Networks securing assets |
| blockchain_features upgradability enabled | boolean | | Is the project upgradable or immutable? |
| blockchain_features upgradability type | string | | Upgradability type (e.g., Governance, Admin keys) |
| blockchain_features upgradability admin_keys | string | | Upgradability condition definition (e.g., Multisign of 5, 80% consensus) |
| licenses | string | | Licenses used (e.g., MIT License, GGML) |
| privacy_policy defined | boolean | | Is there a document defining privacy policies? |
| privacy_policy link | string uri | | Link to the privacy policy |
| privacy_policy data_usage | string | | How is the project using your data? (e.g., Selling data, Analytics) |
| team anonymous | boolean | | Is the project developed by an anonymous team? |
| product_launch_day | string | | Date of the project launch (DD:MM:YYYY)|
| | | | |
| | | | |
| | | | |
| token_link | string url | | Link to the project token contract |
| tokens | array | | Native tokens of project (ex. privUSDC, sETH,...) |
| assets_used | array | | Digital assets that you can use in project/protocol (ex. BTC, ETH, USDC,...)|
| fee | string | | Cost of usage (ex. 0.15%, $5, None) |
| | | | |
| | | | |
| | | | |
| team anonymous | boolean | | Is project developed by anonymous team? (Yes/No) |
| team teammembers name | string | | Member's name |
| team teammembers role | string | | Member's role |
| team teammembers link | string uri | | Member's social link |
| team company name | string | | Name of the development company |
| team company link | string uri | | Official link to the development company |
| team company contacts | string | | Official mail/phone of the development company |
| storage decentralized | boolean | | Is any part of used data stored decentraly? |
| traceability tracked_data | string | | What data is the project tracking (e.g., Address, Name, Phone, IP) |
| traceability kyc | boolean | | Is KYC required for product usage? |
| traceability sign_in_type_requirments | string | | What Sign-in information is required to use the project (e.g., Wallet, Email, Gitcoin Pass) |
| third_party_dependency | string | | What third-party technological dependencies does the project have? (e.g., Uniswap hack, USDC stability) |
| compliance | string | | Does the project comply with any official blacklists? (e.g., OFAC, Hacker_wallet_list) |
| audits name | string | | Name of the project audit |
| audits company | string | | Company that processed the project audit |
| audits logo | string | | Logo of the audit company |
| audits link | string uri | | Official link to the audit company website |
| audits time | string | | Date of the audit |
| social_trust | string | | Is there any social dependency that the project has (e.g., Governance, CEO, Community) |
| technical_spof | string | | Is there any technical single point of failure? (e.g., Pool hack, Bridge malfunction) |
| history title | string | | Title of events/news related to the project |
| history event_type | string | | Type of event (e.g., Product release, Hack announcement) |
| history description | string | | Description of the event |
| history time | string | | Time of the event |
| history link | string uri | | Link to more information about the event |
| client_diversability name | string | | Name of the client (e.g., Wallet name, Bridge name) implementing the project |
| client_diversability link | string uri | | Link to the client's website |
| default_privacy | boolean | | Is privacy applied by default or must it be turned on? |
| team teammembers link | string url | | Member's social link |
| | | | |
| | | | |
| | | | |
| funding name | string | | Name of the investor |
| funding type | string | | Type of investment |
| funding link | string uri | | Link for more information about the investment |
| funding value | string | | Value of the investment |
| funding time | string | | Date of the investment |
| project_status live_status | boolean | | Is the project currently functioning? |
| project_status version | string | | Name of the latest version |
| project_status testnet | boolean | | Does the project have a running testnet? |
| project_status mainnet | boolean | | Is the mainnet running? |
| funding type | string | | Type of investment (Seed, Round1, Angel investment,...) |
| funding link | string url | | Link for more information about the investment |
| funding value | string | | Value of the investment ($1,500,000) |
| funding time | string | | Date of the investment (DD:MM:YYYY)|
| | | | |
| | | | |
| | | | |
| history title | string | | Title of events/news related to the project |
| history event_type | string | | Type of event (e.g., Product release, Hack, Launch) |
| history description | string | | Description of the event |
| history time | string | | Time of the event (DD:MM:YYYY) |
| history link | string url | | Link to more information about the event |
| | | | |
| | | | |
| | | | |
| sunset | boolean | | Project is not active, is not recommended for use, no development |
# Project Links
| Field | Type | Required | Description |
|------------------------|-----------------------|----------|-------------|
| links web | string url | | Official project website |
| links github | string url | | Link to the project GitHub repository |
| links block_explorer | string url | | Project or Network Block Explorer |
| links docs | string url | | Link to project documentation |
| links forum | string url | | Link to project forum (ex. Discourse) |
| links whitepaper | string url | | Link to the project whitepaper |
| links changelog | string url | | Link to changelog |
| links snapshot | string url | | Link to Snapshot |
| | | | |
| | | | |
| | | | |
| links blog | string url | | Project Blog (ex. Medium) |
| links twitter | string url | | Project Twitter profile |
| links discord | string url | | Project Discord server |
| links facebook | string url | | Project Facebook page |
| links lens | string url | | Project Lens profile |
| links farcaster | string url | | Project Farcaster profile |
| links rss_feed | string url | | Link to a information stream related to the project |
| | | | |
| | | | |
| | | | |
| links education | string url | | Links to useful education content about project |
# Technology
| Field | Type | Required | Description |
|------------------------|-----------------------|----------|-------------|
| technology type | string | | Technology that runs underhood (ex. ZK, ZK-Snarks, PLONK, Monero, Ellipcic curves,...) |
| technology features | array | | Key aspects of the privacy tech used (ex. Private wallet, P2P Swap, Fluid compliance, ZK Defi, Private bridge,...) |
| | | | |
| | | | |
| | | | |
| blockchain_features encryption | string | | Encryption used (ex. Cryptonight, Groth16, ECDH,...) |
| blockchain_features opensource | boolean | | Is project opensourced? (Yes/No) |
| | | | |
| | | | |
| | | | |
| project_status live_status | boolean | | Is the project currently working? (Yes/No) |
| project_status version | string | | Name of the latest version (Ex. Arbitrum Nitro, V2.12, Prototest10,...) |
| project_status testnet | boolean | | Does the project have a running testnet? (Yes/No)|
| project_status mainnet | boolean | | Is the mainnet running? (Yes/No) |
| | | | |
| | | | |
| | | | |
| client_diversability name | string | | Name of the clients using project (ex. Wallet name, Bridge name, Project name,...) |
| client_diversability link | string url | | Link to the client's website |
# Privacy
| Field | Type | Required | Description |
|------------------------|-----------------------|----------|-------------|
| licenses | string | | Licenses used (ex. MIT License, GGML,...) |
| privacy_policy defined | boolean | | Is there a document defining privacy policies? (Yes/No)|
| privacy_policy link | string url | | Link to the privacy policy document |
| privacy_policy data_usage | string | | How is the project using your data? (ex. Selling data, Analytics., Not using,...) |
| traceability tracked_data | string | | What data is the project tracking (ex. Address, Name, Phone, IP,...) |
| default_privacy | boolean | | Is privacy applied by default or must it be turned on? (Yes/No) |
| compliance | string | | Does the project comply with any official blacklists? (ex. OFAC, Hacker_wallet_list, USA,...) |
| | | | |
| | | | |
| | | | |
| storage decentralized | boolean | | Is any part of used data stored on decetralized networks? (Yes/No)|
| traceability kyc | boolean | | Is KYC required for product usage? (Yes/No) |
| traceability sign_in_type_requirments | string | | What Sign-in information is required to use the project? (ex. Wallet, Email, Gitcoin Pass,...) |
| blockchain_features identity_integration | string| | What Identity integration project use? (ex. Gitcoin Pass, Proof of Humanity, Degenscore,...) |
| blockchain_features p2p | boolean | | Is the project Peer to Peer-based or enabling such a feature? (Yes/No) |
| blockchain_features data_masking | string | | What type of anonymity mechanism is used? (Mixer, ZK Pool,...) |
| blockchain_features viewing_key | boolean | | Is there a viewing key that can decode your transactions? (Yes/No) |
| blockchain_features dissapearing_tx | boolean | | Is there any trace of your transaction on-chain / online? (Yes/No) |
| blockchain_features connected_tx | boolean | | Is is possible to identify other transactions when is your address revealed? (Yes/No) |
| blockchain_features frontend_anonymity | string| | Are you able to use project with TOR / VPN or other anonymity tools? (TOR address, Geo restricted, VPN banned,...) |
# Security
| Field | Type | Required | Description |
|------------------------|-----------------------|----------|-------------|
| third_party_dependency | string | | What third-party technological dependencies project have? (ex. Uniswap hack, USDC stability,...) |
| social_trust | string | | Is there any social dependency (ex. Governance, Board multisig, CEO have 50% tokens,...) |
| technical_spof | string | | Is there any technical single point of failure? (ex. Pool hack, Bridge malfunction, Viewing key leak,...) |
| | | | |
| | | | |
| | | | |
| blockchain_features asset_custody_type | string | | Are users assets in any custody, by who? Or is it fully non-custodial? (ex. DAO Multisig, Non-custodial, Centralized bridge,...) |
| blockchain_features upgradability enabled | boolean | | Is the project upgradable or immutable? (Yes/No)|
| blockchain_features upgradability type | string | | Upgradability type (ex. DAO Governance, Admin keys, Random Consensus,...) |
| blockchain_features upgradability admin_keys | string | | Upgradability condition definition (ex. Multisign of 5, 80% consensus,...) |
| | | | |
| | | | |
| | | | |
| audits name | string | | Name of the project audit (ex. Certik SmartContract check,...) |
| audits company | string | | Company that processed the project audit (ex. Certik, Blocksec,...) |
| audits logo | string url | | Logo of the audit company |
| audits link | string url | | Official link to the audit company website |
| audits time | string | | Date of the audit (DD:MM:YYYY) |
# License