ethers.js/packages/basex/README.md
2020-08-25 01:09:48 -04:00

32 lines
680 B
Markdown

Base-X
======
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