Skip to content

Commit 3ca2a13

Browse files
committed
fix: ditch necessity to insert missing type exports after types' compiling
1 parent 4208394 commit 3ca2a13

File tree

2 files changed

+23
-57
lines changed

2 files changed

+23
-57
lines changed

README.md

Lines changed: 20 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,37 @@
1-
# Fork Uniswap Interface v3
1+
# Front end for Uniswap v3.3.6
22

3-
The current branch is a fork of the v3.3.6 tag.
3+
## Prerequisites
44

5-
## Development
5+
1. [Git](https://git-scm.com)
6+
2. [Node.js](https://nodejs.org/en) v16.20.2
7+
3. [Yarn](https://classic.yarnpkg.com/lang/en) v1.22.22
68

7-
Node.js v16 required (Checked on v16.20.2).
9+
## Setting Up
810

9-
### Install Dependencies
11+
1. Clone the repository
1012

1113
```bash
12-
yarn install
14+
git clone https://github.com/fullstack-development/uniswap-v3-interface.git
1315
```
1416

15-
### Run
17+
2. Install dependencies
1618

1719
```bash
18-
yarn start
19-
```
20-
21-
After generating types go to `src/types/v3/index.ts` and add two lines:
22-
23-
```ts
24-
export type { UniswapV3Factory } from './UniswapV3Factory'
25-
export type { UniswapV3Pool } from './UniswapV3Pool'
20+
yarn
2621
```
2722

28-
## Uniswap Interface
29-
30-
[![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)
31-
[![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)
32-
[![Lint](https://github.com/Uniswap/uniswap-interface/actions/workflows/lint.yml/badge.svg)](https://github.com/Uniswap/uniswap-interface/actions/workflows/lint.yml)
33-
[![Release](https://github.com/Uniswap/uniswap-interface/actions/workflows/release.yaml/badge.svg)](https://github.com/Uniswap/uniswap-interface/actions/workflows/release.yaml)
34-
35-
An open source interface for Uniswap -- a protocol for decentralized exchange of Ethereum tokens.
36-
37-
- Website: [uniswap.org](https://uniswap.org/)
38-
- Interface: [app.uniswap.org](https://app.uniswap.org)
39-
- Docs: [uniswap.org/docs/](https://uniswap.org/docs/)
40-
- Twitter: [@UniswapProtocol](https://twitter.com/UniswapProtocol)
41-
- Reddit: [/r/Uniswap](https://www.reddit.com/r/Uniswap/)
42-
43-
- Discord: [Uniswap](https://discord.gg/FCfyBSbCU5)
44-
- Whitepaper: [Link](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig)
45-
46-
## Accessing the Uniswap Interface
47-
48-
To access the Uniswap Interface, use an IPFS gateway link from the
49-
[latest release](https://github.com/Uniswap/uniswap-interface/releases/latest),
50-
or visit [app.uniswap.org](https://app.uniswap.org).
51-
52-
## Contributions
23+
## Development
5324

54-
**Please open all pull requests against the `main` branch.**
55-
CI checks will run against all PRs.
25+
1. Start the server
5626

57-
## Accessing Uniswap V2
27+
```bash
28+
yarn start
29+
```
5830

59-
The Uniswap Interface supports swapping, adding liquidity, removing liquidity and migrating liquidity for
60-
Uniswap protocol V2.
31+
## Production
6132

62-
- Swap on Uniswap V2: https://app.uniswap.org/#/swap?use=v2
63-
- View V2 liquidity: https://app.uniswap.org/#/pool/v2
64-
- Add V2 liquidity: https://app.uniswap.org/#/add/v2
65-
- Migrate V2 liquidity to V3: https://app.uniswap.org/#/migrate/v2
33+
1. Build the app
6634

67-
## Accessing Uniswap V1
68-
69-
The Uniswap V1 interface for mainnet and testnets is accessible via IPFS gateways
70-
linked from the [v1.0.0 release](https://github.com/Uniswap/uniswap-interface/releases/tag/v1.0.0).
35+
```bash
36+
yarn build
37+
```

package.json

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,9 @@
107107
"@walletconnect/web3-provider": "1.4.2-rc.2"
108108
},
109109
"scripts": {
110-
"compile-contract-types": "yarn compile-external-abi-types && yarn compile-v3-core-contract-types && yarn compile-v3-periphery-contract-types",
111-
"compile-external-abi-types": "npx typechain --target ethers-v5 --out-dir src/abis/types \"./src/abis/**/*.json\"",
112-
"compile-v3-core-contract-types": "npx typechain --target ethers-v5 --out-dir src/types/v3 \"./node_modules/@uniswap/v3-core/artifacts/contracts/**/*.json\"",
113-
"compile-v3-periphery-contract-types": "npx typechain --target ethers-v5 --out-dir src/types/v3 \"./node_modules/@uniswap/v3-periphery/artifacts/contracts/**/*.json\"",
110+
"compile-contract-types": "yarn compile-external-abi-types && yarn compile-v3-contract-types",
111+
"compile-external-abi-types": "typechain --target ethers-v5 --out-dir src/abis/types './src/abis/**/*.json'",
112+
"compile-v3-contract-types": "typechain --target ethers-v5 --out-dir src/types/v3 \"./node_modules/@uniswap/?(v3-core|v3-periphery)/artifacts/contracts/**/*.json\"",
114113
"build": "yarn compile-contract-types && react-scripts build",
115114
"postinstall": "yarn compile-contract-types",
116115
"start": "yarn compile-contract-types && react-scripts start",

0 commit comments

Comments
 (0)