Update sample-project.yaml

Update Sample-project with new schema
This commit is contained in:
Mf 2024-09-26 14:42:26 +02:00 committed by GitHub
parent e8abd97b29
commit f2fc03ce37
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,27 +1,22 @@
# Essential (minimum) project data ---------------------------------------------------------------------------------------------------------------- # BASIC DATA ------------------------------------------------------------------------------------------------------------------------
# Please have a look at https://github.com/web3privacy/explorer-data for explanations + examples
name: SampleProject name: SampleProject
categories: [ defi ] categories: [ defi ]
assets_used: [ BTC, ETH, USDC ]
ecosystem: [ Ethereum, Polkadot, Cosmos ] ecosystem: [ Ethereum, Polkadot, Cosmos ]
usecases: [ Swap, Wallet, Yield ] # You can find the applicable usecas-es here: https://github.com/web3privacy/explorer-data/blob/main/src/usecases.yaml
project_type: All in one Privacy tool #if your use-case is not mentioned in above file, feel free to add it through a PR.
description: 'Short description of project features and mission' description: 'Short description of project features and mission'
product_readiness: live
product_launch_day: "YYYY-MM-DD" product_launch_day: "YYYY-MM-DD"
# Team - focus on C-Level (CEO) personnel if information public available otherwise "anonymous: true" # TEAM - focus on C-Level (CEO) personnel if information public available otherwise "anonymous: true" -------------------------------
team: team:
anonymous: false anonymous: false
teammembers: teammembers:
- name: Samplic Samplist
role: CEO
link: https://twitter.com/samplesampler
- name: Random Guy - name: Random Guy
role: CTO
link: https://twitter.com/mostrandomguy link: https://twitter.com/mostrandomguy
# LINKS - focus: Web, Github, Docs, Blog, Whitepaper, Twitter -----------------------------------------------------------------------
# LINKS - focus: web, github, docs, blog, whitepaper, twitter
links: links:
web: https://sample-website.com web: https://sample-website.com
github: https://github.com/sample_privacy_project github: https://github.com/sample_privacy_project
@ -29,125 +24,85 @@ links:
whitepaper: https://docs.sample-website.com/whitepaper.pdf whitepaper: https://docs.sample-website.com/whitepaper.pdf
blog: https://medium.com/@sample_privacy_project blog: https://medium.com/@sample_privacy_project
twitter: https://twitter.com/sample_privacy_project twitter: https://twitter.com/sample_privacy_project
block_explorer: https://samplescan.io/
forum: https://forum.sample-website.com
governance: https://snapshot.org/sample-dao
discord: https://discord.com/invite/jgUQSAMPLE
telegram: https://t.me/sample_privacy_project
lens: https://hey.xyz/u/sample_privacy_project
farcaster: "@sampleprivacyproject"
# PROJECT STATUS -------------------------------------------------------------------------------------------------------------------
# Details on live status + version project_status:
# project_status: version: MVP/Alpha/Mainnet/Testnet
# live_status: true sunset: false
# version: Mainnet
# testnet: false
# mainnet: true
# Token ticker + contract address - if there is no token "have_token: false" # ASSETS AND NATIVE TOKENS - if there is no token "have_token: false" --------------------------------------------------------------
assets_used: [ BTC, ETH, USDC ]
have_token: true have_token: true
token_link: https://etherscan.io/address/0x148932fc33d97ae4f85443d2f6af25cacddd6062
tokens: tokens:
- name: SampleToken - name: SampleToken
symbol: SAMPLE symbol: SAMPLE
network: Ethereum
contract_address: "0xe6c83af64e4c60245d8c7de953df673a00000" contract_address: "0xe6c83af64e4c60245d8c7de953df673a00000"
token_link: https://etherscan.io/address/0x148932fc33d97ae4f85443d2f6af25cacddd6062
# Additional basic information -------------------------------------------------------------------------------------------------------------- # FUNDING ------------------------------------------------------------------------------------------------------------------------
# Please have a look at https://github.com/web3privacy/explorer-data for explanations + examples
funding: funding:
- name: Private investors ICO - name: Private investors ICO
type: ICO
link: https://investopedia.org/sample-ico-2022 link: https://investopedia.org/sample-ico-2022
value: $50.000.000
time: "YYYY-MM-DD"
history: # TECHNOLOGY ---------------------------------------------------------------------------------------------------------------------
title: Sample Voyage
event_type: launch
description: Launched Sample Voyage on Mainnet
time: "YYYY-MM-DD"
link: https://infonewspage.com/sample-launch
# more links
# links:
# block_explorer: https://samplescan.io/
# forum: https://forum.sample-website.com
# changelog: https://changelog.sample-website.com
# snapshot: https://snapshot.org/sample-dao
# discord: https://discord.com/invite/jgUQSAMPLE
# facebook: https://facebook.com/sample-privacy-crypto
# telegram: https://t.me/sample_privacy_project
# lens: https://hey.xyz/u/sample_privacy_project
# farcaster: "@sampleprivacyproject"
# rss_feed: https://rss-feeds.com/sample_privacy_project
# education: https://twitter.com/random_user/status/12345678901234
# TECHNOLOGY - information -------------------------------------------------------------------------------------------------------------
# Please have a look at https://github.com/web3privacy/explorer-data for explanations + examples
technology:
type: ZK-Snarks
features:
- Private wallet
- Shielded DeFi
- P2P Swaps
blockchain_features: blockchain_features:
encryption: zksnark
opensource: true opensource: true
identity_integration: Gitcoin Passport
p2p: true
data_masking: Sample_mixer
viewing_key: true
dissapearing_tx: false
connected_tx: false
frontend_anonymity: Sample frontend dont work on Tor
asset_custody_type: non-custody asset_custody_type: non-custody
upgradability: upgradability:
enabled: true enabled: true
type: DAO vote
admin_keys: 51% consensus by DAO
project_status: # PRIVACY ------------------------------------------------------------------------------------------------------------------------
live_status: true
version: Mainnet
testnet: false
mainnet: true
client_diversability:
- name: Sample-wallet
link: https://sample-wallet-using-sample.com
- name: Sample-Defi_Swap
link: https://sample-swap.com
# Privacy - information ---------------------------------------------------------------------------------------------------------------
# Please have a look at https://github.com/web3privacy/explorer-data for explanations + examples
licences: General Public License
privacy_policy: privacy_policy:
defined: true defined: true
link: https://app.shadeprotocol.io/use-terms link: https://app.shadeprotocol.io/use-terms
data_usage: tools you are making TXs on
tracebility: default_privacy: True
tracked_data: user SCRT adress
traceability:
kyc: false kyc: false
sign_in_type_requirments: EVM wallet
compliance: OFAC, USA compliance: OFAC, USA
# SECURITY -----------------------------------------------------------------------------------------------------------------------
storage:
decentralized: true
# Security - information -------------------------------------------------------------------------------------------------------------
# Please have a look at https://github.com/web3privacy/explorer-data for explanations + examples
third_party_dependency: Chainlink oracle
social_trust: Sample board multisig & DAO
technical_spof: Uniswap hack
audits: audits:
- name: Privacy audit company - Sample security check - name: Privacy audit company - Sample security check
link: https://pac.com/sample-security.pdf link: https://pac.com/sample-security.pdf
time: "YYYY-MM-DD" time: "YYYY-MM-DD"
- name: Competitive Audit - Code4rena
link: https://ca.com/audit-result.pdf # ADDITIONAL INFORMATION --------------------------------------------------------------------------------------------------------
history:
title: Sample Voyage
description: Launched Sample Voyage on Mainnet
time: "YYYY-MM-DD" time: "YYYY-MM-DD"
link: https://infonewspage.com/sample-launch
privacy_policy:
data_usage: tools you are making TXs on
traceability:
tracked_data: user SCRT adress
sign_in_type_requirments: EVM wallet
storage:
decentralized: true
technology:
type: ZK-Snarks
blockchain_features:
p2p: true
third_party_dependency: Chainlink oracle
social_trust: Sample board multisig & DAO
technical_spof: Uniswap hack