# UP Protocol Slipstream

This repository contains a sanitized, source-only public snapshot of the UP
Protocol concentrated-liquidity contracts. It derives from Aerodrome Slipstream
and includes Uniswap v3-derived core and periphery components together with gauge,
fee-module, routing, position-management, quoting, and helper contracts.

> **Source snapshot:** This repository is not represented as the exact or
> complete source for any particular on-chain deployment, and it is not intended
> for byte-for-byte deployment verification. Live deployment records, production
> configuration and credentials, operational runbooks, the original test suite,
> and components outside this public snapshot are not included.

References in the source or configuration to a network or upstream project
identify technical compatibility and provenance only. No affiliation with or
endorsement by Robinhood, Aerodrome, Velodrome, Uniswap, or their contributors
is claimed.

## Included components

- Concentrated-liquidity pool and factory contracts under `contracts/core/`.
- Gauge and gauge-factory contracts under `contracts/gauge/`.
- Position management, routing, quoting, lens, and helper contracts under
  `contracts/periphery/`.
- Shared interfaces and libraries, including file-specific permissive components.

The authoritative scope is the tracked source tree under `contracts/`.

## Repository layout

- `contracts/` - Solidity contracts, interfaces, libraries, and component notices.
- `deploy/` - generic Hardhat deployment source.
- `constants/` - sanitized configuration templates and public network metadata.
- `scripts/` - preflight and development utilities retained in this snapshot.
- `audits/` - inherited verification fixtures; this is not a current audit report.

Deployment scripts and configuration templates require independent review before
use. Example values are not production configuration or recommended governance
settings. This README does not publish or certify canonical deployment addresses.

## Development status

The project metadata targets Node.js, Yarn Classic (1.x), Hardhat, and Solidity
0.7.6. After dependencies have been independently reviewed and installed, the
declared compilation entry point is:

```sh
yarn compile
```

A clean `yarn install --frozen-lockfile` currently fails dependency-integrity
verification. Review and regenerate the lockfile from trusted package sources
before treating this snapshot as a reproducible build.

The original Hardhat and Foundry test suites and vendored Foundry dependencies are
not included. The retained `yarn test` command must not be treated as meaningful
public test coverage until tests are added. The retained CI, formatting, analysis,
and invariant configurations may also reference files outside this snapshot.

Never commit RPC credentials, API tokens, mnemonics, private keys, or populated
environment files. Use isolated test credentials and review every transaction
before running any deployment or administration script.

## Licensing and provenance

Licensing is file-specific. Consult each Solidity file's SPDX identifier together
with the repository notices:

- [`LICENSE`](LICENSE) - repository-level licensing and provenance notice.
- [`COPYING`](COPYING) - GNU GPL version 2 text.
- [`THIRD_PARTY_LICENSES`](THIRD_PARTY_LICENSES) - third-party provenance,
  attribution, and permissive-license texts.
- [`LICENSES/PCS_VELODROME_SLIPSTREAM_BUSL-1.1`](LICENSES/PCS_VELODROME_SLIPSTREAM_BUSL-1.1)
  - the historical license shipped with the direct upstream snapshot.
- [`contracts/core/LICENSE`](contracts/core/LICENSE) and the adjacent interface and
  library notices - inherited Uniswap v3 licensing context.

Historical license copies are retained to preserve inherited terms and
provenance; they are not current SPDX declarations for every file.

The direct upstream baseline is
[`aerodrome-finance/slipstream@5b529b4`](https://github.com/aerodrome-finance/slipstream/tree/5b529b4d418a6d2e394391a153dfbd0c98de937d).
Uniswap, Aerodrome, Velodrome, PCS, and other upstream copyrights and notices
remain with their respective holders. Nothing in this README replaces the
applicable license text or a file-level notice, and the statements here concern
only this source snapshot rather than any separate deployment or historical
distribution. Later upstream versions may carry different terms.

## Security

Publication of source code is not an audit, warranty, or recommendation for
production use. Conduct independent security, legal, and deployment review before
using these contracts with assets or privileged roles.