335 referral system

networks.json

@@ -45,24 +45,28 @@
   },
   "mumbai": {
     "TalentLayerID": {
-      "address": "0x3F87289e6Ec2D05C32d8A74CCfb30773fF549306",
-      "startBlock": 33676850
+      "address": "0x87a247A1Aed184F7BC2b4F287Fc23D82E720721b",
+      "startBlock": 36843729
     },
     "TalentLayerReview": {
-      "address": "0x050F59E1871d3B7ca97e6fb9DCE64b3818b14B18",
-      "startBlock": 33676850
+      "address": "0x815035199D281be97D092710fE659445F1EB0DC9",
+      "startBlock": 36843729
     },
     "TalentLayerService": {
-      "address": "0x27ED516dC1df64b4c1517A64aa2Bb72a434a5A6D",
-      "startBlock": 33676850
+      "address": "0x9B7C6FB51D2EEE39b259BDe874710642120a58ED",
+      "startBlock": 36843729
     },
     "TalentLayerEscrow": {
-      "address": "0x4bE920eC3e8552292B2147480111063E0dc36872",
-      "startBlock": 33676850
+      "address": "0xC184101F1C1E4D71bd18F88FB7f36F53ec4F2De8",
+      "startBlock": 36843729
     },
     "TalentLayerPlatformID": {
-      "address": "0xEFD8dbC421380Ee04BAdB69216a0FD97F64CbFD4",
-      "startBlock": 33676850
+      "address": "0xE95a9d7d673716e40B8aa9851592672D6D697c25",
+      "startBlock": 36843729
+    },
+    "TalentLayerPlatformIDV1": {
+      "address": "0x9B7C6FB51D2EEE39b259BDe874710642120a58ED",
+      "startBlock": 36843729
     }
   },
   "matic": {

schema.graphql

@@ -15,12 +15,15 @@ type Service @entity {
   id: ID! # service id
   createdAt: BigInt! # timestamp of block creation
   updatedAt: BigInt! # timestamp of the last change
+  rateToken: Token! # Token entity
+  referralAmount: BigInt! # Referral amount
   status: ServiceStatus! # service status
   buyer: User # service buyer
   seller: User # service seller
+  referrer: User # service referrer (optional)
   transaction: Transaction @derivedFrom(field: "service") # transaction associated with this service
   proposals: [Proposal!] @derivedFrom(field: "service") # proposals for this service
-  platform: Platform # Platform on which service was created
+  platform: Platform # Platform on which the service was created
   cid: String
   description: ServiceDescription
 }
@@ -34,7 +37,6 @@ type ServiceDescription @entity(immutable: true) {
   expectedEndDate: BigInt
   keywords: [Keyword!] #keywords
   keywords_raw: String #lowercase keywords in raw format
-  rateToken: String
   rateAmount: String
   video_url: String
 }
@@ -80,28 +82,32 @@ type User @entity {
   createdAt: BigInt!
   updatedAt: BigInt!
   platform: Platform # Platform on which user nft was minted
-  numReviews: BigInt! # DEPRECATED - will be remove soon, use UserStats.numReceivedReviews instead
+  numReviews: BigInt # DEPRECATED - will be removed soon, use UserStats.numReceivedReviews instead
   address: String! # wallet address of user
   rating: BigDecimal! # average rating from reviews user has received
   reviews: [Review!] @derivedFrom(field: "to") # reviews of user
   buyerServices: [Service!] @derivedFrom(field: "buyer") # services user is an buyer for
   sellerServices: [Service!] @derivedFrom(field: "seller") # services user is an seller for
   totalGains: [UserGain!] @derivedFrom(field: "user")
+  referralGains: [ReferralGain!] @derivedFrom(field: "user")
   cid: String #cid of the description
   description: UserDescription # User description (off chain data)
   delegates: [String!]! # list of user delegators
-  userStats: UserStats # User proposal, service & reviews statistics
+  userStat: UserStat # User proposal, service & reviews statistics
 }
 
-type UserStats @entity {
+type UserStat @entity {
   id: ID! # ID of the user
+  user: User! # Corresponding user
   numReceivedReviews: BigInt! # number of reviews user has received
   numGivenReviews: BigInt! # number of reviews user has given
   numCreatedServices: BigInt! # number of services user has created
   numFinishedServicesAsBuyer: BigInt! # number of services user has finished as a buyer
   numCreatedProposals: BigInt! # number of proposals user has created
   numFinishedServicesAsSeller: BigInt! # number of services user has finished as a seller
-  user: User! # Corresponding user
+  numReferredUsers: BigInt! # number of users user has referred
+  numReferredUsersReviewsReceived: BigInt! # number of reviews referred users received (used for stat calculation)
+  averageReferredRating: BigDecimal! # average rating of referred referred services
 }
 
 type UserDescription @entity(immutable: true) {
@@ -133,12 +139,13 @@ type Proposal @entity {
   updatedAt: BigInt! # timestamp of the last change
   status: ProposalStatus! # Proposal status
   seller: User # Proposal seller
-  rateToken: Token! # Rate token entity
+  rateToken: Token # Rate token entity
   rateAmount: BigInt # Rate amount
   cid: String # cid of the description
   platform: Platform # Platform on which proposal was created
   description: ProposalDescription #Proposals that the description describes.
   expirationDate: BigInt
+  referrer: User # Optional referrer for the proposal
 }
 
 type ProposalDescription @entity(immutable: true) {
@@ -256,6 +263,15 @@ type FeeClaim @entity(immutable: true) {
   transactionHash: String # Transaction hash of the transfer
 }
 
+type ReferralBalanceClaim @entity(immutable: true) {
+  id: ID! # autogenerated id
+  createdAt: BigInt # timestamp of block creation
+  user: User # user entity
+  token: Token # token entity
+  amount: BigInt! # claim amount
+  transactionHash: String # Transaction hash of the transfer
+}
+
 type PlatformGain @entity {
   id: ID! # concatenation of platformId + token entity
   platform: Platform # platform entity
@@ -271,6 +287,15 @@ type UserGain @entity {
   totalGain: BigInt! # total User gain
 }
 
+type ReferralGain @entity {
+  id: ID! # concatenation of userId + token entity
+  user: User # user receiving the referral gain
+  token: Token # token entity
+  service: Service # Service which issued referral gain
+  totalGain: BigInt! # total User gain
+  availableBalance: BigInt! # Balance available to be claimed
+}
+
 type Protocol @entity {
   id: ID! # autogenerated id
   userMintFee: BigInt! # protocol fee for minting a TL id

src/getters.ts

@@ -15,15 +15,20 @@ import {
   Transaction,
   Evidence,
   Keyword,
-  UserStats,
+  UserStat,
+  ReferralGain,
+  ReferralBalanceClaim,
 } from '../generated/schema'
 import { PROTOCOL_ID, ZERO, ZERO_ADDRESS, ZERO_BIGDEC, ZERO_TOKEN_ADDRESS } from './constants'
 import { ERC20 } from '../generated/TalentLayerEscrow/ERC20'
+import { generateIdFromTwoElements } from './mappings/utils'
 
 export function getOrCreateService(id: BigInt): Service {
   let service = Service.load(id.toString())
   if (!service) {
     service = new Service(id.toString())
+    service.rateToken = getOrCreateToken(ZERO_ADDRESS).id
+    service.referralAmount = ZERO
     service.status = 'Opened'
     service.createdAt = ZERO
     service.updatedAt = ZERO
@@ -35,12 +40,14 @@ export function getOrCreateService(id: BigInt): Service {
 export function getOrCreateProposal(id: string, serviceId: BigInt): Proposal {
   let proposal = Proposal.load(id)
   if (!proposal) {
+    const service = getOrCreateService(serviceId)
+
     proposal = new Proposal(id)
     proposal.status = 'Pending'
     proposal.createdAt = ZERO
     proposal.updatedAt = ZERO
-    proposal.service = getOrCreateService(serviceId).id
-    proposal.rateToken = getOrCreateToken(ZERO_ADDRESS).id
+    proposal.service = service.id
+    proposal.rateToken = service.rateToken
     proposal.expirationDate = ZERO
     proposal.save()
   }
@@ -72,28 +79,30 @@ export function getOrCreateUser(id: BigInt): User {
     user.delegates = []
     user.save()
 
-
-    user.userStats = getOrCreateUserStats(id).id
+    user.userStat = getOrCreateUserStat(id).id
     user.save()
   }
-  
+
   return user
 }
 
-export function getOrCreateUserStats(id: BigInt): UserStats {
-  let userStats = UserStats.load(id.toString())
-  if (!userStats) {
-    userStats = new UserStats(id.toString())
-    userStats.user = getOrCreateUser(id).id
-    userStats.numReceivedReviews = ZERO
-    userStats.numGivenReviews = ZERO
-    userStats.numCreatedServices = ZERO
-    userStats.numFinishedServicesAsBuyer = ZERO
-    userStats.numCreatedProposals = ZERO
-    userStats.numFinishedServicesAsSeller = ZERO
-    userStats.save()
+export function getOrCreateUserStat(id: BigInt): UserStat {
+  let userStat = UserStat.load(id.toString())
+  if (!userStat) {
+    userStat = new UserStat(id.toString())
+    userStat.user = getOrCreateUser(id).id
+    userStat.numReceivedReviews = ZERO
+    userStat.numGivenReviews = ZERO
+    userStat.numCreatedServices = ZERO
+    userStat.numFinishedServicesAsBuyer = ZERO
+    userStat.numCreatedProposals = ZERO
+    userStat.numFinishedServicesAsSeller = ZERO
+    userStat.numReferredUsers = ZERO
+    userStat.numReferredUsersReviewsReceived = ZERO
+    userStat.averageReferredRating = ZERO_BIGDEC
+    userStat.save()
   }
-  return userStats
+  return userStat
 }
 
 export function getOrCreateTransaction(id: BigInt, blockTimestamp: BigInt = ZERO): Transaction {
@@ -297,3 +306,28 @@ export function getOrCreateKeyword(id: string): Keyword {
   }
   return keyword
 }
+
+export function getOrCreateReferralGain(userId: BigInt, tokenAddress: Address): ReferralGain {
+  const referralGainId = generateIdFromTwoElements(userId.toString(), tokenAddress.toHex())
+  let referralGain = ReferralGain.load(referralGainId)
+  if (!referralGain) {
+    referralGain = new ReferralGain(referralGainId)
+    referralGain.user = getOrCreateUser(userId).id
+    referralGain.token = getOrCreateToken(tokenAddress).id
+    referralGain.totalGain = ZERO
+    referralGain.availableBalance = ZERO
+
+    referralGain.save()
+  }
+  return referralGain
+}
+
+export function getOrCreateReferralClaim(referralClaimId: string): ReferralBalanceClaim {
+  let claim = ReferralBalanceClaim.load(referralClaimId)
+  if (!claim) {
+    claim = new ReferralBalanceClaim(referralClaimId)
+    claim.amount = ZERO
+    claim.save()
+  }
+  return claim
+}

src/mappings/ipfs-data.ts

@@ -34,7 +34,6 @@ export function handleServiceData(content: Bytes): void {
   if (keywords !== null) {
     description.keywords_raw = keywords.toLowerCase()
   }
-  description.rateToken = getValueAsString(jsonObject, 'rateToken')
   description.rateAmount = getValueAsString(jsonObject, 'rateAmount')
   description.video_url = getValueAsString(jsonObject, 'video_url')
 

src/mappings/talent-layer-escrow.ts

@@ -1,4 +1,4 @@
-import { BigInt, log } from '@graphprotocol/graph-ts'
+import { BigInt } from '@graphprotocol/graph-ts'
 import { Service, Transaction, User } from '../../generated/schema'
 import {
   getOrCreateService,
@@ -13,7 +13,10 @@ import {
   getOrCreateProtocol,
   getOrCreateTransaction,
   getOrCreateEvidence,
-  getOrCreateUserStats,
+  getOrCreateUserStat,
+  getOrCreateReferralGain,
+  getOrCreateReferralClaim,
+  getOrCreateUser,
 } from '../getters'
 import {
   Payment,
@@ -24,12 +27,13 @@ import {
   HasToPayFee,
   Dispute,
   RulingExecuted,
-  Evidence,
   MetaEvidence,
   ArbitrationFeePayment,
   EvidenceSubmitted,
   OriginServiceFeeRateReleased,
   OriginValidatedProposalFeeRateReleased,
+  ReferralAmountReleased,
+  ReferralAmountClaimed,
 } from '../../generated/TalentLayerEscrow/TalentLayerEscrow'
 import { generateIdFromTwoElements, generateUniqueId } from './utils'
 import { ONE, ZERO } from '../constants'
@@ -75,22 +79,30 @@ export function handleTransactionCreated(event: TransactionCreated): void {
   service.status = 'Confirmed'
   service.updatedAt = event.block.timestamp
   service.seller = User.load(event.params._proposalId.toString())!.id
+  if (proposal.referrer != null && proposal.referrer != '0') {
+    service.referrer = User.load(proposal.referrer!)!.id
+  }
   service.save()
 }
 
 export function handlePaymentCompleted(event: PaymentCompleted): void {
   const service = getOrCreateService(event.params._serviceId)
   service.status = 'Finished'
   service.updatedAt = event.block.timestamp
+  if (service.referrer != null && service.referrer != '0') {
+    const referrerUserStat = getOrCreateUserStat(BigInt.fromString(service.referrer!))
+    referrerUserStat.numReferredUsers.plus(ONE)
+    referrerUserStat.save()
+  }
   service.save()
 
-  const buyerUserStats = getOrCreateUserStats(BigInt.fromString(service.buyer!))
-  buyerUserStats.numFinishedServicesAsBuyer.plus(ONE)
-  buyerUserStats.save()
+  const buyerUserStat = getOrCreateUserStat(BigInt.fromString(service.buyer!))
+  buyerUserStat.numFinishedServicesAsBuyer = buyerUserStat.numFinishedServicesAsBuyer.plus(ONE)
+  buyerUserStat.save()
 
-  const sellerUserStats = getOrCreateUserStats(BigInt.fromString(service.seller!))
-  sellerUserStats.numFinishedServicesAsSeller.plus(ONE)
-  sellerUserStats.save()
+  const sellerUserStat = getOrCreateUserStat(BigInt.fromString(service.seller!))
+  sellerUserStat.numFinishedServicesAsSeller = sellerUserStat.numFinishedServicesAsSeller.plus(ONE)
+  sellerUserStat.save()
 }
 
 export function handlePayment(event: Payment): void {
@@ -257,3 +269,31 @@ export function handleMetaEvidence(event: MetaEvidence): void {
   transaction.metaEvidenceUri = event.params._evidence
   transaction.save()
 }
+
+export function handleReferralAmountReleased(event: ReferralAmountReleased): void {
+  const referralGain = getOrCreateReferralGain(event.params._referrerId, event.params._token)
+  referralGain.service = getOrCreateService(event.params._serviceId).id
+  referralGain.totalGain = referralGain.totalGain.plus(event.params._amount)
+  referralGain.availableBalance = referralGain.availableBalance.plus(event.params._amount)
+
+  referralGain.save()
+}
+
+export function handleReferralAmountClaimed(event: ReferralAmountClaimed): void {
+  const claimId = generateUniqueId(event.transaction.hash.toHex(), event.logIndex.toString())
+  const referralClaim = getOrCreateReferralClaim(claimId)
+
+  referralClaim.user = getOrCreateUser(event.params._referrerId).id
+  referralClaim.token = getOrCreateToken(event.params._token).id
+  referralClaim.amount = event.params._amount
+
+  referralClaim.transactionHash = event.transaction.hash.toHex()
+  referralClaim.createdAt = event.block.timestamp
+
+  referralClaim.save()
+
+  const referralGain = getOrCreateReferralGain(event.params._referrerId, event.params._token)
+  referralGain.availableBalance = referralGain.availableBalance.minus(event.params._amount)
+
+  referralGain.save()
+}

src/mappings/talent-layer-id.ts

@@ -39,7 +39,7 @@ export function handleCidUpdated(event: CidUpdated): void {
 
 export function handleMint(event: Mint): void {
   const user = getOrCreateUser(event.params.profileId)
-  user.userStats = event.params.profileId.toString()
+  user.userStat = event.params.profileId.toString()
   user.address = event.params.user.toHex()
   user.handle = event.params.handle
   user.createdAt = event.block.timestamp