From 0b8860f20d736e72f881a41077b8b652a03bc75c Mon Sep 17 00:00:00 2001 From: Daniel Schiavini Date: Wed, 7 Aug 2024 17:37:24 +0200 Subject: [PATCH] Version 0.1.10.0 --- .github/workflows/release.yaml | 29 +++++++++++++++++++++++++++++ CONTRIBUTING.md | 2 +- README.md | 17 ++++++++++------- docs/source/overview.rst | 8 ++++---- pyproject.toml | 8 ++++---- 5 files changed, 48 insertions(+), 16 deletions(-) create mode 100644 .github/workflows/release.yaml diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 00000000..816e4892 --- /dev/null +++ b/.github/workflows/release.yaml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ac184365..388001c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 ``` diff --git a/README.md b/README.md index 5275c366..0161eb0c 100644 --- a/README.md +++ b/README.md @@ -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. @@ -12,12 +15,12 @@ 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 ``` @@ -25,12 +28,12 @@ If you are installing titanoboa from git alongside brownie, you may have to manu ``` 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'` @@ -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: @@ -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 ``` diff --git a/docs/source/overview.rst b/docs/source/overview.rst index e5e5cb02..b956cacf 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -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 `_. +Alternatively, the latest in-development version of ``titanoboa`` can be installed from `GitHub `_. .. 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 `_ as a dependency manager: @@ -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 = } + titanoboa = { git = "https://github.com/curvefi/titanoboa.git", rev = } diff --git a/pyproject.toml b/pyproject.toml index dc389f97..9a7e5494 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"]