68 lines
2.8 KiB
Markdown
68 lines
2.8 KiB
Markdown
# Uniswap Interface
|
|
|
|
[](https://github.com/Uniswap/uniswap-interface/actions/workflows/unit-tests.yaml)
|
|
[](https://github.com/Uniswap/uniswap-interface/actions/workflows/integration-tests.yaml)
|
|
[](https://github.com/Uniswap/uniswap-interface/actions/workflows/lint.yml)
|
|
[](https://github.com/Uniswap/uniswap-interface/actions/workflows/release.yaml)
|
|
|
|
An open source interface for Uniswap -- a protocol for decentralized exchange of Ethereum tokens.
|
|
|
|
- Website: [uniswap.org](https://uniswap.org/)
|
|
- Interface: [app.uniswap.org](https://app.uniswap.org)
|
|
- Docs: [uniswap.org/docs/](https://uniswap.org/docs/)
|
|
- Twitter: [@UniswapProtocol](https://twitter.com/UniswapProtocol)
|
|
- Reddit: [/r/Uniswap](https://www.reddit.com/r/Uniswap/)
|
|
- Email: [contact@uniswap.org](mailto:contact@uniswap.org)
|
|
- Discord: [Uniswap](https://discord.gg/FCfyBSbCU5)
|
|
- Whitepaper: [Link](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig)
|
|
|
|
## Accessing the Uniswap Interface
|
|
|
|
To access the Uniswap Interface, use an IPFS gateway link from the
|
|
[latest release](https://github.com/Uniswap/uniswap-interface/releases/latest),
|
|
or visit [app.uniswap.org](https://app.uniswap.org).
|
|
|
|
## Listing a token
|
|
|
|
Please see the
|
|
[@uniswap/default-token-list](https://github.com/uniswap/default-token-list)
|
|
repository.
|
|
|
|
## Development
|
|
|
|
### Install Dependencies
|
|
|
|
```bash
|
|
yarn
|
|
```
|
|
|
|
### Run
|
|
|
|
```bash
|
|
yarn start
|
|
```
|
|
|
|
### Configuring the environment (optional)
|
|
|
|
To have the interface default to a different network when a wallet is not connected:
|
|
|
|
1. Make a copy of `.env` named `.env.local`
|
|
2. Change `REACT_APP_NETWORK_ID` to `"{YOUR_NETWORK_ID}"`
|
|
3. Change `REACT_APP_NETWORK_URL` to e.g. `"https://{YOUR_NETWORK_ID}.infura.io/v3/{YOUR_INFURA_KEY}"`
|
|
|
|
Note that the interface only works on testnets where both
|
|
[Uniswap V2](https://uniswap.org/docs/v2/smart-contracts/factory/) and
|
|
[multicall](https://github.com/makerdao/multicall) are deployed.
|
|
The interface will not work on other networks.
|
|
|
|
## Contributions
|
|
|
|
**Please open all pull requests against the `main` branch.**
|
|
CI checks will run against all PRs.
|
|
|
|
## Accessing Uniswap Interface V1
|
|
|
|
The Uniswap Interface supports swapping against, and migrating or removing liquidity from Uniswap V1. However,
|
|
if you would like to use Uniswap V1, the Uniswap V1 interface for mainnet and testnets is accessible via IPFS gateways
|
|
linked from the [v1.0.0 release](https://github.com/Uniswap/uniswap-interface/releases/tag/v1.0.0).
|