Issue 471 provider fees (#474)

* Adding providerFee to Order in the schema

* Adding ProviderFee to subgraph.template.yaml

* Creating order utils

* Saving providerFee as a string

* Saving providerFee as an array of all previous provider fees

* Creating test for providerFee

* Removing arrary from providerFee

* Updating or Creating OrderResue provider fee

* lint:fix

* Creating additional tests for testing providerFees on Order and reuseOrder

* lint:fix

* Updating JSON string notation

* Fixing first test

* fixing second test: testing provider fees after calling reuseOrder on a using a previous txId

* added providerFeeValidUntil

Co-authored-by: mihaisc <[email protected]>

Author: jamiehewitt15

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "wix.vscode-import-cost"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "search.exclude": {
+    "**/.next": true,
+    "**/out": true
+  }
+}

schema.graphql

@@ -249,6 +249,8 @@ type OrderReuse @entity {
   createdTimestamp: BigInt!
   tx: String!
   block: BigInt!
+  providerFee: String
+  providerFeeValidUntil: BigInt
   }
 type Order @entity {  
   "transaction hash - token address - from address"                                       
@@ -265,6 +267,8 @@ type Order @entity {
   publishingMarket: User
   publishingMarketToken: Token                                #
   publishingMarketAmmount: BigDecimal                         #call contract to get fee amount
+  providerFee: String
+  providerFeeValidUntil: BigInt
 
   consumerMarket: User
   consumerMarketToken: Token                                  #

src/mappings/erc20Templates.ts

@@ -10,22 +10,16 @@ import {
   RemovedMinter,
   RemovedPaymentManager,
   CleanedPermissions,
-  OrderReused
+  OrderReused,
+  ProviderFee
 } from '../@types/templates/ERC20Template/ERC20Template'
 
 import { integer } from './utils/constants'
 import { weiToDecimal } from './utils/generic'
 import { addOrder } from './utils/globalUtils'
 import { getToken, getUSDValue } from './utils/tokenUtils'
 import { getUser } from './utils/userUtils'
-
-function getOrderId(
-  tx: string,
-  tokenAddress: string,
-  fromAddress: string
-): string {
-  return `${tx}-${tokenAddress}-${fromAddress}`
-}
+import { getOrderId } from './utils/orderUtils'
 
 export function handleOrderStarted(event: OrderStarted): void {
   const order = new Order(
@@ -204,26 +198,38 @@ export function handleNewPaymentCollector(event: NewPaymentCollector): void {
   token.save()
 }
 
-// export function handlePublishMarketFees(event: PublishMarketFees): void {
-//   const order = Order.load(
-//     getOrderId(
-//       event.transaction.hash.toHex(),
-//       event.address.toHex(),
-//       event.transaction.from.toHex()
-//     )
-//   )
-
-//   order.save()
-// }
-
-// export function handleConsumeMarketFees(event: ConsumeMarketFees): void {
-//   const order = Order.load(
-//     getOrderId(
-//       event.transaction.hash.toHex(),
-//       event.address.toHex(),
-//       event.transaction.from.toHex()
-//     )
-//   )
-
-//   order.save()
-// }
+export function handleProviderFee(event: ProviderFee): void {
+  const providerFee: string = `{"providerFeeAddress": "${event.params.providerFeeAddress.toHex()}", "providerFeeToken": "${event.params.providerFeeToken.toHex()}", "providerFeeAmount": "${
+    event.params.providerFeeAmount
+  }", "providerData": "${event.params.providerData.toHexString()}", "v": "${
+    event.params.v
+  }", "r": "${event.params.r.toHexString()}", "s": "${event.params.s.toHexString()}", "validUntil": "${
+    event.params.validUntil
+  }"}`
+
+  const orderId = getOrderId(
+    event.transaction.hash.toHex(),
+    event.address.toHex(),
+    event.transaction.from.toHex()
+  )
+  const order = Order.load(orderId)
+
+  if (order) {
+    order.providerFee = providerFee
+    order.providerFeeValidUntil = event.params.validUntil
+    order.save()
+    return
+  }
+
+  let orderReuse = OrderReuse.load(event.transaction.hash.toHex())
+  if (orderReuse) {
+    orderReuse.providerFee = providerFee
+    orderReuse.providerFeeValidUntil = event.params.validUntil
+    orderReuse.save()
+  } else {
+    orderReuse = new OrderReuse(event.transaction.hash.toHex())
+    orderReuse.providerFee = providerFee
+    orderReuse.providerFeeValidUntil = event.params.validUntil
+    orderReuse.save()
+  }
+}

src/mappings/utils/orderUtils.ts

@@ -0,0 +1,27 @@
+import { Order } from '../../@types/schema'
+
+export function getOrderId(
+  tx: string,
+  tokenAddress: string,
+  fromAddress: string
+): string {
+  return `${tx}-${tokenAddress}-${fromAddress}`
+}
+
+export function createOrder(orderId: string): Order {
+  const order = new Order(orderId)
+  return order
+}
+
+export function getOrder(
+  transactionHash: string,
+  address: string,
+  transactionFrom: string
+): Order {
+  const orderId = getOrderId(transactionHash, address, transactionFrom)
+  let newOrder = Order.load(orderId)
+  if (newOrder === null) {
+    newOrder = createOrder(orderId)
+  }
+  return newOrder
+}

subgraph.template.yaml

@@ -113,6 +113,8 @@ templates:
           handler: handleRemovedPaymentManager
         - event: CleanedPermissions(indexed address,uint256,uint256)
           handler: handleCleanedPermissions
+        - event: ProviderFee(indexed address,indexed address,uint256,bytes,uint8,bytes32,bytes32,uint256)
+          handler: handleProviderFee
 
   - name: BPool
     kind: ethereum/contract