@ensdomains/ensjs 2.0.1 → 3.0.0-alpha.2

package/src/ABIs/ReverseRegistrar.json

@@ -0,0 +1,323 @@
+[
+  {
+    "inputs": [
+      {
+        "internalType": "contract ENS",
+        "name": "ensAddr",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "controller",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "bool",
+        "name": "enabled",
+        "type": "bool"
+      }
+    ],
+    "name": "ControllerChanged",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "previousOwner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "newOwner",
+        "type": "address"
+      }
+    ],
+    "name": "OwnershipTransferred",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "addr",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "bytes32",
+        "name": "node",
+        "type": "bytes32"
+      }
+    ],
+    "name": "ReverseClaimed",
+    "type": "event"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      }
+    ],
+    "name": "claim",
+    "outputs": [
+      {
+        "internalType": "bytes32",
+        "name": "",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "addr",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "resolver",
+        "type": "address"
+      }
+    ],
+    "name": "claimForAddr",
+    "outputs": [
+      {
+        "internalType": "bytes32",
+        "name": "",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "resolver",
+        "type": "address"
+      }
+    ],
+    "name": "claimWithResolver",
+    "outputs": [
+      {
+        "internalType": "bytes32",
+        "name": "",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "name": "controllers",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "defaultResolver",
+    "outputs": [
+      {
+        "internalType": "contract NameResolver",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "ens",
+    "outputs": [
+      {
+        "internalType": "contract ENS",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "addr",
+        "type": "address"
+      }
+    ],
+    "name": "node",
+    "outputs": [
+      {
+        "internalType": "bytes32",
+        "name": "",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "owner",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "renounceOwnership",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "controller",
+        "type": "address"
+      },
+      {
+        "internalType": "bool",
+        "name": "enabled",
+        "type": "bool"
+      }
+    ],
+    "name": "setController",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "resolver",
+        "type": "address"
+      }
+    ],
+    "name": "setDefaultResolver",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "name",
+        "type": "string"
+      }
+    ],
+    "name": "setName",
+    "outputs": [
+      {
+        "internalType": "bytes32",
+        "name": "",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "addr",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "resolver",
+        "type": "address"
+      },
+      {
+        "internalType": "string",
+        "name": "name",
+        "type": "string"
+      }
+    ],
+    "name": "setNameForAddr",
+    "outputs": [
+      {
+        "internalType": "bytes32",
+        "name": "",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "newOwner",
+        "type": "address"
+      }
+    ],
+    "name": "transferOwnership",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  }
+]

package/src/ABIs/StaticMetadataService.json

@@ -0,0 +1,32 @@
+[
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "_metaDataUri",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "name": "uri",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  }
+]

package/src/ABIs/UniversalResolver.json

@@ -0,0 +1,187 @@
+[
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "_registry",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "sender",
+        "type": "address"
+      },
+      {
+        "internalType": "string[]",
+        "name": "urls",
+        "type": "string[]"
+      },
+      {
+        "internalType": "bytes",
+        "name": "callData",
+        "type": "bytes"
+      },
+      {
+        "internalType": "bytes4",
+        "name": "callbackFunction",
+        "type": "bytes4"
+      },
+      {
+        "internalType": "bytes",
+        "name": "extraData",
+        "type": "bytes"
+      }
+    ],
+    "name": "OffchainLookup",
+    "type": "error"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes",
+        "name": "name",
+        "type": "bytes"
+      }
+    ],
+    "name": "findResolver",
+    "outputs": [
+      {
+        "internalType": "contract Resolver",
+        "name": "",
+        "type": "address"
+      },
+      {
+        "internalType": "bytes32",
+        "name": "",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "registry",
+    "outputs": [
+      {
+        "internalType": "contract ENS",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes",
+        "name": "name",
+        "type": "bytes"
+      },
+      {
+        "internalType": "bytes",
+        "name": "data",
+        "type": "bytes"
+      }
+    ],
+    "name": "resolve",
+    "outputs": [
+      {
+        "internalType": "bytes",
+        "name": "",
+        "type": "bytes"
+      },
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes",
+        "name": "response",
+        "type": "bytes"
+      },
+      {
+        "internalType": "bytes",
+        "name": "extraData",
+        "type": "bytes"
+      }
+    ],
+    "name": "resolveCallback",
+    "outputs": [
+      {
+        "internalType": "bytes",
+        "name": "",
+        "type": "bytes"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes",
+        "name": "reverseName",
+        "type": "bytes"
+      }
+    ],
+    "name": "reverse",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      },
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes4",
+        "name": "interfaceId",
+        "type": "bytes4"
+      }
+    ],
+    "name": "supportsInterface",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  }
+]

package/src/GqlManager.ts

@@ -0,0 +1,18 @@
+export default class GqlManager {
+  public gql: any = () => null
+  public client?: any | null = null
+
+  public setUrl = async (url: string | null) => {
+    if (url) {
+      const imported = await import('graphql-request')
+      this.client = new imported.GraphQLClient(url)
+      this.gql = imported.gql
+    } else {
+      this.client = null
+      this.gql = () => null
+    }
+  }
+
+  public request = (...arg: any[]) =>
+    this.client ? this.client.request(...arg) : null
+}

package/src/contracts/baseRegistrar.ts

@@ -0,0 +1,5 @@
+import { ethers } from 'ethers'
+import { BaseRegistrarImplementation__factory } from '../generated/factories/BaseRegistrarImplementation__factory'
+
+export default (provider: ethers.providers.JsonRpcProvider, address: string) =>
+  BaseRegistrarImplementation__factory.connect(address, provider)

package/src/contracts/doNotCallOnChainUniversalResolverProxy.ts

@@ -0,0 +1,5 @@
+import { ethers } from 'ethers'
+import { DoNotCallOnChainUniversalResolverProxy__factory } from '../generated/factories/DoNotCallOnChainUniversalResolverProxy__factory'
+
+export default (provider: ethers.providers.JsonRpcProvider, address: string) =>
+  DoNotCallOnChainUniversalResolverProxy__factory.connect(address, provider)

package/src/contracts/ethRegistrarController.ts

@@ -0,0 +1,5 @@
+import { ethers } from 'ethers'
+import { ETHRegistrarController__factory } from '../generated/factories/ETHRegistrarController__factory'
+
+export default (provider: ethers.providers.JsonRpcProvider, address: string) =>
+  ETHRegistrarController__factory.connect(address, provider)

package/src/contracts/getContractAddress.ts

@@ -0,0 +1,52 @@
+import { ContractName, SupportedNetworkId } from './types'
+
+const addresses: Record<
+  ContractName,
+  Partial<Record<SupportedNetworkId, string>> | string
+> = {
+  BaseRegistrarImplementation: {
+    '1': '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
+    '3': '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
+    '4': '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
+    '5': '0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85',
+  },
+  ETHRegistrarController: {
+    '1': '0x283af0b28c62c092c9727f1ee09c02ca627eb7f5',
+    '3': '0x283af0b28c62c092c9727f1ee09c02ca627eb7f5',
+    '4': '0x283af0b28c62c092c9727f1ee09c02ca627eb7f5',
+    '5': '0x283af0b28c62c092c9727f1ee09c02ca627eb7f5',
+  },
+  Multicall: '0xcA11bde05977b3631167028862bE2a173976CA11',
+  NameWrapper: '0x0000000000000000000000000000000000000000',
+  PublicResolver: {
+    '1': '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+  },
+  ENSRegistryWithFallback: {
+    '1': '0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e',
+    '3': '0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e',
+    '4': '0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e',
+    '5': '0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e',
+  },
+  ReverseRegistrar: {
+    '1': '0x084b1c3C81545d370f3634392De611CaaBFf8148',
+  },
+  UniversalResolver: {
+    '1': '0x580AF46E06DaaD47eb5940526FD64d95b815Cb70',
+    '4': '0x74e20bd2a1fe0cdbe45b9a1d89cb7e0a45b36376',
+  },
+}
+
+export type ContractAddressFetch = (contractName: ContractName) => string
+
+export const getContractAddress = (networkId: SupportedNetworkId) =>
+  ((contractName: ContractName) => {
+    try {
+      return typeof addresses[contractName] === 'string'
+        ? addresses[contractName]
+        : addresses[contractName][networkId]
+    } catch {
+      throw new Error(
+        `No address for contract ${contractName} on network ${networkId}`,
+      )
+    }
+  }) as ContractAddressFetch

package/src/contracts/index.ts

@@ -0,0 +1,68 @@
+import { ethers } from 'ethers'
+import getBaseRegistrar from './baseRegistrar'
+import getEthRegistrarController from './ethRegistrarController'
+import { ContractAddressFetch } from './getContractAddress'
+import getMulticall from './multicall'
+import getNameWrapper from './nameWrapper'
+import getPublicResolver from './publicResolver'
+import getRegistry from './registry'
+import getReverseRegistrar from './reverseRegistrar'
+import { ContractName } from './types'
+import getUniversalResolver from './universalResolver'
+
+export default class ContractManager {
+  private provider: ethers.providers.Provider
+  private fetchAddress: ContractAddressFetch
+
+  constructor(
+    provider: ethers.providers.Provider,
+    fetchAddress: ContractAddressFetch,
+  ) {
+    this.provider = provider
+    this.fetchAddress = fetchAddress
+  }
+
+  private generateContractGetter = <C extends (...args: any) => any>(
+    name: ContractName,
+    func: C,
+  ) => {
+    return async (
+      passedProvider?: any,
+      address?: string,
+    ): Promise<ReturnType<C>> => {
+      const inputAddress = address || this.fetchAddress(name)
+      const provider = passedProvider || this.provider
+      return func(provider, inputAddress)
+    }
+  }
+
+  public getPublicResolver = this.generateContractGetter(
+    'PublicResolver',
+    getPublicResolver,
+  )
+  public getUniversalResolver = this.generateContractGetter(
+    'UniversalResolver',
+    getUniversalResolver,
+  )
+  public getRegistry = this.generateContractGetter(
+    'ENSRegistryWithFallback',
+    getRegistry,
+  )
+  public getReverseRegistrar = this.generateContractGetter(
+    'ReverseRegistrar',
+    getReverseRegistrar,
+  )
+  public getNameWrapper = this.generateContractGetter(
+    'NameWrapper',
+    getNameWrapper,
+  )
+  public getBaseRegistrar = this.generateContractGetter(
+    'BaseRegistrarImplementation',
+    getBaseRegistrar,
+  )
+  public getEthRegistrarController = this.generateContractGetter(
+    'ETHRegistrarController',
+    getEthRegistrarController,
+  )
+  public getMulticall = this.generateContractGetter('Multicall', getMulticall)
+}