@honeycomb-finance/portfolio
v1.0.3
Published
Components to interact to show the portfolio of a account or track tokens prices.
Downloads
56
Readme
Pangolin Portfolio
Components to interact to show the portfolio of a account or track tokens prices.
Installation
yarn add @honeycomb-finance/portfolio
or
npm install @honeycomb-finance/portfolio
Install below dependancies as its peer dependancies
react
react-dom
@pangolindex/sdk
Story Book
- do
yarn storybook
to start the storybook - now connect to http://localhost:6006 to see the components
Development
yarn install
yarn dev
and keep that terminal running
or see the README file in monorepo to run the example app.
Getting Start
In your main file wrap your app with HoneycombProvider
and Web3ReactProvider
:
Use version 6.0.9 of @web3-react/core
package.
import { HoneycombProvider } from '@honeycomb-finance/honeycomb-provider';
import { NetworkContextName, useActiveWeb3React } from '@honeycomb-finance/shared';
import { Web3ReactProvider, createWeb3ReactRoot } from '@web3-react/core';
import React from 'react';
import ReactDOM from 'react-dom';
import './index.css';
import App from './App';
const Web3ProviderNetwork = createWeb3ReactRoot(NetworkContextName);
function getLibrary(provider: any): Web3Provider {
try {
const library = new Web3Provider(provider, 'any');
library.pollingInterval = 15000;
return library;
} catch (error) {
return provider;
}
}
// library -> web3.js provider
// chainId -> chain id with which user is connected
// account -> user's connected wallet address
// theme -> optional ( refer Theme guide to customize it )
ReactDOM.render(
<React.StrictMode>
<Web3ReactProvider getLibrary={getLibrary}>
<Web3ProviderNetwork getLibrary={getLibrary}>
<HoneycombProvider library={library} chainId={chainId} account={account} theme={theme}>
<App />
</HoneycombProvider>
</Web3ProviderNetwork>
</Web3ReactProvider>
</React.StrictMode>,
document.getElementById('root'),
);
Components
MyPortfolio
This component show the tokens and the liquidity in pangolin on avalanche, on selected chain.
Portfolio
This component shows the total in dollar of a account in wallet in chains.
WatchList
This component is used to track the price of various tokens.
TokenInfo
This component show the information about a token, balance of token in wallet, unclameid balance of token, price of token in usd, circulation supply and total supply.
Variations:
- TokenInfoModal is the TokenInfo wrapped in Modal.