Add ENS and DIDregistry to yargs cli

Author: davekay100

addresses.json

@@ -1,5 +1,11 @@
 {
   "4": {
+    "IENS": {
+      "address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e"
+    },
+    "IEthereumDIDRegistry": {
+      "address": "0xdCa7EF03e98e0DC2B855bE647C39ABe984fcF21B"
+    },
     "EpochManager": {
       "address": "0xFd12A3ee8Bf3C417e0cedbc591BA10156724C069",
       "initArgs": [
@@ -203,6 +209,18 @@
     }
   },
   "42": {
+    "IENS": {
+      "address": "0xB66B2f307B6e46a6D038a85997B401aE87455772"
+    },
+    "ITestRegistrar": {
+      "address": "0x327033bA7B23A6E3a3Ca165e44D619E3dd675f8b"
+    },
+    "IPublicResolver": {
+      "address": "0xc30F6CCc48F1eA5374aC618dfe5243ddD1e264E7"
+    },
+    "IEthereumDIDRegistry": {
+      "address": "0xdCa7EF03e98e0DC2B855bE647C39ABe984fcF21B"
+    },
     "EpochManager": {
       "address": "0xc56bA09727030e018990089964E8537FDa13a786",
       "initArgs": [
@@ -607,21 +625,5 @@
       "runtimeCodeHash": "0x962af945f8852d82fe16690798107779ff368624a510e9dbf837bafb6fac557e",
       "txHash": "0xc6666d7b1a9731a1797f26c5ac3f203ce8adbff27aedc454f2d0b83e8c01e140"
     }
-  },
-  "kovan": {
-    "ens": "0xB66B2f307B6e46a6D038a85997B401aE87455772",
-    "ensTestRegistrar": "0x327033bA7B23A6E3a3Ca165e44D619E3dd675f8b",
-    "ensPublicResolver": "0xc30F6CCc48F1eA5374aC618dfe5243ddD1e264E7",
-    "ethereumDIDRegistry": "0xdCa7EF03e98e0DC2B855bE647C39ABe984fcF21B"
-  },
-  "rinkeby": {
-    "ens": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
-    "ensTestRegistrar": "0x327033bA7B23A6E3a3Ca165e44D619E3dd675f8b",
-    "ensPublicResolver": "0xc30F6CCc48F1eA5374aC618dfe5243ddD1e264E7",
-    "ethereumDIDRegistry": "0xdCa7EF03e98e0DC2B855bE647C39ABe984fcF21B"
-  },
-  "mainnet": {
-    "ens": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
-    "ethereumDIDRegistry": "0xdCa7EF03e98e0DC2B855bE647C39ABe984fcF21B"
   }
 }

scripts/cli/commands/contracts/contracts.ts

@@ -2,13 +2,20 @@ import yargs, { Argv } from 'yargs'
 
 import { curationCommand } from './curation'
 import { serviceRegistryCommand } from './service-registry'
+import { ensCommand } from './ens'
+import { ethereumDIDRegistryCommand } from './ethereumDIDRegistry'
+
 import { CLIArgs } from '../../env'
 
 export const contractsCommand = {
   command: 'contracts',
   describe: 'Contract calls for all contracts',
   builder: (yargs: Argv): yargs.Argv => {
-    return yargs.command(curationCommand).command(serviceRegistryCommand)
+    return yargs
+      .command(curationCommand)
+      .command(serviceRegistryCommand)
+      .command(ensCommand)
+      .command(ethereumDIDRegistryCommand)
   },
   handler: (argv: CLIArgs): void => {
     yargs.showHelp()

scripts/cli/commands/contracts/curation.ts

@@ -2,12 +2,12 @@ import consola from 'consola'
 import yargs, { Argv } from 'yargs'
 import { parseGRT } from '@graphprotocol/common-ts'
 
-import { getContractAt, sendTransaction } from '../../network'
+import { sendTransaction } from '../../network'
 import { loadEnv, CLIArgs, CLIEnvironment } from '../../env'
 
 const logger = consola.create({})
 
-export const mint = async (cli: CLIEnvironment, cliArgs: CLIArgs) => {
+export const mint = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const subgraphID = cliArgs.subgraphID
   const amount = parseGRT(cliArgs.amount)
 
@@ -19,7 +19,7 @@ export const mint = async (cli: CLIEnvironment, cliArgs: CLIArgs) => {
   logger.log(`Signaling on ${subgraphID} with ${cliArgs.amount} tokens...`)
   await sendTransaction(cli.wallet, curation, 'mint', ...[subgraphID, amount])
 }
-export const burn = async (cli: CLIEnvironment, cliArgs: CLIArgs) => {
+export const burn = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const subgraphID = cliArgs.subgraphID
   const amount = parseGRT(cliArgs.amount)
   const curation = cli.contracts.Curation

scripts/cli/commands/contracts/ens.ts

@@ -0,0 +1,74 @@
+import consola from 'consola'
+import yargs, { Argv } from 'yargs'
+import { utils } from 'ethers'
+
+import { sendTransaction } from '../../network'
+import { loadEnv, CLIArgs, CLIEnvironment } from '../../env'
+
+const logger = consola.create({})
+export const registerTestName = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
+  const name = cliArgs.name
+  const testRegistrar = cli.contracts.ITestRegistrar
+  const normalizedName = name.toLowerCase()
+  const labelNameFull = `${normalizedName}.${'eth'}`
+  const labelHashFull = utils.namehash(labelNameFull)
+  const label = utils.keccak256(utils.toUtf8Bytes(normalizedName))
+  logger.log(`Namehash for ${labelNameFull}: ${labelHashFull}`)
+  logger.log(`Registering ${name} with ${cli.walletAddress} on the test registrar`)
+  await sendTransaction(cli.wallet, testRegistrar, 'register', ...[label, cli.walletAddress])
+}
+export const checkOwner = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
+  const name = cliArgs.name
+  const ens = cli.contracts.IENS
+  const node = nameToNode(name)
+  const res = await ens.owner(node)
+  logger.success(`owner = ${res}`)
+}
+
+export const nameToNode = (name: string): string => {
+  const node = utils.namehash(`${name}.eth`)
+  logger.log(`Name: ${name}`)
+  logger.log(`Node: ${node}`)
+  return node
+}
+
+export const ensCommand = {
+  command: 'ens',
+  describe: 'ENS contract calls',
+  builder: (yargs: Argv): yargs.Argv => {
+    return yargs
+      .command({
+        command: 'registerTestName',
+        describe: 'Register a name on the test registrar',
+        builder: (yargs: Argv) => {
+          return yargs.option('name', {
+            description: 'Name being registered',
+            type: 'string',
+            requiresArg: true,
+            demandOption: true,
+          })
+        },
+        handler: async (argv: CLIArgs): Promise<void> => {
+          return registerTestName(await loadEnv(argv), argv)
+        },
+      })
+      .command({
+        command: 'checkOwner',
+        describe: 'Check the owner of a name',
+        builder: (yargs: Argv) => {
+          return yargs.option('name', {
+            description: 'Name being checked',
+            type: 'string',
+            requiresArg: true,
+            demandOption: true,
+          })
+        },
+        handler: async (argv: CLIArgs): Promise<void> => {
+          return checkOwner(await loadEnv(argv), argv)
+        },
+      })
+  },
+  handler: (argv: CLIArgs): void => {
+    yargs.showHelp()
+  },
+}

scripts/cli/commands/contracts/ethereumDIDRegistry.ts

@@ -0,0 +1,90 @@
+import * as fs from 'fs'
+import consola from 'consola'
+import yargs, { Argv } from 'yargs'
+
+import { IPFS } from '../../helpers'
+import { sendTransaction } from '../../network'
+import { loadEnv, CLIArgs, CLIEnvironment } from '../../env'
+import { jsonToAccountMetadata } from './metadataHelpers'
+
+const logger = consola.create({})
+
+const handleAccountMetadata = async (ipfs: string, path: string): Promise<string> => {
+  const metadata = jsonToAccountMetadata(JSON.parse(fs.readFileSync(__dirname + path).toString()))
+  console.log('Meta data:')
+  console.log('  Code Repository: ', metadata.codeRepository || '')
+  console.log('  Description:     ', metadata.description || '')
+  console.log('  Image:           ', metadata.image || '')
+  console.log('  Name:            ', metadata.name || '')
+  console.log('  Website:         ', metadata.website || '')
+
+  const ipfsClient = IPFS.createIpfsClient(ipfs)
+  console.log('\nUpload JSON meta data to IPFS...')
+  const result = await ipfsClient.add(Buffer.from(JSON.stringify(metadata)))
+  const metaHash = result[0].hash
+  try {
+    const data = JSON.parse(await ipfsClient.cat(metaHash))
+    if (JSON.stringify(data) !== JSON.stringify(metadata)) {
+      throw new Error(`Original meta data and uploaded data are not identical`)
+    }
+  } catch (e) {
+    throw new Error(`Failed to retrieve and parse JSON meta data after uploading: ${e.message}`)
+  }
+  console.log(`Upload metadata successful: ${metaHash}\n`)
+  return IPFS.ipfsHashToBytes32(metaHash)
+}
+
+export const setAttribute = async (cli: CLIEnvironment, cliArgs: CLIArgs) => {
+  const metadataPath = cliArgs.metadataPath
+  const ipfsEndpoint = cliArgs.ipfs
+  const ethereumDIDRegistry = cli.contracts.IEthereumDIDRegistry
+  // const name comes from: keccak256("GRAPH NAME SERVICE")
+  const name = '0x72abcb436eed911d1b6046bbe645c235ec3767c842eb1005a6da9326c2347e4c'
+  const metaHashBytes = await handleAccountMetadata(ipfsEndpoint, metadataPath)
+
+  logger.log(`Setting attribute on ethereum DID registry ...`)
+  await sendTransaction(
+    cli.wallet,
+    ethereumDIDRegistry,
+    'setAttribute',
+    ...[cli.walletAddress, name, metaHashBytes, 0],
+  )
+}
+
+export const ethereumDIDRegistryCommand = {
+  command: 'ethereumDIDRegistry',
+  describe: 'Calls into the Ethereum DID Registry Contract',
+  builder: (yargs: Argv): yargs.Argv => {
+    return yargs.command({
+      command: 'setAttribute',
+      describe: 'Set metadata for graph account',
+      builder: (yargs: Argv) => {
+        return yargs
+          .option('i', {
+            alias: 'ipfs',
+            description: 'IPFS endpoint where file is being uploaded',
+            type: 'string',
+            requiresArg: true,
+            demandOption: true,
+          })
+          .option('metadataPath', {
+            description: `filepath to metadata with the JSON format:\n
+                            "codeRepository": "github.com/davekaj",
+                            "description": "Dave Kajpusts graph account",
+                            "image": "http://localhost:8080/ipfs/QmTFK5DZc58XrTqhuuDTYoaq29ndnwoHX5TAW1bZr5EMpq",
+                            "name": "Dave Kajpust",
+                            "website": "https://kajpust.com/"`,
+            type: 'string',
+            requiresArg: true,
+            demandOption: true,
+          })
+      },
+      handler: async (argv: CLIArgs): Promise<void> => {
+        return setAttribute(await loadEnv(argv), argv)
+      },
+    })
+  },
+  handler: (argv: CLIArgs): void => {
+    yargs.showHelp()
+  },
+}

scripts/cli/commands/contracts/metadataHelpers.ts

@@ -0,0 +1,66 @@
+interface AccountMetadata {
+  codeRepository: string
+  description: string
+  image: string
+  name: string
+  website: string
+}
+
+interface SubgraphMetadata {
+  description: string
+  displayName: string
+  image: string
+  codeRepository: string
+  website: string
+}
+
+interface VersionMetadata {
+  label: string
+  description: string
+}
+
+const jsonToSubgraphMetadata = (json): SubgraphMetadata => {
+  const subgraphMetadata: SubgraphMetadata = {
+    description: checkString(json.description),
+    displayName: checkString(json.displayName),
+    image: checkString(json.image),
+    codeRepository: checkString(json.codeRepository),
+    website: checkString(json.website),
+  }
+  return subgraphMetadata
+}
+
+const jsonToVersionMetadata = (json): VersionMetadata => {
+  const subgraphMetadata: VersionMetadata = {
+    label: checkString(json.label),
+    description: checkString(json.description),
+  }
+  return subgraphMetadata
+}
+
+const jsonToAccountMetadata = (json): AccountMetadata => {
+  const accountMetadata: AccountMetadata = {
+    codeRepository: checkString(json.codeRepository),
+    description: checkString(json.description),
+    image: checkString(json.image),
+    name: checkString(json.name),
+    website: checkString(json.website),
+  }
+  return accountMetadata
+}
+
+const checkString = (field): string => {
+  if (typeof field != 'string') {
+    throw Error('Metadata field is incorrect for one or more files')
+  }
+  return field
+}
+
+export {
+  AccountMetadata,
+  SubgraphMetadata,
+  VersionMetadata,
+  jsonToSubgraphMetadata,
+  jsonToVersionMetadata,
+  jsonToAccountMetadata,
+}

scripts/cli/commands/contracts/service-registry.ts

@@ -1,19 +1,19 @@
 import consola from 'consola'
 import yargs, { Argv } from 'yargs'
 
-import { getContractAt, sendTransaction } from '../../network'
+import { sendTransaction } from '../../network'
 import { loadEnv, CLIArgs, CLIEnvironment } from '../../env'
 
 const logger = consola.create({})
-export const register = async (cli: CLIEnvironment, cliArgs: CLIArgs) => {
+export const register = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const url = cliArgs.url
   const geoHash = cliArgs.geoHash
   const serviceRegistry = cli.contracts.ServiceRegistry
 
   logger.log(`Registering indexer ${cli.walletAddress} with url ${url} and geoHash ${geoHash}`)
   await sendTransaction(cli.wallet, serviceRegistry, 'register', ...[url, geoHash])
 }
-export const unregister = async (cli: CLIEnvironment, cliArgs: CLIArgs) => {
+export const unregister = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const serviceRegistry = cli.contracts.ServiceRegistry
 
   logger.log(`Unregistering indexer ${cli.walletAddress}`)