eth-method-registry

Eth Method Registry

A javascript library for getting Solidity method data from a four-byte method signature.

Currently uses the parity on-chain method registry, but eventually I am interested in adding various parallel methods, whatever works and returns a valid response!

Installation

With Node.js Installed:

yarn install eth-method-registry -S

Usage

const { MethodRegistry } = require('eth-method-registry')
const Eth = require('@metamask/ethjs')

const provider = new Eth.HttpProvider('https://mainnet.infura.io/v3/YOUR-PROJECT-ID')
const registry = new MethodRegistry({ provider })

// Uses promises, pass the 4byte prefix to the lookup method:
registry.lookup('0xa9059cbb')
  .then((result) => {
   console.log(result) // prints 'transfer(address,uint256)'
  })

// Also includes a method for parsing the resulting sig
// into something more useful for rendering:
const sig = 'transferFrom(address,uint256)'
const parsed = registry.parse(sig)
/* Parsed value:
   {
    name :'Transfer From',
    args: [
      { type: 'address' },
      { type: 'uint256' }
    ]
   }
*/

Development

The unit tests of this package run against Infura's v3 API. After cloning this repository, run cp .infurarc.template .infurarc and add your Infura project ID to the file.

Running Tests

yarn test

Changelog

[4.0.0]

Changed

• BREAKING: Support for Node.js v12 and v14 have been removed. Minimum Node.js version is now 16.20 (#57)
• BREAKING: @babel/runtime@^7.0.0 is now a peerDependency (#62)
• These private MethodRegistry properties are now removed: eth, provider, registry (#60)
• Replace dependency @metamask/ethjs with used subdependencies @metamask/ethjs-query and @metamask/ethjs-contract (#61)
• Update dependencies @metamask/ethjs-contract and @metamask/ethjs-query (#62)
  • @metamask/ethjs-contract@^0.3.4->^0.4.1
  • @metamask/ethjs-query@^0.5.3->^0.7.1

Fixed

• Remove undocumented peerDependency on babel-runtime (#62)