Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/primitivefinance/portfolio
Portfolio is an automated market making protocol for implementing custom strategies at the lowest cost possible.
https://github.com/primitivefinance/portfolio
forge portfolio primitive rmm solidity
Last synced: about 2 months ago
JSON representation
Portfolio is an automated market making protocol for implementing custom strategies at the lowest cost possible.
- Host: GitHub
- URL: https://github.com/primitivefinance/portfolio
- Owner: primitivefinance
- License: agpl-3.0
- Created: 2022-05-02T17:31:55.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-18T14:46:24.000Z (about 1 year ago)
- Last Synced: 2024-04-14T04:24:18.467Z (10 months ago)
- Topics: forge, portfolio, primitive, rmm, solidity
- Language: Solidity
- Homepage: https://www.primitive.xyz/
- Size: 81.6 MB
- Stars: 110
- Watchers: 7
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Beta: Portfolio is experimental software. Use at your own risk.
# Portfolio by Primitive
[](https://github.com/primitivefinance/portfolio#contributing) [](https://primitive.xyz/discord) [](https://twitter.com/primitivefi)
Portfolio is an automated market making protocol for implementing custom liquidity distribution strategies at the lowest cost possible.
## Table of Contents
- [Overview](#overview)
- [Deployments](#deployments)
- [Security](#security)
- [Install](#install)
- [Documentation](#documentation)
- [Resources](#resources)
- [Contributing](#contributing)
- [License](#license)
## Overview
Portfolio is an automated market making protocol for creating custom liquidity distribution strategies at the lowest cost possible. Each pool in Portfolio can be created with a default strategy or custom strategy that defines a trading function, determining the available prices offered by the provider's liquidity. These pools all exist within the single Portfolio smart contract resulting in significantly lower gas costs for liquidity providers and swappers.
Read the local [docs](./docs/src/), hosted docs [docs.primitive.xyz](https://docs.primitive.xyz), or the [formal specification](https://primitive.xyz/whitepaper) for more information.
## Deployments
### Canonical Cross-chain Deployment Addresses
| Contract | Canonical cross-chain address |
| -------------------- | -------------------------------------------- |
| Portfolio 1.3.0-beta | `0x82360b9a2076a09ea8abe2b3e11aed89de3a02d1` |
| Portfolio 1.4.0-beta | `n/a` |
| Portfolio 1.5.0-beta | `0x0000a37Fd680Ab248119b448545eF72C51Bf7530` |
### Deployments by Chain
| Network | Portfolio 1.3.0-beta | Portfolio v1.4.0-beta | Portfolio v1.5.0-beta |
| -------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------- |
| Ethereum | [0x82360b9a2076a09ea8abe2b3e11aed89de3a02d1](https://etherscan.io/address/0x82360b9a2076a09ea8abe2b3e11aed89de3a02d1 ) | n/a | [0x0000a37Fd680Ab248119b448545eF72C51Bf7530](https://etherscan.io/address/0x0000a37fd680ab248119b448545ef72c51bf7530) |
| Base | n/a | n/a | n/a |
| Sepolia | [0x82360b9a2076a09ea8abe2b3e11aed89de3a02d1](https://sepolia.etherscan.io/address/0x82360b9a2076a09ea8abe2b3e11aed89de3a02d1) | n/a | n/a |
| Network | PortfolioRegistry v1.5.0-beta |
| -------- | --------------------------------------------------------------------------------------------------------------------- |
| Ethereum | [0x42776F58b6BC63492E0b7A7a937D1138DF716670](https://etherscan.io/address/0x42776f58b6bc63492e0b7a7a937d1138df716670) |
| Network | PositionRenderer v1.5.0-beta |
| -------- | --------------------------------------------------------------------------------------------------------------------- |
| Ethereum | [0xdDA01E1d7684Cc35e6a3A5803736D32d012B8C99](https://etherscan.io/address/0xdDA01E1d7684Cc35e6a3A5803736D32d012B8C99) |
# Security
[Visit Primitive Security](https://www.primitive.xyz/security) to view a comprehensive overview of the security initiatives of Portfolio.
## Audits
| Security Firm | Date | Review Time | Status | Final Commit w/ Fixes |
| ------------------------------------------------------------------------------------------------------------- | ---------- | ----------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| [ChainSecurity](https://github.com/primitivefinance/security/blob/main/audits/portfolio/chainsecurity.pdf) | 2022-05-31 | 8-weeks | Completed | [c6f692f41c1d20ac09acb832923bd46500fd8e06](https://github.com/primitivefinance/portfolio/commit/c6f692f41c1d20ac09acb832923bd46500fd8e06) |
| [Trail of Bits](https://github.com/primitivefinance/security/blob/main/audits/portfolio/trailofbits.pdf) | 2023-01-31 | 8-weeks | Completed | n/a |
| [Spearbit #1](https://github.com/primitivefinance/security/blob/main/audits/portfolio/spearbit.pdf) | 2023-03-31 | 5-weeks | Completed | [tag/v1.1.0-beta](https://github.com/primitivefinance/portfolio/releases/tag/v1.1.0-beta) |
| [Spearbit #1 Extension](https://github.com/primitivefinance/security/blob/main/audits/portfolio/spearbit.pdf) | 2023-05-12 | 2-weeks | Competed | [36e9efa28332fa03f6d5910edda2fec2f5937190](https://github.com/primitivefinance/portfolio/commit/36e9efa28332fa03f6d5910edda2fec2f5937190 ) |
| Spearbit #2 | 2023-07-78 | 2-weeks | Completed | [tag/v1.4.0-beta-spearbit-2023-08-complete](https://github.com/primitivefinance/portfolio/releases/tag/v1.4.0-beta-spearbit-2023-08-complete) |
## Install
To install locally and compile contracts:
#### [Required] Foundry. [Source](https://github.com/foundry-rs/foundry).
If not installed, run the following:
```bash
# First install foundryup
curl -L https://foundry.paradigm.xyz | bash
# Restart terminal or reload `PATH`, then run foundryup
foundryup
```
#### [Required] Install Deps
```bash
forge install
```
#### Usage
##### Testing
```bash
FOUNDRY_PROFILE=test forge test
```
##### Building
```bash
FOUNDRY_PROFILE=optimized forge build --skip test
```
##### Coverage
[Optional] Install coverage gutters [vs code extension](https://github.com/ryanluker/vscode-coverage-gutters).
Then run this to generate a coverage report:
```bash
forge coverage --report lcov
```
### Install Artifacts via NPM
To install the artifacts to use in your own project:
```bash
npm install @primitivexyz/portfolio
```
# Documentation
## Hosted
[Visit Primitive Documentation](https://docs.primitive.xyz) to view the hosted documentation for Portfolio.
## Local
### Autogenerated documentation:
Generated from the natspc of the contracts.
```bash
FOUNDRY_PROFILE=default forge doc --build --serve --port 4000
```
### Written documentation:
#### [Required] Rust & Cargo
If not installed, follow the [rust installation instructions](https://www.rust-lang.org/tools/install).
#### [Required] Mdbook
If not installed, run the following:
```bash
cargo install mdbook
```
### Build and serve
```bash
cd docs
mdbook serve --open
```
## Resources
- [Hosted Documentation](https://docs.primitive.xyz)
- [Portfolio Yellow Paper (Deprecated)](https://www.primitive.xyz/papers/yellow.pdf)
- [RMM in desmos](https://www.desmos.com/calculator/8py0nzdgfp)
- [Original codebase](https://github.com/primitivefinance/rmm-core)
- [solstat](https://github.com/primitivefinance/solstat)
- [Replicating Market Makers](https://github.com/angeris/angeris.github.io/blob/master/papers/rmms.pdf)
- [RMM whitepaper](https://primitive.xyz/whitepaper)
- [High precision calculator](https://keisan.casio.com/calculator)
## Contributing
Important:
- This codebase uses the FORGE formatter. This is not prettier. If you have not already, make sure if you use vs code that the `formatOnSave`config variable uses forge fmt instead of prettier.
- Setup the proper settings using this guide: [forge fmt for formatOnSave vscode](https://github.com/juanfranblanco/vscode-solidity/pull/359#issue-1344943156).
When making a pull request:
- All tests pass.
- Code coverage does not change.
- Code follows the style guide:
- Follows Primitive [styling](https://github.com/primitivefinance/pso-sol) rules.
- Run `forge fmt`.
- Code is thoroughly commented with natspec where relevant.
- If making a change to the contracts:
- Gas snapshots are provided and demonstrate an improvement (or an acceptable deficit given other improvements).
- New tests for all new features or code paths.
- If making a modification to third-party dependencies, yarn audit passes.
- A descriptive summary of the PR has been provided.
## Copyright
[AGPL-3.0](./LICENSE) © 2023 Primitive Bits, Inc.