Skip to content

Commit

Permalink
Updated docs for all packages on npm pages (#1013).
Browse files Browse the repository at this point in the history
  • Loading branch information
ricmoo committed Aug 25, 2020
1 parent 8facc1a commit cb8f4a3
Show file tree
Hide file tree
Showing 35 changed files with 851 additions and 187 deletions.
47 changes: 41 additions & 6 deletions packages/abi/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,50 @@
Ethereum ABI Coder
==================

**EXPERIMENTAL**
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).

Please see the [ethers](https://github.com/ethers-io/ethers.js) repository
for more informations.
It is responsible for encoding and decoding the Application Binary Interface (ABI)
used by most smart contracts to interoperate between other smart contracts and clients.

API
---
For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/abi/).

`@TODO`
Importing
---------

Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.

```javascript
const {

ConstructorFragment,
EventFragment,
Fragment,
FunctionFragment,
ParamType,
FormatTypes,

AbiCoder,
defaultAbiCoder,

Interface,
Indexed,

/////////////////////////
// Types

CoerceFunc,
JsonFragment,
JsonFragmentType,

Result,
checkResultErrors,

LogDescription,
TransactionDescription

} = require("@ethersproject/abi");
```

License
-------
Expand Down
53 changes: 47 additions & 6 deletions packages/abstract-provider/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,56 @@
Abstract Provider
=================

**EXPERIMENTAL**
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).

Please see the [ethers](https://github.com/ethers-io/ethers.js) repository
for more informations.
It is responsible for defining the common interface for a Provider, which in
ethers differs quite substantially from Web3.js.

API
---
A Provider is an abstraction of non-account-based operations on a blockchain and
is generally not directly involved in signing transaction or data.

`@TODO`
For signing, see the [Abstract Signer](https://www.npmjs.com/package/@ethersproject/abstract-signer)
or [Wallet](https://www.npmjs.com/package/@ethersproject/wallet) sub-modules.

For more information, see the [documentation](https://docs.ethers.io/v5/api/providers/).

Importing
---------

Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.

```javascript
const {

Provider,

ForkEvent,
BlockForkEvent,
TransactionForkEvent,
TransactionOrderForkEvent,

// Types
BlockTag,

Block,
BlockWithTransactions,

TransactionRequest,
TransactionResponse,
TransactionReceipt,

Log,
EventFilter,

Filter,
FilterByBlockHash,

EventType,
Listener

} = require("@ethersproject/abstract-provider");
```

License
-------
Expand Down
29 changes: 23 additions & 6 deletions packages/abstract-signer/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,32 @@
Abstract Signer
===============

**EXPERIMENTAL**
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).

Please see the [ethers](https://github.com/ethers-io/ethers.js) repository
for more informations.
It is an abstraction of an Ethereum account, which may be backed by a [private key](https://www.npmjs.com/package/@ethersproject/wallet),
signing service (such as Geth or Parity with key managment enabled, or a
dedicated signing service such as Clef),
[hardware wallets](https://www.npmjs.com/package/@ethersproject/hardware-wallets), etc.

API
---
For more information, see the [documentation](https://docs.ethers.io/v5/api/signer/).

`@TODO`
Importing
---------

Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.

```javascript
const {

Signer,
VoidSigner,

// Types
ExternallyOwnedAccount

} = require("@ethersproject/abstract-signer");
```

License
-------
Expand Down
30 changes: 24 additions & 6 deletions packages/address/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,33 @@
Ethereum Address Utilities
==========================

**EXPERIMENTAL**
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).

Please see the [ethers](https://github.com/ethers-io/ethers.js) repository
for more informations.
It is responsible for encoding, verifying and computing checksums for
Ethereum addresses and computing special addresses, such as those
enerated by and for contracts under various situations.

API
---
For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/address/).

`@TODO`
Importing
---------

Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.

```javascript
const {

getAddress,
isAddress,

getIcapAddress,

getContractAddress,
getCreate2Address

} = require("@ethersproject/address");
```

License
-------
Expand Down
1 change: 1 addition & 0 deletions packages/asm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ Building
If you make changes to the `grammar.jison` file, make sure to run the `npm generate`
command to re-build the AST parser.


License
=======

Expand Down
1 change: 0 additions & 1 deletion packages/base64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ console.log(encodedData);
// "..."
```


License
=======

Expand Down
30 changes: 28 additions & 2 deletions packages/basex/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
Base X
Base-X
======

**EXPERIMENTAL**
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).

It is responsible for encoding and decoding vinary data in arbitrary bases, but
is primarily for Base58 encoding which is used for various blockchain data.

For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/encoding/).

Importing
---------

Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.

```javascript
const {

BaseX,

Base32,
Base58

} = require("@ethersproject/basex");
```

License
-------

MIT License
36 changes: 30 additions & 6 deletions packages/bignumber/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,39 @@
Big Numbers
===========

**EXPERIMENTAL**
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).

Please see the [ethers](https://github.com/ethers-io/ethers.js) repository
for more informations.
It is responsible for handling arbitrarily large numbers and mathematic operations.

API
---
For more information, see the documentation for [Big Numbers](https://docs.ethers.io/v5/api/utils/bignumber/)
and [Fixed-Point Numbers](https://docs.ethers.io/v5/api/utils/fixednumber/).


Importing
---------

Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.

```javascript
const {

BigNumber,

FixedFormat,
FixedNumber,

formatFixed,

parseFixed

// Types

BigNumberish

} = require("@ethersproject/bignumber");
```

`@TODO`

License
-------
Expand Down
63 changes: 55 additions & 8 deletions packages/bytes/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,62 @@
Byte Manipulation Libraries
===========================
Byte Manipulation
=================

**EXPERIMENTAL**
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).

Please see the [ethers](https://github.com/ethers-io/ethers.js) repository
for more informations.
It is responsible for manipulating binary data.

API
---
For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/bytes/).


Importing
---------

Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.

```javascript
const {

isBytesLike,
isBytes,

arrayify,

concat,

stripZeros,
zeroPad,

isHexString,
hexlify,

hexDataLength,
hexDataSlice,
hexConcat,

hexValue,

hexStripZeros,
hexZeroPad,

splitSignature,
joinSignature,

// Types

Bytes,
BytesLike,

DataOptions,

Hexable,

SignatureLike,
Signature

} = require("@ethersproject/bytes");
```

`@TODO`

License
-------
Expand Down
1 change: 1 addition & 0 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ and debug Ethereum-related tasks using the ethers.js library.

-----


Sandbox Utility
===============

Expand Down
Loading

0 comments on commit cb8f4a3

Please sign in to comment.