ethers.js/packages/basex/README.md

32 lines
680 B
Markdown
Raw Permalink Normal View History

Base-X
2019-05-14 18:25:46 -04:00
======
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 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