web3ibn 4.0.7

package/lib/esm/iban.js

@@ -0,0 +1,361 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+import { toChecksumAddress, leftPad, hexToNumber } from 'web3-utils';
+import { isAddress } from 'web3-validator';
+import { InvalidAddressError } from 'web3-errors';
+/**
+ * Converts Ethereum addresses to IBAN or BBAN addresses and vice versa.
+ */
+export class Iban {
+    /**
+     * Construct a direct or indirect IBAN that has conversion methods and validity checks.
+     * If the provided string was not of either the length of a direct IBAN (34 or 35),
+     * nor the length of an indirect IBAN (20), an Error will be thrown ('Invalid IBAN was provided').
+     *
+     * @param iban - a Direct or an Indirect IBAN
+     * @returns - Iban instance
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS");
+     * > Iban { _iban: 'XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS' }
+     * ```
+     */
+    constructor(iban) {
+        /**
+         * This method should be used to create the equivalent ethereum address for the early provided Direct IBAN address.
+         * If the provided string was not a direct IBAN (has the length of 34 or 35), an Error will be thrown:
+         * ('Iban is indirect and cannot be converted. Must be length of 34 or 35').
+         * Note: this is also available as a static method.
+         *
+         * @return the equivalent ethereum address
+         *
+         * @example
+         * ```ts
+         * const iban = new web3.eth.Iban("XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS");
+         * iban.toAddress();
+         * > "0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8"
+         * ```
+         */
+        this.toAddress = () => {
+            if (this.isDirect()) {
+                // check if Iban can be converted to an address
+                const base36 = this._iban.slice(4);
+                const parsedBigInt = Iban._parseInt(base36, 36); // convert the base36 string to a bigint
+                const paddedBigInt = leftPad(parsedBigInt, 40);
+                return toChecksumAddress(paddedBigInt);
+            }
+            throw new Error('Iban is indirect and cannot be converted. Must be length of 34 or 35');
+        };
+        if (Iban.isIndirect(iban) || Iban.isDirect(iban)) {
+            this._iban = iban;
+        }
+        else {
+            throw new Error('Invalid IBAN was provided');
+        }
+    }
+    /**
+     * A static method that checks if an IBAN is Direct.
+     * It actually check the length of the provided variable and, only if it is 34 or 35, it returns true.
+     * Note: this is also available as a method at an Iban instance.
+     * @param iban - an IBAN to be checked
+     * @returns - `true` if the provided `iban` is a Direct IBAN, and `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.isDirect("XE81ETHXREGGAVOFYORK");
+     * > false
+     * ```
+     */
+    static isDirect(iban) {
+        return iban.length === 34 || iban.length === 35;
+    }
+    /**
+     * An instance method that checks if iban number is Direct.
+     * It actually check the length of the provided variable and, only if it is 34 or 35, it returns true.
+     * Note: this is also available as a static method.
+     * @param iban - an IBAN to be checked
+     * @returns - `true` if the provided `iban` is a Direct IBAN, and `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.isDirect();
+     * > false
+     * ```
+     */
+    isDirect() {
+        return Iban.isDirect(this._iban);
+    }
+    /**
+     * A static method that checks if an IBAN is Indirect.
+     * It actually check the length of the provided variable and, only if it is 20, it returns true.
+     * Note: this is also available as a method at an Iban instance.
+     * @param iban - an IBAN to be checked
+     * @returns - `true` if the provided `iban` is an Indirect IBAN, and `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.isIndirect("XE81ETHXREGGAVOFYORK");
+     * > true
+     * ```
+     */
+    static isIndirect(iban) {
+        return iban.length === 20;
+    }
+    /**
+     * check if iban number if indirect
+     * It actually check the length of the provided variable and, only if it is 20, it returns true.
+     * Note: this is also available as a static method.
+     * @param iban - an IBAN to be checked
+     * @returns - `true` if the provided `iban` is an Indirect IBAN, and `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.isIndirect();
+     * > true
+     * ```
+     */
+    isIndirect() {
+        return Iban.isIndirect(this._iban);
+    }
+    /**
+     * This method could be used to check if a given string is valid IBAN object.
+     * Note: this is also available as a method at an Iban instance.
+     *
+     * @param iban - a string to be checked if it is in IBAN
+     * @returns - true if it is valid IBAN
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.isValid("XE81ETHXREGGAVOFYORK");
+     * > true
+     *
+     * web3.eth.Iban.isValid("XE82ETHXREGGAVOFYORK");
+     * > false // because the checksum is incorrect
+     * ```
+     */
+    static isValid(iban) {
+        return (/^XE[0-9]{2}(ETH[0-9A-Z]{13}|[0-9A-Z]{30,31})$/.test(iban) &&
+            Iban._mod9710(Iban._iso13616Prepare(iban)) === 1);
+    }
+    /**
+     * Should be called to check if the early provided IBAN is correct.
+     * Note: this is also available as a static method.
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.isValid();
+     * > true
+     *
+     * const iban = new web3.eth.Iban("XE82ETHXREGGAVOFYORK");
+     * iban.isValid();
+     * > false // because the checksum is incorrect
+     * ```
+     */
+    isValid() {
+        return Iban.isValid(this._iban);
+    }
+    /**
+     * Convert the passed BBAN to an IBAN for this country specification.
+     * Please note that <i>"generation of the IBAN shall be the exclusive responsibility of the bank/branch servicing the account"</i>.
+     * This method implements the preferred algorithm described in http://en.wikipedia.org/wiki/International_Bank_Account_Number#Generating_IBAN_check_digits
+     *
+     * @param bban - the BBAN to convert to IBAN
+     * @returns an Iban class instance that holds the equivalent IBAN
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.fromBban('ETHXREGGAVOFYORK');
+     * > Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
+     * ```
+     */
+    static fromBban(bban) {
+        const countryCode = 'XE';
+        const remainder = this._mod9710(this._iso13616Prepare(`${countryCode}00${bban}`));
+        const checkDigit = `0${(98 - remainder).toString()}`.slice(-2);
+        return new Iban(`${countryCode}${checkDigit}${bban}`);
+    }
+    /**
+     * Should be used to create IBAN object for given institution and identifier
+     *
+     * @param options - an object holds the `institution` and the `identifier` which will be composed to create an `Iban` object from.
+     * @returns an Iban class instance that holds the equivalent IBAN
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.createIndirect({
+     *     institution: "XREG",
+     *     identifier: "GAVOFYORK"
+     * });
+     * > Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
+     * ```
+     */
+    static createIndirect(options) {
+        return Iban.fromBban(`ETH${options.institution}${options.identifier}`);
+    }
+    /**
+     * This method should be used to create iban object from an Ethereum address.
+     *
+     * @param address - an Ethereum address
+     * @returns an Iban class instance that holds the equivalent IBAN
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.fromAddress("0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8");
+     * > Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
+     * ```
+     */
+    static fromAddress(address) {
+        if (!isAddress(address)) {
+            throw new InvalidAddressError(address);
+        }
+        const num = BigInt(hexToNumber(address));
+        const base36 = num.toString(36);
+        const padded = leftPad(base36, 15);
+        return Iban.fromBban(padded.toUpperCase());
+    }
+    /**
+     * This method should be used to create IBAN address from an Ethereum address
+     *
+     * @param address - an Ethereum address
+     * @return the equivalent IBAN address
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.toIban("0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8");
+     * > "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"
+     * ```
+     */
+    static toIban(address) {
+        return Iban.fromAddress(address).toString();
+    }
+    /**
+     * Should be called to get client identifier within institution
+     *
+     * @return the client of the IBAN instance.
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.client();
+     * > 'GAVOFYORK'
+     * ```
+     */
+    client() {
+        return this.isIndirect() ? this._iban.slice(11) : '';
+    }
+    /**
+     * Returns the IBAN checksum of the early provided IBAN
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.checksum();
+     * > "81"
+     * ```
+     *
+     */
+    checksum() {
+        return this._iban.slice(2, 4);
+    }
+    /**
+     * Returns institution identifier from the early provided  IBAN
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.institution();
+     * > 'XREG'
+     * ```
+     */
+    institution() {
+        return this.isIndirect() ? this._iban.slice(7, 11) : '';
+    }
+    /**
+     * Simply returns the early provided IBAN
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban('XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS');
+     * iban.toString();
+     * > 'XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS'
+     * ```
+     */
+    toString() {
+        return this._iban;
+    }
+}
+/**
+ * Prepare an IBAN for mod 97 computation by moving the first 4 chars to the end and transforming the letters to
+ * numbers (A = 10, B = 11, ..., Z = 35), as specified in ISO13616.
+ */
+Iban._iso13616Prepare = (iban) => {
+    const A = 'A'.charCodeAt(0);
+    const Z = 'Z'.charCodeAt(0);
+    const upperIban = iban.toUpperCase();
+    const modifiedIban = `${upperIban.slice(4)}${upperIban.slice(0, 4)}`;
+    return modifiedIban
+        .split('')
+        .map(n => {
+        const code = n.charCodeAt(0);
+        if (code >= A && code <= Z) {
+            // A = 10, B = 11, ... Z = 35
+            return code - A + 10;
+        }
+        return n;
+    })
+        .join('');
+};
+/**
+ * return the bigint of the given string with the specified base
+ */
+Iban._parseInt = (str, base) => [...str].reduce((acc, curr) => BigInt(parseInt(curr, base)) + BigInt(base) * acc, BigInt(0));
+/**
+ * Calculates the MOD 97 10 of the passed IBAN as specified in ISO7064.
+ */
+Iban._mod9710 = (iban) => {
+    let remainder = iban;
+    let block;
+    while (remainder.length > 2) {
+        block = remainder.slice(0, 9);
+        remainder = `${(parseInt(block, 10) % 97).toString()}${remainder.slice(block.length)}`;
+    }
+    return parseInt(remainder, 10) % 97;
+};
+/**
+ * This method should be used to create an ethereum address from a Direct IBAN address.
+ * If the provided string was not a direct IBAN (has the length of 34 or 35), an Error will be thrown:
+ * ('Iban is indirect and cannot be converted. Must be length of 34 or 35').
+ * Note: this is also available as a method at an Iban instance.
+ *
+ * @param iban - a Direct IBAN address
+ * @return the equivalent ethereum address
+ *
+ * @example
+ * ```ts
+ * web3.eth.Iban.toAddress("XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS");
+ * > "0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8"
+ * ```
+ */
+Iban.toAddress = (iban) => {
+    const ibanObject = new Iban(iban);
+    return ibanObject.toAddress();
+};
+//# sourceMappingURL=iban.js.map

package/lib/esm/iban.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iban.js","sourceRoot":"","sources":["../../src/iban.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;EAeE;AAGF,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAGlD;;GAEG;AACH,MAAM,OAAO,IAAI;IAmKhB;;;;;;;;;;;;;OAaG;IACH,YAAmB,IAAY;QA6F/B;;;;;;;;;;;;;;WAcG;QACI,cAAS,GAAG,GAAc,EAAE;YAClC,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;gBACpB,+CAA+C;gBAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,wCAAwC;gBACzF,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAC/C,OAAO,iBAAiB,CAAC,YAAY,CAAC,CAAC;aACvC;YACD,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QACzF,CAAC,CAAC;QApHD,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACjD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SAClB;aAAM;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC7C;IACF,CAAC;IApID;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY;QAClC,OAAO,IAAI,CAAC,MAAM,KAAK,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,QAAQ;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,UAAU,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,MAAM,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,UAAU;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,OAAO,CAAC,IAAY;QACjC,OAAO,CACN,+CAA+C,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAChD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,OAAO;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAwBD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY;QAClC,MAAM,WAAW,GAAG,IAAI,CAAC;QAEzB,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,WAAW,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QAClF,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/D,OAAO,IAAI,IAAI,CAAC,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,cAAc,CAAC,OAAoB;QAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,WAAW,CAAC,OAAkB;QAC3C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;YACxB,MAAM,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;SACvC;QAED,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5C,CAAC;IAgDD;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,MAAM,CAAC,OAAkB;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM;QACZ,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACtD,CAAC;IAED;;;;;;;;;;OAUG;IACI,QAAQ;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW;QACjB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;IACI,QAAQ;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;;AA9WD;;;GAGG;AACqB,qBAAgB,GAAG,CAAC,IAAY,EAAU,EAAE;IACnE,MAAM,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC5B,MAAM,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAE5B,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACrC,MAAM,YAAY,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;IAErE,OAAO,YAAY;SACjB,KAAK,CAAC,EAAE,CAAC;SACT,GAAG,CAAC,CAAC,CAAC,EAAE;QACR,MAAM,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE;YAC3B,6BAA6B;YAC7B,OAAO,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;SACrB;QACD,OAAO,CAAC,CAAC;IACV,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CAAC;AACZ,CAAC,CAAC;AAEF;;GAEG;AACqB,cAAS,GAAG,CAAC,GAAW,EAAE,IAAY,EAAU,EAAE,CACzE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,CACd,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,EAChE,MAAM,CAAC,CAAC,CAAC,CACT,CAAC;AAEH;;GAEG;AACqB,aAAQ,GAAG,CAAC,IAAY,EAAU,EAAE;IAC3D,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,KAAK,CAAC;IAEV,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;QAC5B,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,SAAS,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;KACvF;IAED,OAAO,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC;AACrC,CAAC,CAAC;AAyMF;;;;;;;;;;;;;;GAcG;AACW,cAAS,GAAG,CAAC,IAAY,EAAa,EAAE;IACrD,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,OAAO,UAAU,CAAC,SAAS,EAAE,CAAC;AAC/B,CAAC,CAAC"}

package/lib/esm/index.js

@@ -0,0 +1,21 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+import { Iban } from './iban.js';
+export * from './iban.js';
+export * from './types.js';
+export default Iban;
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;EAeE;AAEF,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAE3B,eAAe,IAAI,CAAC"}

package/lib/esm/package.json

@@ -0,0 +1 @@
+{"type": "module"}

package/lib/esm/types.js

@@ -0,0 +1,18 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+export {};
+//# sourceMappingURL=types.js.map

package/lib/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;EAeE"}

package/lib/types/iban.d.ts

@@ -0,0 +1,264 @@
+import { HexString } from 'web3-types';
+import { IbanOptions } from './types.js';
+/**
+ * Converts Ethereum addresses to IBAN or BBAN addresses and vice versa.
+ */
+export declare class Iban {
+    private readonly _iban;
+    /**
+     * Prepare an IBAN for mod 97 computation by moving the first 4 chars to the end and transforming the letters to
+     * numbers (A = 10, B = 11, ..., Z = 35), as specified in ISO13616.
+     */
+    private static readonly _iso13616Prepare;
+    /**
+     * return the bigint of the given string with the specified base
+     */
+    private static readonly _parseInt;
+    /**
+     * Calculates the MOD 97 10 of the passed IBAN as specified in ISO7064.
+     */
+    private static readonly _mod9710;
+    /**
+     * A static method that checks if an IBAN is Direct.
+     * It actually check the length of the provided variable and, only if it is 34 or 35, it returns true.
+     * Note: this is also available as a method at an Iban instance.
+     * @param iban - an IBAN to be checked
+     * @returns - `true` if the provided `iban` is a Direct IBAN, and `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.isDirect("XE81ETHXREGGAVOFYORK");
+     * > false
+     * ```
+     */
+    static isDirect(iban: string): boolean;
+    /**
+     * An instance method that checks if iban number is Direct.
+     * It actually check the length of the provided variable and, only if it is 34 or 35, it returns true.
+     * Note: this is also available as a static method.
+     * @param iban - an IBAN to be checked
+     * @returns - `true` if the provided `iban` is a Direct IBAN, and `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.isDirect();
+     * > false
+     * ```
+     */
+    isDirect(): boolean;
+    /**
+     * A static method that checks if an IBAN is Indirect.
+     * It actually check the length of the provided variable and, only if it is 20, it returns true.
+     * Note: this is also available as a method at an Iban instance.
+     * @param iban - an IBAN to be checked
+     * @returns - `true` if the provided `iban` is an Indirect IBAN, and `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.isIndirect("XE81ETHXREGGAVOFYORK");
+     * > true
+     * ```
+     */
+    static isIndirect(iban: string): boolean;
+    /**
+     * check if iban number if indirect
+     * It actually check the length of the provided variable and, only if it is 20, it returns true.
+     * Note: this is also available as a static method.
+     * @param iban - an IBAN to be checked
+     * @returns - `true` if the provided `iban` is an Indirect IBAN, and `false` otherwise.
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.isIndirect();
+     * > true
+     * ```
+     */
+    isIndirect(): boolean;
+    /**
+     * This method could be used to check if a given string is valid IBAN object.
+     * Note: this is also available as a method at an Iban instance.
+     *
+     * @param iban - a string to be checked if it is in IBAN
+     * @returns - true if it is valid IBAN
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.isValid("XE81ETHXREGGAVOFYORK");
+     * > true
+     *
+     * web3.eth.Iban.isValid("XE82ETHXREGGAVOFYORK");
+     * > false // because the checksum is incorrect
+     * ```
+     */
+    static isValid(iban: string): boolean;
+    /**
+     * Should be called to check if the early provided IBAN is correct.
+     * Note: this is also available as a static method.
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.isValid();
+     * > true
+     *
+     * const iban = new web3.eth.Iban("XE82ETHXREGGAVOFYORK");
+     * iban.isValid();
+     * > false // because the checksum is incorrect
+     * ```
+     */
+    isValid(): boolean;
+    /**
+     * Construct a direct or indirect IBAN that has conversion methods and validity checks.
+     * If the provided string was not of either the length of a direct IBAN (34 or 35),
+     * nor the length of an indirect IBAN (20), an Error will be thrown ('Invalid IBAN was provided').
+     *
+     * @param iban - a Direct or an Indirect IBAN
+     * @returns - Iban instance
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS");
+     * > Iban { _iban: 'XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS' }
+     * ```
+     */
+    constructor(iban: string);
+    /**
+     * Convert the passed BBAN to an IBAN for this country specification.
+     * Please note that <i>"generation of the IBAN shall be the exclusive responsibility of the bank/branch servicing the account"</i>.
+     * This method implements the preferred algorithm described in http://en.wikipedia.org/wiki/International_Bank_Account_Number#Generating_IBAN_check_digits
+     *
+     * @param bban - the BBAN to convert to IBAN
+     * @returns an Iban class instance that holds the equivalent IBAN
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.fromBban('ETHXREGGAVOFYORK');
+     * > Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
+     * ```
+     */
+    static fromBban(bban: string): Iban;
+    /**
+     * Should be used to create IBAN object for given institution and identifier
+     *
+     * @param options - an object holds the `institution` and the `identifier` which will be composed to create an `Iban` object from.
+     * @returns an Iban class instance that holds the equivalent IBAN
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.createIndirect({
+     *     institution: "XREG",
+     *     identifier: "GAVOFYORK"
+     * });
+     * > Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
+     * ```
+     */
+    static createIndirect(options: IbanOptions): Iban;
+    /**
+     * This method should be used to create iban object from an Ethereum address.
+     *
+     * @param address - an Ethereum address
+     * @returns an Iban class instance that holds the equivalent IBAN
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.fromAddress("0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8");
+     * > Iban {_iban: "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"}
+     * ```
+     */
+    static fromAddress(address: HexString): Iban;
+    /**
+     * This method should be used to create an ethereum address from a Direct IBAN address.
+     * If the provided string was not a direct IBAN (has the length of 34 or 35), an Error will be thrown:
+     * ('Iban is indirect and cannot be converted. Must be length of 34 or 35').
+     * Note: this is also available as a method at an Iban instance.
+     *
+     * @param iban - a Direct IBAN address
+     * @return the equivalent ethereum address
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.toAddress("XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS");
+     * > "0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8"
+     * ```
+     */
+    static toAddress: (iban: string) => HexString;
+    /**
+     * This method should be used to create the equivalent ethereum address for the early provided Direct IBAN address.
+     * If the provided string was not a direct IBAN (has the length of 34 or 35), an Error will be thrown:
+     * ('Iban is indirect and cannot be converted. Must be length of 34 or 35').
+     * Note: this is also available as a static method.
+     *
+     * @return the equivalent ethereum address
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS");
+     * iban.toAddress();
+     * > "0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8"
+     * ```
+     */
+    toAddress: () => HexString;
+    /**
+     * This method should be used to create IBAN address from an Ethereum address
+     *
+     * @param address - an Ethereum address
+     * @return the equivalent IBAN address
+     *
+     * @example
+     * ```ts
+     * web3.eth.Iban.toIban("0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8");
+     * > "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"
+     * ```
+     */
+    static toIban(address: HexString): string;
+    /**
+     * Should be called to get client identifier within institution
+     *
+     * @return the client of the IBAN instance.
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.client();
+     * > 'GAVOFYORK'
+     * ```
+     */
+    client(): string;
+    /**
+     * Returns the IBAN checksum of the early provided IBAN
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.checksum();
+     * > "81"
+     * ```
+     *
+     */
+    checksum(): string;
+    /**
+     * Returns institution identifier from the early provided  IBAN
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban("XE81ETHXREGGAVOFYORK");
+     * iban.institution();
+     * > 'XREG'
+     * ```
+     */
+    institution(): string;
+    /**
+     * Simply returns the early provided IBAN
+     *
+     * @example
+     * ```ts
+     * const iban = new web3.eth.Iban('XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS');
+     * iban.toString();
+     * > 'XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS'
+     * ```
+     */
+    toString(): string;
+}
+//# sourceMappingURL=iban.d.ts.map

package/lib/types/iban.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iban.d.ts","sourceRoot":"","sources":["../../src/iban.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAIvC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC;;GAEG;AACH,qBAAa,IAAI;IAChB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAE/B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAkBtC;IAEF;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAI9B;IAEH;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAU9B;IAEF;;;;;;;;;;;;OAYG;WACW,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI7C;;;;;;;;;;;;;OAaG;IACI,QAAQ,IAAI,OAAO;IAI1B;;;;;;;;;;;;OAYG;WACW,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI/C;;;;;;;;;;;;;OAaG;IACI,UAAU,IAAI,OAAO;IAI5B;;;;;;;;;;;;;;;OAeG;WACW,OAAO,CAAC,IAAI,EAAE,MAAM;IAOlC;;;;;;;;;;;;;;OAcG;IACI,OAAO,IAAI,OAAO;IAIzB;;;;;;;;;;;;;OAaG;gBACgB,IAAI,EAAE,MAAM;IAQ/B;;;;;;;;;;;;;OAaG;WACW,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS1C;;;;;;;;;;;;;;OAcG;WACW,cAAc,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAIxD;;;;;;;;;;;OAWG;WACW,WAAW,CAAC,OAAO,EAAE,SAAS,GAAG,IAAI;IAWnD;;;;;;;;;;;;;;OAcG;IACH,OAAc,SAAS,SAAU,MAAM,KAAG,SAAS,CAGjD;IAEF;;;;;;;;;;;;;;OAcG;IACI,SAAS,QAAO,SAAS,CAS9B;IAEF;;;;;;;;;;;OAWG;WACW,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM;IAIhD;;;;;;;;;;;OAWG;IACI,MAAM,IAAI,MAAM;IAIvB;;;;;;;;;;OAUG;IACI,QAAQ,IAAI,MAAM;IAIzB;;;;;;;;;OASG;IACI,WAAW,IAAI,MAAM;IAI5B;;;;;;;;;OASG;IACI,QAAQ,IAAI,MAAM;CAGzB"}