validation.d.ts 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. import { BlockNumberOrTag } from 'web3-types';
  2. /**
  3. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  4. */
  5. export declare const isHexStrict: (hex: import("web3-validator").ValidInputTypes) => boolean;
  6. /**
  7. * returns true if input is a hexstring, number or bigint
  8. *
  9. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  10. */
  11. export declare const isHex: (hex: import("web3-validator").ValidInputTypes) => boolean;
  12. /**
  13. * Checks the checksum of a given address. Will also return false on non-checksum addresses.
  14. *
  15. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  16. */
  17. export declare const checkAddressCheckSum: (data: string) => boolean;
  18. /**
  19. * Checks if a given string is a valid Ethereum address. It will also check the checksum, if the address has upper and lowercase letters.
  20. *
  21. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  22. */
  23. export declare const isAddress: (value: import("web3-validator").ValidInputTypes, checkChecksum?: boolean | undefined) => boolean;
  24. /**
  25. * Returns true if the bloom is a valid bloom
  26. * https://github.com/joshstevens19/ethereum-bloom-filters/blob/fbeb47b70b46243c3963fe1c2988d7461ef17236/src/index.ts#L7
  27. *
  28. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  29. */
  30. export declare const isBloom: (bloom: import("web3-validator").ValidInputTypes) => boolean;
  31. /**
  32. * Returns true if the value is part of the given bloom
  33. * note: false positives are possible.
  34. *
  35. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  36. */
  37. export declare const isInBloom: (bloom: string, value: string | Uint8Array) => boolean;
  38. /**
  39. * Returns true if the ethereum users address is part of the given bloom note: false positives are possible.
  40. *
  41. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  42. */
  43. export declare const isUserEthereumAddressInBloom: (bloom: string, ethereumAddress: string) => boolean;
  44. /**
  45. * Returns true if the contract address is part of the given bloom.
  46. * note: false positives are possible.
  47. *
  48. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  49. */
  50. export declare const isContractAddressInBloom: (bloom: string, contractAddress: string) => boolean;
  51. /**
  52. * Checks if its a valid topic
  53. *
  54. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  55. */
  56. export declare const isTopic: (topic: string) => boolean;
  57. /**
  58. * Returns true if the topic is part of the given bloom.
  59. * note: false positives are possible.
  60. *
  61. * @deprecated Will be removed in next release. Please use `web3-validator` package instead.
  62. */
  63. export declare const isTopicInBloom: (bloom: string, topic: string) => boolean;
  64. /**
  65. * Compares between block A and block B
  66. * @param blockA - Block number or string
  67. * @param blockB - Block number or string
  68. *
  69. * @returns - Returns -1 if a \< b, returns 1 if a \> b and returns 0 if a == b
  70. *
  71. * @example
  72. * ```ts
  73. * console.log(web3.utils.compareBlockNumbers('latest', 'pending'));
  74. * > -1
  75. *
  76. * console.log(web3.utils.compareBlockNumbers(12, 11));
  77. * > 1
  78. * ```
  79. */
  80. export declare const compareBlockNumbers: (blockA: BlockNumberOrTag, blockB: BlockNumberOrTag) => 0 | 1 | -1;
  81. export declare const isNullish: (item: unknown) => item is null | undefined;