feat: add support for L2 contracts

Signed-off-by: Tomás Migone <[email protected]>

Author: tmigone

packages/common-ts/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.4-testnet-scratch1] - 2022-08-30
+### Changed
+- Update to use @graphprotocol/contracts@2.0.4-testnet-scratch1
+
+## [2.0.3-testnet-scratch1] - 2022-08-30
+### Fixed
+- Fixed a bug where L2 graph token would initialize with L1 address.
+
+## [2.0.2-testnet-scratch1] - 2022-08-30
+### Fixed
+- Don't require L1Reservoir to be deployed (not deployed in scratch1)
+
+## [2.0.1-testnet-scratch1] - 2022-08-29
+### Changed
+- Add support for L2 contracts
+- Add GraphChain utils
+- Update @graphprotocol/contracts to v2.0.2-testnet-scratch1
+
 ## [Unreleased]
 ### Changed
 - Include AllocationExchange in NetworkContracts

packages/common-ts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/common-ts",
-  "version": "1.8.6",
+  "version": "2.0.4-testnet-scratch1",
   "description": "Common TypeScript library for Graph Protocol components",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,15 +16,15 @@
     "test:watch": "jest --watch --passWithNoTests --detectOpenHandles --verbose"
   },
   "dependencies": {
-    "@graphprotocol/contracts": "1.13.0",
+    "@graphprotocol/contracts": "^2.0.4-testnet-scratch1",
     "@graphprotocol/pino-sentry-simple": "0.7.1",
     "@urql/core": "2.4.4",
     "@urql/exchange-execute": "1.2.2",
     "body-parser": "1.19.1",
     "bs58": "4.0.1",
     "cors": "2.8.5",
     "cross-fetch": "3.1.5",
-    "ethers": "5.6.2",
+    "ethers": "5.7.0",
     "express": "4.17.3",
     "graphql": "16.3.0",
     "graphql-tag": "2.12.6",

packages/common-ts/src/contracts/chain.ts

@@ -0,0 +1,46 @@
+class MapWithGetKey<K> extends Map<K, K> {
+  getKey(value: K): K | undefined {
+    for (const [k, v] of this.entries()) {
+      if (v === value) {
+        return k
+      }
+    }
+    return
+  }
+}
+
+// List of supported L1 <> L2 chain mappings
+const chainMap = new MapWithGetKey<number>([
+  [1, 42161], // Ethereum Mainnet - Arbitrum One
+  [4, 421611], // Ethereum Rinkeby - Arbitrum Rinkeby
+  [5, 421613], // Ethereum Goerli - Arbitrum Goerli
+  [1337, 412346], // Localhost - Arbitrum Localhost
+])
+
+export const l1Chains = Array.from(chainMap.keys())
+export const l2Chains = Array.from(chainMap.values())
+export const chains = [...l1Chains, ...l2Chains]
+
+export const isL1 = (chainId: number): boolean => l1Chains.includes(chainId)
+export const isL2 = (chainId: number): boolean => l2Chains.includes(chainId)
+export const isSupported = (chainId: number | undefined): boolean =>
+  chainId !== undefined && chains.includes(chainId)
+
+export const l1ToL2 = (chainId: number): number | undefined => chainMap.get(chainId)
+export const l2ToL1 = (chainId: number): number | undefined => chainMap.getKey(chainId)
+export const counterpart = (chainId: number): number | undefined => {
+  if (!isSupported(chainId)) return
+  return isL1(chainId) ? l1ToL2(chainId) : l2ToL1(chainId)
+}
+
+export default {
+  l1Chains,
+  l2Chains,
+  chains,
+  isL1,
+  isL2,
+  isSupported,
+  l1ToL2,
+  l2ToL1,
+  counterpart,
+}

packages/common-ts/src/contracts/index.ts

@@ -1,4 +1,5 @@
 import { providers, Signer } from 'ethers'
+import graphChain from './chain'
 
 // Contract addresses
 import * as DEPLOYED_CONTRACTS from '@graphprotocol/contracts/addresses.json'
@@ -14,6 +15,15 @@ import { Staking } from '@graphprotocol/contracts/dist/types/Staking'
 import { GraphToken } from '@graphprotocol/contracts/dist/types/GraphToken'
 import { Controller } from '@graphprotocol/contracts/dist/types/Controller'
 import { AllocationExchange } from '@graphprotocol/contracts/dist/types/AllocationExchange'
+import { GraphProxyAdmin } from '@graphprotocol/contracts/dist/types/GraphProxyAdmin'
+import { SubgraphNFT } from '@graphprotocol/contracts/dist/types/SubgraphNFT'
+import { GraphCurationToken } from '@graphprotocol/contracts/dist/types/GraphCurationToken'
+import { L1GraphTokenGateway } from '@graphprotocol/contracts/dist/types/L1GraphTokenGateway'
+import { L1Reservoir } from '@graphprotocol/contracts/dist/types/L1Reservoir'
+import { BridgeEscrow } from '@graphprotocol/contracts/dist/types/BridgeEscrow'
+import { L2GraphToken } from '@graphprotocol/contracts/dist/types/L2GraphToken'
+import { L2GraphTokenGateway } from '@graphprotocol/contracts/dist/types/L2GraphTokenGateway'
+import { L2Reservoir } from '@graphprotocol/contracts/dist/types/L2Reservoir'
 
 // Contract factories
 import { Curation__factory } from '@graphprotocol/contracts/dist/types/factories/Curation__factory'
@@ -26,6 +36,17 @@ import { Staking__factory } from '@graphprotocol/contracts/dist/types/factories/
 import { GraphToken__factory } from '@graphprotocol/contracts/dist/types/factories/GraphToken__factory'
 import { Controller__factory } from '@graphprotocol/contracts/dist/types/factories/Controller__factory'
 import { AllocationExchange__factory } from '@graphprotocol/contracts/dist/types/factories/AllocationExchange__factory'
+import { GraphProxyAdmin__factory } from '@graphprotocol/contracts/dist/types/factories/GraphProxyAdmin__factory'
+import { SubgraphNFT__factory } from '@graphprotocol/contracts/dist/types/factories/SubgraphNFT__factory'
+import { GraphCurationToken__factory } from '@graphprotocol/contracts/dist/types/factories/GraphCurationToken__factory'
+import { L1GraphTokenGateway__factory } from '@graphprotocol/contracts/dist/types/factories/L1GraphTokenGateway__factory'
+import { L1Reservoir__factory } from '@graphprotocol/contracts/dist/types/factories/L1Reservoir__factory'
+import { BridgeEscrow__factory } from '@graphprotocol/contracts/dist/types/factories/BridgeEscrow__factory'
+import { L2GraphToken__factory } from '@graphprotocol/contracts/dist/types/factories/L2GraphToken__factory'
+import { L2GraphTokenGateway__factory } from '@graphprotocol/contracts/dist/types/factories/L2GraphTokenGateway__factory'
+import { L2Reservoir__factory } from '@graphprotocol/contracts/dist/types/factories/L2Reservoir__factory'
+
+export const GraphChain = graphChain
 
 export interface NetworkContracts {
   curation: Curation
@@ -35,9 +56,21 @@ export interface NetworkContracts {
   rewardsManager: RewardsManager
   serviceRegistry: ServiceRegistry
   staking: Staking
-  token: GraphToken
+  token: GraphToken | L2GraphToken
   controller: Controller
   allocationExchange: AllocationExchange
+  graphProxyAdmin: GraphProxyAdmin
+  subgraphNFT: SubgraphNFT
+  graphCurationToken: GraphCurationToken
+
+  // Only L1
+  l1GraphTokenGateway?: L1GraphTokenGateway
+  l1Reservoir?: L1Reservoir
+  bridgeEscrow?: BridgeEscrow
+
+  // Only L2
+  l2GraphTokenGateway?: L2GraphTokenGateway
+  l2Reservoir?: L2Reservoir
 }
 
 export const connectContracts = async (
@@ -46,7 +79,16 @@ export const connectContracts = async (
 ): Promise<NetworkContracts> => {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const deployedContracts = (DEPLOYED_CONTRACTS as any)[`${chainId}`]
-  return {
+
+  const GraphTokenFactory = GraphChain.isL1(chainId)
+    ? GraphToken__factory
+    : L2GraphToken__factory
+
+  const graphTokenAddress = GraphChain.isL1(chainId)
+    ? deployedContracts.GraphToken.address
+    : deployedContracts.L2GraphToken.address
+
+  const contracts: NetworkContracts = {
     curation: Curation__factory.connect(
       deployedContracts.Curation.address,
       providerOrSigner,
@@ -72,8 +114,8 @@ export const connectContracts = async (
       deployedContracts.Staking.address,
       providerOrSigner,
     ),
-    token: GraphToken__factory.connect(
-      deployedContracts.GraphToken.address,
+    token: GraphTokenFactory.connect(
+      graphTokenAddress,
       providerOrSigner,
     ),
     controller: Controller__factory.connect(
@@ -84,5 +126,46 @@ export const connectContracts = async (
       deployedContracts.AllocationExchange.address,
       providerOrSigner,
     ),
+    graphProxyAdmin: GraphProxyAdmin__factory.connect(
+      deployedContracts.GraphProxyAdmin.address,
+      providerOrSigner,
+    ),
+    subgraphNFT: SubgraphNFT__factory.connect(
+      deployedContracts.SubgraphNFT.address,
+      providerOrSigner,
+    ),
+    graphCurationToken: GraphCurationToken__factory.connect(
+      deployedContracts.GraphCurationToken.address,
+      providerOrSigner,
+    ),
   }
+
+  if (GraphChain.isL1(chainId)) {
+    contracts.l1GraphTokenGateway = L1GraphTokenGateway__factory.connect(
+      deployedContracts.L1GraphTokenGateway.address,
+      providerOrSigner,
+    )
+    contracts.bridgeEscrow = BridgeEscrow__factory.connect(
+      deployedContracts.BridgeEscrow.address,
+      providerOrSigner,
+    )
+    // L1Reservoir is not deployed on scratch1
+    if (deployedContracts.L1Reservoir) {
+      contracts.l1Reservoir = L1Reservoir__factory.connect(
+        deployedContracts.L1Reservoir.address,
+        providerOrSigner,
+      )
+    }
+  } else if (GraphChain.isL2(chainId)) {
+    contracts.l2GraphTokenGateway = L2GraphTokenGateway__factory.connect(
+      deployedContracts.L2GraphTokenGateway.address,
+      providerOrSigner,
+    )
+    contracts.l2Reservoir = L2Reservoir__factory.connect(
+      deployedContracts.L2Reservoir.address,
+      providerOrSigner,
+    )
+  }
+
+  return contracts
 }