Skip to content

Commit

Permalink
Add simple documentation of constants (#34)
Browse files Browse the repository at this point in the history
* Add simple documentation of constants

Not sure if it's necessary to document every constant in README, so I simply mention the existence of `constants` and link it to the actual module.

* Document constants

* Fix spacing in document
  • Loading branch information
kingdido999 authored and Francisco Giordano committed May 2, 2019
1 parent 8a2de42 commit e2df932
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,23 @@ A [bn.js](https://github.com/indutny/bn.js) object. Use `new BN(number)` to crea

---

### constants
A collection of useful [constants](src/constants.js).

#### constants.ZERO_ADDRESS
The initial value of a type `address` variable, i.e., `address(0)` in Solidity.

#### constants.MAX_UINT256
The maximum unsigned integer `2^256 - 1` represented in `BN`.

#### constants.MAX_INT256
The maximum signed integer `2^255 - 1` represented in `BN`.

#### constants.MIN_INT256
The minimum signed integer `-2^255` represented in `BN`.

---

### ether
Converts a value in Ether to wei.

Expand Down

0 comments on commit e2df932

Please sign in to comment.