Skip to content

Latest commit

 

History

History
580 lines (355 loc) · 9.34 KB

web3-eth-iban.rst

File metadata and controls

580 lines (355 loc) · 9.34 KB

web3.eth.Iban

The web3.eth.Iban function lets convert Ethereum addresses from and to IBAN and BBAN.

Iban instance

This's instance of Iban

> Iban { _iban: 'XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS' }

Iban contructor

new web3.eth.Iban(ibanAddress)

Generates a iban object with conversion methods and validity checks. Also has singleton functions for conversion like :ref:`Iban.toAddress() <_eth-iban-toaddress>`, :ref:`Iban.toIban() <_eth-iban-toiban>`, :ref:`Iban.fromAddress() <_eth-iban-fromaddress>`, :ref:`Iban.fromBban() <_eth-iban-frombban>`, :ref:`Iban.createIndirect() <_eth-iban-createindirect>`, :ref:`Iban.isValid() <_eth-iban-isvalid>`.

Parameters

  1. String: the IBAN address to instantiate an Iban instance from.

Returns

Object - The Iban instance.

Example

var iban = new web3.eth.Iban("XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS");
> Iban { _iban: 'XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS' }

toAddress

static function
web3.eth.Iban.toAddress(ibanAddress)

Singleton: Converts a direct IBAN address into an Ethereum address.

Note

This method also exists on the IBAN instance.

Parameters

  1. String: the IBAN address to convert.

Returns

String - The Ethereum address.

Example

web3.eth.Iban.toAddress("XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS");
> "0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8"

toIban

static function
web3.eth.Iban.toIban(address)

Singleton: Converts an Ethereum address to a direct IBAN address.

Parameters

  1. String: the Ethereum address to convert.

Returns

String - The IBAN address.

Example

web3.eth.Iban.toIban("0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8");
> "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"
static function, return IBAN instance

fromAddress

web3.eth.Iban.fromAddress(address)

Singleton: Converts an Ethereum address to a direct IBAN instance.

Parameters

  1. String: the Ethereum address to convert.

Returns

Object - The IBAN instance.

Example

web3.eth.Iban.fromAddress("0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8");
> Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
static function, return IBAN instance

fromBban

web3.eth.Iban.fromBban(bbanAddress)

Singleton: Converts an BBAN address to a direct IBAN instance.

Parameters

  1. String: the BBAN address to convert.

Returns

Object - The IBAN instance.

Example

web3.eth.Iban.fromBban('ETHXREGGAVOFYORK');
> Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
static function, return IBAN instance

createIndirect

web3.eth.Iban.createIndirect(options)

Singleton: Creates an indirect IBAN address from a institution and identifier.

Parameters

  1. Object: the options object as follows:
    • institution - String: the institution to be assigned
    • identifier - String: the identifier to be assigned

Returns

Object - The IBAN instance.

Example

web3.eth.Iban.createIndirect({
    institution: "XREG",
    identifier: "GAVOFYORK"
});
> Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
static function, return boolean

isValid

web3.eth.Iban.isValid(ibanAddress)

Singleton: Checks if an IBAN address is valid.

Note

This method also exists on the IBAN instance.

Parameters

  1. String: the IBAN address to check.

Returns

Boolean

Example

web3.eth.Iban.isValid("XE81ETHXREGGAVOFYORK");
> true

web3.eth.Iban.isValid("XE82ETHXREGGAVOFYORK");
> false // because the checksum is incorrect

prototype.isValid

method of Iban instance
web3.eth.Iban.prototype.isValid()

Singleton: Checks if an IBAN address is valid.

Note

This method also exists on the IBAN instance.

Parameters

  1. String: the IBAN address to check.

Returns

Boolean

Example

var iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
iban.isValid();
> true

prototype.isDirect

method of Iban instance
web3.eth.Iban.prototype.isDirect()

Checks if the IBAN instance is direct.

Parameters

none

Returns

Boolean

Example

var iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
iban.isDirect();
> false

prototype.isIndirect

method of Iban instance
web3.eth.Iban.prototype.isIndirect()

Checks if the IBAN instance is indirect.

Parameters

none

Returns

Boolean

Example

var iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
iban.isIndirect();
> true

prototype.checksum

method of Iban instance
web3.eth.Iban.prototype.checksum()

Returns the checksum of the IBAN instance.

Parameters

none

Returns

String: The checksum of the IBAN

Example

var iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
iban.checksum();
> "81"

prototype.institution

method of Iban instance
web3.eth.Iban.prototype.institution()

Returns the institution of the IBAN instance.

Parameters

none

Returns

String: The institution of the IBAN

Example

var iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
iban.institution();
> 'XREG'

prototype.client

method of Iban instance
web3.eth.Iban.prototype.client()

Returns the client of the IBAN instance.

Parameters

none

Returns

String: The client of the IBAN

Example

var iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
iban.client();
> 'GAVOFYORK'

prototype.toAddress

method of Iban instance
web3.eth.Iban.prototype.toString()

Returns the Ethereum address of the IBAN instance.

Parameters

none

Returns

String: The Ethereum address of the IBAN

Example

var iban = new web3.eth.Iban('XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS');
iban.toAddress();
> '0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8'

prototype.toString

method of Iban instance
web3.eth.Iban.prototype.toString()

Returns the IBAN address of the IBAN instance.

Parameters

none

Returns

String: The IBAN address.

Example

var iban = new web3.eth.Iban('XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS');
iban.toString();
> 'XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS'