Skip to content

Commit

Permalink
Version 0.1.10.0
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielSchiavini committed Aug 7, 2024
1 parent ed798eb commit 0b8860f
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 16 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
on:
release:
types: [published]

jobs:
publish-pypi:
runs-on: ubuntu-latest

permissions:
id-token: write

steps:
- uses: actions/checkout@v4

- name: Python
uses: actions/setup-python@v5
with:
cache: "pip"

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine build
- name: Build
run: python -m build

- name: Publish
uses: pypa/gh-action-pypi-publish@release/v1
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Follow the steps to clone the repo for you to make changes to this project.
1. Clone the repo

```bash
git clone https://github.com/vyperlang/titanoboa
git clone https://github.com/curvefi/titanoboa
cd titanoboa
```

Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Titanoboa
# Curve-boa

This is a fork of the [Titanoboa](https://github.com/vyperlang/titanoboa) interpreter, specifically for the needs of Curve Finance.
In this fork we experiment with adding new features before they are merged into the main repository.

A [Vyper](https://github.com/vyperlang/vyper) interpreter with pretty tracebacks, forking, debugging features and more! Titanoboa's goal is to provide a modern, advanced and integrated development experience for vyper users.

Expand All @@ -12,25 +15,25 @@ Usage and quickstart are [below](#usage-quick-start). For more detailed document

## Installation
```
pip install titanoboa
pip install curve-boa
```

For latest dev version:
```
pip install git+https://github.com/vyperlang/titanoboa
pip install git+https://github.com/curvefi/titanoboa
```


If you are installing titanoboa from git alongside brownie, you may have to manually install titanoboa *after* installing brownie

```
pip install brownie
pip install git+https://github.com/vyperlang/titanoboa
pip install git+https://github.com/curvefi/titanoboa
```

Sometimes, using [pypy](https://www.pypy.org/download.html) can result in a substantial performance improvement for computation heavy contracts. `Pypy` can usually be used as a drop-in replacement for `CPython`.

To get a performance boost for mainnet forking, install with the `forking-recommended` extra (`pip install "git+https://github.com/vyperlang/titanoboa#egg=titanoboa[forking-recommended]"`, or `pip install titanoboa[forking-recommended]`). This installs `plyvel` to cache RPC results between sessions, and `ujson` which improves json performance.
To get a performance boost for mainnet forking, install with the `forking-recommended` extra (`pip install "git+https://github.com/curvefi/titanoboa#egg=titanoboa[forking-recommended]"`, or `pip install curve-boa[forking-recommended]`). This installs `plyvel` to cache RPC results between sessions, and `ujson` which improves json performance.

If you are running titanoboa on a local [Vyper](https://github.com/vyperlang/vyper) project folder, you might need to run `python setup.py install` on your [Vyper](https://github.com/vyperlang/vyper) project if you encounter errors such as `ModuleNotFoundError: No module named 'vyper.version'`

Expand Down Expand Up @@ -222,7 +225,7 @@ Before being able to use the plugin, you need to install it.
You can do this by running the following command in the terminal:

```bash
pip install titanoboa
pip install curve-boa
jupyter lab extension enable boa
```
To activate our IPython extension, you need to run the following command in the notebook:
Expand All @@ -243,7 +246,7 @@ The source code for this website is available in the [GitHub repository](https:/
It is also possible to run our plugin in [Google Colab](https://colab.research.google.com/).
To do this, you need to install the plugin by running the following commands:
```jupyter
!pip install titanoboa
!pip install curve-boa
%load_ext boa.ipython
```

Expand Down
8 changes: 4 additions & 4 deletions docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Installation

.. code-block:: bash
pip install titanoboa
pip install curve-boa
Alternatively, the latest in-development version of ``titanoboa`` can be installed from `GitHub <https://github.com/vyperlang/titanoboa>`_.
Alternatively, the latest in-development version of ``titanoboa`` can be installed from `GitHub <https://github.com/curvefi/titanoboa>`_.

.. code-block:: bash
pip install git+https://github.com/vyperlang/titanoboa#egg=titanoboa
pip install git+https://github.com/curvefi/titanoboa#egg=titanoboa
If you are using `Poetry <https://python-poetry.org/>`_ as a dependency manager:

Expand All @@ -37,4 +37,4 @@ If you want to use a specific version you can customize the dependency in your `
.. code-block:: toml
[tool.poetry.dependencies]
titanoboa = { git = "https://github.com/vyperlang/titanoboa.git", rev = <commit hash> }
titanoboa = { git = "https://github.com/curvefi/titanoboa.git", rev = <commit hash> }
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[project]
name = "titanoboa"
version = "0.1.10b1"
name = "curve-boa"
version = "0.1.10.0"
description = "A Vyper interpreter"
#authors = []
license = { file = "LICENSE" }
readme = "README.md"
#homepage = "https://github.com/vyperlang/titanoboa"
#repository = "https://github.com/vyperlang/titanoboa"
#homepage = "https://github.com/curvefi/titanoboa"
#repository = "https://github.com/curvefi/titanoboa"
#documentation =

keywords = ["ethereum", "evm", "smart contract", "development"]
Expand Down

0 comments on commit 0b8860f

Please sign in to comment.