Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uniswap/v3-core
🦄 🦄 🦄 Core smart contracts of Uniswap v3
https://github.com/uniswap/v3-core
automated-market-maker core ethereum smart-contracts
Last synced: 7 days ago
JSON representation
🦄 🦄 🦄 Core smart contracts of Uniswap v3
- Host: GitHub
- URL: https://github.com/uniswap/v3-core
- Owner: Uniswap
- License: other
- Created: 2020-04-29T20:27:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T23:23:44.000Z (about 2 months ago)
- Last Synced: 2024-12-16T17:04:51.957Z (14 days ago)
- Topics: automated-market-maker, core, ethereum, smart-contracts
- Language: TypeScript
- Homepage: https://uniswap.org
- Size: 6.22 MB
- Stars: 4,458
- Watchers: 142
- Forks: 2,752
- Open Issues: 66
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audits/abdk/audit.pdf
Awesome Lists containing this project
README
# Uniswap V3
[](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/lint.yml)
[](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/tests.yml)
[](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/fuzz-testing.yml)
[](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/mythx.yml)
[](https://www.npmjs.com/package/@uniswap/v3-core/v/latest)
This repository contains the core smart contracts for the Uniswap V3 Protocol.
For higher level contracts, see the [uniswap-v3-periphery](https://github.com/Uniswap/uniswap-v3-periphery)
repository.
## Bug bounty
This repository is subject to the Uniswap V3 bug bounty program, per the terms defined [here](./bug-bounty.md).
## Local deployment
In order to deploy this code to a local testnet, you should install the npm package
`@uniswap/v3-core`
and import the factory bytecode located at
`@uniswap/v3-core/artifacts/contracts/UniswapV3Factory.sol/UniswapV3Factory.json`.
For example:
```typescript
import {
abi as FACTORY_ABI,
bytecode as FACTORY_BYTECODE,
} from '@uniswap/v3-core/artifacts/contracts/UniswapV3Factory.sol/UniswapV3Factory.json'
// deploy the bytecode
```
This will ensure that you are testing against the same bytecode that is deployed to
mainnet and public testnets, and all Uniswap code will correctly interoperate with
your local deployment.
## Using solidity interfaces
The Uniswap v3 interfaces are available for import into solidity smart contracts
via the npm artifact `@uniswap/v3-core`, e.g.:
```solidity
import '@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol';
contract MyContract {
IUniswapV3Pool pool;
function doSomethingWithPool() {
// pool.swap(...);
}
}
```
## Licensing
The primary license for Uniswap V3 Core is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE). However, some files are dual licensed under `GPL-2.0-or-later`:
- All files in `contracts/interfaces/` may also be licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers), see [`contracts/interfaces/LICENSE`](./contracts/interfaces/LICENSE)
- Several files in `contracts/libraries/` may also be licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers), see [`contracts/libraries/LICENSE`](contracts/libraries/LICENSE)
### Other Exceptions
- `contracts/libraries/FullMath.sol` is licensed under `MIT` (as indicated in its SPDX header), see [`contracts/libraries/LICENSE_MIT`](contracts/libraries/LICENSE_MIT)
- All files in `contracts/test` remain unlicensed (as indicated in their SPDX headers).