npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@matstyler/token-list

v1.0.14

Published

## Overview

Downloads

63

Readme

Spectra Token List

Overview

As Spectra, we use this repository as source of the tokens & platforms for our Web3 app as well as other services. This list is updated regularly as new tokens are added to the platform.

Spectra App: https://app.spectra.finance

Tokens and Protocols

How to add a token

Expected structure - src/tokens/spectraTokens.json

| chainId | address | symbol | name | decimals | logoURI | extensions | |---------|--------------------------------------------|--------|---------------|----------|--------------------------|-------------------------------------------------------------| | 1 | 0x6def54ae7e38992a7d1ab60d279483ba7f7b0aeb | KweETH | Wrapped Ether | 18 | /images/tokens/weETH.svg | underlying, ibtRoutes, protocol, faucetAddress, aprEndpoint |

Steps:

  1. Create a new branch from the main with the name chore/token-<token-symbol>-<chain-id>
  2. Add the token to the src/tokens/spectraTokens.json file

Example:

[
  ...
  {
    "chainId": 1,
    "address": "0x4104b135dbc9609fc1a9490e61369036497660c8",
    "name": "Spectra",
    "symbol": "APW",
    "decimals": 18,
    "logoURI": "images/tokens/apw.svg"
  }
]
  1. Add the token logo to the src/images/tokens folder (use .png or .svg format)
  2. Commit the changes with the message: chore: add <token-symbol>, chainId: <chain-id>
  3. Create a pull request
  4. Once the PR is approved, the token will be added to the list and included in the Spectra platform in the next build.
  5. Done

How to add a protocol

Expected structure - src/protocols/protocolList.json

| ptAddress | chainId | protocolName | bgUrl | token.symbol | token.logoURI | token.underlying | multipliers.amount | multipliers.name | |--------------------------------------------|---------|--------------|---------------------------------------|--------------|-------------------------|------------------|--------------------|------------------| | 0x6def54ae7e38992a7d1ab60d279483ba7f7b0aeb | 1 | Karak | images/textures/etherfiBackground.svg | KweETH | images/tokens/weETH.svg | weETH | 1.5 | Karak XP |

Steps:

  1. Create a new branch from the main with the name chore/protocol-<protocol-name>-<chain-id>
  2. Add the protocol to the src/protocols/protocolList.json file

Example:

[
  ...
  {
    "ptAddress": "0x6def54ae7e38992a7d1ab60d279483ba7f7b0aeb",
    "chainId": 1,
    "protocolName": "Karak",
    "bgUrl": "images/textures/etherfiBackground.svg",
    "token": {
      "symbol": "KweETH",
      "logoURI": "images/tokens/weETH.svg",
      "underlying": "weETH"
    },
    "multipliers": [
      {
        "amount": 1.5,
        "name": "Karak XP"
      },
      {
        "amount": 3,
        "name": "Ether.fi Points"
      },
      {
        "amount": 1,
        "name": "EigenLayer Points"
      }
    ]
  }
]
  1. Add the protocol background image to the src/images/textures folder (use .png or .svg format)
  2. Commit the changes with the message: chore: add <protocol-name>, chainId: <chain-id>
  3. Create a pull request
  4. Once the PR is approved, the protocol will be added to the list and included in the Spectra platform in the next build.
  5. Done

How to add a custom protocol content to the Spectra web3 application

Expected structure - src/protocols/protocolCustomContent.tsx

| YT | pendingPoints | helpText | |------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| | Each YT is entitled to all the extra yield and point on top of one weETH deposit in Karak (with the multiplier). | Integration of Ether.fi Points portfolio is underway. View your Points on the Ether.fi dashboard. | Karak is a yield farming protocol that allows users to earn extra yield and points on top of their weETH deposits. |

Steps:

  1. Create a new branch from the main with the name chore/protocol-content-<protocol-name>-<chain-id>
  2. Add the protocol content to the src/protocols/protocolCustomContent.tsx with pt address as key and the custom content properties as value
const protocolCustomContent: Record<string, ProtocolText> = {
    "0x6def54ae7e38992a7d1ab60d279483ba7f7b0aeb": {
        YT: "Each YT is entitled to all the extra yield and point on top of one weETH deposit in Karak (with the multiplier).",
        pendingPoints: (
            <>
                Integration of Ether.fi Points portfolio is underway.
                <br/>
                <br/>
                View your Points on the{" "}
                <a
                    href="https://www.ether.fi/"
                    target="_blank"
                    className="underline"
                >
                    Ether.fi dashboard
                </a>
                .
            </>
        ),
    },
};
  1. Commit the changes with the message: chore: add <protocol-name> content, chainId: <chain-id>
  2. Create a pull request
  3. Once the PR is approved, the protocol content will be added to the list and included in the Spectra platform in the next build.
  4. Done

How to add a ERC4626 wrapper

Expected structure - src/tokens/erc4626Wrappers.json

| chainId | address | symbol | name | decimals | logoURI | extensions | |---------|--------------------------------------------|--------|---------------|----------|--------------------------|-----------------------------------------------------| | 1 | 0x6def54ae7e38992a7d1ab60d279483ba7f7b0aeb | KweETH | Wrapped Ether | 18 | /images/tokens/weETH.svg | underlying, ibtRoutes, protocol, aprEndpoint, vault |

Steps:

  1. Create a new branch from the main with the name chore/wrapper-<token-symbol>-<chain-id>
  2. Add the wrapper to the src/tokens/erc4626Wrappers.json file
  3. Commit the changes with the message: chore: add <token-symbol> wrapper, chainId: <chain-id>
  4. Create a pull request
  5. Once the PR is approved, the wrapper will be added to the list and included in the Spectra platform in the next build.
  6. Done