From 334f1c71995f9aa688db718302d38c68bfa59464 Mon Sep 17 00:00:00 2001
From: PaulieB14 <94752445+PaulieB14@users.noreply.github.com>
Date: Thu, 8 Dec 2022 10:23:06 -0500
Subject: [PATCH] Update schema.graphql (#10525)

* Update schema.graphql

Added descriptions to Schema

* Update CLA.txt

CLA agreement

* Update schema.graphql

Made suggested edits

* Update CLA.txt

* Update .clabot

Added user name.

* Update schema.graphql

Made requested changed by @wonderwoman

* Update subgraph/schema.graphql

Co-authored-by: Julien Genestoux <julien.genestoux@gmail.com>
---
 CLA.txt                 |  2 ++
 subgraph/schema.graphql | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+)

diff --git a/CLA.txt b/CLA.txt
index abdf184e79d..c45fdbab86e 100644
--- a/CLA.txt
+++ b/CLA.txt
@@ -109,3 +109,5 @@ and interest in and to Your Contributions.
 8. You agree to notify Unlock of any facts or circumstances of
    which you become aware that would make these representations
    inaccurate in any respect.
+
+
diff --git a/subgraph/schema.graphql b/subgraph/schema.graphql
index cd1ca4b6d6e..06515b5c67b 100644
--- a/subgraph/schema.graphql
+++ b/subgraph/schema.graphql
@@ -1,43 +1,75 @@
 type Lock @entity {
+  "Unique ID for the Lock object (uses the lock address)"
   id: ID!
+  "Address of the lock"
   address: Bytes!
+  "A descriptive name for a collection of NFTs in this contract"
   name: String
+  "Token symbol" 
   symbol: String
+  "Duration is set the on the lock when you deploy and the expiration which is set on each key when they are minted"
   expirationDuration: BigInt
+  "Address of the 'currency' ERC20 contract if the keys are priced using an ERC20"
   tokenAddress: Bytes!
+  "Price of the keys sold by the lock" 
   price: BigInt!
+  "An assigned role set on a Lock contract which gives the highest level of permissions to the wallet address set to that role"
   lockManagers: [Bytes!]!
+  "Unlock Protocol version of a minting contract"  
   version: BigInt!
+  "Number of keys minted (expired or not)"
   totalKeys: BigInt!
+  "Maximum number of keys for sale" 
   maxNumberOfKeys: BigInt
+ "The maximum number of keys allowed for a single address"
   maxKeysPerAddress: BigInt
+  "Refer to key entity"
   keys: [Key!] @derivedFrom(field: "lock")
+  "Which block the lock was created"
   createdAtBlock: BigInt
+  "The timestamp of the block in which the last key was minted"
   lastKeyMintedAt: BigInt
 }
 
 type Key @entity {
+  "Unique identifier for a key (combination of lock address and token id)" 
   id: ID!
+  "In the Unlock ecosystem, a “Lock” is a smart contract that creates (or “mints”) NFTs"
   lock: Lock!
+  "TokenId for a given key" 
   tokenId: BigInt!
+ "The address of the key owner"
   owner: Bytes!
+  "An assigned title set on an Unlock key which gives a specific wallet address authorization to transfer, share or cancel"
   manager: Bytes
+  "Time the key expires"  
   expiration: BigInt!
+  "The tokenURI on an NFT is a unique identifier"
   tokenURI: String
+  "Block key was created"
   createdAtBlock: BigInt!
+  "Invoked by a Lock manager to expire the user's key and perform a refund and cancellation of the key"
   cancelled: Boolean
 }
 
 type UnlockDailyData @entity {
+  "Day identifier" 
   id: ID!
+  "Number of locks deployed on that day"
   lockDeployed: BigInt!
+  "Daily number of keys sold" 
   keysSold: BigInt!
+  "Daily number of active locks" 
   activeLocks: [Bytes!]
+  "Total value exchanged on the network" 
   grossNetworkProduct: BigInt!
 }
 
 type LockStats @entity {
+  "Transaction Hash"
   id: ID!
+  "Total locks deployed"
   totalLocksDeployed: BigInt!
+  "Total keys sold"
   totalKeysSold: BigInt!
 }