Skip to content

Commit

Permalink
Merge branch 'master' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick Dodson authored Mar 7, 2017
2 parents 36402b4 + 1793e7a commit faf0dbe
Show file tree
Hide file tree
Showing 22 changed files with 9,072 additions and 835 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ included in the project:

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/default.git
git clone https://github.com/<your-username>/ethjs-abi.git
# Navigate to the newly cloned directory
cd default
cd ethjs-abi
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/ethjs/ethjs-abi.git
```
Expand Down Expand Up @@ -113,7 +113,7 @@ included in the project:
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description.

**DESIGN NOTE**: default follows the UNIX programming philosophy. Please consider this before contributing, keep your commits/modules concise and to the point.
**DESIGN NOTE**: ethjs-abi follows the UNIX programming philosophy. Please consider this before contributing, keep your commits/modules concise and to the point.

Read more here:
http://www.catb.org/esr/writings/taoup/html/ch01s06.html
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Don't check auto-generated stuff into git
node_modules
coverage
lib

# Cruft
.DS_Store
Expand Down
41 changes: 41 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
# 0.1.7 -- handles empty address decode nicely

1. Handles decode of value [] -- '0x' nicely..

# 0.1.6 -- BN formatting update

1. BN formatting update

# 0.1.5 -- replace out sha3

1. Getting rid of `ethjs-sha3` for `js-sha3`

# 0.1.4 -- config fixes

1. Webpack config updates
2. Build config updates
3. Less deps
4. Better number handling

# 0.1.2 -- removal of BigNumber for BN

1. Removal of BigNumber for BN (see `user-guide` for more)
2. More docs
3. More coverage
4. package config fixes

# 0.0.5 -- complete BigNumber support

1. Complete BigNumber object support in and out
2. Fix bytes32 padding bug
3. More test coverage across the board
4. Better error handling
5. Package config updates

# 0.0.4 -- more adjustments, stronger typing

1. More adjustments
2. Stronger typing
3. More accepting convertions
4. More coverage

# 0.0.3 -- travis fix, better testing

1. Travic-CI fix
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project maintainer at [email protected]. All
reported by contacting the project maintainer at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. Maintainers are
obligated to maintain confidentiality with regard to the reporter of an
Expand Down
55 changes: 44 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,48 @@

Just method and event encoding and decoding from the [`ethers-wallet`](https://github.com/ethers-io/ethers-wallet).

Note, this package is experimental, incomplete and is under construction.
Note, this package is experimental, and is not ready for production use.

<div>
<!-- Dependency Status -->
<a href="https://david-dm.org/ethjs/ethjs-abi">
<img src="https://david-dm.org/ethjs/ethjs-abi.svg"
alt="Dependency Status" />
</a>

<!-- devDependency Status -->
<a href="https://david-dm.org/ethjs/ethjs-abi#info=devDependencies">
<img src="https://david-dm.org/ethjs/ethjs-abi/dev-status.svg" alt="devDependency Status" />
</a>

<!-- Build Status -->
<a href="https://travis-ci.org/ethjs/ethjs-abi">
<img src="https://travis-ci.org/ethjs/ethjs-abi.svg"
alt="Build Status" />
</a>

<!-- NPM Version -->
<a href="https://www.npmjs.org/package/ethjs-abi">
<img src="http://img.shields.io/npm/v/ethjs-abi.svg"
alt="NPM version" />
</a>

<!-- Test Coverage -->
<a href="https://coveralls.io/r/ethjs/ethjs-abi">
<img src="https://coveralls.io/repos/github/ethjs/ethjs-abi/badge.svg" alt="Test Coverage" />
</a>

<!-- Javascript Style -->
<a href="http://airbnb.io/javascript/">
<img src="https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg" alt="js-airbnb-style" />
</a>
</div>

<br />

## Usage

```
```js
const abi = require('ethjs-abi');
const SimpleStoreABI = [{"constant":false,"inputs":[{"name":"_value","type":"uint256"}],"name":"set","outputs":[{"name":"","type":"bool"}],"payable":false,"type":"function"},{"constant":false,"inputs":[],"name":"get","outputs":[{"name":"storeValue","type":"uint256"}],"payable":false,"type":"function"},{"anonymous":false,"inputs":[{"indexed":false,"name":"_newValue","type":"uint256"},{"indexed":false,"name":"_sender","type":"address"}],"name":"SetComplete","type":"event"}];

Expand Down Expand Up @@ -77,29 +114,25 @@ Just the encoding and decoding of contract data.

Please help better the ecosystem by submitting issues and pull requests to default. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.

<!--
## Guides

You'll find more detailed information on using default and tailoring it to your needs in our guides:
You'll find more detailed information on using `ethjs-abi` and tailoring it to your needs in our guides:

- [User guide](docs/user-guide.md) - Usage, configuration, FAQ and complementary tools.
- [Developer guide](docs/developer-guide.md) - Contributing to wafr and writing your own plugins & formatters.
-->
- [Developer guide](docs/developer-guide.md) - Contributing to `ethjs-abi` and writing your own code and coverage.

## Help out

There is always a lot of work to do, and will have many rules to maintain. So please help out in any way that you can:

<!-- - Create, enhance, and debug rules (see our guide to ["Working on rules"](./github/CONTRIBUTING.md)). -->
- Create, enhance, and debug ethjs rules (see our guide to ["Working on rules"](./github/CONTRIBUTING.md)).
- Improve documentation.
- Chime in on any open issue or pull request.
- Open new issues about your ideas for making stylelint better, and pull requests to show us how your idea works.
- Open new issues about your ideas for making `ethjs-abi` better, and pull requests to show us how your idea works.
- Add new tests to *absolutely anything*.
- Create or contribute to ecosystem tools, like the plugins for Atom and Sublime Text.
- Create or contribute to ecosystem tools, like modules for encoding or contracts.
- Spread the word.

Please consult our [Code of Conduct](CODE_OF_CONDUCT.md) docs before helping out.

We communicate via [issues](https://github.com/ethjs/ethjs-abi/issues) and [pull requests](https://github.com/ethjs/ethjs-abi/pulls).

## Important documents
Expand Down
Loading

0 comments on commit faf0dbe

Please sign in to comment.