Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.

Add support to ts type #49

Closed
segux opened this issue Dec 18, 2019 · 2 comments
Closed

Add support to ts type #49

segux opened this issue Dec 18, 2019 · 2 comments
Labels
wontfix This will not be worked on

Comments

@segux
Copy link

segux commented Dec 18, 2019

Hi, let you what type i created to get typescript type

type CryptoAddressValidator = {
  /**
   * @param {string} address Wallet address to validate.
   * @param {string} [currency="bitcoin"] - Optional. Currency name or symbol,
   *  e.g. 'bitcoin' (default), 'litecoin' or 'LTC'
   * @param {string} [networkType="prod"] - Optional. Use 'prod' (default) to enforce standard address,
   *  'testnet' to enforce testnet address and 'both' to enforce nothing.
   * @param {string} [addressType="legacy"] - Optional. Specifies what version of the address should be validated.
   *  Defaults to 'legacy', but can be changed on a per asset basis.
   *
   * @description
   * Simple wallet address validator for validating Bitcoin and other altcoins addresses in Node.js and browser.
   *
   * 0x/zrx '0x' or 'zrx'
   *
   * AdEx/adx 'AdEx' or 'adx'
   *
   * aelf/ELF 'aelf' or 'ELF'
   *
   * Aeternity/ae 'Aeternity' or 'ae'
   *
   * Aragon/ant 'Aragon' or 'ant'
   *
   * Ardor/ardr 'Ardor' or 'ardr'
   *
   * Augur/rep 'Augur' or 'rep'
   *
   * AuroraCoin/aur 'AuroraCoin' or 'aur'
   *
   * Australian Dollars/aud 'Australian Dollars' or 'aud'
   *
   * Bancor/bnt 'Bancor' or 'bnt'
   *
   * Bankex/bkx 'Bankex' or 'bkx'
   *
   * BasicAttentionToken/bat 'BasicAttentionToken' or 'bat'
   *
   * BeaverCoin/bvc 'BeaverCoin' or 'bvc'
   *
   * BinanceCoin/bnb 'BinanceCoin' or 'bnb'
   *
   * BioCoin/bio 'BioCoin' or 'bio'
   *
   * Bitcoin/btc 'Bitcoin' or 'btc'
   *
   * Bitcoin Diamond/bcd 'Bitcoin Diamond' or 'bcd'
   *
   * BitcoinCash/bch 'BitcoinCash' or 'bch'
   *
   * BitcoinCash/bcc 'BitcoinCash' or 'bcc'
   *
   * BitcoinGold/btg 'BitcoinGold' or 'btg'
   *
   * BitcoinPrivate/btcp 'BitcoinPrivate' or 'btcp'
   *
   * BitcoinZ/btcz 'BitcoinZ' or 'btcz'
   *
   * Bitquence/bqx 'Bitquence' or 'bqx'
   *
   * Bitshares/bts 'Bitshares' or 'bts'
   *
   * BitTorrent/btt 'BitTorrent' or 'btt'
   *
   * Callisto/clo 'Callisto' or 'clo'
   *
   * Cardano/ada 'Cardano' or 'ada'
   *
   * Chainlink/link 'Chainlink' or 'link'
   *
   * Civic/cvc 'Civic' or 'cvc'
   *
   * Cosmos/atom 'Cosmos' or 'atom'
   *
   * Dash/dash 'Dash' or 'dash'
   *
   * Decentraland/MANA 'Decentraland' or 'MANA'
   *
   * Decred/dcr 'Decred' or 'dcr'
   *
   * Dent/dent 'Dent' or 'dent'
   *
   * DigiByte/dgb 'DigiByte' or 'dgb'
   *
   * District0x/dnt 'District0x' or 'dnt'
   *
   * DogeCoin/doge 'DogeCoin' or 'doge'
   *
   * Enjin Coin/enj 'Enjin Coin' or 'enj'
   *
   * EOS/eos 'EOS' or 'eos'
   *
   * Ethereum/eth 'Ethereum' or 'eth'
   *
   * EthereumClassic/etc 'EthereumClassic' or 'etc'
   *
   * EtherZero/etz 'EtherZero' or 'etz'
   *
   * ETHOS/ethos 'ETHOS' or 'ethos'
   *
   * Expanse/exp 'Expanse' or 'exp'
   *
   * FreiCoin/frc 'FreiCoin' or 'frc'
   *
   * FunFair/fun 'FunFair' or 'fun'
   *
   * GameCredits/game 'GameCredits' or 'game'
   *
   * GarliCoin/grlc 'GarliCoin' or 'grlc'
   *
   * Gnosis/gno 'Gnosis' or 'gno'
   *
   * Golem/gnt 'Golem' or 'gnt'
   *
   * Golem/gnt 'Golem' or 'gnt'
   *
   * Holo/HOT 'Holo' or 'HOT'
   *
   * Horizen/zen 'Horizen' or 'zen'
   *
   * Hush/hush 'Hush' or 'hush'
   *
   * ICON/icx 'ICON' or 'icx'
   *
   * iExec RLC/RLC 'iExec RLC' or 'RLC'
   *
   * iExec RLC/rlc 'iExec RLC' or 'rlc'
   *
   * Internet of Services/IOST 'Internet of Services' or 'IOST'
   *
   * Iota/iota 'Iota' or 'iota'
   *
   * Komodo/kmd 'Komodo' or 'kmd'
   *
   * Lisk/lsk 'Lisk' or 'lsk'
   *
   * LiteCoin/ltc 'LiteCoin' or 'ltc'
   *
   * Matchpool/gup 'Matchpool' or 'gup'
   *
   * MegaCoin/mec 'MegaCoin' or 'mec'
   *
   * Melon/mln 'Melon' or 'mln'
   *
   * Metal/mtl 'Metal' or 'mtl'
   *
   * Monacao/mco 'Monacao' or 'mco'
   *
   * MonaCoin/mona 'MonaCoin' or 'mona'
   *
   * Monero/xmr 'Monero' or 'xmr'
   *
   * NameCoin/nmc 'NameCoin' or 'nmc'
   *
   * Nano/nano 'Nano' or 'nano'
   *
   * NEM/xem 'NEM' or 'xem'
   *
   * Neo/neo 'Neo' or 'neo'
   *
   * NeoGas/gas 'NeoGas' or 'gas'
   *
   * Nexus/nxs 'Nexus' or 'nxs'
   *
   * Numeraire/nmr 'Numeraire' or 'nmr'
   *
   * Odyssey/ocn 'Odyssey' or 'ocn'
   *
   * OmiseGO/omg 'OmiseGO' or 'omg'
   *
   * Ontology/ont 'Ontology' or 'ont'
   *
   * Paxos Standard Token/pax 'Paxos Standard Token' or 'pax'
   *
   * PeerCoin/ppc 'PeerCoin' or 'ppc'
   *
   * PIVX/pivx 'PIVX' or 'pivx'
   *
   * Polymath/poly 'Polymath' or 'poly'
   *
   * Populous/ppt 'Populous' or 'ppt'
   *
   * PowerLedger/powr 'PowerLedger' or 'powr'
   *
   * PrimeCoin/xpm 'PrimeCoin' or 'xpm'
   *
   * ProtoShares/pts 'ProtoShares' or 'pts'
   *
   * Pundi X/npxs 'Pundi X' or 'npxs'
   *
   * Qtum/qtum 'Qtum' or 'qtum'
   *
   * RaiBlocks/xrb 'RaiBlocks' or 'xrb'
   *
   * Ravencoin/rvn 'Ravencoin' or 'rvn'
   *
   * RipioCreditNetwork/rcn 'RipioCreditNetwork' or 'rcn'
   *
   * Ripple/xrp 'Ripple' or 'xrp'
   *
   * Salt/salt 'Salt' or 'salt'
   *
   * Siacoin/sc 'Siacoin' or 'sc'
   *
   * SnowGem/sng 'SnowGem' or 'sng'
   *
   * SolarCoin/slr 'SolarCoin' or 'slr'
   *
   * Status/snt 'Status' or 'snt'
   *
   * STEEM/steem 'STEEM' or 'steem'
   *
   * Stellar Lumens/xlm 'Stellar Lumens' or 'xlm'
   *
   * Storj/storj 'Storj' or 'storj'
   *
   * Storm/storm 'Storm' or 'storm'
   *
   * Stratis/strat 'Stratis' or 'strat'
   *
   * Substratum/sub 'Substratum' or 'sub'
   *
   * Swarm City/swt 'Swarm City' or 'swt'
   *
   * Syscoin/sys 'Syscoin' or 'sys'
   *
   * TenX/pay 'TenX' or 'pay'
   *
   * Tether/usdt 'Tether' or 'usdt'
   *
   * Tezos/XTZ 'Tezos' or 'XTZ'
   *
   * THETA/theta 'THETA' or 'theta'
   *
   * Tron/trx 'Tron' or 'trx'
   *
   * TrueUSD/tusd 'TrueUSD' or 'tusd'
   *
   * USD Coin/usdc 'USD Coin' or 'usdc'
   *
   * VeChain/vet 'VeChain' or 'vet'
   *
   * Verge/xvg 'Verge' or 'xvg'
   *
   * VertCoin/vtc 'VertCoin' or 'vtc'
   *
   * Viberate/vib 'Viberate' or 'vib'
   *
   * VoteCoin/vot 'VoteCoin' or 'vot'
   *
   * WaltonChain/wtc 'WaltonChain' or 'wtc'
   *
   * Waves/waves 'Waves' or 'waves'
   *
   * Wings/wings 'Wings' or 'wings'
   *
   * ZCash/zec 'ZCash' or 'zec'
   *
   * ZClassic/zcl 'ZClassic' or 'zcl'
   *
   * ZenCash/zen 'ZenCash' or 'zen'
   *
   * Zilliqa/zil 'Zilliqa' or 'zil'
   *
   */
  validate: (
    address: string,
    currency?: string,
    networkType?: 'prod' | 'testnet' | 'both',
    addressType?: string,
  ) => boolean;
}; 
@GusGold
Copy link
Contributor

GusGold commented Dec 18, 2019

This is written in es6 JS, but you're more than welcome to create a pull request for TS type, while maintaining backwards compatibility with vanilla javascript

@GusGold GusGold added the wontfix This will not be worked on label Dec 18, 2019
@GusGold
Copy link
Contributor

GusGold commented Dec 18, 2019

I'll close the issue for now, but feel free to still create the PR or add further comments

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants