3c7eabc3d8
* Update PR template * Add screen capture section and simplify descriptions * Link out to PR title conventions & remove monitoring section
81 lines
4.0 KiB
Markdown
81 lines
4.0 KiB
Markdown
# Uniswap Labs Interface
|
|
|
|
[](https://codecov.io/gh/Uniswap/interface)
|
|
|
|
[](https://github.com/Uniswap/interface/actions/workflows/unit-tests.yaml)
|
|
[](https://github.com/Uniswap/interface/actions/workflows/integration-tests.yaml)
|
|
[](https://github.com/Uniswap/interface/actions/workflows/lint.yml)
|
|
[](https://github.com/Uniswap/interface/actions/workflows/release.yaml)
|
|
[](https://crowdin.com/project/uniswap-interface)
|
|
|
|
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://docs.uniswap.org/)
|
|
- Twitter: [@Uniswap](https://twitter.com/Uniswap)
|
|
- Reddit: [/r/Uniswap](https://www.reddit.com/r/Uniswap/)
|
|
- Email: [contact@uniswap.org](mailto:contact@uniswap.org)
|
|
- Discord: [Uniswap](https://discord.gg/FCfyBSbCU5)
|
|
- Whitepapers:
|
|
- [V1](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig)
|
|
- [V2](https://uniswap.org/whitepaper.pdf)
|
|
- [V3](https://uniswap.org/whitepaper-v3.pdf)
|
|
|
|
## 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).
|
|
|
|
## Unsupported tokens
|
|
|
|
Check out `useUnsupportedTokenList()` in [src/state/lists/hooks.ts](./src/state/lists/hooks.ts) for blocking tokens in your instance of the interface.
|
|
|
|
You can block an entire list of tokens by passing in a tokenlist like [here](./src/constants/lists.ts)
|
|
|
|
## Contributions
|
|
|
|
For steps on local deployment, development, and code contribution, please see [CONTRIBUTING](./CONTRIBUTING.md).
|
|
|
|
#### PR Title
|
|
Your PR title must follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary), and should start with one of the following [types](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type):
|
|
|
|
- build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
|
|
- ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
|
|
- docs: Documentation only changes
|
|
- feat: A new feature
|
|
- fix: A bug fix
|
|
- perf: A code change that improves performance
|
|
- refactor: A code change that neither fixes a bug nor adds a feature
|
|
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
|
|
- test: Adding missing tests or correcting existing tests
|
|
|
|
Example commit messages:
|
|
|
|
- feat: adds support for gnosis safe wallet
|
|
- fix: removes a polling memory leak
|
|
- chore: bumps redux version
|
|
|
|
Other things to note:
|
|
|
|
- Please describe the change using verb statements (ex: Removes X from Y)
|
|
- PRs with multiple changes should use a list of verb statements
|
|
- Add any relevant unit / integration tests
|
|
- Changes will be previewable via vercel. Non-obvious changes should include instructions for how to reproduce them
|
|
|
|
|
|
## Accessing Uniswap V2
|
|
|
|
The Uniswap Interface supports swapping, adding liquidity, removing liquidity and migrating liquidity for Uniswap protocol V2.
|
|
|
|
- Swap on Uniswap V2: <https://app.uniswap.org/#/swap?use=v2>
|
|
- View V2 liquidity: <https://app.uniswap.org/#/pools/v2>
|
|
- Add V2 liquidity: <https://app.uniswap.org/#/add/v2>
|
|
- Migrate V2 liquidity to V3: <https://app.uniswap.org/#/migrate/v2>
|
|
|
|
## Accessing 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).
|