@honeycomb-finance/swap
v1.0.6
Published
A widget for projects to embed Pangolin's Swap functionality within their dApp.
Downloads
28
Readme
Swap Widget
A widget for projects to embed Pangolin's Swap functionality within their dApp.
Installation
yarn add @honeycomb-finance/swap
or
npm install @honeycomb-finance/swap
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 component
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'),
);
Now you can import the widget in your app
import { useChainId } from '@honeycomb-finance/shared';
import { SwapWidget } from '@honeycomb-finance/swap';
import React from 'react';
export default function Swap() {
const chainId = useChainId();
return (
<div>
<SwapWidget />
</div>
);
}
Customizing Theme
In HoneycombProvider
you can pass custom theme. Follow Guide -> Theme
to customize theme.