pip install -r requirements.txt
Before running pip however, you may want to follow these steps for Python and Golang setup strategies (unless you have your own).
Python 3.6 is required. We strongly recommend you use a dedicated virtual environment for goest. Here virtualenv is used, but you could use venv as well:
virtualenv -p python3.6 --no-site-packages <path-to-virtual-env-dir>
source <path-to-virtual-env-dir>/bin/activate
Make sure your Go environment is configured. See go installation directions. Note that it is idiomatic go to have your
$GOPATH and $GOROOT exported to your shell. Of particular import is $GOPATH which is used by some of the invoke tasks in this project. This dev, for example, has:
export GOROOT=$HOME/.go
export GOPATH=$HOME/go
The test suite uses geth utilities and libraries. You can install geth with go get:
go get -d github.com/ethereum/go-ethereum
Alternatively, if you'd prefer, you can install Geth from source. See instructions. Once installed,
ensure that abigen is available to your go environment by at least building the devtools:
cd $GOPATH/src/github.com/ethereum/go-ethereum
make devtools (or make all)
We use "latest" Go (currently at 1,13,1), typically bumping our own environments quickly after each release. You can always check the .travis.yml file for Golang version.
I have found it useful to employ a version manager, see g
The test suites are written in Go, so you can run tests with the invoke task (from root directory):
invoke test
You can also run individual tests by specifying a package. For example, here's how you would run the tests for ethertoken:
go test -v ./tests/ethertokentest/
If you've changed a contract in this repo, you will need to regenerate the .abi and .bin files for that file. These files are used to regenerate the go API bindings that power the spec suite.
Finally, you should regenerate the external interface file for any changed contract. Here are the invoke tasks for performing these actions:
Vyper contracts can have their ABI and BIN files created by using the invoke task dedicated to "precompiling"
invoke precompile
Once ABI and BIN files are created we need to create Golang bindings so that the spec suite can run. There is a dedicated task for compilation of these:
invoke compile (note this will also trigger precompilation)
Aside from precompilation of Vyper files and compilation of Golang bindings we generate external inferfaces for reference purposes. As a convenience there is a single command to perforom all three:
invoke build (runs precompilation, compilation and external interface construction)
You can see all the commands available to the invoke task runner in tasks.py