Merge pull request #279 from 0xdevant/fix/deployment-issue

fix: update yaml validation rules for project data, and fix inconsistent yaml formatting and remove unused fields across project data

README.md

@@ -127,7 +127,7 @@ https://data.web3privacy.info/
 
 | Field                  | Type                  | Required | Description |
 |------------------------|-----------------------|----------|-------------|
-| licenses               | string                |          | Licenses used (ex. MIT License, GGML,...) |
+| licences               | 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,...) |

sample-project.yaml

@@ -135,7 +135,7 @@ storage:
   decentralized: true
 
 
-SECURITY ---------------------------------------------------------------------
+# SECURITY ---------------------------------------------------------------------
 
 third_party_dependency: Chainlink oracle
 social_trust: Sample board multisig & DAO
@@ -145,3 +145,7 @@ audits:
   - name: Privacy audit company - Sample security check
     link: https://pac.com/sample-security.pdf
     time: "YYYY-MM-DD"
+  - name: Competitive Audit - Code4rena
+    link: https://ca.com/audit-result.pdf
+    time: "YYYY-MM-DD"
+  

schema/project.yaml

@@ -24,10 +24,12 @@ properties:
       type: string
       pattern: '^[A-Z0-9-]+$'
   ecosystem:
-    type: array
+    anyOf: [{type: array}, {type: string}]
     items: 
       type: string
       pattern: '^[A-Z0-9-]+$'
+  have_token:
+    type: boolean
   token_link:
     type: string
     format: uri
@@ -53,6 +55,8 @@ properties:
     type: string
   project_type:
     type: string
+  product_readiness:
+    type: string
   product_launch_day:
     type: string
   technology:
@@ -149,8 +153,6 @@ properties:
         link:
           type: string
           format: uli
-    third_party_dependency:
-      type: boolean
     opensource:
       type: boolean
     viewing_key:
@@ -179,12 +181,29 @@ properties:
         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:
       anonymous:
         type: boolean
+      company:
+        type: object
+        properties:
+          link:
+            type: string
+            format: uri
       teammembers:
+        type: array
+        items:
           type: object
           properties:
             name:
@@ -209,10 +228,12 @@ properties:
       sign_in_type_requirments:
         type: string
   third_party_dependency:
-    type: string
+    type: boolean
   compliance:
-    type: string
+    anyOf: [{type: boolean}, {type: string}]
   audits:
+    type: array
+    items:
       type: object
       properties:
         name:
@@ -247,6 +268,8 @@ properties:
         type: string
         format: uri
   client_diversability:
+    type: array
+    items: 
       type: object
       properties:
         name:

src/projects/basicswap/index.yaml

@@ -43,10 +43,10 @@ tracebility:
   tracked_data: Chains activity
   kyc: false
   sign_in_type_requirments: wallets
-third_party_dependency: none
+third_party_dependency: false
 compliance: none
 client_diversability: 
-  name: BasicSwap client
+  - name: BasicSwap client
     link: https://basicswapdex.com/
 default_privacy: false
 project_status:

src/projects/blackbox/index.yaml

@@ -37,14 +37,14 @@ privacy_policy:
   defined: false
 team:
   anonymous: false
+  company:
+    name: Trivium Nodes
+    link: https://trivium.network/
+    contacts: info@trivium.network
   teammembers:
     - name: Xiphiar
       role: rdeveloper
       link: https://github.com/Xiphiar
-  company:
-    - name: Trivium Nodes
-      link: https://trivium.network/
-      contacts: info@trivium.network
 storage:
   decentralized: true
 tracebility:

src/projects/brume-wallet/index.yaml

@@ -32,7 +32,7 @@ privacy_policy:
 team:
   anonymous: false
   teammembers:
-    name: Haz Æ 41
+    - name: Haz Æ 41
       role: developer
       link: https://bento.me/hazae41
 storage:
@@ -41,7 +41,7 @@ tracebility:
   tracked_data: no ( Tor based )
   kyc: false
   sign_in_type_requirments: seed
-third_party_dependency: none
+third_party_dependency: false
 compliance: compliant
 
 history:

src/projects/elusiv/index.yaml

@@ -14,5 +14,5 @@ project_status:
   live_status: true
 team:
   anonymous: false
-  teammembers:
+  company:
     link: https://www.linkedin.com/search/results/people/?currentCompany=%5B%2280778213%22%5D&origin=COMPANY_PAGE_CANNED_SEARCH&sid=s_%40

src/projects/firn-protocol/index.yaml

@@ -2,8 +2,8 @@ name: Firn Protocol
 categories: [ defi ]
 ecosystem: Ethereum
 description: 'Firn is the first-ever zero-knowledge privacy platform in the account-based model, and introduces pluggable, flexible privacy to Ethereum-based chains.'
-token:
+tokens:
-  name: Firn
+  - name: Firn
     symbol: FIRN
     network: Optimism
     contract_address: "0xb20d84ebFeCdC6821448C7094564a039F0AE5EA4"
@@ -67,7 +67,7 @@ client_diversability:
     link: https://www.metamask.io
 default_privacy: true
 funding:
-  - name: LunarDAO
+  name: LunarDAO
   type: token sale
   link: https://lunardao.net/firn_investment.html
   value: 45.000 $

src/projects/offshift/index.yaml

@@ -10,6 +10,6 @@ project_status:
   live_status: true
 team:
   anonymous: true
-  teammembers:
+  company:
     link: https://offshift.io/#team
 

src/projects/railgun/index.yaml

@@ -1,6 +1,6 @@
 name: RAILGUN
 categories: [ defi ]
-token:
+tokens:
   - name: Railgun
     symbol: RAIL
     network: Ethereum
@@ -43,10 +43,11 @@ blockchain_features:
   reversability_condition: viewing key, hack
   data_masking: Contract deposit
   asset_custody_type: non-custody
-licences: 
 privacy_policy:
   defined: false
 team:
+  anonymous: false
+  teammembers:
     - name: Alan Scott
       role: researcher
     - name: Kieran Mesquita
@@ -74,7 +75,6 @@ team:
 storage:
   decentralized: true
 tracebility:
-  tracked_data:
   kyc: false
   sign_in_type_requirments: wallet
 third_party_dependency: false
@@ -83,8 +83,6 @@ audits:
   - name: Railgun audit report
     link: https://assets.railgun.org/docs/audits/
     time: July, 2021
-social_trust:
-technical_spof:
 history:
   title: Mainet
   event_type: launch
@@ -98,7 +96,7 @@ client_diversability:
     link: https://tokenshielder.com/
 default_privacy: true
 funding:
-  - name: DCG
+  name: DCG
   type: Investments
   link: https://www.coindesk.com/business/2022/01/26/railgun-aims-for-private-defi-with-10m-backing-from-dcg/
   value: 10.000.000 $

src/projects/secret-network/index.yaml

@@ -49,14 +49,14 @@ privacy_policy:
   defined: false
 team:
   anonymous: false
-  teammembers:
-    name: Alex Zaidelson
-    role: SLabs CEO
-    link: https://twitter.com/azaidelson
   company:
     name: Secret Labs
     link: https://www.scrtlabs.com/
     contacts: info@scrtlabs.com
+  teammembers:
+    - name: Alex Zaidelson
+      role: SLabs CEO
+      link: https://twitter.com/azaidelson
 storage:
   decentralized: true
 tracebility:
@@ -80,7 +80,7 @@ client_diversability:
     link: https://starshell.net/
 default_privacy: false
 funding:
-  - name: Private investors
+  name: Private investors
   type: ICO
   link: https://icodrops.com/secret-network/
   value: 236.500.000 $

src/projects/shade/index.yaml

@@ -1,8 +1,8 @@
 name: Shade Protocol
 categories: [ defi ]
 ecosystem: Secret
-token:
+tokens:
-  name: Shade Protocol
+  - name: Shade Protocol
     symbol: SHD
     network: Secret Network
     contract_address: secret153wu605vvp934xhd4k9dtd640zsep5jkesstdm
@@ -21,12 +21,10 @@ links:
   telegram: https://t.me/ShadeProtocol
   discord: https://discord.com/invite/YMcUrXK476
   blog: https://shadeprotocol.io/blog
-  facebook: 
   block_explorer: https://www.mintscan.io/secret
   whitepaper: https://framerusercontent.com/modules/assets/aAMeX7kkaxljkFRXRIN4CElVJbo~pEHSkrNceWvWuHWRiNuOD_CQEuYf_tS-dLtgATuz0QY.pdf
   github: https://github.com/securesecrets/shade
   docs: https://docs.shadeprotocol.io/shade-protocol/
-  changelog: 
   forum: https://forum.shadeprotocol.io/
 blockchain_features:
   p2p: false
@@ -53,14 +51,14 @@ privacy_policy:
   data_usage: tools you are making TXs on
 team:
   anonymous: false
+  company:
+    name: Secure Secrets
+    link: https://www.securesecrets.org/
+    contacts: https://twitter.com/securesecrets
   teammembers:
     - name: Carter L. Woetzel
       role: researcher
       link: https://twitter.com/l_woetzel
-  company:
-    - name: Secure Secrets
-      link: https://www.securesecrets.org/
-      contacts: https://twitter.com/securesecrets
 storage:
   decentralized: true
 tracebility:
@@ -91,7 +89,7 @@ client_diversability:
     link: https://starshell.net/
 default_privacy: true
 funding:
-  - name: Private investors
+  name: Private investors
   type: ICO
   link: https://shadeprotocol.io/blog/shade-protocol-raises-5m-20-key-partners-invested
   value: 5.000.000 $

src/projects/sienna/index.yaml

@@ -1,8 +1,8 @@
 name: Sienna Network
 categories: [ defi ]
 ecosystem: Secret
-token:
+tokens:
-  name: Sienna Network
+  - name: Sienna Network
     symbol: SIENNA
     network: Secret Network
     contract_address: secret1rgm2m5t530tdzyd99775n6vzumxa5luxcllml4
@@ -61,11 +61,11 @@ compliance: false
 audits:
   - name: Halborn and Certik
     link: https://sienna.network/audits/
-    time: April 28th, 2021
+    time: "2021-04-18"
 social_trust: Slabs ( MRSINGER )
 technical_spof: Can decrypt
 history:
-  - title: Mainet
+  title: Mainet
   event_type: launch
   description: V1
   time: October 2021
@@ -77,7 +77,7 @@ client_diversability:
     link: https://starshell.net/
 default_privacy: true
 funding:
-  - name: Public presale
+  name: Public presale
   type: ICO
   link: https://icodrops.com/sienna-network/
   value: 11.200.000

src/projects/wownero/index.yaml

@@ -7,7 +7,13 @@ ecosystem: Wownero
 product_launch_day: 01 April 2018
 project_type: Memecoin
 technology:
-  features: Ring Signatures (21 decoys), Ring Confidential Transactions (RingCT), Stealth Addresses, Bulletproofs+, Dynamic Block Size
+  type: Privacy
+  features: 
+    - Ring Signatures (21 decoys)
+    - Ring Confidential Transactions (RingCT)
+    - Stealth Addresses
+    - Bulletproofs+
+    - Dynamic Block Size
 blockchain_features:
   p2p: true
   network: Dandelion++, RandomX PoW (lite variant)
@@ -20,7 +26,7 @@ links:
   discord: https://discord.gg/ykZyAzJhDK
 team:
   anonymous: true
-licenses: MIT License
+licences: MIT License
 traceability:
   tracked_data: None
   kyc: false