@bitpay-labs/bitcore-wallet-service 11.5.2

package/src/lib/common/constants.ts

@@ -0,0 +1,231 @@
+'use strict';
+import * as CWC from '@bitpay-labs/crypto-wallet-core';
+
+export const Constants = {
+  CHAINS: {
+    BTC: 'btc',
+    BCH: 'bch',
+    ETH: 'eth',
+    MATIC: 'matic',
+    ARB: 'arb',
+    BASE: 'base',
+    OP: 'op',
+    XRP: 'xrp',
+    DOGE: 'doge',
+    LTC: 'ltc',
+    SOL: 'sol'
+  },
+
+  BITPAY_SUPPORTED_COINS: {
+    // used for rates
+    BTC: 'btc',
+    BCH: 'bch',
+    ETH: 'eth',
+    MATIC: 'matic',
+    XRP: 'xrp',
+    DOGE: 'doge',
+    LTC: 'ltc',
+    SHIB: 'shib',
+    APE: 'ape',
+    USDC: 'usdc',
+    PYUSD: 'pyusd',
+    USDP: 'usdp',
+    PAX: 'pax',
+    GUSD: 'gusd',
+    BUSD: 'busd',
+    DAI: 'dai',
+    WBTC: 'wbtc',
+    EUROC: 'euroc',
+    USDT: 'usdt',
+    WETH: 'weth',
+    SOL: 'sol'
+  },
+
+  BITPAY_SUPPORTED_ETH_ERC20: {
+    // there is no need to add new entries here ( only for backwards compatibility )
+    MATIC: 'matic',
+    USDC: 'usdc',
+    PYUSD: 'pyusd',
+    USDP: 'usdp',
+    PAX: 'pax', // backwards compatability
+    GUSD: 'gusd',
+    BUSD: 'busd',
+    DAI: 'dai',
+    WBTC: 'wbtc',
+    SHIB: 'shib',
+    APE: 'ape',
+    EUROC: 'euroc',
+    USDT: 'usdt'
+  },
+
+  BITPAY_USD_STABLECOINS: {
+    // used for rates
+    USDC: 'usdc',
+    PYUSD: 'pyusd',
+    USDP: 'usdp',
+    PAX: 'pax',
+    GUSD: 'gusd',
+    BUSD: 'busd',
+    DAI: 'dai',
+    USDT: 'usdt'
+  },
+
+  BITPAY_EUR_STABLECOINS: {
+    // used for rates
+    EUROC: 'euroc'
+  },
+
+  UTXO_CHAINS: {
+    BTC: 'btc',
+    BCH: 'bch',
+    DOGE: 'doge',
+    LTC: 'ltc'
+  },
+
+  EVM_CHAINS: {
+    ETH: 'eth',
+    MATIC: 'matic',
+    ARB: 'arb',
+    BASE: 'base',
+    OP: 'op',
+  },
+
+  EVM_CHAINS_WITH_ETH_GAS: {
+    ETH: 'eth',
+    ARB: 'arb',
+    BASE: 'base',
+    OP: 'op',
+  },
+
+  SVM_CHAINS: {
+    SOL: 'sol'
+  },
+
+  NETWORKS: {
+    btc: ['livenet', 'testnet3', 'testnet4', 'signet', 'regtest'],
+    bch: ['livenet', 'testnet3', 'testnet4', 'scalenet', 'chipnet', 'regtest'],
+    eth: ['livenet', 'sepolia', 'holesky', 'regtest'],
+    matic: ['livenet', 'amoy', 'regtest'],
+    ltc: ['livenet', 'testnet4', 'regtest'],
+    doge: ['livenet', 'testnet3', 'regtest'],
+    xrp: ['livenet', 'testnet', 'regtest'],
+    arb: ['livenet', 'sepolia', 'holesky', 'regtest'],
+    base: ['livenet', 'sepolia', 'holesky', 'regtest'],
+    op: ['livenet', 'sepolia', 'holesky', 'regtest'],
+    sol: ['livenet', 'testnet', 'devnet', 'regtest']
+  } as { [chain: string]: Array<string> },
+
+  // These aliases are here to support legacy clients so don't change them lightly
+  NETWORK_ALIASES: {
+    btc: {
+      mainnet: 'livenet',
+      testnet: 'testnet4'
+    },
+    bch: {
+      mainnet: 'livenet',
+      testnet: 'testnet4'
+    },
+    ltc: {
+      mainnet: 'livenet',
+      testnet: 'testnet4'
+    },
+    doge: {
+      mainnet: 'livenet',
+      testnet: 'testnet3'
+    },
+    xrp: {
+      mainnet: 'livenet',
+    },
+    eth: {
+      mainnet: 'livenet',
+      testnet: 'sepolia'
+    },
+    matic: {
+      mainnet: 'livenet',
+      testnet: 'amoy'
+    },
+    arb: {
+      mainnet: 'livenet',
+      testnet: 'sepolia'
+    },
+    base: {
+      mainnet: 'livenet',
+      testnet: 'sepolia'
+    },
+    op: {
+      mainnet: 'livenet',
+      testnet: 'sepolia'
+    },
+    sol: {
+      mainnet: 'livenet',
+      testnet: 'devnet'
+    }
+  },
+
+  ADDRESS_FORMATS: ['copay', 'cashaddr', 'legacy'],
+
+  SCRIPT_TYPES: {
+    P2SH: 'P2SH',
+    P2WSH: 'P2WSH',
+    P2PKH: 'P2PKH',
+    P2WPKH: 'P2WPKH',
+    P2TR: 'P2TR'
+  },
+
+  NATIVE_SEGWIT_CHAINS: {
+    BTC: 'btc',
+    LTC: 'ltc'
+  },
+
+  TAPROOT_CHAINS: {
+    BTC: 'btc'
+  },
+
+  DERIVATION_STRATEGIES: {
+    BIP44: 'BIP44',
+    BIP45: 'BIP45'
+  },
+
+  PATHS: {
+    SINGLE_ADDRESS: "m/0'/0",
+    REQUEST_KEY: "m/1'/0",
+    TXPROPOSAL_KEY: "m/1'/1",
+    REQUEST_KEY_AUTH: 'm/2' // relative to BASE
+  },
+
+  BIP45_SHARED_INDEX: 0x80000000 - 1,
+
+  ETH_TOKEN_OPTS: CWC.Constants.ETH_TOKEN_OPTS,
+  MATIC_TOKEN_OPTS: CWC.Constants.MATIC_TOKEN_OPTS,
+  ARB_TOKEN_OPTS: CWC.Constants.ARB_TOKEN_OPTS,
+  OP_TOKEN_OPTS: CWC.Constants.OP_TOKEN_OPTS,
+  BASE_TOKEN_OPTS: CWC.Constants.BASE_TOKEN_OPTS,
+  SOL_TOKEN_OPTS: CWC.Constants.SOL_TOKEN_OPTS,
+
+  BITPAY_CONTRACTS: {
+    MULTISEND: 'MULTISEND'
+  },
+
+  // Number of confirmations from which tx in history will be cached
+  // There is a default value in defaults.ts that applies to UTXOs
+  CONFIRMATIONS_TO_START_CACHING: {
+    eth: 100,
+    matic: 150
+  },
+
+  // Individual chain settings for block throttling
+  CHAIN_NEW_BLOCK_THROTTLE_TIME_SECONDS: {
+    btc: { testnet: 300, livenet: 0 },
+    bch: { testnet: 300, livenet: 0 },
+    eth: { testnet: 300, livenet: 0 },
+    matic: { testnet: 300, livenet: 12 }, // MATIC set to 12 because blocks normally occur every 1-2 seconds
+    xrp: { testnet: 300, livenet: 0 },
+    doge: { testnet: 300, livenet: 0 },
+    ltc: { testnet: 300, livenet: 0 }
+  } as { [chain: string]: { [network: string]: number } },
+
+  // May be different from the defaults if we rollback
+  // or want to beta test new versions.
+  TSS_KEYGEN_SCHEME_VERSION_MAX: 1,
+  TSS_SIGGEN_SCHEME_VERSION_MAX: 1,
+} as const;

package/src/lib/common/defaults.ts

@@ -0,0 +1,436 @@
+'use strict';
+
+export const Defaults = {
+  MIN_FEE_PER_KB: 0,
+
+  MAX_KEYS: 100,
+
+  // Time after which a tx proposal can be erased by any copayer. in seconds
+  DELETE_LOCKTIME: 600,
+
+  // Allowed consecutive txp rejections before backoff is applied.
+  BACKOFF_OFFSET: 10,
+
+  // Time a copayer need to wait to create a new tx after her previous proposal was rejected. in seconds.
+  BACKOFF_TIME: 600,
+
+  MAX_MAIN_ADDRESS_GAP: 20,
+
+  // TODO: should allow different gap sizes for external/internal chains
+  SCAN_ADDRESS_GAP: 30,
+
+  FEE_LEVELS: {
+    btc: [
+      {
+        name: 'urgent',
+        nbBlocks: 2,
+        multiplier: 1.5,
+        defaultValue: 75000
+      },
+      {
+        name: 'priority',
+        nbBlocks: 2,
+        defaultValue: 50000
+      },
+      {
+        name: 'normal',
+        nbBlocks: 3,
+        defaultValue: 30000
+      },
+      {
+        name: 'economy',
+        nbBlocks: 6,
+        defaultValue: 25000
+      },
+      {
+        name: 'superEconomy',
+        nbBlocks: 24,
+        defaultValue: 10000
+      }
+    ],
+    bch: [
+      {
+        name: 'normal',
+        nbBlocks: 2,
+        multiplier: 1.05, // To fix fees < 1sat/byte
+        defaultValue: 2000
+      }
+    ],
+    eth: [
+      {
+        name: 'urgent',
+        nbBlocks: 1,
+        defaultValue: 10000000000
+      },
+      {
+        name: 'priority',
+        nbBlocks: 2,
+        defaultValue: 5000000000
+      },
+      {
+        name: 'normal',
+        nbBlocks: 3,
+        defaultValue: 1000000000
+      },
+      {
+        name: 'economy',
+        nbBlocks: 4,
+        defaultValue: 1000000000
+      },
+      {
+        name: 'superEconomy',
+        nbBlocks: 4,
+        defaultValue: 1000000000
+      }
+    ],
+    matic: [
+      {
+        name: 'urgent',
+        nbBlocks: 1,
+        defaultValue: 300000000000
+      },
+      {
+        name: 'priority',
+        nbBlocks: 2,
+        defaultValue: 250000000000
+      },
+      {
+        name: 'normal',
+        nbBlocks: 3,
+        defaultValue: 200000000000
+      },
+      {
+        name: 'economy',
+        nbBlocks: 4,
+        defaultValue: 200000000000
+      },
+      {
+        name: 'superEconomy',
+        nbBlocks: 4,
+        defaultValue: 200000000000
+      }
+    ],
+    arb: [
+      {
+        name: 'urgent',
+        nbBlocks: 1,
+        defaultValue: 3000000000
+      },
+      {
+        name: 'priority',
+        nbBlocks: 2,
+        defaultValue: 2500000000
+      },
+      {
+        name: 'normal',
+        nbBlocks: 3,
+        defaultValue: 2000000000
+      },
+      {
+        name: 'economy',
+        nbBlocks: 4,
+        defaultValue: 2000000000
+      },
+      {
+        name: 'superEconomy',
+        nbBlocks: 4,
+        defaultValue: 2000000000
+      }
+    ],
+    base: [
+      {
+        name: 'urgent',
+        nbBlocks: 1,
+        defaultValue: 3000000000
+      },
+      {
+        name: 'priority',
+        nbBlocks: 2,
+        defaultValue: 2500000000
+      },
+      {
+        name: 'normal',
+        nbBlocks: 3,
+        defaultValue: 2000000000
+      },
+      {
+        name: 'economy',
+        nbBlocks: 4,
+        defaultValue: 2000000000
+      },
+      {
+        name: 'superEconomy',
+        nbBlocks: 4,
+        defaultValue: 2000000000
+      }
+    ],
+    op: [
+      {
+        name: 'urgent',
+        nbBlocks: 1,
+        defaultValue: 3000000000
+      },
+      {
+        name: 'priority',
+        nbBlocks: 2,
+        defaultValue: 2500000000
+      },
+      {
+        name: 'normal',
+        nbBlocks: 3,
+        defaultValue: 2000000000
+      },
+      {
+        name: 'economy',
+        nbBlocks: 4,
+        defaultValue: 2000000000
+      },
+      {
+        name: 'superEconomy',
+        nbBlocks: 4,
+        defaultValue: 2000000000
+      }
+    ],
+    xrp: [
+      {
+        name: 'normal',
+        nbBlocks: 1, // 3 seconds
+        defaultValue: 12
+      }
+    ],
+    doge: [
+      {
+        name: 'normal',
+        nbBlocks: 2,
+        defaultValue: 100000000
+      }
+    ],
+    ltc: [
+      {
+        name: 'urgent',
+        nbBlocks: 2,
+        defaultValue: 150000
+      },
+      {
+        name: 'priority',
+        nbBlocks: 2,
+        defaultValue: 100000
+      },
+      {
+        name: 'normal',
+        nbBlocks: 3,
+        defaultValue: 100000
+      },
+      {
+        name: 'economy',
+        nbBlocks: 6,
+        defaultValue: 10000
+      },
+      {
+        name: 'superEconomy',
+        nbBlocks: 24,
+        defaultValue: 10000
+      }
+    ],
+    sol: [
+      {
+        name: 'normal',
+        nbBlocks: 1,
+        defaultValue: 5000
+      }
+    ],
+  },
+
+  // How many levels to fallback to if the value returned by the network for a given nbBlocks is -1
+  FEE_LEVELS_FALLBACK: 2,
+
+  FIAT_RATE_PROVIDER: 'BitPay',
+  FIAT_RATE_FETCH_INTERVAL: 10, // In minutes
+  FIAT_RATE_MAX_LOOK_BACK_TIME: 120, // In minutes
+
+  HISTORY_LIMIT: 1001,
+
+  // The maximum amount of an UTXO to be considered too big to be used in the tx before exploring smaller
+  // alternatives (proportinal to tx amount).
+  UTXO_SELECTION_MAX_SINGLE_UTXO_FACTOR: 2,
+
+  // The minimum amount an UTXO need to contribute proportional to tx amount.
+  UTXO_SELECTION_MIN_TX_AMOUNT_VS_UTXO_FACTOR: 0.1,
+
+  // The maximum threshold to consider fees non-significant in relation to tx amount.
+  UTXO_SELECTION_MAX_FEE_VS_TX_AMOUNT_FACTOR: 0.05,
+
+  // The maximum amount to pay for using small inputs instead of one big input
+  // when fees are significant (proportional to how much we would pay for using that big input only).
+  UTXO_SELECTION_MAX_FEE_VS_SINGLE_UTXO_FEE_FACTOR: 5,
+
+  // Minimum allowed amount for tx outputs (including change) in SAT
+  MIN_OUTPUT_AMOUNT: 546,
+
+  // Number of confirmations from which tx in history will be cached
+  // (ie we consider them inmutables)
+  CONFIRMATIONS_TO_START_CACHING: 6 * 6, // ~ 6hrs
+
+  // Number of addresses from which tx history is enabled in a wallet
+  HISTORY_CACHE_ADDRESS_THRESOLD: 100,
+
+  // Number of addresses from which balance in cache for a few seconds
+  BALANCE_CACHE_ADDRESS_THRESOLD: 100,
+
+  BALANCE_CACHE_DURATION: 10,
+
+  // Cache time for blockchain height (in ms)
+  BLOCKHEIGHT_CACHE_TIME: {
+    default: 30 * 60 * 1000, // this is erased on 'new block' notifications so, 30m seems fine
+    sol: 5 * 1000 // 5 seconds - Solana needs to maintain the freshes blockheight to land txs consistently
+  },
+  // Cache time fee levels (in ms)
+  FEE_LEVEL_CACHE_DURATION: 6 * 60 * 1000,
+
+  // Cache time for latest copay version (in ms)
+  COPAY_VERSION_CACHE_DURATION: 6 * 60 * 1000,
+
+  // Oneinch token list cache duration (in ms)
+  ONE_INCH_CACHE_DURATION: 1 * 60 * 1000,
+
+  // Coingecko get token cache duration (in ms)
+  COIN_GECKO_CACHE_DURATION: 1 * 24 * 60 * 60 * 1000,
+
+  COIN_GECKO_MARKET_STATS_CACHE_DURATION: 5 * 60 * 1000,
+
+  // Max allowed timespan for notification queries in seconds
+  MAX_NOTIFICATIONS_TIMESPAN: 60 * 60 * 24 * 14, // ~ 2 weeks
+  NOTIFICATIONS_TIMESPAN: 60,
+
+  SESSION_EXPIRATION: 1 * 60 * 60, // 1 hour to session expiration
+
+  RateLimit: {
+    createWallet: {
+      windowMs: 60 * 60 * 1000, // hour window
+      delayAfter: 8, // begin slowing down responses after the 3rd request
+      delayMs: 3000, // slow down subsequent responses by 3 seconds per request
+      max: 15, // start blocking after 20 request
+      message: 'Too many wallets created from this IP, please try again after an hour'
+    },
+    estimateFee: {
+      windowMs: 60 * 10 * 1000, // 10 min window
+      delayAfter: 5, // begin slowing down responses after the 3rd request
+      delayMs: 300, // slow down subsequent responses by 3 seconds per request
+
+      max: 10, // start blocking after 200 request
+      message: 'Too many request'
+    }
+
+    // otherPosts: {
+    //   windowMs: 60 * 60 * 1000, // 1 hour window
+    //   max: 1200 , // 1 post every 3 sec average, max.
+    // },
+  },
+  COIN: 'btc',
+  EVM_COIN: 'eth',
+  CHAIN: 'btc',
+  EVM_CHAIN: 'eth',
+  INSIGHT_REQUEST_POOL_SIZE: 10,
+  INSIGHT_TIMEOUT: 30000,
+
+  ADDRESS_SYNC_BATCH_SIZE: 500000,
+
+  LOCK_WAIT_TIME: 5 * 1000, // wait time 5s
+  LOCK_EXE_TIME: 40 * 1000, // max lock time 40s
+  SERVER_EXE_TIME: 40 * 1000 * 1.5,
+
+  BE_KEY_SALT: 'bws-auth-keysalt',
+
+  BROADCAST_RETRY_TIME: 350, // ms
+
+  /*
+   *      COIN SPECIFIC
+   */
+
+  MAX_TX_SIZE_IN_KB_BTC: 100,
+  MAX_TX_SIZE_IN_KB_BCH: 100,
+  MAX_TX_SIZE_IN_KB_DOGE: 100,
+
+  MAX_FEE_PER_KB: {
+    btc: 10000 * 1000, // 10k sat/b
+    bch: 10000 * 1000, // 10k sat/b
+    eth: 1000000000000, // 50 Gwei,
+    matic: 1000000000000, // 50 Gwei,
+    arb: 1000000000000, // 50 Gwei,
+    base: 1000000000000, // 50 Gwei,
+    op: 1000000000000, // 50 Gwei,
+    xrp: 1000000000000,
+    doge: 100000000 * 100,
+    ltc: 10000 * 1000, // 10k sat/b
+    sol: 15000 // Lamports per signature
+  },
+
+  MIN_TX_FEE: {
+    btc: 0,
+    bch: 0,
+    eth: 0,
+    matic: 0,
+    arb: 0,
+    base: 0,
+    op: 0,
+    xrp: 0,
+    doge: 0,
+    ltc: 0,
+    sol: 0,
+  },
+
+  MAX_TX_FEE: {
+    btc: 0.05 * 1e8,
+    bch: 0.05 * 1e8,
+    eth: 1 * 1e18, // 1 eth
+    matic: 1 * 1e18, // 1 matic
+    arb: 1 * 1e18, // 1 eth
+    base: 1 * 1e18, // 1 eth
+    op: 1 * 1e18, // 1 eth
+    xrp: 1 * 1e6, // 1 xrp
+    doge: 400 * 1e8,
+    ltc: 0.05 * 1e8
+  },
+
+  // ETH
+  DEFAULT_GAS_LIMIT: 60000,
+  DEFAULT_ERC20_GAS_LIMIT: 160000,
+  // Gas Limit per each multisend recipient
+  DEFAULT_MULTISEND_RECIPIENT_GAS_LIMIT: 45000,
+  DEFAULT_MULTISEND_RECIPIENT_ERC20_GAS_LIMIT: 65000,
+  MIN_GAS_LIMIT: 21000,
+
+  // Added buffer to account for variance between estimateGas and live execution
+  MS_GAS_LIMIT_BUFFER_PERCENT: 10 / 100,
+
+  // XRP has a non-refundable mininum activation fee / balance
+  MIN_XRP_BALANCE: 1000000,
+
+  // SOL has a non-refundable rent fee / balance
+  MIN_SOL_BALANCE: 1002240,
+
+  SOL_BASE_FEE: 5000,
+
+  // Time to get the latest push notification subscriptions. In ms.
+  PUSH_NOTIFICATION_SUBS_TIME: 10 * 60 * 1000, // 10 min.
+
+  PUSH_NOTIFICATION_LIMIT: 10,
+
+  FIAT_CURRENCIES: [
+    { code: 'USD', name: 'US Dollar' },
+    { code: 'INR', name: 'Indian Rupee' },
+    { code: 'GBP', name: 'Pound Sterling' },
+    { code: 'EUR', name: 'Eurozone Euro' },
+    { code: 'CAD', name: 'Canadian Dollar' },
+    { code: 'COP', name: 'Colombian Peso' },
+    { code: 'NGN', name: 'Nigerian Naira' },
+    { code: 'BRL', name: 'Brazilian Real' },
+    { code: 'ARS', name: 'Argentine Peso' },
+    { code: 'AUD', name: 'Australian Dollar' },
+    { code: 'JPY', name: 'Japanese Yen' },
+    { code: 'NZD', name: 'New Zealand Dollar' }
+  ],
+
+  TSS_KEYGEN_SCHEME_VERSION: 1,
+  TSS_SIGGEN_SCHEME_VERSION: 1,
+} as const;

package/src/lib/common/index.ts

@@ -0,0 +1,11 @@
+import { Constants } from './constants';
+import { Defaults } from './defaults';
+import { Services } from './services';
+import { Utils } from './utils';
+
+export const Common = {
+  Constants,
+  Defaults,
+  Services,
+  Utils
+};

package/src/lib/common/services.ts

@@ -0,0 +1,43 @@
+'use strict';
+
+export const Services = {
+  // Recommended whitelist of contracts as spenders for ERC20 tokens
+  ERC20_SPENDER_APPROVAL_WHITELIST: [
+    {
+      address: '0x11111112542D85B3EF69AE05771c2dCCff4fAa26', // 1inch v3 Contract address
+      contractName: '1inch V3',
+      name: '1inch',
+      url: 'https://app.1inch.io'
+    },
+    {
+      address: '0x1111111254fb6c44bac0bed2854e76f90643097d', // 1inch v4 Contract address
+      contractName: '1inch V4',
+      name: '1inch',
+      url: 'https://app.1inch.io'
+    },
+    {
+      address: '0xE592427A0AEce92De3Edee1F18E0157C05861564', // Uniswap V3: Router Contract address
+      contractName: 'Uniswap V3: Router',
+      name: 'Uniswap',
+      url: 'https://app.uniswap.org'
+    },
+    {
+      address: '0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D', // Uniswap V2: Router 2 Contract address
+      contractName: 'Uniswap V2: Router 2',
+      name: 'Uniswap',
+      url: 'https://app.uniswap.org'
+    },
+    {
+      address: '0xd9e1ce17f2641f24ae83637ab66a2cca9c378b9f', // SushiSwap: Router Contract address
+      contractName: 'SushiSwap: Router',
+      name: 'SushiSwap',
+      url: 'https://www.sushi.com/swap'
+    },
+    {
+      address: '0xD37BbE5744D730a1d98d8DC97c42F0Ca46aD7146', // THORChain: THORChain Router v4.1.1 Contract address
+      contractName: 'THORChain: THORChain Router v4.1.1',
+      name: 'THORChain',
+      url: 'https://thorchain.org/'
+    }
+  ]
+} as const;