Skip to content

Commit b40372b

Browse files
committed
update readmes
1 parent 641909c commit b40372b

File tree

8 files changed

+31
-48
lines changed

8 files changed

+31
-48
lines changed

Diff for: README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# purescript-eth
2+
<img src=https://github.com/martyall/purescript-eth/blob/master/web3/purescript-web3-logo.png width="75">
3+
4+
Core libraries for interacting with Ethereum data
5+
6+
- eth-core: Core types and functions (e.g. bytestring operations, encodings, crypto, etc)
7+
- web3: Web3 client API for interacting with an ethereum node
8+
- web3-generator: Generate purescript FFI for your solidity smart contracts
9+
- solc: Wrapper for the solidity compiler (mostly for internal use in chanterelle)
10+
- chanterelle: A CLI for deploying, managing, and testing smart contracts on Ethereum
11+
12+
13+
### Previous work
14+
All of these packages were previously listed in the [f-o-a-m](https://github.com/f-o-a-m) github org (no longer active). Since spago now allows for monorepo package management, I have greatly simplified the situation by consolidating everything here. All future work will be posted in this repository, the others are
15+
no archived.

Diff for: chanterelle/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![Build Status](https://travis-ci.com/f-o-a-m/chanterelle.svg?branch=master)](https://travis-ci.com/f-o-a-m/chanterelle)
44

5-
<img src=https://github.com/f-o-a-m/chanterelle/blob/master/chanterelle-logo.svg width="150">
5+
[![Chanterelle example tests](https://github.com/martyall/purescript-eth/actions/workflows/test-chanterelle-example.yml/badge.svg)](https://github.com/martyall/purescript-eth/actions/workflows/test-chanterelle-example.yml)
6+
7+
<img src=https://github.com/martyall/purescript-eth/blob/master/chanterelle/chanterelle-logo.svg width="150">
68

79
_a more functional truffle_
810

Diff for: chanterelle/example/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# Chanterelle Example
2+
[![Chanterelle example tests](https://github.com/martyall/purescript-eth/actions/workflows/test-chanterelle-example.yml/badge.svg)](https://github.com/martyall/purescript-eth/actions/workflows/test-chanterelle-example.yml)
3+
24

35
This folder contains a complete example project for an Ethereum appliation managed using chanterelle. The application is simple -- there is an ERC20 token contract (`Token.sol`) and a contract (`SimplePaidStorage.sol`) that maintains a simple `uint` variable and requires users to pay tokens to update the state.
46

Diff for: eth-core/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# purescript-eth-core
2-
3-
[![Build Status](https://travis-ci.com/f-o-a-m/purescript-eth-core.svg?branch=master)](https://travis-ci.com/f-o-a-m/purescript-eth-core)
2+
[![Run eth-core test suite](https://github.com/martyall/purescript-eth/actions/workflows/eth-core-tests.yml/badge.svg)](https://github.com/martyall/purescript-eth/actions/workflows/eth-core-tests.yml)
43

54
Common types and utility functions for all web3 libraries

Diff for: solc/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# purescript-solc
2-
3-
[![Build Status](https://travis-ci.com/f-o-a-m/purescript-solc.svg?branch=master)](https://travis-ci.com/f-o-a-m/purescript-solc)
2+
[![Run the solc test suite](https://github.com/martyall/purescript-eth/actions/workflows/solc-tests.yml/badge.svg)](https://github.com/martyall/purescript-eth/actions/workflows/solc-tests.yml)
43

54
PureScript bindings for the JavaScript bindings for the Solidity compiler.

Diff for: test/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# purescript-web3-tests
2+
[![Web3 E2E tests](https://github.com/martyall/purescript-eth/actions/workflows/ci.yml/badge.svg)](https://github.com/martyall/purescript-eth/actions/workflows/ci.yml)
23

34
This repo is the closest thing you can get to a monorepo in spago (unfortunately as of right now you cannot manage multiple packes in one repo with spago).
45

@@ -12,8 +13,7 @@ You can run the tests locally via
1213
```
1314
> docker run -d -p 8545:8545 -e ACCOUNTS_TO_CREATE=10 foamspace/cliquebait:v1.9.12
1415
> npm install
15-
> npm run build
16-
> npm run chanterelle-build
16+
> npm run build-contracts
1717
> npm run test
1818
1919
```

Diff for: web3-generator/README.md

+3-25
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,14 @@
11
# purescript-web3-generator
2-
<img src=https://github.com/f-o-a-m/purescript-web3/blob/master/purescript-web3-logo.png width="75">
2+
[![Run web3-generator test suite](https://github.com/martyall/purescript-eth/actions/workflows/web3-generator-tests.yml/badge.svg)](https://github.com/martyall/purescript-eth/actions/workflows/web3-generator-tests.yml)
33

4-
[![Latest release](http://img.shields.io/github/release/f-o-a-m/purescript-web3-generator.svg?branch=master)](https://github.com/f-o-a-m/purescript-web3-generator/releases)
5-
[![purescript-web3-generator on Pursuit](https://pursuit.purescript.org/packages/purescript-web3-generator/badge)](https://pursuit.purescript.org/packages/purescript-web3-generator)
6-
[![Build status](https://travis-ci.com/f-o-a-m/purescript-web3-generator.svg?branch=master)](https://travis-ci.com/f-o-a-m/purescript-web3-generator?branch=master)
7-
8-
Generats purescript modules from Solidity ABIs
9-
10-
## Requirements
11-
12-
- `npm`
13-
14-
## Getting Started
15-
```
16-
> git clone
17-
> cd purescript-web3-generator
18-
> npm install
19-
> npm run build
20-
> npm run test
21-
```
4+
Generates purescript modules from Solidity ABIs
225

236
## How to use it
247

25-
see the `example` directory in this repo.
26-
27-
## Documentation
28-
29-
Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-web3-generator).
8+
see the `example` directory in this repo, or the [chanterelle-example](../chanterelle/example/README.md)
309

3110
## Resources
3211

33-
- [purescript-web3](https://github.com/f-o-a-m/purescript-web3)
3412
- [web3.js repo](https://github.com/ethereum/web3.js)
3513
- [web3 Javascript API wiki](https://github.com/ethereum/wiki/wiki/JavaScript-API)
3614

Diff for: web3/README.md

+4-16
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,14 @@
11
# purescript-web3
2-
<img src=https://github.com/f-o-a-m/purescript-web3/blob/master/purescript-web3-logo.png width="75">
2+
[![Run web3 test suite](https://github.com/martyall/purescript-eth/actions/workflows/web3-tests.yml/badge.svg)](https://github.com/martyall/purescript-eth/actions/workflows/web3-tests.yml)
33

44

55
# A Purescript Client for the Web3 API
66

77
`purescript-web3` is a library for interacting with an ethereum node in purescript.
88

9-
Using [purescript-web3-generator](https://github.com/f-o-a-m/purescript-web3-generator) or [chanterelle](https://github.com/f-o-a-m/chanterelle) it is also possible (and recommended) to generate a library from a set of smart contract abis which is capable of templating transactions and event filters/watchers. The README has instructions for getting started.
9+
Using [purescript-web3-generator](../web3-generator/README.md) or [chanterelle](../chanterelle/README.md) it is also possible (and recommended) to generate a library from a set of smart contract abis which is capable of templating transactions and event filters/watchers. The README has instructions for getting started.
1010

11-
To see an example project, it is recommended to look at the [tests repository](https://github.com/f-o-a-m/purescript-web3-tests) (which uses Chanterelle)
12-
13-
## Build Instructions
14-
```
15-
> npm install
16-
> npm run build
17-
> docker run -d -p 8545:8545 -e ACCOUNTS_TO_CREATE=10 foamspace/cliquebait:v1.9.12
18-
> npm run test
19-
```
20-
21-
## Documentation
22-
23-
Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-web3).
11+
To see an example project, it is recommended to look at the [tests repository](../test) (which uses Chanterelle)
2412

2513
## Examples
2614

@@ -43,7 +31,7 @@ contract TupleStorage {
4331
}
4432
```
4533

46-
If we used [purescript-web3-generator](https://github.com/f-o-a-m/purescript-web3-generator), we are given a function with the following signature:
34+
If we used [purescript-web3-generator](../web3-generator/README.md), we are given a function with the following signature:
4735

4836
```purescript
4937
setTuple :: forall e.

0 commit comments

Comments
 (0)