npm

npm’s 2019 JavaScript ecosystem survey analysis is now available! Get your copy here »

nuko-contract-metadata

0.1.4 • Public • Published

Ethereum Contract Metadata CircleCI

Greenkeeper badge

A mapping of checksummed ethereum addresses to metadata, like names, and images of those addresses' logos.

All address keys follow the EIP 55 address checksum format.

Submit PRs to add valid logos, and obviously valid logos will be merged.

Usage

You can install from npm with npm install eth-contract-metadata and use it in your code like this:

const contractMap = require('eth-contract-metadata')
const toChecksumAddress = require('ethereumjs-util').toChecksumAddress
 
function imageElFor (address) {
  const metadata = iconMap[toChecksumAddress(address)]
  if (!('logo' in metadata)) {
    return false
  }
  const fileName = metadata.logo
  const path = `images/contract/${fileName}`
  const img = document.createElement('img')
  img.src = path
  img.style.width = '100%'
  return img
}

Submission Process

  1. Fork this repository.
  2. Add your logo image in a web-safe format to the images folder.
  3. Add an entry to the contract-map.json file with the specified address as the key, and the image file's name as the value.

Criteria:

  • The icon should be small, square, but high resolution, ideally a vector/svg.
  • Do not add your entry to the end of the JSON map, messing with the trailing comma. Your pull request should only be an addition of lines, and any line removals should be deliberate deprecations of those logos.
  • PR should include link to official project website referencing the suggested address.
  • Project website should include explanation of project.
  • Project should have clear signs of activity, either traffic on the network, activity on GitHub, or community buzz.
  • Nice to have a verified source code on a block explorer like Etherscan.

A sample submission:

{
  "0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef": {
    "name": "ENS Registrar",
    "logo": "ens.svg"
  }
}

Tokens should include a field "erc20": true, and can include additional fields:

  • symbol (a four-character or less ticker symbol)
  • decimals (precision of the tokens stored)

A full list of permitted fields can be found in the permitted-fields.json file.

install

npm i nuko-contract-metadata

Downloadsweekly downloads

13

version

0.1.4

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability