Skip to content

Commit

Permalink
test minimum supported rust version with CI (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
nlordell authored Dec 20, 2019
1 parent a2dc00d commit a885d33
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ stages:
stage: "Build and Test"
language: rust
rust:
- 1.39.0
- stable
- beta
- nightly
Expand Down
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ ethcontract::contract!("path/to/truffle/build/contract/Contract.json");
This will generate a new struct `ContractName` with contract generated methods
for interacting with contract functions in a type-safe way.

### Minimum Supported Rust Version

The minimum supported Rust version is 1.39. This is required for `async`/`await`
support which is used by one of the examples. Note that the core libraries
probably work with some earlier versions of Rust but they are not officially
supported or tested.

## Generator API

As an alternative to the procedural macro, a generator API is provided for
Expand All @@ -31,11 +38,9 @@ found in the `ethcontract-generate` [README](generate/README.md).

## Running the Examples

In order to run local examples you need:
- Rust >=1.39 for `async`/`await` support
- NodeJS in order to compile truffle contracts and, depending on the example,
start development node
- Yarn is used as the package manager
In order to run local examples you will additionally need:
- NodeJS
- Yarn

For all examples, the smart contracts must first be built:

Expand Down

0 comments on commit a885d33

Please sign in to comment.