@rosen-bridge/address-codec 0.6.3 → 1.0.0

package/dist/vitest.config.js

@@ -1,18 +0,0 @@
-import { defineConfig } from 'vitest/config';
-export default defineConfig({
-    test: {
-        globals: true,
-        coverage: {
-            all: true,
-            reporter: ['cobertura', 'lcov', 'text', 'text-summary'],
-            provider: 'istanbul',
-            include: ['src'],
-        },
-        poolOptions: {
-            forks: {
-                singleFork: true,
-            },
-        },
-    },
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidml0ZXN0LmNvbmZpZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3ZpdGVzdC5jb25maWcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLGVBQWUsQ0FBQztBQUU3QyxlQUFlLFlBQVksQ0FBQztJQUMxQixJQUFJLEVBQUU7UUFDSixPQUFPLEVBQUUsSUFBSTtRQUNiLFFBQVEsRUFBRTtZQUNSLEdBQUcsRUFBRSxJQUFJO1lBQ1QsUUFBUSxFQUFFLENBQUMsV0FBVyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsY0FBYyxDQUFDO1lBQ3ZELFFBQVEsRUFBRSxVQUFVO1lBQ3BCLE9BQU8sRUFBRSxDQUFDLEtBQUssQ0FBQztTQUNqQjtRQUNELFdBQVcsRUFBRTtZQUNYLEtBQUssRUFBRTtnQkFDTCxVQUFVLEVBQUUsSUFBSTthQUNqQjtTQUNGO0tBQ0Y7Q0FDRixDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBkZWZpbmVDb25maWcgfSBmcm9tICd2aXRlc3QvY29uZmlnJztcblxuZXhwb3J0IGRlZmF1bHQgZGVmaW5lQ29uZmlnKHtcbiAgdGVzdDoge1xuICAgIGdsb2JhbHM6IHRydWUsXG4gICAgY292ZXJhZ2U6IHtcbiAgICAgIGFsbDogdHJ1ZSxcbiAgICAgIHJlcG9ydGVyOiBbJ2NvYmVydHVyYScsICdsY292JywgJ3RleHQnLCAndGV4dC1zdW1tYXJ5J10sXG4gICAgICBwcm92aWRlcjogJ2lzdGFuYnVsJyxcbiAgICAgIGluY2x1ZGU6IFsnc3JjJ10sXG4gICAgfSxcbiAgICBwb29sT3B0aW9uczoge1xuICAgICAgZm9ya3M6IHtcbiAgICAgICAgc2luZ2xlRm9yazogdHJ1ZSxcbiAgICAgIH0sXG4gICAgfSxcbiAgfSxcbn0pO1xuIl19

package/lib/const.ts

@@ -1,20 +0,0 @@
-export const BITCOIN_CHAIN = 'bitcoin';
-export const RUNES_CHAIN = 'bitcoin-runes';
-export const CARDANO_CHAIN = 'cardano';
-export const ERGO_CHAIN = 'ergo';
-export const ETHEREUM_CHAIN = 'ethereum';
-export const BINANCE_CHAIN = 'binance';
-export const DOGE_CHAIN = 'doge';
-
-export const DOGE_NETWORK = {
-  // Doge network parameters
-  messagePrefix: '\x19Dogecoin Signed Message:\n',
-  bech32: 'dc',
-  bip32: {
-    public: 0x02facafd,
-    private: 0x02fac398,
-  },
-  pubKeyHash: 0x1e,
-  scriptHash: 0x16,
-  wif: 0x9e,
-};

package/lib/decoder.ts

@@ -1,57 +0,0 @@
-import {
-  BINANCE_CHAIN,
-  BITCOIN_CHAIN,
-  CARDANO_CHAIN,
-  DOGE_CHAIN,
-  DOGE_NETWORK,
-  ERGO_CHAIN,
-  ETHEREUM_CHAIN,
-  RUNES_CHAIN,
-} from './const';
-import { UnsupportedAddressError, UnsupportedChainError } from './types';
-import * as ergoLib from 'ergo-lib-wasm-nodejs';
-import * as cardanoLib from '@emurgo/cardano-serialization-lib-nodejs';
-import * as bitcoinLib from 'bitcoinjs-lib';
-
-/**
- * decodes address of a chain
- *  throws error if encoded address length is more than 60 bytes
- * @param chain
- * @param encodedAddress
- */
-export const decodeAddress = (
-  chain: string,
-  encodedAddress: string
-): string => {
-  if (encodedAddress.length > 60 * 2)
-    throw new UnsupportedAddressError(chain, encodedAddress);
-  switch (chain) {
-    case ERGO_CHAIN:
-      return ergoLib.Address.from_public_key(
-        Uint8Array.from(Buffer.from(encodedAddress, 'hex'))
-      ).to_base58(ergoLib.NetworkPrefix.Mainnet);
-    case CARDANO_CHAIN:
-      return cardanoLib.Address.from_bytes(
-        Uint8Array.from(Buffer.from(encodedAddress, 'hex'))
-      ).to_bech32();
-    case RUNES_CHAIN:
-    case BITCOIN_CHAIN:
-      return bitcoinLib.address.fromOutputScript(
-        Buffer.from(encodedAddress, 'hex')
-      );
-    case BINANCE_CHAIN:
-    case ETHEREUM_CHAIN:
-      if (encodedAddress.length != 40) {
-        throw new UnsupportedAddressError(chain, encodedAddress);
-      }
-
-      return '0x' + encodedAddress;
-    case DOGE_CHAIN:
-      return bitcoinLib.address.fromOutputScript(
-        Buffer.from(encodedAddress, 'hex'),
-        DOGE_NETWORK
-      );
-    default:
-      throw new UnsupportedChainError(chain);
-  }
-};

package/lib/encoder.ts

@@ -1,57 +0,0 @@
-import {
-  BINANCE_CHAIN,
-  BITCOIN_CHAIN,
-  CARDANO_CHAIN,
-  DOGE_CHAIN,
-  DOGE_NETWORK,
-  ERGO_CHAIN,
-  ETHEREUM_CHAIN,
-  RUNES_CHAIN,
-} from './const';
-import { UnsupportedAddressError, UnsupportedChainError } from './types';
-import * as ergoLib from 'ergo-lib-wasm-nodejs';
-import * as cardanoLib from '@emurgo/cardano-serialization-lib-nodejs';
-import * as bitcoinLib from 'bitcoinjs-lib';
-
-/**
- * encodes address of a chain to hex string
- *  throws error if encoded address length is more than 60 bytes
- * @param chain
- * @param address
- */
-export const encodeAddress = (chain: string, address: string): string => {
-  let encoded: string;
-  switch (chain) {
-    case ERGO_CHAIN:
-      encoded = Buffer.from(
-        ergoLib.Address.from_base58(address).content_bytes()
-      ).toString('hex');
-      break;
-    case CARDANO_CHAIN:
-      encoded = Buffer.from(
-        cardanoLib.Address.from_bech32(address).to_bytes()
-      ).toString('hex');
-      break;
-    case RUNES_CHAIN:
-    case BITCOIN_CHAIN:
-      encoded = bitcoinLib.address.toOutputScript(address).toString('hex');
-      break;
-    case BINANCE_CHAIN:
-    case ETHEREUM_CHAIN:
-      if (address.length != 42 || address.substring(0, 2) != '0x') {
-        throw new UnsupportedAddressError(chain, address);
-      }
-      encoded = address.substring(2);
-      break;
-    case DOGE_CHAIN:
-      encoded = bitcoinLib.address
-        .toOutputScript(address, DOGE_NETWORK)
-        .toString('hex');
-      break;
-    default:
-      throw new UnsupportedChainError(chain);
-  }
-  if (encoded.length > 60 * 2)
-    throw new UnsupportedAddressError(chain, address);
-  return encoded;
-};

package/lib/index.ts

@@ -1,9 +0,0 @@
-import { initEccLib } from 'bitcoinjs-lib';
-import ecc from '@bitcoinerlab/secp256k1';
-
-initEccLib(ecc);
-
-export * from './encoder';
-export * from './decoder';
-export * from './types';
-export * from './validator';

package/lib/types.ts

@@ -1,15 +0,0 @@
-export class UnsupportedAddressError extends Error {
-  constructor(chain: string, address: string) {
-    super(
-      `UnsupportedAddressError: Address [${address}] is not supported in current implementation of [${chain}] chain`
-    );
-  }
-}
-
-export class UnsupportedChainError extends Error {
-  constructor(chain: string) {
-    super(
-      `UnsupportedChainError: Address encoding does not support [${chain}] chain currently`
-    );
-  }
-}

package/lib/validator.ts

@@ -1,59 +0,0 @@
-import {
-  BINANCE_CHAIN,
-  BITCOIN_CHAIN,
-  CARDANO_CHAIN,
-  DOGE_CHAIN,
-  DOGE_NETWORK,
-  ERGO_CHAIN,
-  ETHEREUM_CHAIN,
-  RUNES_CHAIN,
-} from './const';
-import { UnsupportedAddressError, UnsupportedChainError } from './types';
-import * as ergoLib from 'ergo-lib-wasm-nodejs';
-import * as cardanoLib from '@emurgo/cardano-serialization-lib-nodejs';
-import * as bitcoinLib from 'bitcoinjs-lib';
-import * as ethereumLib from 'ethers';
-
-/**
- * validates address of a chain
- * @param chain
- * @param address
- */
-export const validateAddress = (chain: string, address: string): boolean => {
-  switch (chain) {
-    case ERGO_CHAIN:
-      ergoLib.Address.from_base58(address);
-      return true;
-    case CARDANO_CHAIN:
-      cardanoLib.Address.from_bech32(address);
-      return true;
-    case BITCOIN_CHAIN:
-      bitcoinLib.address.fromBech32(address);
-      if (address.slice(0, 4) != 'bc1q')
-        throw new UnsupportedAddressError(chain, address);
-      return true;
-    case BINANCE_CHAIN:
-    case ETHEREUM_CHAIN:
-      if (address.toLowerCase() != address || !ethereumLib.isAddress(address))
-        throw new UnsupportedAddressError(chain, address);
-      return true;
-    case DOGE_CHAIN:
-      try {
-        bitcoinLib.address.toOutputScript(address, DOGE_NETWORK);
-      } catch (e) {
-        throw new UnsupportedAddressError(chain, address);
-      }
-      return true;
-    case RUNES_CHAIN:
-      try {
-        bitcoinLib.address.toOutputScript(address);
-        if (address.slice(0, 4) != 'bc1p')
-          throw new UnsupportedAddressError(chain, address);
-      } catch (e) {
-        throw new UnsupportedAddressError(chain, address);
-      }
-      return true;
-    default:
-      throw new UnsupportedChainError(chain);
-  }
-};

package/tests/decoder.spec.ts

@@ -1,131 +0,0 @@
-import * as testData from './testData';
-import {
-  UnsupportedAddressError,
-  UnsupportedChainError,
-  decodeAddress,
-} from '../lib';
-import {
-  BITCOIN_CHAIN,
-  CARDANO_CHAIN,
-  DOGE_CHAIN,
-  ERGO_CHAIN,
-  ETHEREUM_CHAIN,
-  RUNES_CHAIN,
-} from '../lib/const';
-
-describe('decodeAddress', () => {
-  /**
-   * @target `decodeAddress` should decode Ergo address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be address in base58 format
-   */
-  it('should decode Ergo address successfully', () => {
-    const res = decodeAddress(ERGO_CHAIN, testData.encodedErgoAddress);
-    expect(res).toEqual(testData.ergoAddress);
-  });
-
-  /**
-   * @target `decodeAddress` should decode Cardano address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be address in bech32 format
-   */
-  it('should decode Cardano address successfully', () => {
-    const res = decodeAddress(CARDANO_CHAIN, testData.encodedCardanoAddress);
-    expect(res).toEqual(testData.cardanoAddress);
-  });
-
-  /**
-   * @target `decodeAddress` should decode Bitcoin address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be address in bech32 format
-   */
-  it('should decode Bitcoin address successfully', () => {
-    const res = decodeAddress(BITCOIN_CHAIN, testData.encodedBitcoinAddress);
-    expect(res).toEqual(testData.bitcoinAddress);
-  });
-
-  /**
-   * @target `decodeAddress` should decode Ethereum address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be address in hex format
-   */
-  it('should decode Ethereum address successfully', () => {
-    const res = decodeAddress(ETHEREUM_CHAIN, testData.encodedEthereumAddress);
-    expect(res).toEqual(testData.ethereumAddress);
-  });
-
-  /**
-   * @target `decodeAddress` should throw error when encoded address is more than 60 bytes
-   * @dependencies
-   * @scenario
-   * - run test & check thrown exception
-   * @expected
-   * - it should throw UnsupportedAddress error
-   */
-  it('should throw error when encoded address is more than 60 bytes', () => {
-    expect(() => {
-      decodeAddress(ERGO_CHAIN, testData.longEncodedAddress);
-    }).toThrow(UnsupportedAddressError);
-  });
-
-  /**
-   * @target `decodeAddress` should throw error when chain is not supported
-   * @dependencies
-   * @scenario
-   * - run test & check thrown exception
-   * @expected
-   * - it should throw UnsupportedChain error
-   */
-  it('should throw error when chain is not supported', () => {
-    expect(() => {
-      decodeAddress('unsupported-chain', '0011223344');
-    }).toThrow(UnsupportedChainError);
-  });
-
-  /**
-   * @target `decodeAddress` should decode Doge address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be address in hex format
-   */
-  it('should decode Doge address successfully', () => {
-    const res = decodeAddress(DOGE_CHAIN, testData.encodedDogeAddress);
-    expect(res).toEqual(testData.dogeAddress);
-  });
-
-  /**
-   * @target `decodeAddress` should decode Runes address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be address in hex format
-   */
-  it('should decode Runes address successfully', () => {
-    const res = decodeAddress(
-      RUNES_CHAIN,
-      testData.encodedTaprootBitcoinAddress
-    );
-    expect(res).toEqual(testData.taprootBitcoinAddress);
-  });
-});

package/tests/encoder.spec.ts

@@ -1,143 +0,0 @@
-import * as testData from './testData';
-import {
-  UnsupportedAddressError,
-  UnsupportedChainError,
-  encodeAddress,
-} from '../lib';
-import {
-  BITCOIN_CHAIN,
-  CARDANO_CHAIN,
-  DOGE_CHAIN,
-  ERGO_CHAIN,
-  ETHEREUM_CHAIN,
-  RUNES_CHAIN,
-} from '../lib/const';
-
-describe('encodeAddress', () => {
-  /**
-   * @target `encodeAddress` should encode Ergo address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be public key of given address in hex
-   */
-  it('should encode Ergo address successfully', () => {
-    const res = encodeAddress(ERGO_CHAIN, testData.ergoAddress);
-    expect(res).toEqual(testData.encodedErgoAddress);
-  });
-
-  /**
-   * @target `encodeAddress` should encode Cardano address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be public key of given address in hex
-   */
-  it('should encode Cardano address successfully', () => {
-    const res = encodeAddress(CARDANO_CHAIN, testData.cardanoAddress);
-    expect(res).toEqual(testData.encodedCardanoAddress);
-  });
-
-  /**
-   * @target `encodeAddress` should encode Bitcoin address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be output script of given address in hex
-   */
-  it('should encode Bitcoin address successfully', () => {
-    const res = encodeAddress(BITCOIN_CHAIN, testData.bitcoinAddress);
-    expect(res).toEqual(testData.encodedBitcoinAddress);
-  });
-
-  /**
-   * @target `encodeAddress` should encode Ethereum address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be output script of given address in hex
-   */
-  it('should encode Ethereum address successfully', () => {
-    const res = encodeAddress(ETHEREUM_CHAIN, testData.ethereumAddress);
-    expect(res).toEqual(testData.encodedEthereumAddress);
-  });
-
-  /**
-   * @target `encodeAddress` should throw error when address is not 40 bytes
-   * @dependencies
-   * @scenario
-   * - run test
-   * - run test & check thrown exception
-   * @expected
-   * - it should throw UnsupportedAddress error
-   */
-  it('should encode Ethereum address successfully', () => {
-    expect(() => {
-      encodeAddress(ETHEREUM_CHAIN, testData.invalidEthereumAddressLength);
-    }).toThrow(UnsupportedAddressError);
-  });
-
-  /**
-   * @target `encodeAddress` should throw error when encoded address is more than 60 bytes
-   * @dependencies
-   * @scenario
-   * - run test & check thrown exception
-   * @expected
-   * - it should throw UnsupportedAddress error
-   */
-  it('should throw error when encoded address is more than 60 bytes', () => {
-    expect(() => {
-      encodeAddress(ERGO_CHAIN, testData.longErgoAddress);
-    }).toThrow(UnsupportedAddressError);
-  });
-
-  /**
-   * @target `encodeAddress` should throw error when chain is not supported
-   * @dependencies
-   * @scenario
-   * - run test & check thrown exception
-   * @expected
-   * - it should throw UnsupportedChain error
-   */
-  it('should throw error when chain is not supported', () => {
-    expect(() => {
-      encodeAddress('unsupported-chain', 'address');
-    }).toThrow(UnsupportedChainError);
-  });
-
-  /**
-   * @target `encodeAddress` should encode Doge address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be output script of given address in hex
-   */
-  it('should encode Doge address successfully', () => {
-    const res = encodeAddress(DOGE_CHAIN, testData.dogeAddress);
-    expect(res).toEqual(testData.encodedDogeAddress);
-  });
-
-  /**
-   * @target `encodeAddress` should encode Runes address successfully
-   * @dependencies
-   * @scenario
-   * - run test
-   * - check returned value
-   * @expected
-   * - it should be output script of given address in hex
-   */
-  it('should encode Runes address successfully', () => {
-    const res = encodeAddress(RUNES_CHAIN, testData.taprootBitcoinAddress);
-    expect(res).toEqual(testData.encodedTaprootBitcoinAddress);
-  });
-});

package/tests/testData.ts

@@ -1,43 +0,0 @@
-export const ergoAddress =
-  '9iMjQx8PzwBKXRvsFUJFJAPoy31znfEeBUGz8DRkcnJX4rJYjVd';
-export const encodedErgoAddress =
-  '03f999da8e6e42660e4464d17d29e63bc006734a6710a24eb489b466323d3a9339';
-export const invalidErgoAddress =
-  '9iMjQx8PzwBKXRvsFUJFJAPoy31znfEeBUGz8DRkcnJX4rJYjVD';
-
-export const cardanoAddress =
-  'addr1qxxa3kfnnh40yqtepa5frt0tkw4a0rys7v33422lzt8glx43sqtd4vkhjzawajej8aujh27p5a54zx62xf3wvuplynqs3fsqet';
-export const encodedCardanoAddress =
-  '018dd8d9339deaf201790f6891adebb3abd78c90f3231aa95f12ce8f9ab18016dab2d790baeecb323f792babc1a769511b4a3262e6703f24c1';
-export const invalidCardanoAddress =
-  'addr1qxxa3kfnnh40yqtepa5frt0tkw4a0rys7v33422lzt8glx43sqtd4vkhjzawajej8aujh27p5a54zx62xf3wvuplynqs3fsqee';
-
-export const bitcoinAddress = 'bc1qkgp89fjerymm5ltg0hygnumr0m2qa7n22gyw6h';
-export const invalidBitcoinAddress =
-  'bc1qkgp89fjerymm5ltg0hygnumr0m2qa7n22gyw6';
-export const taprootBitcoinAddress =
-  'bc1px0ad45qrfwc20yfd9wljeytrvfa6tmrcxv6pgxze2svvx00tp7mstj5rpk';
-export const encodedTaprootBitcoinAddress =
-  '512033fadad0034bb0a7912d2bbf2c9163627ba5ec7833341418595418c33deb0fb7';
-export const encodedBitcoinAddress =
-  '0014b20272a6591937ba7d687dc889f3637ed40efa6a';
-
-export const longErgoAddress =
-  'nB3L2PD3LBtiNhDYK7XhZ8nVt6uekBXN7RcPUKgdKLXFcrJiSPxmQsUKuUkTRQ1hbvDrxEQAKYurGFbaGD1RPxU7XqQimD78j23HHMQKL1boUGsnNhCxaVNAYMcFbQNo355Af8cWkhAN6';
-export const longEncodedAddress =
-  '100304000e20a6ac381e6fa99929fd1477b3ba9499790a775e91d4c14c5aa86e9a118dfac8530400d801d601b2db6501fe730000ea02d1aedb63087201d901024d0e938c720201730198b2e4c672010510730200ade4c67201041ad901020ecdee7202';
-
-export const ethereumAddress = '0xb416c8a6d7ec94706a9ae2c26c11d320519482b1';
-export const encodedEthereumAddress =
-  'b416c8a6d7ec94706a9ae2c26c11d320519482b1';
-
-export const invalidEthereumAddressLength =
-  '0xb416c8a7ec94706a9ae2c26c11d320519482b1';
-export const invalidEthereumIcapAddress = 'XE65GB6LDNXYOFTX0NSV3FUWKOWIXAMJK36';
-export const invalidEthereumChecksumAddress =
-  '0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97';
-
-export const dogeAddress = 'A69cznKpaYVWjzU3sNFZnGhbpSmUVFzvHB';
-export const invalidDogeAddress = 'bc1qkgp89fjerymm5ltg0hygnumr0m2qa7n22gyw6h';
-export const encodedDogeAddress =
-  'a914966ba9f4755996c3d51025d53044b415121bc10287';