Skip to content

Commit

Permalink
Remove warrant direct dependency. Change Readme to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
gnpar committed Feb 15, 2024
1 parent 7ca35e0 commit 536fd58
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 57 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# eth-prototype


Prototype Ethereum Smart Contracts in Python


## Description

Library with base classes to prototype Ethereum Smart Contracts in Python. This includes:

- wadray: classes for fixed number of decimals math implemented with integers.
- contracts: classes to simulate contracts in Python with features like *rollback* on exception, external
methods, views. Also classes for common contracts like ERC20 (tokens), ERC721 (NFTs) and AccessControl.
- w3wrappers: classes to wrap ethereum contracts called thru [web3py](https://web3py.readthedocs.io/) but with a pythonic interface

To use the `defender_relay` module you need to have the `warrant` package from this repo: https://github.com/gnarvaja/warrant. Add it to your requirements.txt as:

```
warrant @ git+https://github.com/gnarvaja/warrant.git#egg=warrant
```

Note that using the `warrant` package from pypi will not work because of incompatibilities with newer python versions.

## Tox Tests

The tox tests run in two variants:

- `default`: only uses and tests the prototype libraries, no blockchain.
- `default-w3`: users and tests two variants: prototype and w3wrappers (wrappers using web3py).

# Note

This project has been set up using PyScaffold 4.0.2. For details and usage
information on PyScaffold see https://pyscaffold.org/.
55 changes: 0 additions & 55 deletions README.rst

This file was deleted.

2 changes: 0 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ web3 =

defender =
boto3
warrant @ git+https://github.com/gnarvaja/warrant.git#egg=warrant

gmpy2 =
gmpy2
Expand All @@ -85,7 +84,6 @@ testing-w3 =
pytest
pytest-cov
boto3
warrant @ git+https://github.com/gnarvaja/warrant.git#egg=warrant

[options.entry_points]
# Add here console scripts like:
Expand Down
2 changes: 2 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ passenv =
WEB3_*
extras =
testing-w3
deps =
warrant @ git+https://github.com/gnarvaja/warrant.git#egg=warrant
commands =
pytest {posargs}

Expand Down

0 comments on commit 536fd58

Please sign in to comment.