ethers.js/packages/address/README.md

36 lines
821 B
Markdown
Raw Permalink Normal View History

2019-05-14 18:25:46 -04:00
Ethereum Address Utilities
==========================
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
2019-05-14 18:25:46 -04:00
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.
2019-05-14 18:25:46 -04:00
For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/address/).
2019-05-14 18:25:46 -04:00
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");
```
2019-05-14 18:25:46 -04:00
License
-------
MIT License