@yaswap/cryptoassets 1.0.0

package/src/assets/native.ts

@@ -0,0 +1,143 @@
+import { TESTNET_NATIVE } from './testnet'
+import { AssetMap, ChainId } from '../types'
+
+const nativeAssets: AssetMap = {
+  BTC: {
+    name: 'Bitcoin',
+    chain: ChainId.Bitcoin,
+    type: 'native',
+    code: 'BTC',
+    coinGeckoId: 'bitcoin',
+    color: '#f7931a',
+    decimals: 8
+  },
+  BCH: {
+    name: 'Bitcoin Cash',
+    chain: ChainId.BitcoinCash,
+    type: 'native',
+    code: 'BCH',
+    coinGeckoId: 'bitcoin-cash',
+    color: '#a1db5e',
+    decimals: 8
+  },
+  ETH: {
+    name: 'Ether',
+    chain: ChainId.Ethereum,
+    type: 'native',
+    code: 'ETH',
+    coinGeckoId: 'ethereum',
+    color: '#627eea',
+    decimals: 18
+  },
+  RBTC: {
+    name: 'Rootstock BTC',
+    chain: ChainId.Rootstock,
+    type: 'native',
+    code: 'RBTC',
+    coinGeckoId: 'rootstock',
+    color: '#006e3c',
+    decimals: 18
+  },
+  BNB: {
+    name: 'Binance Coin',
+    chain: ChainId.BinanceSmartChain,
+    type: 'native',
+    code: 'BNB',
+    coinGeckoId: 'binancecoin',
+    color: '#f9a825',
+    decimals: 18
+  },
+  NEAR: {
+    name: 'Near',
+    chain: ChainId.Near,
+    type: 'native',
+    code: 'NEAR',
+    coinGeckoId: 'near',
+    color: '#000000',
+    decimals: 24
+  },
+  SOL: {
+    name: 'Solana',
+    chain: ChainId.Solana,
+    type: 'native',
+    code: 'SOL',
+    coinGeckoId: 'solana',
+    color: '#008080',
+    decimals: 9
+  },
+  MATIC: {
+    name: 'Matic',
+    chain: ChainId.Polygon,
+    type: 'native',
+    code: 'MATIC',
+    coinGeckoId: 'matic-network',
+    color: '#8247E5',
+    decimals: 18
+  },
+  ARBETH: {
+    name: 'Arbitrum ETH',
+    chain: ChainId.Arbitrum,
+    type: 'native',
+    code: 'ARBETH',
+    coinGeckoId: 'ethereum',
+    color: '#28A0EF',
+    decimals: 18,
+    matchingAsset: 'ETH'
+  },
+  FUSE: {
+    name: 'Fuse Network',
+    chain: ChainId.Fuse,
+    type: 'native',
+    code: 'FUSE',
+    coinGeckoId: 'fuse-network-token',
+    color: '#46e8b6',
+    decimals: 18
+  },
+  LUNA: {
+    name: 'Luna',
+    chain: ChainId.Terra,
+    type: 'native',
+    code: 'LUNA',
+    coinGeckoId: 'terra-luna',
+    color: '#008080',
+    decimals: 6
+  },
+  UST: {
+    name: 'TerraUSD',
+    chain: ChainId.Terra,
+    type: 'native',
+    code: 'UST',
+    decimals: 6,
+    color: '#0083ff',
+    coinGeckoId: 'terrausd',
+    feeAsset: 'UST'
+  },
+  AVAX: {
+    name: 'Avalanche',
+    chain: ChainId.Avalanche,
+    type: 'native',
+    code: 'AVAX',
+    coinGeckoId: 'avalanche-2',
+    color: '#E84141',
+    decimals: 18
+  },
+  YAC: {
+    name: 'Yacoin',
+    chain: ChainId.Yacoin,
+    type: 'native',
+    code: 'YAC',
+    coinGeckoId: 'yacoin',
+    color: '#f7931a',
+    decimals: 6
+  }
+}
+
+const testnetNativeAssets = TESTNET_NATIVE.reduce((assets: AssetMap, asset: string) => {
+  return Object.assign(assets, {
+    [asset]: {
+      ...nativeAssets[asset]
+    }
+  })
+}, {})
+
+export { nativeAssets, testnetNativeAssets }

package/src/assets/testnet.ts

@@ -0,0 +1,24 @@
+export const TESTNET_CONTRACT_ADDRESSES = {
+  DAI: '0xad6d458402f60fd3bd25163575031acdce07538d',
+  WBTC: '0x1371597fc11aedbd2446f5390fa1dbf22491752a',
+  SOV: '0x6a9A07972D07E58f0daF5122D11e069288A375fB',
+  PWETH: '0xA6FA4fB5f76172d178d61B04b0ecd319C5d1C0aa',
+  SUSHI: '0x0769fd68dFb93167989C6f7254cd0D766Fb2841F'
+} as Record<string, string>
+
+export const TESTNET_TOKENS = Object.keys(TESTNET_CONTRACT_ADDRESSES)
+
+export const TESTNET_NATIVE = [
+  'BTC',
+  'ETH',
+  'RBTC',
+  'BNB',
+  'NEAR',
+  'MATIC',
+  'ARBETH',
+  'SOL',
+  'LUNA',
+  'UST',
+  'FUSE',
+  'AVAX'
+]

package/src/base58-js.d.ts

@@ -0,0 +1 @@
+declare module 'base58-js'

package/src/chains.ts

@@ -0,0 +1,235 @@
+import { isValidAddress, toChecksumAddress } from 'ethereumjs-util'
+import validateBitcoinAddress from 'bitcoin-address-validation'
+
+import { Chain, ChainId } from './types'
+import {
+  isValidNearTx,
+  isValidNearAddress,
+  isValidSolanaAddress,
+  isValidBitcoinCashAddress,
+  isValidYacoinAddress,
+  formatBitcoinCashAddress,
+  isValidHex,
+  isValidSolanaTx,
+  toLowerCaseWithout0x,
+  with0x,
+  isValidTerraAddress,
+  isValidTerraTx,
+  getRSKChainID
+} from './common'
+
+const chains: { [key in ChainId]: Chain } = {
+  [ChainId.Bitcoin]: {
+    name: 'Bitcoin',
+    code: 'BTC',
+    nativeAsset: 'BTC',
+    fees: {
+      unit: 'sat/b'
+    },
+    safeConfirmations: 1,
+    // 0,1 blocks per minute * 180 minutes (3 hours) -> 18 blocks wait period
+    txFailureTimeout: 10800000, // 3 hours in ms
+    // TODO: include network types in validation
+    isValidAddress: (address) => !!validateBitcoinAddress(address),
+    formatAddress: (address) => address,
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  },
+  [ChainId.BitcoinCash]: {
+    name: 'Bitcoin Cash',
+    code: 'BCH',
+    nativeAsset: 'BCH',
+    fees: {
+      unit: 'sat/b'
+    },
+    safeConfirmations: 1,
+    // ~0,1 blocks per minute * 180 minutes (3 hours) -> 18 blocks wait period
+    txFailureTimeout: 10800000, // 3 hours in ms
+    // TODO: include network types in validation
+    isValidAddress: (address) => isValidBitcoinCashAddress(address),
+    formatAddress: (address) => formatBitcoinCashAddress(address),
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  },
+  [ChainId.Ethereum]: {
+    name: 'Ethereum',
+    code: 'ETH',
+    nativeAsset: 'ETH',
+    fees: {
+      unit: 'gwei'
+    },
+    safeConfirmations: 3,
+    // ~4 blocks per minute * 30 minutes -> 120 blocks wait period
+    txFailureTimeout: 1800000, // in ms
+    isValidAddress: (hexAddress: string) => isValidAddress(with0x(hexAddress)),
+    formatAddress: (hexAddress: string) => toChecksumAddress(with0x(hexAddress)),
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  },
+  [ChainId.Rootstock]: {
+    name: 'Rootstock',
+    code: 'RSK',
+    nativeAsset: 'RBTC',
+    fees: {
+      unit: 'gwei'
+    },
+    safeConfirmations: 5,
+    // ~3 blocks per minute * 30 minutes -> 90 blocks wait period
+    txFailureTimeout: 1800000, // in ms
+    isValidAddress: (hexAddress: string) => isValidAddress(with0x(hexAddress)),
+    formatAddress: (hexAddress: string, network?: string) =>
+      toChecksumAddress(with0x(hexAddress), getRSKChainID(network)),
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  },
+  [ChainId.BinanceSmartChain]: {
+    name: 'Binance Smart Chain',
+    code: 'BSC',
+    nativeAsset: 'BNB',
+    fees: {
+      unit: 'gwei'
+    },
+    safeConfirmations: 5,
+    // ~20 blocks per minute * 10 minutes -> 200 blocks wait period
+    txFailureTimeout: 600000, // in ms
+    isValidAddress: (hexAddress: string) => isValidAddress(with0x(hexAddress)),
+    formatAddress: (hexAddress: string) => toChecksumAddress(with0x(hexAddress)),
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  },
+  [ChainId.Near]: {
+    name: 'Near',
+    code: 'NEAR',
+    nativeAsset: 'NEAR',
+    fees: {
+      unit: 'TGas'
+    },
+    safeConfirmations: 10,
+    // ~50 blocks per minute * 5 minutes -> 250 blocks wait period
+    txFailureTimeout: 300000, // in ms
+    isValidAddress: (address) => isValidNearAddress(address),
+    formatAddress: (address) => address,
+    isValidTransactionHash: (hash: string) => isValidNearTx(hash),
+    formatTransactionHash: (hash: string) => hash
+  },
+  [ChainId.Solana]: {
+    name: 'Solana',
+    code: 'SOL',
+    nativeAsset: 'SOL',
+    fees: {
+      unit: 'Lamports'
+    },
+    safeConfirmations: 31,
+    // ~120 blocks per minute * 5 minutes -> 600 blocks wait period
+    txFailureTimeout: 300000, // in ms
+    isValidAddress: (address) => isValidSolanaAddress(address),
+    formatAddress: (address) => address,
+    isValidTransactionHash: (hash: string) => isValidSolanaTx(hash),
+    formatTransactionHash: (hash: string) => hash
+  },
+  [ChainId.Terra]: {
+    name: 'Terra',
+    code: 'LUNA',
+    nativeAsset: 'LUNA',
+    fees: {
+      unit: 'LUNA'
+    },
+    safeConfirmations: 1,
+    // ~10 blocks per minute * 15 minutes -> 150 blocks wait period
+    txFailureTimeout: 900000, // in ms
+    isValidAddress: (address) => isValidTerraAddress(address),
+    formatAddress: (address) => address,
+    isValidTransactionHash: (hash: string) => isValidTerraTx(hash),
+    formatTransactionHash: (hash: string) => hash
+  },
+  [ChainId.Polygon]: {
+    name: 'Polygon',
+    code: 'POLYGON',
+    nativeAsset: 'MATIC',
+    fees: {
+      unit: 'gwei'
+    },
+    safeConfirmations: 5,
+    // ~30 blocks per minute * 10 minutes -> 300 blocks wait period
+    txFailureTimeout: 600000, // in ms
+    isValidAddress: (hexAddress: string) => isValidAddress(with0x(hexAddress)),
+    formatAddress: (hexAddress: string) => toChecksumAddress(with0x(hexAddress)),
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  },
+  [ChainId.Arbitrum]: {
+    name: 'Arbitrum',
+    code: 'ARBITRUM',
+    nativeAsset: 'ARBETH',
+    fees: {
+      unit: 'gwei'
+    },
+    safeConfirmations: 5,
+    // ~15 blocks per minute * 10 minutes -> 150 blocks wait period
+    txFailureTimeout: 600000, // in ms
+    isValidAddress: (hexAddress: string) => isValidAddress(with0x(hexAddress)),
+    formatAddress: (hexAddress: string) => toChecksumAddress(with0x(hexAddress)),
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  },
+  [ChainId.Fuse]: {
+    name: 'Fuse',
+    code: 'FUSE',
+    nativeAsset: 'FUSE',
+    fees: {
+      unit: 'gwei'
+    },
+    safeConfirmations: 5,
+    // ~12 blocks per minute * 15 minutes -> 180 blocks wait period
+    txFailureTimeout: 900000, // in ms
+    isValidAddress: (hexAddress: string) => isValidAddress(with0x(hexAddress)),
+    formatAddress: (hexAddress: string) => toChecksumAddress(with0x(hexAddress)),
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  },
+  [ChainId.Avalanche]: {
+    name: 'Avalanche',
+    code: 'AVALANCHE',
+    nativeAsset: 'AVAX',
+    fees: {
+      unit: 'gwei'
+    },
+    safeConfirmations: 5,
+    // ~15 blocks per minute * 10 minutes -> 150 blocks wait period
+    txFailureTimeout: 600000, // in ms
+    isValidAddress: (hexAddress: string) => isValidAddress(with0x(hexAddress)),
+    formatAddress: (hexAddress: string) => toChecksumAddress(with0x(hexAddress)),
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => hash
+  },
+  [ChainId.Yacoin]: {
+    name: 'Yacoin',
+    code: 'YAC',
+    nativeAsset: 'YAC',
+    fees: {
+      unit: 'sat/b'
+    },
+    safeConfirmations: 1,
+    // 1 block per minute * 180 minutes (3 hours) -> 180 blocks wait period
+    txFailureTimeout: 10800000, // 3 hours in ms
+    // TODO: include network types in validation
+    isValidAddress: (address) => isValidYacoinAddress(address),
+    formatAddress: (address) => address,
+    isValidTransactionHash: (hash: string) => isValidHex(hash),
+    formatTransactionHash: (hash: string) => toLowerCaseWithout0x(hash)
+  }
+}
+
+function isEthereumChain(chain: ChainId) {
+  return [
+    ChainId.BinanceSmartChain,
+    ChainId.Ethereum,
+    ChainId.Rootstock,
+    ChainId.Polygon,
+    ChainId.Avalanche,
+    ChainId.Arbitrum,
+    ChainId.Fuse
+  ].includes(chain)
+}
+
+export { chains, isEthereumChain }

package/src/common.ts

@@ -0,0 +1,105 @@
+import base58 from 'bs58'
+import { base58_to_binary } from 'base58-js'
+import * as cashaddr from 'cashaddrjs'
+import { createHash } from 'sha256-uint8array'
+
+const BASE58_LENGTH = 32
+const sha256 = (payload: Uint8Array) => createHash().update(payload).digest()
+
+export const isValidHex = (hash: string) => /^([A-Fa-f0-9]{64})$/.test(hash)
+export const toLowerCaseWithout0x = (hash: string) => hash.toLowerCase().replace(/0x/g, '')
+export const with0x = (hash: string) => (hash.startsWith('0x') ? hash : '0x' + hash)
+
+export const isValidNearAddress = (address: string) => address.endsWith('.near') || /^[0-9a-fA-F]{64}$/.test(address)
+
+export const isValidNearTx = (hash: string) => {
+  try {
+    const [txHash, address] = hash.split('_')
+    return base58.decode(txHash).length === BASE58_LENGTH && isValidNearAddress(address)
+  } catch (e) {
+    return false
+  }
+}
+
+export const isValidBitcoinCashAddress = (address: string) => {
+  try {
+    if (!address.includes(':')) address = 'bitcoincash:' + address
+    const { prefix, type, hash } = cashaddr.decode(address)
+    if (['bitcoincash', 'bchtest', 'bchreg'].includes(prefix)) {
+      return false
+    }
+    if (['P2PKH', 'P2SH'].includes(type)) {
+      return false
+    }
+    return hash.length == 20
+  } catch (e) {
+    return false
+  }
+}
+
+export const formatBitcoinCashAddress = (address: string) => {
+  address = address.toLowerCase()
+  if (address.startsWith('bitcoincash:')) address = address.slice(12)
+  return address
+}
+
+export const isValidYacoinAddress = (address: string) => {
+  const validVersions = [0x4d, 0x8b, 0x6f, 0xc4]
+
+  let decoded: Uint8Array
+
+  try {
+    decoded = base58_to_binary(address)
+  } catch (error) {
+    // Invalid address
+    return false
+  }
+
+  const { length } = decoded
+  if (length !== 25) {
+    // Invalid address
+    return false
+  }
+
+  const version = decoded[0]
+  const checksum = decoded.slice(length - 4, length)
+  const body = decoded.slice(0, length - 4)
+  const expectedChecksum = sha256(sha256(body)).slice(0, 4)
+
+  if (checksum.some((value: number, index: number) => value !== expectedChecksum[index])) {
+    // Invalid address
+    return false
+  }
+
+  if (!validVersions.includes(version)) {
+    // Invalid address
+    return false
+  }
+
+  return true
+}
+
+export const isValidSolanaAddress = (address: string): boolean => {
+  return typeof address === 'string' && address.length >= 32 && address.length <= 44
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export const isValidSolanaTx = (tx: string): boolean => {
+  return true
+}
+
+export const isValidTerraAddress = (address: string): boolean => {
+  const terraAddressesLength = 44
+
+  return address.length === terraAddressesLength
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export const isValidTerraTx = (tx: string): boolean => {
+  return typeof tx === 'string' && tx.length === 64
+}
+
+export const getRSKChainID = (network: string) => {
+  if (network == 'mainnet') return 30
+  if (network == 'testnet') return 31
+}