Curvesim

No changes from the release candidate.

Cryptoswap simulations are expected to work without major issues.

This release candidate fixes data provider issues not fully resolved by the previous beta release, but only for Mainnet. Cryptoswap simulations are expected to work without major issues.

A noteworthy highlight is that full pythonic interaction with cryptoswap functionality should be available for 3-coin pools, not just 2-coin.

A detailed list of changes and enhancements are available in the [changelog](https://github.com/curveresearch/curvesim/blob/be907852b61c18bc6c7c7e2de71264616e3b23b0/CHANGELOG.rst).

This is a follow-up to the last beta release, which fixes some of the data provider issues necessary to accurately run cryptopool simulations. The volume issue is still not fixed but will be resolved by the release candidate vresion. Several bugs were found and resolved. A detailed list of changes and enhancements are available in the [changelog](https://github.com/curveresearch/curvesim/blob/v0.5.0.b2/CHANGELOG.rst).

This release introduces our top feature request and a major project milestone: Curve v2 Cryptoswap simulations. Both Cryptoswap factory pools and Cryptoswap-NG pools are supported and tested against their vyper counterparts.

Cryptoswap simulations can be run using the same interface and pipelines used for Curve v1 Stableswap pools, e.g.:

python
triCRV = "0x4ebdf703948ddcea3b11f675b4d1fba9d2414a14"
res = curvesim.autosim(triCRV, A=[270000, 2700000], gamma=[1300000000000, 13000000000])


This release is marked as "beta" due to three known limitations, which we expect to remedy shortly:
- Estimates of total volume may be innacurate for v2 pools. For now, we recommend using the `vol_mult` argument to specify the estimated proportion of total token volume that passes through the pool (e.g., `vol_mult=0.3` if 30% of market volume uses the pool).
- The current CoinGecko data source only provides price data at up to 1 hour intervals, which may be insufficient for robust simulation of v2 pools. We are currently working to find and integrate a better data source.
- While simulations are fully functioning, complete pythonic interaction with 3-coin cryptopools is not yet available.

A detailed list of changes and enhancements are available in the [changelog](https://github.com/curveresearch/curvesim/blob/1bddb535b692be8d56850abf7b40e4c4b4f9ebb6/CHANGELOG.rst).

This release is in preparation of the upcoming "cryptosim" milestone, which will enable arbitrage simulation of cryptopools. We have greatly improved readability and maintainability. A detailed list of changes and enhancements are available in the [changelog](CHANGELOG.rst).

This second release of Curvesim is a foundational release, bringing it much closer to being a general framework for arbitrage simulations on Curve pools.

Highlights include:
- User-definable metric objects that can be used to generate custom simulation results
- Much more powerful data visualization through integration with the Altair library
- Easy instantiation of 2-token cryptopools from chain data as can currently be done with stableswap pools

A detailed list of changes and enhancements are available in the [changelog](CHANGELOG.rst).

In the coming weeks, we will be rolling out additional updates to the [documentation](https://curvesim.readthedocs.io/), such as Jupyter notebooks to make it even easier for users to dip their toes into the water with Curvesim.

We're very excited by what is coming down the road:

- wrapping up cryptopool simulation capability
- incorporating more general data sources
- expanding the set of arbitrage strategies

Stay tuned and continue using Curvesim and letting us know how we can improve it!