Skip to content

Latest commit

 

History

History
101 lines (73 loc) · 3.09 KB

README.md

File metadata and controls

101 lines (73 loc) · 3.09 KB
Raw

@ledgerhq/crypto-icons

A package which provides a <CryptoIcon /> component that can be consumed by Ledger applications in a React environment and used with a ledgerId to render icons.

Installation

npm install @ledgerhq/crypto-icons

Usage example

import { CryptoIcon } from '@ledgerhq/crypto-icons';

const Page = () => {
  return (
    <>
      <CryptoIcon ledgerId="bitcoin" ticker="BTC" />
      <CryptoIcon ledgerId="ethereum" ticker="ETH" size="32px" />
      <CryptoIcon ledgerId="solana" ticker="SOL" size="48px" theme="light" />
      <CryptoIcon ledgerId="ethereum/erc20/usd_tether__erc20_" ticker="USDT" network="ethereum"/>
    </>
  )
}

Icon sources

The component's primary source of icons is Ledger's CDN which contains the assets from this repository. It attempts to fetch a mapping from Ledger's CDN and if the ledgerId that is passed in as a prop to the component is found, the URL for that key is used as the image source. You can see an up-to-date list of all available Ledger icons in this Storybook.

Otherwise, a request to the Ledger mapping service is made to retrieve a CoinGecko mapping as a fallback. If a match for an icon is found using the ledgerId then it is used as the image source.

If neither mapping has a match, a <FallbackIcon /> component is returned with the first letter of the currency ticker as its content e.g. B for BTC.

flowchart TD
  A[getIconUrl with ledgerId] --> B{ledgerMapping is null?}
  B --> |Yes| C[setLedgerIconMapping] --> D[fetchIconMapping from Ledger CDN] --> E{success?}
  E --> |Yes| F[cache data in ledgerMapping] --> G
  E --> |No| I{coinGeckoMapping is null?}
  B --> |No| G{ledgerId in ledgerMapping?}
  G --> |Yes| H[return URL]
  G --> |No| I{coinGeckoMapping is null?}
  I --> |Yes| J[setCoinGeckoIconMapping] --> K[fetchIconMapping from CoinGecko] --> L{success?}
  I --> |No| O
  L --> |Yes| M[cache data in coinGeckoMapping] --> O{ledgerId in coinGeckoMapping?}
  L --> |No| N[return null]
  O --> |Yes| P[return URL]
  O --> |No| R[return null]
Loading

Contributing

Make sure you're in the correct directory:

cd lib

Install dependencies

pnpm i

Run tests

pnpm test
# or
pnpm test:watch # to run in watch mode

Run storybook

pnpm storybook

Lint

pnpm lint # to find issues
# or
pnpm lint:fix # to find and fix issues

Build package with Rollup

pnpm build

Test locally

Package can be tested locally with pnpm-link or file: protocol. Details can be found here: https://pnpm.io/cli/link#whats-the-difference-between-pnpm-link-and-using-the-file-protocol.

Disclaimer

Some of the icons provided are trademarks: they are the property of their respective owners.