/evm-proxy-detection

Detect proxy contracts and their target addresses using an EIP-1193 compatible JSON-RPC request function

Primary LanguageTypeScriptMIT LicenseMIT

evm-proxy-detection

Detect proxy contracts and their target addresses using an EIP-1193 compatible JSON-RPC request function

This package offers a utility function for checking if a smart contract at a given address implements one of the known proxy patterns. It detects the following kinds of proxies:

  • EIP-1167 Minimal Proxy Contract
  • EIP-1967 Transparent Proxy Pattern
  • EIP-897 Delegate Proxy Pattern
  • EIP-1822 Universal Upgradeable Proxy Standard
  • OpenZeppelin Proxy Pattern
  • Gnosis Safe Proxy Contract

Installation

This module is distributed via npm. For adding it to your project, run:

npm install --save evm-proxy-detection

To install it using yarn, run:

yarn add evm-proxy-detection

How to use

The function requires an EIP-1193 compatible request function that it uses to make JSON-RPC requests to run a set of checks against the given address. It returns a promise that resolves to the proxy target address, i.e., the address of the contract implementing the logic. The promise resolves to null if no proxy can be detected.

Ethers with an adapter function

import { InfuraProvider } from '@ethersproject/providers'
import detectProxyTarget from 'evm-proxy-detection'

const infuraProvider = new InfuraProvider(1, process.env.INFURA_API_KEY)
const requestFunc = ({ method, params }) => infuraProvider.send(method, params)

const target = await detectProxyTarget(
  '0xA7AeFeaD2F25972D80516628417ac46b3F2604Af',
  requestFunc
)
console.log(target) // logs "0x4bd844F72A8edD323056130A86FC624D0dbcF5b0"

Web3 with an EIP1193 provider

Web3.js doesn't have a way to export an EIP1193 provider, so you need to ensure that the underlying provider you use is EIP1193 compatible. Most Ethereum-supported browsers like MetaMask and TrustWallet have an EIP-1193 compliant provider. Otherwise, you can use providers like eip1193-provider.

import Web3 from 'web3'
import detectProxyTarget from 'evm-proxy-detection'

const web3 = new Web3(Web3.givenProvider || 'ws://localhost:8545')

const target = await detectProxyTarget(
  '0xA7AeFeaD2F25972D80516628417ac46b3F2604Af',
  web3.currentProvider.request
)
console.log(target) // logs "0x4bd844F72A8edD323056130A86FC624D0dbcF5b0"

API

detectProxyTarget(address: string, jsonRpcRequest: EIP1193ProviderRequestFunc, blockTag?: BlockTag): Promise<string | null>

Arguments

  • address (string): The address of the proxy contract
  • jsonRpcRequest (EIP1193ProviderRequestFunc): A JSON-RPC request function, compatible with EIP-1193 ((method: string, params: any[]) => Promise<any>)
  • blockTag (optional: BlockTag): "earliest", "latest", "pending" or hex block number, default is "latest"

The function returns a promise that will generally resolve to either the detected target contract address (non-checksummed) or null if it couldn't detect one.