token-list 1.5.4
Install from the command line:
Learn more about npm packages
$ npm install @perspectivefi/token-list@1.5.4
Install via package.json:
"@perspectivefi/token-list": "1.5.4"
About this version
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
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 |
- Create a new branch from the
main
with the namechore/token-<token-symbol>-<chain-id>
- 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"
}
]
- Add the token logo to the
src/images/tokens
folder (use .png or .svg format) - Commit the changes with the message:
chore: add <token-symbol>, chainId: <chain-id>
- Create a pull request
- Once the PR is approved, the token will be added to the list and included in the Spectra platform in the next build.
- Done
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 |
- Create a new branch from the
main
with the namechore/protocol-<protocol-name>-<chain-id>
- 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"
}
]
}
]
- Add the protocol background image to the
src/images/textures
folder (use .png or .svg format) - Commit the changes with the message:
chore: add <protocol-name>, chainId: <chain-id>
- Create a pull request
- Once the PR is approved, the protocol will be added to the list and included in the Spectra platform in the next build.
- Done
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. |
- Create a new branch from the
main
with the namechore/protocol-content-<protocol-name>-<chain-id>
- 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>
.
</>
),
},
};
- Commit the changes with the message:
chore: add <protocol-name> content, chainId: <chain-id>
- Create a pull request
- Once the PR is approved, the protocol content will be added to the list and included in the Spectra platform in the next build.
- Done
chainId | address | symbol | name | decimals | logoURI | extensions |
---|---|---|---|---|---|---|
1 | 0x6def54ae7e38992a7d1ab60d279483ba7f7b0aeb | KweETH | Wrapped Ether | 18 | /images/tokens/weETH.svg | underlying, ibtRoutes, protocol, aprEndpoint, vault |
- Create a new branch from the
main
with the namechore/wrapper-<token-symbol>-<chain-id>
- Add the wrapper to the
src/tokens/erc4626Wrappers.json
file - Commit the changes with the message:
chore: add <token-symbol> wrapper, chainId: <chain-id>
- Create a pull request
- Once the PR is approved, the wrapper will be added to the list and included in the Spectra platform in the next build.
- Done