https://github.com/critesjosh/vyper-testing

An exercise in writing and testing Vyper contracts with web3.js 1.0
https://github.com/critesjosh/vyper-testing

Last synced: 18 days ago
JSON representation

An exercise in writing and testing Vyper contracts with web3.js 1.0

• Host: GitHub
• URL: https://github.com/critesjosh/vyper-testing
• Owner: critesjosh
• Created: 2018-11-15T16:10:37.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-15T16:45:46.000Z (about 6 years ago)
• Last Synced: 2024-10-29T07:41:15.307Z (2 months ago)
• Language: JavaScript
• Size: 37.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Writing Ethereum Smart Contracts in Vyper

In this exercise we are going to work on writing a simple bank

contract similar to the one in this

[repository](https://github.com/ConsenSys-Academy/simple-bank-exercise),

except we are going to do it with Vyper!

To get started, clone this repository to your machine, navigate to the root of the project directory and run `npm install`.

You will be working on completing the SimpleBank.vy contract in the contracts directory. There are comments in the file to guide you. You will also want to consult the [Vyper documentation](https://vyper.readthedocs.io/en/latest/).

**The SimpleBank.vy contract is complete and tests are passing in this version of the exercise. It will be gutted before distributing to students.**

## Install Vyper

To compile the Vyper contract, you need to use the Vyper compiler. First, you need to install the Vyper compiler, which will generate the ABI and

bytecode from the [SimpleBank.vy](./contracts/SimpleBank.vy) file.

Alternatively you can use [vyper.online](https://vyper.online) IDE to develop the contract. Vyper.online is similar to Remix in that it offers a text editing environment along with contract compilation to get the bytecode and ABI. It will also provide an LLL version of your Vyper contract. 

## Run the compiler

Once the Vyper compiler is installed, you can test compiling your Vyper contract (./contracts/SimpleBank.vy) by running

```sh

vyper -f "abi" ./contracts/SimpleBank.vy > abi.json

vyper -f "bytecode" ./contracts/SimpleBank.vy > bytecode

```

The first command will get the abi from the Vyper contract and save it in a file called abi.json.

The second command will save the bytecode in the file called 'bytecode'. These files are imported into the /test/test.js

file before the test are run.

If you haven't installed the Vyper compiler on your machine, you can copy the ABI and bytecode outputs from [vyper.online](https://vyper.online) into the appropriate files in this directory ([abi.json](./abi.json) and [bytecode](./bytecode)).

## Run the tests

The project uses mocha to run tests. Run the tests with `npm run test`.

Notice that the tests are a bit different in this directory than the Solidity SimpleBank exercise. In this exercise, we are using web3 version 1.0 beta. The main differences are how to deploy contracts and how to watch events. Watching events requires that you are connected to ganache-cli via a websocket connection rather than http. 

```js

var web3 = new Web3('ws://localhost:8545')

```

Also the structure of the logs is a bit different. [You can read more about the differences between handling events in web3.js-0.2x.x and web3.js-1.0 here](https://web3js.readthedocs.io/en/1.0/web3-eth-contract.html#contract-events).