xdc-web/packages/web3-eth-iban/README.md

XinFin JavaScript API wrapper repository

# web3-eth-iban

This is a sub package of [web3.js][repo]

This is the IBAN package to be used in the `web3-eth` package.
Please read the [documentation][docs] for more.

## Installation

### Node.js

```bash
npm install web3-eth-iban
```

### In the Browser

Build running the following in the [web3.js][repo] repository:

```bash
npm run-script build-all
```

Then include `dist/web3-eth-iban.js` in your html file.
This will expose the `Web3EthIban` object on the window object.


## Usage

```js
// in node.js
var Web3EthIban = require('web3-eth-iban');

var iban = new Web3EthIban('XE75JRZCTTLBSYEQBGAS7GID8DKR7QY0QA3');
iban.toAddress()
> '0xa94f5374Fce5edBC8E2a8697C15331677e6EbF0B'
```


[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js