Updated docs for all packages on npm pages (#1013).

This commit is contained in:
Richard Moore 2020-08-25 01:09:48 -04:00
parent 8facc1a530
commit cb8f4a3a4e
No known key found for this signature in database
GPG Key ID: 665176BE8E9DC651
35 changed files with 851 additions and 187 deletions

@ -1,15 +1,50 @@
Ethereum ABI Coder 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 It is responsible for encoding and decoding the Application Binary Interface (ABI)
for more informations. 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 License
------- -------

@ -1,15 +1,56 @@
Abstract Provider 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 It is responsible for defining the common interface for a Provider, which in
for more informations. 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 License
------- -------

@ -1,15 +1,32 @@
Abstract Signer 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 It is an abstraction of an Ethereum account, which may be backed by a [private key](https://www.npmjs.com/package/@ethersproject/wallet),
for more informations. 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 License
------- -------

@ -1,15 +1,33 @@
Ethereum Address Utilities 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 It is responsible for encoding, verifying and computing checksums for
for more informations. 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 License
------- -------

@ -205,6 +205,7 @@ Building
If you make changes to the `grammar.jison` file, make sure to run the `npm generate` If you make changes to the `grammar.jison` file, make sure to run the `npm generate`
command to re-build the AST parser. command to re-build the AST parser.
License License
======= =======

@ -29,7 +29,6 @@ console.log(encodedData);
// "..." // "..."
``` ```
License License
======= =======

@ -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

@ -1,15 +1,39 @@
Big Numbers 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 It is responsible for handling arbitrarily large numbers and mathematic operations.
for more informations.
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 License
------- -------

@ -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 It is responsible for manipulating binary data.
for more informations.
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 License
------- -------

@ -12,6 +12,7 @@ and debug Ethereum-related tasks using the ethers.js library.
----- -----
Sandbox Utility Sandbox Utility
=============== ===============

@ -1,15 +1,37 @@
Etehreum Constants Etehreum Constants
================== ==================
**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 It contains many frequently used constants when dealing with Ethereum.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/constants/).
---
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 {
AddressZero,
HashZero,
EtherSymbol,
NegativeOne,
Zero,
One,
Two,
WeiPerEther,
MaxUint256
} = require("@ethersproject/constants");
```
`@TODO`
License License
------- -------

@ -1,15 +1,50 @@
Ethereum Contract Meta-Class Ethereum Contract Meta-Class
============================ ============================
**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 It is creating (at run-time) an object which interacts with an on-chain
for more informations. contract as a native JavaScript object.
API If you are familiar with ORM for Databases, this is similar, but for smart contracts.
---
For more information, see the [documentation](https://docs.ethers.io/v5/api/contract/).
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 {
Contract,
ContractFactory,
RunningEvent,
// Types
ContractInterface,
Overrides,
PayableOverrides,
CallOverrides,
PopulatedTransaction,
EventFilter,
ContractFunction,
Event,
ContractReceipt,
ContractTransaction
} = require("@ethersproject/contract");
```
`@TODO`
License License
------- -------

@ -1,15 +1,32 @@
Etheruem Hash Utilities Etheruem Hash 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 It contains several common hashing utilities (but not the actual hash functions).
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/hashing/).
---
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 {
isValidName,
namehash,
id,
messagePrefix,
hashMessage
} = require("@ethersproject/hash");
```
`@TODO`
License License
------- -------

@ -1,15 +1,38 @@
Hierarchal Deterministic Utilities (BIP32) Hierarchal Deterministic Utilities (BIP32)
========================================== ==========================================
**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 It is responsible computing, deriving, encoding and decoding Hierarchal-Deterministic
for more informations. private keys.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/hdnode/).
---
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 {
HDNode,
defaultPath,
mnemonicToSeed,
mnemonicToEntropy,
entropyToMnemonic,
isValidMnemonic,
// Types
Mnemonic
} = require("@ethersproject/hdnode");
```
`@TODO`
License License
------- -------

@ -1,15 +1,45 @@
Secret Storage JSON Wallet Utilities Secret Storage JSON Wallet 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 It is responsible for encoding, decoding, encrypting and decrypting JSON wallet
for more informations. formats.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/).
---
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 {
isCrowdsaleWallet,
decryptCrowdsale,
isKeystoreWallet,
decryptKeystore,
decryptKeystoreSync,
encryptKeystore,
getJsonWalletAddress,
decryptJsonWallet,
decryptJsonWalletSync,
// Types
ProgressCallback,
EncryptOptions
} = require("@ethersproject/json-wallets");
```
`@TODO`
License License
------- -------

@ -1,15 +1,27 @@
KECCAK256 Hash Function KECCAK256 Hash Function
======================= =======================
**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 It is responsible for the identify function (i.e. KECCAK256) use in Ethereum.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/hashing/#utils-keccak256).
---
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 {
keccak256
} = require("@ethersproject/keccak256");
```
`@TODO`
License License
------- -------

@ -1,7 +1,33 @@
Logger Logger
====== ======
@TODO: This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
It is responsible for managing logging and errors to maintain a standard
structure.
For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/logger/).
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 {
Logger,
// Enums
ErrorCode,
LogLevel,
} = require("@ethersproject/logger");
```
License License
------- -------

@ -1,15 +1,32 @@
Ethereum (and ilk) Network Definitions Ethereum (and ilk) Network Definitions
====================================== ======================================
**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 It is responsible for tracking common networks along with important
for more informations. parameters for each.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/providers/types/#providers-Network).
---
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 {
getNetwork,
// Types
Network,
Networkish
} = require("@ethersproject/networks");
```
`@TODO`
License License
------- -------

@ -1,15 +1,26 @@
Password-Based Key Derivation Function 2 (pbkdf2) Password-Based Key Derivation Function 2 (pbkdf2)
================================================= =================================================
**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 It contains the PBKDF2 function.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/).
---
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 {
pbkdf2
} = require("@ethersproject/pbkdf2");
```
`@TODO`
License License
------- -------

@ -1,15 +1,42 @@
Property Utilities Property 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 It contains several useful utility methods for managing simple objects with
for more informations. defined properties.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/properties/).
---
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 {
defineReadOnly,
getStatic,
resolveProperties,
checkProperties,
shallowCopy,
deepCopy,
Description,
// Types
Deferrable
} = require("@ethersproject/properties");
```
`@TODO`
License License
------- -------

@ -1,15 +1,76 @@
Ethereum Providers Ethereum Providers
================== ==================
**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 It contains common Provider classes, utility functions for dealing with providers
for more informations. and re-exports many of the classes and types needed implement a custom Provider.
API 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,
BaseProvider,
JsonRpcProvider,
StaticJsonRpcProvider,
UrlJsonRpcProvider,
FallbackProvider,
AlchemyProvider,
CloudflareProvider,
EtherscanProvider,
InfuraProvider,
NodesmithProvider,
IpcProvider,
Web3Provider,
WebSocketProvider,
JsonRpcSigner,
getDefaultProvider,
getNetwork,
Formatter,
// Types
TransactionReceipt,
TransactionRequest,
TransactionResponse,
Listener,
ExternalProvider,
Block,
BlockTag,
EventType,
Filter,
Log,
JsonRpcFetchFunc,
Network,
Networkish
} = require("@ethersproject/providers");
```
`@TODO`
License License
------- -------

@ -1,15 +1,29 @@
Random Value Utilities Random Value 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 It contains functions to assist with random numbers.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/bytes/#byte-manipulation--random-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 {
shuffled,
randomBytes
} = require("@ethersproject/random");
```
`@TODO`
License License
------- -------

@ -1,15 +1,28 @@
Recursive-Length Prefix Coder Recursive-Length Prefix 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 It contains functions for encoding and decoding RLP data.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/encoding/#rlp--methods).
---
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 {
encode,
decode
} = require("@ethersproject/rlp");
```
`@TODO`
License License
------- -------

@ -1,15 +1,36 @@
SHA2 Hash Functions SHA2 Hash Functions
=================== ===================
**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 It is responsible for common cryptographic hashes and HMAC.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/hashing/).
---
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 {
ripemd160,
sha256,
sha512,
computeHmac,
// Enums
SupportedAlgorithm
} = require("@ethersproject/sha2");
```
`@TODO`
License License
------- -------

@ -1,15 +1,7 @@
Compatibility Shims (for constrained environments) Compatibility Shims (for constrained environments)
================================================== ==================================================
**EXPERIMENTAL** Common shims to fix incomplete environments.
Please see the [ethers](https://github.com/ethers-io/ethers.js) repository
for more informations.
API
---
`@TODO`
License License
------- -------

@ -1,5 +1,30 @@
Signing Key Signing Key
=========== ===========
**EXPERIMENTAL** This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
It is responsible for secp256-k1 signing, verifying and recovery operations.
For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/signing-key/).
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 {
SigningKey,
computePublicKey,
recoverPublicKey
} = require("@ethersproject/signing-key");
```
License
-------
MIT License

@ -1,15 +1,29 @@
Solidity Packed-Encoding Utilities Solidity Packed-Encoding 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 It contains functions to perform Solidity-specific packed (i.e. non-standard)
for more informations. encoding operations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/hashing/#utils--solidity-hashing).
---
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 {
pack,
keccak256,
sha256
} = require("@ethersproject/solidity");
```
`@TODO`
License License
------- -------

@ -1,15 +1,45 @@
String Manipulation Utilities String Manipulation 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 It contains functions to safely convert between UTF-8 data, strings and Bytes32 strings
for more informations. (i.e. "short strings").
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/strings/).
---
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 {
toUtf8Bytes,
toUtf8CodePoints,
toUtf8String,
formatBytes32String,
parseBytes32String,
nameprep
// Enums
Utf8ErrorFuncs,
Utf8ErrorReason,
UnicodeNormalizationForm
// Types
Utf8ErrorFunc,
} = require("@ethersproject/strings");
```
`@TODO`
License License
------- -------

@ -1,15 +1,12 @@
Testcases for Ethereum Testcases for Ethereum
====================== ======================
**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 It contains the testcases used to verify various Ethereum operations.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/testing/).
---
`@TODO`
License License
------- -------

@ -1,15 +1,11 @@
Mocha Test Suite for Ethers Mocha Test Suite for Ethers
=========================== ===========================
**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 It contains the tests to verify ethers is working correctly.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/testing/).
---
`@TODO`
License License
------- -------

@ -1,15 +1,36 @@
Ethereum Transaction Utilities Ethereum Transaction 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 It contains various functions for encoding and decoding serialized transactios.
for more informations.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/transactions/).
---
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 {
computeAddress,
recoverAddress,
serialize,
parse,
// Types
Transaction,
UnsignedTransaction
} = require("@ethersproject/abi");
```
`@TODO`
License License
------- -------

@ -1,15 +1,34 @@
Ethereum Unit Conversion Utilities Ethereum Unit Conversion 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 It contains functions to convert between string representations and numeric
for more informations. representations of numbers, including those out of the range of JavaScript.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/display-logic/).
---
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 {
formatUnits,
parseUnits,
formatEther,
parseEther,
commify
} = require("@ethersproject/units");
```
`@TODO`
License License
------- -------

@ -1,15 +1,30 @@
Ethereum Wallet Ethereum Wallet
=============== ===============
**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 It contains the class to manage a private key and signing for a standard
for more informations. externally-owned account.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/signer/#Wallet).
---
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 {
Wallet,
verifyMessage
} = require("@ethersproject/wallet");
```
`@TODO`
License License
------- -------

@ -1,15 +1,37 @@
Web Utilities Web 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 It contains functions to abstract safely and responsibly connecting to the web,
for more informations. including exponential back-off.
API For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/web/).
---
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 {
fetchJson,
poll,
// Types
ConnectionInfo,
FetchJsonResponse,
PollOptions,
OncePollable,
OnceBlockable
} = require("@ethersproject/web");
```
`@TODO`
License License
------- -------

@ -1,9 +1,10 @@
BIP39 Wordlists BIP39 Wordlists
=============== ===============
**EXPERIMENTAL** This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
Supported Languages: Supported Languages:
- **en** - English - **en** - English
- **es** - Spanish - **es** - Spanish
- **fr** - French - **fr** - French
@ -13,13 +14,8 @@ Supported Languages:
- **zh_cn** - Chinese (simplified) - **zh_cn** - Chinese (simplified)
- **zh_tw** - Chinese (traditional) - **zh_tw** - Chinese (traditional)
Please see the [ethers](https://github.com/ethers-io/ethers.js) repository For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/wordlists/).
for more informations.
API
---
`@TODO`
Browser Browser
------- -------
@ -28,7 +24,6 @@ In the browser distribution file, only the English word list is included in the
root `ethers` pacakge. To include additional word lists, they must be added using root `ethers` pacakge. To include additional word lists, they must be added using
additional `<script>` tags, **after** the root `ethers` library has been included. additional `<script>` tags, **after** the root `ethers` library has been included.
@TODO: Examples and links to wordlists
License License
------- -------