From 72ce59ed8ff62c0db33ce82be3f1920228c3f0a5 Mon Sep 17 00:00:00 2001 From: 0xdevant <0xdevant@gmail.com> Date: Sat, 18 May 2024 16:57:12 +0800 Subject: [PATCH] feat: align sample project yaml with validation schema format for better readibility, and fix related projects' data --- sample-project.yaml | 18 +- schema/project.yaml | 398 ++++++++++++------------- src/projects/basicswap/index.yaml | 3 +- src/projects/blackbox/index.yaml | 2 +- src/projects/brume-wallet/index.yaml | 2 +- src/projects/firn-protocol/index.yaml | 3 +- src/projects/railgun/index.yaml | 3 +- src/projects/secret-network/index.yaml | 2 +- src/projects/shade/index.yaml | 3 +- src/projects/sienna/index.yaml | 3 +- 10 files changed, 210 insertions(+), 227 deletions(-) diff --git a/sample-project.yaml b/sample-project.yaml index 3e6d89fa..696aede5 100644 --- a/sample-project.yaml +++ b/sample-project.yaml @@ -1,22 +1,21 @@ #PROJECT DESCRIPTION ------------------------------------------------------------- - name: SampleProject categories: [ defi ] +assets_used: [ BTC, ETH, USDC ] ecosystem: [ Ethereum, Polkadot, Cosmos ] - project_type: All in one Privacy tool description: 'Short description of project features and mission' +product_readiness: live product_launch_day: "YYYY-MM-DD" - +have_token: true token_link: https://etherscan.io/address/0x148932fc33d97ae4f85443d2f6af25cacddd6062 tokens: - name: SampleToken symbol: SAMPLE network: Ethereum contract_address: "0xe6c83af64e4c60245d8c7de953df673a00000" -assets_used: [ BTC, ETH, USDC ] fee: 3.5% team: @@ -29,7 +28,6 @@ team: role: CTO link: https://twitter.com/mostrandomguy - funding: - name: Private investors ICO type: ICO @@ -44,13 +42,10 @@ history: time: "YYYY-MM-DD" link: https://infonewspage.com/sample-launch - sunset: false # LINKS --------------------------------------------------------------------- - - links: web: https://sample-website.com github: https://github.com/sample_privacy_project @@ -74,8 +69,6 @@ links: # TECHNOLOGY --------------------------------------------------------------------- - - technology: type: ZK-Snarks features: @@ -83,7 +76,6 @@ technology: - Shielded DeFi - P2P Swaps - blockchain_features: encryption: zksnark opensource: true @@ -116,7 +108,6 @@ client_diversability: # PRIVACY --------------------------------------------------------------------- - licences: General Public License privacy_policy: @@ -124,7 +115,7 @@ privacy_policy: link: https://app.shadeprotocol.io/use-terms data_usage: tools you are making TXs on -tracebility: +traceability: tracked_data: user SCRT adress kyc: false sign_in_type_requirments: EVM wallet @@ -136,7 +127,6 @@ storage: # SECURITY --------------------------------------------------------------------- - third_party_dependency: Chainlink oracle social_trust: Sample board multisig & DAO technical_spof: Uniswap hack diff --git a/schema/project.yaml b/schema/project.yaml index 4413507e..fc8c53a6 100644 --- a/schema/project.yaml +++ b/schema/project.yaml @@ -11,6 +11,7 @@ properties: description: | Unique project identifier pattern: '^[a-z0-9-]+$' + #PROJECT DESCRIPTION ------------------------------------------------------------- name: type: string categories: @@ -28,6 +29,14 @@ properties: items: type: string pattern: '^[A-Z0-9-]+$' + project_type: + type: string + description: + type: string + product_readiness: + type: string + product_launch_day: + type: string have_token: type: boolean token_link: @@ -51,145 +60,8 @@ properties: format: uri required: - symbol - description: + fee: type: string - project_type: - type: string - product_readiness: - type: string - product_launch_day: - type: string - technology: - type: object - properties: - type: - type: string - name: - type: string - features: - type: array - items: - type: string - required: - - type - - features - links: - type: object - properties: - web: - type: string - format: uri - twitter: - type: string - format: uri - telegram: - type: string - format: uri - discord: - type: string - format: uri - blog: - type: string - format: uri - facebook: - type: string - format: uri - block_explorer: - type: string - format: uri - whitepaper: - type: string - format: uri - github: - type: string - format: uri - docs: - type: string - format: uri - changelog: - type: string - format: uri - forum: - type: string - format: uri - snapshot: - type: string - format: uri - lens: - type: string - format: uri - farcaster: - type: string - format: uri - rss_feed: - type: string - format: uri - education: - type: string - format: uri - blockchain_features: - type: object - properties: - p2p: - type: boolean - encryption: - type: string - network: - type: string - upgradability: - type: object - properties: - enabled: - type: boolean - type: - type: string - admin_keys: - type: string - wallets: - type: object - properties: - name: - type: string - link: - type: string - format: uli - opensource: - type: boolean - viewing_key: - type: boolean - dissapearing_tx: - type: boolean - frontend_anonymity: - type: string - identity_integration: - type: string - connected_tx: - type: boolean - data_masking: - type: string - asset_custody_type: - type: string - licences: - type: string - privacy_policy: - type: object - properties: - defined: - type: boolean - link: - type: string - format: uri - data_usage: - type: string - traceability: - type: object - properties: - tracked_data: - type: string - kyc: - type: boolean - sign_in_type_requirments: - type: string team: type: object properties: @@ -213,12 +85,184 @@ properties: link: type: string format: uri - storage: + funding: type: object properties: - decentralized: + name: + type: string + type: + type: string + link: + type: string + format: uri + value: + type: string + time: + type: string + history: + type: object + properties: + title: + type: string + event_type: + type: string + description: + type: string + time: + type: string + link: + type: string + format: uri + sunset: + type: boolean + # LINKS --------------------------------------------------------------------- + links: + type: object + properties: + web: + type: string + format: uri + github: + type: string + format: uri + block_explorer: + type: string + format: uri + docs: + type: string + format: uri + forum: + type: string + format: uri + whitepaper: + type: string + format: uri + changelog: + type: string + format: uri + snapshot: + type: string + format: uri + blog: + type: string + format: uri + twitter: + type: string + format: uri + discord: + type: string + format: uri + facebook: + type: string + format: uri + telegram: + type: string + format: uri + lens: + type: string + format: uri + farcaster: + type: string + format: uri + rss_feed: + type: string + format: uri + education: + type: string + format: uri + logos: + type: array + items: + type: object + properties: + file: + type: string + ext: + type: string + url: + type: string + format: uri + # TECHNOLOGY --------------------------------------------------------------------- + technology: + type: object + properties: + type: + type: string + name: + type: string + features: + type: array + items: + type: string + required: + - type + - features + blockchain_features: + type: object + properties: + encryption: + type: string + opensource: type: boolean - tracebility: + identity_integration: + type: string + wallets: + type: object + properties: + name: + type: string + link: + type: string + format: uli + p2p: + type: boolean + data_masking: + type: string + network: + type: string + upgradability: + type: object + properties: + enabled: + type: boolean + type: + type: string + admin_keys: + type: string + viewing_key: + type: boolean + dissapearing_tx: + type: boolean + connected_tx: + type: boolean + frontend_anonymity: + type: string + asset_custody_type: + type: string + client_diversability: + type: array + items: + type: object + properties: + name: + type: string + link: + type: string + format: uri + # PRIVACY --------------------------------------------------------------------- + licences: + type: string + privacy_policy: + type: object + properties: + defined: + type: boolean + link: + type: string + format: uri + data_usage: + type: string + traceability: type: object properties: tracked_data: @@ -227,10 +271,20 @@ properties: type: boolean sign_in_type_requirments: type: string + compliance: + anyOf: [{type: boolean}, {type: string}] + storage: + type: object + properties: + decentralized: + type: boolean + # SECURITY --------------------------------------------------------------------- third_party_dependency: type: boolean - compliance: - anyOf: [{type: boolean}, {type: string}] + social_trust: + type: string + technical_spof: + type: string audits: type: array items: @@ -247,52 +301,8 @@ properties: format: uri time: type: string - social_trust: - type: string - technical_spof: - type: string - fee: - type: string - history: - type: object - properties: - title: - type: string - event_type: - type: string - description: - type: string - time: - type: string - link: - type: string - format: uri - client_diversability: - type: array - items: - type: object - properties: - name: - type: string - link: - type: string - format: uri default_privacy: type: boolean - funding: - type: object - properties: - name: - type: string - type: - type: string - link: - type: string - format: uri - value: - type: string - time: - type: string project_status: type: object properties: @@ -303,16 +313,4 @@ properties: testnet: type: boolean mainnet: - type: boolean - logos: - type: array - items: - type: object - properties: - file: - type: string - ext: - type: string - url: - type: string - format: uri + type: boolean \ No newline at end of file diff --git a/src/projects/basicswap/index.yaml b/src/projects/basicswap/index.yaml index 970091f5..d462b29a 100644 --- a/src/projects/basicswap/index.yaml +++ b/src/projects/basicswap/index.yaml @@ -25,7 +25,6 @@ blockchain_features: opensource: true dissapearing_tx: true frontend_anonymity: self-hosted - identity_integration: connected_tx: false revealed_recipient: true revealed_sender: true @@ -39,7 +38,7 @@ team: anonymous: true storage: decentralized: true -tracebility: +traceability: tracked_data: Chains activity kyc: false sign_in_type_requirments: wallets diff --git a/src/projects/blackbox/index.yaml b/src/projects/blackbox/index.yaml index 4bc87195..2255e7f2 100644 --- a/src/projects/blackbox/index.yaml +++ b/src/projects/blackbox/index.yaml @@ -47,7 +47,7 @@ team: link: https://github.com/Xiphiar storage: decentralized: true -tracebility: +traceability: kyc: false sign_in_type_requirments: wallet third_party_dependency: true diff --git a/src/projects/brume-wallet/index.yaml b/src/projects/brume-wallet/index.yaml index f6d6f9bb..7d1c7fc8 100644 --- a/src/projects/brume-wallet/index.yaml +++ b/src/projects/brume-wallet/index.yaml @@ -37,7 +37,7 @@ team: link: https://bento.me/hazae41 storage: decentralized: true -tracebility: +traceability: tracked_data: no ( Tor based ) kyc: false sign_in_type_requirments: seed diff --git a/src/projects/firn-protocol/index.yaml b/src/projects/firn-protocol/index.yaml index 76b65d2b..14db0067 100644 --- a/src/projects/firn-protocol/index.yaml +++ b/src/projects/firn-protocol/index.yaml @@ -32,7 +32,6 @@ blockchain_features: viewing_key: false dissapearing_tx: true frontend_anonymity: options - identity_integration: connected_tx: false revealed_recipient: false revealed_sender: false @@ -46,7 +45,7 @@ team: anonymous: true storage: decentralized: true -tracebility: +traceability: tracked_dat: non kyc: false sign_in_type_requirments: wallet diff --git a/src/projects/railgun/index.yaml b/src/projects/railgun/index.yaml index af88dd09..1f43aeae 100644 --- a/src/projects/railgun/index.yaml +++ b/src/projects/railgun/index.yaml @@ -35,7 +35,6 @@ blockchain_features: viewing_key: true dissapearing_tx: false frontend_anonymity: ( Railway frontend dont work on Firefox/Tor ) - identity_integration: connected_tx: false revealed_recipient: false revealed_sender: false @@ -74,7 +73,7 @@ team: role: Global economist storage: decentralized: true -tracebility: +traceability: kyc: false sign_in_type_requirments: wallet third_party_dependency: false diff --git a/src/projects/secret-network/index.yaml b/src/projects/secret-network/index.yaml index d6e0187b..01d28b89 100644 --- a/src/projects/secret-network/index.yaml +++ b/src/projects/secret-network/index.yaml @@ -59,7 +59,7 @@ team: link: https://twitter.com/azaidelson storage: decentralized: true -tracebility: +traceability: tracked_data: user SCRT adress kyc: false sign_in_type_requirments: wallet diff --git a/src/projects/shade/index.yaml b/src/projects/shade/index.yaml index 88c63349..59c6142e 100644 --- a/src/projects/shade/index.yaml +++ b/src/projects/shade/index.yaml @@ -36,7 +36,6 @@ blockchain_features: viewing_key: true dissapearing_tx: false frontend_anonymity: options - identity_integration: connected_tx: false revealed_recipient: false revealed_sender: false @@ -61,7 +60,7 @@ team: link: https://twitter.com/l_woetzel storage: decentralized: true -tracebility: +traceability: tracked_data: user SCRT adress kyc: false sign_in_type_requirments: wallet diff --git a/src/projects/sienna/index.yaml b/src/projects/sienna/index.yaml index b9bd99c9..74849c09 100644 --- a/src/projects/sienna/index.yaml +++ b/src/projects/sienna/index.yaml @@ -37,7 +37,6 @@ blockchain_features: viewing_key: true dissapearing_tx: false frontend_anonymity: options - identity_integration: connected_tx: false revealed_recipient: false revealed_sender: false @@ -52,7 +51,7 @@ team: anonymous: true storage: decentralized: true -tracebility: +traceability: tracked_data: user SCRT adress kyc: false sign_in_type_requirments: wallet