ptokens-utils/types/index.d.ts

repo holding some utils needed by other packages

import { EventEmitter } from 'events'
import { TransactionReceipt } from 'web3-core'
import { Api, JsonRpc } from 'eosjs'
import { JsSignatureProvider } from 'eosjs/dist/eosjs-jssig'
import Web3 from 'web3'
import { BigNumber } from 'bignumber.js'

// btc
export interface BitcoinUtxoList extends Array<BitcoinUtxo> {}

export interface BitcoinTransactionStatus {
  confirmed: boolean
  block_height?: number
  block_hash?: string
  block_time?: number
}

export interface BitcoinUtxo {
  txid: string
  vout: number
  status: BitcoinTransactionStatus
  value: number
}

export interface BitcoinBroadcastedTx {
  txid: string
}

export interface BitcoinVin {
  txid: string
  vout: number
  prevout: {
    scriptpubkey: string
    scriptpubkey_asm: string
    scriptpubkey_type: string
    scriptpubkey_address: string
    value: number
  }
  scriptsig: string
  scriptsig_asm: string
  is_coinbase: false
  sequence: number
  inner_redeemscript_asm: string
}

export interface BitcoinVout {
  n: number
  scriptPubKey: {
    addresses: string[]
    asm: string
    hex: string
    type: string
  }
  spentHeight: number
  spentIndex: number
  spentTxId: string
  value: number
}

export interface BitcoinVinList extends Array<BitcoinVin> {}

export interface BitcoinVoutList extends Array<BitcoinVout> {}

export interface BitcoinTransactionReceipt {
  txid: string
  version: number
  locktime: number
  vin: BitcoinVinList
  vout: BitcoinVoutList
  size: number
  weight: number
  fee: number
  status: BitcoinTransactionStatus
}

export interface BtcUtils {
  broadcastTransaction(_network: string, _tx: string): Promise<BitcoinBroadcastedTx>
  getUtxoByAddress(_network: string, _address: string): Promise<BitcoinUtxoList>
  getTransactionHexById(_network: string, _txId: string): Promise<string>
  isValidAddress(_address: string): boolean
  monitorUtxoByAddress(
    _network: string,
    _address: string,
    _eventEmitter: EventEmitter,
    _pollingTime: number,
    _broadcastEventName?: string,
    _confirmationEventName?: string,
    _confirmations?: number
  ): Promise<string>
  waitForTransactionConfirmation(
    _network: string,
    _tx: string,
    _pollingTime: number,
    _broadcastEventName: string,
    _confirmationEventName: string
  ): Promise<BitcoinTransactionReceipt>
}

export const btc: BtcUtils

// converters
export interface Converters {
  decodeUint64le(_buffer: Buffer): number
  encodeUint64le(_number: number): Buffer
}

export const converters: Converters

// eth
export interface ContractCallParam {
  abi: any // difficult to get abi interface
  contractAddress: string
  value?: number
}

export interface ContractSendParam {
  abi: any // difficult to get abi interface
  contractAddress: string
  value?: number
  privateKey?: string
  gas?: number
  gasPrice?: number | string | BigNumber
}

export interface EthUtils {
  addHexPrefix(_string: string): string
  removeHexPrefix(_string: string): string
  onChainFormat(_amount: BigNumber, _decimals: number): BigNumber
  offChainFormat(_amount: BigNumber, _decimals: number): BigNumber
  getAccount(_web3: Web3, _isWeb3Injected: boolean): string
  getContract(_web3: Web3, _abi: any, _contractAddress: string, _account: string): object
  getGasLimit(_web3: Web3): number
  isHexPrefixed(_string: string): boolean
  makeContractCall(
    _web3: Web3,
    _method: string,
    _options: ContractCallParam,
    _params: Array<number | string>
  ): Promise<TransactionReceipt>
  makeContractSend(
    _web3: Web3,
    _method: string,
    _options: ContractSendParam,
    _params: Array<number | string>
  ): Promise<TransactionReceipt>
  sendSignedMethodTx(
    _web3: Web3,
    _method: string,
    _options: ContractSendParam,
    _params: Array<number | string>
  ): Promise<TransactionReceipt>
  waitForTransactionConfirmation(_web3: Web3, _tx: string, _pollingTime: number): Promise<TransactionReceipt>
}

export const eth: EthUtils

// eos
export interface EosUtils {
  getApi(_privateKey: string, _rpc: string | JsonRpc, _signatureProvider: JsSignatureProvider | null): Api
  getAvailablePublicKeys(_signatureProvider: JsSignatureProvider): Promise<string[]>
  getAmountInEosFormat(_amount: number, _decimals: number): number
  isValidAccountName(_accountName: string): boolean
  transferNativeToken(
    _api: Api,
    _to: string,
    _accountName: string,
    _amount: number,
    _memo: string,
    _blocksBehind: number,
    _expireSeconds: number
  ): Promise<any>
  waitForTransactionConfirmation(_api: Api, _tx: string): Promise<any>
}

export const eos: EosUtils

// helpers
export interface Params {
  network?: string
  hostNetwork?: string
  blockchain?: string
  hostBlockchain?: string
  nativeNetwork?: string
  nativeBlockchain?: string
}

export interface ParsedParams {
  hostNetwork: string
  hostBlockchain: string
  nativeNetwork: string
  nativeBlockchain: string
}

export interface Helpers {
  parseParams(_params: object, _nativeBlockchain: string): ParsedParams
  getBlockchainType(_blockchain: string): string
  getBlockchainShortType(_blockchain: string): string
  getNetworkType(_network: string): string
  getNativeBlockchainFromPtokenName(_name: string): string
  isValidPTokenName(_name: string): boolean
}

export const helpers: Helpers

// constants
export interface Blockchains {
  Bitcoin: string
  Litecoin: string
  Ethereum: string
  Eosio: string
  Telos: string
  Dogecoin: string
  BinanceSmartChain: string
  Polygon: string
  Xdai: string
  Ravencoin: string
  Lbry: string
  Ultra: string
  Arbitrum: string
  Luxochain: string
  Algorand: string
  Fantom: string
}

export interface Networks {
  Mainnet: string
  Testnet: string
  BitcoinMainnet: string
  BitcoinTestnet: string
  LitecoinMainnet: string
  LitecoinTestnet: string
  EthereumMainnet: string
  EthereumRopsten: string
  EosioMainnet: string
  EosioJungle3: string
  TelosMainnet: string
  DogecoinMainnet: string
  BinanceSmartChainMainnet: string
  PolygonMainnet: string
  XdaiMainnet: string
  RavecoinMainnet: string
  LbryMainnet: string
  UltraMainnet: string
  UltraTestnet: string
  ArbitrumMainnet: string
  LuxochainMainnet: string
  AlgorandMainnet: string
  FantomMainnet: string
}

export interface pTokens {
  pBTC: string
  pLTC: string
  pWETH: string
  pETH: string
  pLINK: string
  PNT: string
  PTERIA: string
  pMKR: string
  pYFI: string
  pUNI: string
  pBAND: string
  pBAL: string
  pCOMP: string
  pSNX: string
  pOMG: string
  pDAI: string
  pANT: string
  pLRC: string
  pUOS: string
  pBAT: string
  pREP: string
  pZRX: string
  pPNK: string
  pDOGE: string
  pEOS: string
  IQ: string
  TLOS: string
  pOPIUM: string
  pBCP: string
  pDEFIPlusPlus: string
  CGG: string
  pUSDC: string
  pUSDT: string
  pRVN: string
  pOPEN: string
  OCP: string
  ANRX: string
  TFF: string
  pSAFEMOON: string
  EFX: string
  pSEEDS: string
  pLBC: string
  USDO: string
  GALA: string
  BIST: string
  pVAI: string
  WSB: string
  LUXO: string
  pTET: string
  pKEYS: string
  OATH: string
  pFTM: string
  pWFTM: string
  NUCO: string
  ORE: string
}

export interface EthereumMainnetTokens {
  ETH: string
  WETH: string
  LINK: string
  PNT: string
  PTERIA: string
  MKR: string
  YFI: string
  UNI: string
  BAND: string
  BAL: string
  COMP: string
  SNX: string
  OMG: string
  DAI: string
  ANT: string
  LRC: string
  UOS: string
  BAT: string
  REP: string
  ZRX: string
  PNK: string
  OPIUM: string
  BCP: string
  'DEFI++': string
  CGG: string
  USDC: string
  USDT: string
  OPEN: string
  ANRX: string
  GALA: string
  BIST: string
  LUXO: string
  KEYS: string
  NCDT: string
}

export interface EthereumRopstenTokens {
  UOS: string
}

export interface BinanceSmartC0x00d5beb0hainMainnetTokens {
  OCP: string
  TFF: string
  SAFEMOON: string
  USDO: string
  VAI: string
  WSB: string
}

export interface TelosMainnetTokens {
  TELOS: string
  SEEDS: string
}

export interface TelosTokens {
  mainnet: TelosMainnetTokens
}

export interface OreMainnetTokens {
  ORE: string
}

export interface OreTokens {
  mainnet: OreMainnetTokens
}

export interface EosioMainnetTokens {
  EOS: string
  IQ: string
  EFX: string
}

export interface EthereumTokens {
  mainnet: EthereumMainnetTokens
  testnet_ropsten: EthereumRopstenTokens
}

export interface EosioTokens {
  mainnet: EosioMainnetTokens
}

export interface BinanceSmartChainMainnetTokens {
  OCP: string
  TFF: string
  SAFEMOON: string
  USDO: string
  VAI: string
  WSB: string
  pTET: string
}

export interface BinanceSmartChainTokens {
  mainnet: BinanceSmartChainMainnetTokens
}

export interface Tokens {
  ethereum: EthereumTokens
  eosio: EosioTokens
  telos: TelosTokens
  'binance-smart-chain': BinanceSmartChainTokens
  ore: OreTokens
}

export interface ChainIdsArbitrum {
  mainnet: string
}

export interface ChainIds {
  arbitrum: ChainIdsArbitrum
}

export interface Constants {
  blockchains: Blockchains
  networks: Networks
  pTokens: pTokens
  tokens: Tokens
}

export const constants: Constants

// ltc
export interface LitecoinUtxoList extends Array<LitecoinUtxo> {}

export interface LitecoinUtxo {
  address: string
  txid: string
  vout: number
  value: number
  scriptPubKey: string
  amount: number
  satoshis: number
  height: number
  confirmations: number
}

export interface LitecoinBroadcastedTx {
  txid: string
}

export interface LitecoinVin {
  addr: string
  doubleSpentTxID: string | null
  n: number
  scriptSig: {
    asm: string
    hex: string
  }
  sequence: number
  txid: string
  value: number
  valueSat: number
  vout: number
}

export interface LitecoinVout {
  n: number
  scriptPubKey: {
    addresses: string[]
    asm: string
    hex: string
    type: string
  }
  spentHeight: number
  spentIndex: number
  spentTxId: string
  value: number
}

export interface LitecoinVinList extends Array<LitecoinVin> {}

export interface LitecoinVoutList extends Array<LitecoinVout> {}

export interface LitecoinTransactionReceipt {
  blockhash: string
  blockheight: number
  blocktime: number
  confirmations: number
  fees: number
  locktime: number
  size: number
  time: number
  txid: string
  valueIn: number
  valueOut: number
  version: number
  vin: LitecoinVinList
  vout: LitecoinVoutList
}

export interface LtcUtils {
  broadcastTransaction(_network: string, _tx: string): Promise<LitecoinBroadcastedTx>
  getUtxoByAddress(_network: string, _address: string): Promise<LitecoinUtxoList>
  getTransactionHexById(_network: string, _txId: string): Promise<string>
  isValidAddress(_network: string, _address: string): boolean
  monitorUtxoByAddress(
    _network: string,
    _address: string,
    _eventEmitter: EventEmitter,
    _pollingTime: number,
    _broadcastEventName?: string,
    _confirmationEventName?: string,
    _confirmations?: number
  ): Promise<string>
  waitForTransactionConfirmation(
    _network: string,
    _tx: string,
    _pollingTime: number,
    _broadcastEventName: string,
    _confirmationEventName: string
  ): Promise<LitecoinTransactionReceipt>
}

export const ltc: LtcUtils

// doge
export interface DogecoinBroadcastedTx {
  tx: string
}

export interface DogecoinUtxoList extends Array<DogecoinUtxo> {}

export interface DogecoinUtxo {
  tx_hash: string
  tx_output_n: number
  script: string
  value: string
  confirmations: number
}

export interface DogecoinInput {
  pos: number
  value: string
  type: string
  address: string
  scriptSig: object
  previous_output: object
}

export interface DogecoinOutput {
  pos: number
  value: string
  type: string
  address: string
}

export interface DogecoinInputs extends Array<DogecoinInput> {}

export interface DogecoinOutputs extends Array<DogecoinOutput> {}

export interface DogecoinTransactionReceipt {
  hash: string
  confirmations: number
  size: number
  version: BitcoinVinList
  locktime: BitcoinVoutList
  block_hash: string
  time: number
  inputs_n: number
  inputs: DogecoinInputs
  inputs_value: string
  outputs_n: number
  outputs: DogecoinOutputs
  outputs_value: string
  fee: number
}

export interface DogeUtils {
  broadcastTransaction(_network: string, _tx: string): Promise<DogecoinBroadcastedTx>
  getUtxoByAddress(_network: string, _address: string): Promise<DogecoinUtxoList>
  isValidAddress(_network: string, _address: string): boolean
  monitorUtxoByAddress(
    _network: string,
    _address: string,
    _eventEmitter: EventEmitter,
    _pollingTime: number
  ): Promise<string>
  waitForTransactionConfirmation(
    _network: string,
    _tx: string,
    _pollingTime: number,
    _broadcastEventName: string,
    _confirmationEventName: string
  ): Promise<LitecoinTransactionReceipt>
}

export const doge: LtcUtils

// ltc
export interface RavencoinUtxoList extends Array<RavencoinUtxo> {}

export interface RavencoinUtxo {
  address: string
  txid: string
  vout: number
  value: number
  scriptPubKey: string
  amount: number
  satoshis: number
  height: number
  confirmations: number
}

export interface RavencoinBroadcastedTx {
  txid: string
}

export interface RavencoinVin {
  addr: string
  doubleSpentTxID: string | null
  n: number
  scriptSig: {
    asm: string
    hex: string
  }
  sequence: number
  txid: string
  value: number
  valueSat: number
  vout: number
}

export interface RavencoinVout {
  n: number
  scriptPubKey: {
    addresses: string[]
    asm: string
    hex: string
    type: string
  }
  spentHeight: number
  spentIndex: number
  spentTxId: string
  value: number
}

export interface RavencoinVinList extends Array<RavencoinVin> {}

export interface RavencoinVoutList extends Array<RavencoinVout> {}

export interface RavencoinTransactionReceipt {
  blockhash: string
  blockheight: number
  blocktime: number
  confirmations: number
  fees: number
  locktime: number
  size: number
  time: number
  txid: string
  valueIn: number
  valueOut: number
  version: number
  vin: LitecoinVinList
  vout: LitecoinVoutList
}

export interface RvnUtils {
  broadcastTransaction(_network: string, _tx: string): Promise<RavencoinBroadcastedTx>
  getUtxoByAddress(_network: string, _address: string): Promise<RavencoinUtxoList>
  getTransactionHexById(_network: string, _txId: string): Promise<string>
  isValidAddress(_network: string, _address: string): boolean
  monitorUtxoByAddress(
    _network: string,
    _address: string,
    _eventEmitter: EventEmitter,
    _pollingTime: number,
    _broadcastEventName?: string,
    _confirmationEventName?: string,
    _confirmations?: number
  ): Promise<string>
  waitForTransactionConfirmation(
    _network: string,
    _tx: string,
    _pollingTime: number,
    _broadcastEventName: string,
    _confirmationEventName: string
  ): Promise<RavencoinTransactionReceipt>
}

export const rvn: RvnUtils

export interface AlgoUtils {
  isValidAddress(_network: string, _address: string): boolean
  waitForTransactionConfirmation(
    _network: string,
    _tx: string,
    _pollingTime: number,
    _broadcastEventName: string,
    _confirmationEventName: string
  ): Promise<RavencoinTransactionReceipt>
}

export const algo: AlgoUtils