web3-eth-iban

What is web3-eth-iban?

The web3-eth-iban npm package is a utility for handling IBAN (International Bank Account Number) addresses in the context of Ethereum. It allows for the conversion between IBAN and Ethereum addresses, validation of IBAN addresses, and other related functionalities.

What are web3-eth-iban's main functionalities?

Convert Ethereum address to IBAN

This feature allows you to convert a standard Ethereum address to an IBAN address. The code sample demonstrates how to use the `toIban` method to achieve this.

const Web3EthIban = require('web3-eth-iban');
const iban = Web3EthIban.toIban('0x1234567890123456789012345678901234567890');
console.log(iban);

Convert IBAN to Ethereum address

This feature allows you to convert an IBAN address back to a standard Ethereum address. The code sample demonstrates how to use the `toAddress` method to achieve this.

const Web3EthIban = require('web3-eth-iban');
const address = Web3EthIban.toAddress('XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS');
console.log(address);

Validate IBAN address

This feature allows you to validate whether a given IBAN address is valid. The code sample demonstrates how to use the `isValid` method to achieve this.

const Web3EthIban = require('web3-eth-iban');
const isValid = Web3EthIban.isValid('XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS');
console.log(isValid);

Other packages similar to web3-eth-iban

ethereumjs-util

The ethereumjs-util package provides a variety of utility functions for Ethereum, including address manipulation and validation. While it does not specifically handle IBAN addresses, it offers a broader range of utilities for Ethereum development.

web3-utils

The web3-utils package is part of the Web3.js library and provides various utility functions for Ethereum, such as address validation, conversion, and formatting. Similar to ethereumjs-util, it does not focus on IBAN addresses but offers a wide array of general-purpose utilities.

README

web3.js - IBAN

This is a sub-package of web3.js.

web3-eth-iban This package converts Ethereum addresses to IBAN addresses a vice versa.

Installation

You can install the package either using NPM or using Yarn

Using NPM

npm install web3-eth-iban

Using Yarn

yarn add web3-eth-iban

Getting Started

• :writing_hand: If you have questions submit an issue or join us on Discord

Prerequisites

• :gear: NodeJS (LTS/Fermium)
• :toolbox: Yarn/Lerna

Package.json Scripts

Script	Description
clean	Uses rimraf to remove dist/
build	Uses tsc to build package and dependent packages
lint	Uses eslint to lint package
lint:fix	Uses eslint to check and fix any warnings
format	Uses prettier to format the code
test	Uses jest to run unit tests
test:integration	Uses jest to run tests under /test/integration
test:unit	Uses jest to run tests under /test/unit