subscriber-polling.d.ts 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. import type { AbstractProvider, Subscriber } from "./abstract-provider.js";
  2. import type { EventFilter, OrphanFilter, ProviderEvent } from "./provider.js";
  3. /**
  4. * Return the polling subscriber for common events.
  5. *
  6. * @_docloc: api/providers/abstract-provider
  7. */
  8. export declare function getPollingSubscriber(provider: AbstractProvider, event: ProviderEvent): Subscriber;
  9. /**
  10. * A **PollingBlockSubscriber** polls at a regular interval for a change
  11. * in the block number.
  12. *
  13. * @_docloc: api/providers/abstract-provider
  14. */
  15. export declare class PollingBlockSubscriber implements Subscriber {
  16. #private;
  17. /**
  18. * Create a new **PollingBlockSubscriber** attached to %%provider%%.
  19. */
  20. constructor(provider: AbstractProvider);
  21. /**
  22. * The polling interval.
  23. */
  24. get pollingInterval(): number;
  25. set pollingInterval(value: number);
  26. start(): void;
  27. stop(): void;
  28. pause(dropWhilePaused?: boolean): void;
  29. resume(): void;
  30. }
  31. /**
  32. * An **OnBlockSubscriber** can be sub-classed, with a [[_poll]]
  33. * implmentation which will be called on every new block.
  34. *
  35. * @_docloc: api/providers/abstract-provider
  36. */
  37. export declare class OnBlockSubscriber implements Subscriber {
  38. #private;
  39. /**
  40. * Create a new **OnBlockSubscriber** attached to %%provider%%.
  41. */
  42. constructor(provider: AbstractProvider);
  43. /**
  44. * Called on every new block.
  45. */
  46. _poll(blockNumber: number, provider: AbstractProvider): Promise<void>;
  47. start(): void;
  48. stop(): void;
  49. pause(dropWhilePaused?: boolean): void;
  50. resume(): void;
  51. }
  52. export declare class PollingBlockTagSubscriber extends OnBlockSubscriber {
  53. #private;
  54. constructor(provider: AbstractProvider, tag: string);
  55. pause(dropWhilePaused?: boolean): void;
  56. _poll(blockNumber: number, provider: AbstractProvider): Promise<void>;
  57. }
  58. /**
  59. * @_ignore:
  60. *
  61. * @_docloc: api/providers/abstract-provider
  62. */
  63. export declare class PollingOrphanSubscriber extends OnBlockSubscriber {
  64. #private;
  65. constructor(provider: AbstractProvider, filter: OrphanFilter);
  66. _poll(blockNumber: number, provider: AbstractProvider): Promise<void>;
  67. }
  68. /**
  69. * A **PollingTransactionSubscriber** will poll for a given transaction
  70. * hash for its receipt.
  71. *
  72. * @_docloc: api/providers/abstract-provider
  73. */
  74. export declare class PollingTransactionSubscriber extends OnBlockSubscriber {
  75. #private;
  76. /**
  77. * Create a new **PollingTransactionSubscriber** attached to
  78. * %%provider%%, listening for %%hash%%.
  79. */
  80. constructor(provider: AbstractProvider, hash: string);
  81. _poll(blockNumber: number, provider: AbstractProvider): Promise<void>;
  82. }
  83. /**
  84. * A **PollingEventSubscriber** will poll for a given filter for its logs.
  85. *
  86. * @_docloc: api/providers/abstract-provider
  87. */
  88. export declare class PollingEventSubscriber implements Subscriber {
  89. #private;
  90. /**
  91. * Create a new **PollingTransactionSubscriber** attached to
  92. * %%provider%%, listening for %%filter%%.
  93. */
  94. constructor(provider: AbstractProvider, filter: EventFilter);
  95. start(): void;
  96. stop(): void;
  97. pause(dropWhilePaused?: boolean): void;
  98. resume(): void;
  99. }
  100. //# sourceMappingURL=subscriber-polling.d.ts.map