uniswap-interface-uncensored/README.md

68 lines
2.8 KiB
Markdown
Raw Normal View History

2020-07-01 20:09:37 +03:00
# Uniswap Interface
2019-04-15 19:07:16 +03:00
[![Unit Tests](https://github.com/Uniswap/uniswap-interface/actions/workflows/unit-tests.yaml/badge.svg)](https://github.com/Uniswap/uniswap-interface/actions/workflows/unit-tests.yaml)
[![Integration Tests](https://github.com/Uniswap/uniswap-interface/actions/workflows/integration-tests.yaml/badge.svg)](https://github.com/Uniswap/uniswap-interface/actions/workflows/integration-tests.yaml)
[![Lint](https://github.com/Uniswap/uniswap-interface/actions/workflows/lint.yml/badge.svg)](https://github.com/Uniswap/uniswap-interface/actions/workflows/lint.yml)
[![Release](https://github.com/Uniswap/uniswap-interface/actions/workflows/release.yaml/badge.svg)](https://github.com/Uniswap/uniswap-interface/actions/workflows/release.yaml)
2019-04-15 19:07:16 +03:00
2020-05-08 20:51:47 +03:00
An open source interface for Uniswap -- a protocol for decentralized exchange of Ethereum tokens.
2018-01-18 22:15:59 +03:00
- Website: [uniswap.org](https://uniswap.org/)
2020-06-30 21:13:27 +03:00
- 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)
2021-02-10 18:56:42 +03:00
- Discord: [Uniswap](https://discord.gg/FCfyBSbCU5)
2019-04-15 21:05:54 +03:00
- Whitepaper: [Link](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig)
2020-06-30 21:13:27 +03:00
## Accessing the Uniswap Interface
2020-06-30 21:13:27 +03:00
To access the Uniswap Interface, use an IPFS gateway link from the
2021-02-16 11:31:16 +03:00
[latest release](https://github.com/Uniswap/uniswap-interface/releases/latest),
2020-06-30 20:53:18 +03:00
or visit [app.uniswap.org](https://app.uniswap.org).
2020-05-21 22:54:28 +03:00
## Listing a token
Please see the
2021-02-16 11:31:16 +03:00
[@uniswap/default-token-list](https://github.com/uniswap/default-token-list)
repository.
2020-05-21 22:54:28 +03:00
## Development
### Install Dependencies
```bash
yarn
```
### Run
2019-04-15 21:05:54 +03:00
```bash
yarn start
```
2020-06-30 21:13:27 +03:00
### 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}"`
2021-02-16 11:31:16 +03:00
3. Change `REACT_APP_NETWORK_URL` to e.g. `"https://{YOUR_NETWORK_ID}.infura.io/v3/{YOUR_INFURA_KEY}"`
2021-02-16 11:31:16 +03:00
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.
2020-06-30 21:13:27 +03:00
The interface will not work on other networks.
2019-04-15 21:05:54 +03:00
## Contributions
**Please open all pull requests against the `main` branch.**
2020-06-30 21:13:27 +03:00
CI checks will run against all PRs.
2020-06-30 21:13:27 +03:00
## Accessing Uniswap Interface V1
The Uniswap Interface supports swapping against, and migrating or removing liquidity from Uniswap V1. However,
2021-02-16 11:31:16 +03:00
if you would like to use Uniswap V1, the Uniswap V1 interface for mainnet and testnets is accessible via IPFS gateways
2020-07-01 20:09:37 +03:00
linked from the [v1.0.0 release](https://github.com/Uniswap/uniswap-interface/releases/tag/v1.0.0).