Permissions: Track method signatures for permissions (#23)

Co-authored-by: Facu Spagnuolo <[email protected]>

.gitignore

@@ -2,4 +2,5 @@ build
 types
 node_modules
 subgraph.yaml
+/src/permissions/dictionary.ts
 *.log

package.json

@@ -40,8 +40,10 @@
     "@graphprotocol/graph-ts": "^0.31.0",
     "@typescript-eslint/eslint-plugin": "^4.1.1",
     "@typescript-eslint/parser": "^4.1.1",
+    "ethers": "~5.6.0",
     "eslint": "^7.9.0",
     "eslint-config-mimic": "^0.0.2",
+    "ts-node": "^10.9.1",
     "typescript": "~4.3.4"
   },
   "eslintConfig": {

schema.graphql

@@ -57,6 +57,7 @@ type Permission @entity {
   who: String!
   where: String!
   what: String!
+  method: String!
   params: [PermissionParam!] @derivedFrom(field: "permission")
 }
 

scripts/build-permissions-dictionary.ts

@@ -0,0 +1,46 @@
+import { ethers } from 'ethers'
+import * as fs from 'fs'
+
+const FUNCTIONS = {}
+const DEPENDENCIES_DIR = './node_modules/@mimic-fi'
+const DICTIONARY_OUTPUT = './src/permissions/dictionary.ts'
+
+fs.readdirSync(DEPENDENCIES_DIR).forEach((dependency) => {
+  const interfacesDir = `${DEPENDENCIES_DIR}/${dependency}/artifacts/contracts/interfaces`
+  if (!fs.existsSync(interfacesDir)) return
+  fs.readdirSync(interfacesDir).forEach((file) => processInterfaces(`${interfacesDir}/${file}`))
+})
+
+writeOutput()
+
+function processInterfaces(path: string): void {
+  if (fs.statSync(path).isDirectory())
+    return fs.readdirSync(path).forEach((file) => processInterfaces(`${path}/${file}`))
+
+  const data = JSON.parse(fs.readFileSync(path).toString())
+  if (!data.abi) return
+
+  const iface = new ethers.utils.Interface(data.abi)
+  data.abi
+    .filter((input) => input.type === 'function')
+    .filter((input) => input.stateMutability === 'nonpayable')
+    .forEach((input) => (FUNCTIONS[iface.getSighash(input.name)] = functionDefinition(input.name, input.inputs)))
+}
+
+function functionDefinition(name: string, inputs: { type: string; name: string }[]): string {
+  const args = inputs.map((input) => `${input.type} ${input.name}`).join(', ')
+  return `${name}(${args})`
+}
+
+function writeOutput(): void {
+  if (fs.existsSync(DICTIONARY_OUTPUT)) fs.unlinkSync(DICTIONARY_OUTPUT)
+  const content = `// This file was autogenerated at deployment time
+
+const dictionary = new Map<string, string>()
+${Object.entries(FUNCTIONS)
+  .map(([selector, name]) => `dictionary.set('${selector}', '${name}')`)
+  .join('\n')}
+export default dictionary
+`
+  fs.writeFileSync(DICTIONARY_OUTPUT, `${content}`)
+}

scripts/build.sh

@@ -155,6 +155,10 @@ sed -i -e "s/{{feeControllerAddress}}/${FEE_CONTROLLER_ADDRESS}/g" subgraph.yaml
 sed -i -e "s/{{blockNumber}}/${BLOCK_NUMBER}/g" subgraph.yaml
 rm -f subgraph.yaml-e
 
+# Build functions selector dictionary
+echo "Building functions selector dictionary"
+yarn ts-node ./scripts/build-permissions-dictionary.ts
+
 # Run codegen and build
 rm -rf ./types && yarn graph codegen -o types
 yarn graph build

src/Authorizer.ts

@@ -2,14 +2,17 @@ import { Address, Bytes, crypto, log, store } from '@graphprotocol/graph-ts'
 
 import { Permission, PermissionParam } from '../types/schema'
 import { Authorized, Authorizer as AuthorizerContract, Unauthorized } from '../types/templates/Authorizer/Authorizer'
+import { getFunctionNameForSelector } from './permissions/index'
 
 export function handleAuthorized(event: Authorized): void {
   const permissionId = getPermissionId(event.address, event.params.who, event.params.where, event.params.what)
   const permission = new Permission(permissionId)
+  const what = event.params.what.toHexString()
   permission.authorizer = event.address.toHexString()
   permission.who = event.params.who.toHexString()
   permission.where = event.params.where.toHexString()
-  permission.what = event.params.what.toHexString()
+  permission.what = what
+  permission.method = getFunctionNameForSelector(what)
   permission.save()
 
   const authorizerContract = AuthorizerContract.bind(event.address)

src/permissions/index.ts

@@ -0,0 +1,6 @@
+import dictionary from './dictionary'
+
+export function getFunctionNameForSelector(selector: string): string {
+  const functionName = dictionary.has(selector) ? dictionary.get(selector) : 'Unknown'
+  return functionName
+}