@ozdao/prometheus-framework 0.2.57 → 0.2.59

package/dist/node_modules/web3-eth/lib/esm/web3_eth.js

@@ -7,62 +7,62 @@ import "../../../web3-core/lib/esm/web3_subscription_manager.js";
 import "../../../web3-core/lib/esm/web3_subscriptions.js";
 import { Web3Context as T } from "../../../web3-core/lib/esm/web3_context.js";
 import "../../../web3-core/lib/esm/web3_batch_request.js";
-import { isSupportedProvider as S } from "../../../web3-core/lib/esm/utils.js";
-import { TransactionNotFound as g } from "../../../web3-errors/lib/esm/errors/transaction_errors.js";
+import { isSupportedProvider as y } from "../../../web3-core/lib/esm/utils.js";
+import { TransactionNotFound as f } from "../../../web3-errors/lib/esm/errors/transaction_errors.js";
 import "../../../web3-errors/lib/esm/errors/rpc_errors.js";
 import "../../../web3-eth-iban/lib/esm/iban.js";
 import "../../../web3-validator/lib/esm/formats.js";
 import "../../../web3-validator/lib/esm/default_validator.js";
 import "../../../web3-core/lib/esm/web3_promi_event.js";
-import { getProtocolVersion as y, getSyncing as w, getCoinbase as M, getMining as A, getAccounts as q, getWork as C, submitWork as N, requestAccounts as P, getNodeInfo as _ } from "../../../web3-rpc-methods/lib/esm/eth_rpc_methods.js";
+import { getProtocolVersion as P, getSyncing as S, getCoinbase as F, getMining as M, getAccounts as w, getWork as A, submitWork as G, requestAccounts as q, getNodeInfo as C } from "../../../web3-rpc-methods/lib/esm/eth_rpc_methods.js";
 import "../../../web3-rpc-methods/lib/esm/net_rpc_methods.js";
 import "../../../web3-rpc-methods/lib/esm/personal_rpc_methods.js";
-import { getHashRate as H, getGasPrice as R, getBlockNumber as F, getBalance as L, getStorageAt as U, getCode as I, getBlock as W, getBlockTransactionCount as G, getBlockUncleCount as j, getUncle as D, getTransaction as E, getPendingTransactions as x, getTransactionFromBlock as V, getTransactionReceipt as z, getTransactionCount as J, sendTransaction as K, sendSignedTransaction as Q, sign as X, signTransaction as Y, call as Z, estimateGas as $, getLogs as O, getChainId as tt, getProof as it, getFeeHistory as nt, createAccessList as et, signTypedData as rt } from "./rpc_method_wrappers.js";
-import { LogsSubscription as p, NewPendingTransactionsSubscription as f, NewHeadsSubscription as l, SyncingSubscription as m } from "./web3_subscriptions.js";
-import { toChecksumAddress as ot } from "../../../web3-utils/lib/esm/converters.js";
-import { isNullish as st } from "../../../web3-utils/lib/esm/validation.js";
-var e = globalThis && globalThis.__awaiter || function(k, t, i, n) {
+import { getHashRate as N, getGasPrice as _, getMaxPriorityFeePerGas as H, getBlockNumber as R, getBalance as x, getStorageAt as L, getCode as U, getBlock as D, getBlockTransactionCount as I, getBlockUncleCount as W, getUncle as j, getTransaction as E, getPendingTransactions as V, getTransactionFromBlock as z, getTransactionReceipt as J, getTransactionCount as K, sendTransaction as Q, sendSignedTransaction as X, sign as Y, signTransaction as Z, call as $, estimateGas as O, getLogs as tt, getChainId as it, getProof as et, getFeeHistory as nt, createAccessList as rt, signTypedData as ot } from "./rpc_method_wrappers.js";
+import { LogsSubscription as m, NewPendingTransactionsSubscription as g, NewHeadsSubscription as v, SyncingSubscription as b } from "./web3_subscriptions.js";
+import { ethUnitMap as st, toChecksumAddress as ut } from "../../../web3-utils/lib/esm/converters.js";
+import { isNullish as ct } from "../../../web3-utils/lib/esm/validation.js";
+var n = function(B, t, i, e) {
   function o(s) {
     return s instanceof i ? s : new i(function(u) {
       u(s);
     });
   }
   return new (i || (i = Promise))(function(s, u) {
-    function a(c) {
+    function c(a) {
       try {
-        d(n.next(c));
-      } catch (h) {
-        u(h);
+        d(e.next(a));
+      } catch (l) {
+        u(l);
       }
     }
-    function B(c) {
+    function h(a) {
       try {
-        d(n.throw(c));
-      } catch (h) {
-        u(h);
+        d(e.throw(a));
+      } catch (l) {
+        u(l);
       }
     }
-    function d(c) {
-      c.done ? s(c.value) : o(c.value).then(a, B);
+    function d(a) {
+      a.done ? s(a.value) : o(a.value).then(c, h);
     }
-    d((n = n.apply(k, t || [])).next());
+    d((e = e.apply(B, t || [])).next());
   });
 };
-const v = {
-  logs: p,
-  newPendingTransactions: f,
-  newHeads: l,
-  syncing: m,
-  pendingTransactions: f,
-  newBlockHeaders: l
+const p = {
+  logs: m,
+  newPendingTransactions: g,
+  newHeads: v,
+  syncing: b,
+  pendingTransactions: g,
+  newBlockHeaders: v
   // the same as newHeads. just for support API like in version 1.x
 };
-class b extends T {
+class k extends T {
   constructor(t) {
-    if (typeof t == "string" || S(t)) {
+    if (typeof t == "string" || y(t)) {
       super({
         provider: t,
-        registeredSubscriptions: v
+        registeredSubscriptions: p
       });
       return;
     }
@@ -70,7 +70,7 @@ class b extends T {
       super(t);
       return;
     }
-    super(Object.assign(Object.assign({}, t), { registeredSubscriptions: v }));
+    super(Object.assign(Object.assign({}, t), { registeredSubscriptions: p })), this.getFeeData = this.calculateFeeData;
   }
   /**
    * @returns Returns the ethereum protocol version of the node.
@@ -81,8 +81,8 @@ class b extends T {
    * ```
    */
   getProtocolVersion() {
-    return e(this, void 0, void 0, function* () {
-      return y(this.requestManager);
+    return n(this, void 0, void 0, function* () {
+      return P(this.requestManager);
     });
   }
   // TODO Add returnFormat parameter
@@ -103,8 +103,8 @@ class b extends T {
    * ```
    */
   isSyncing() {
-    return e(this, void 0, void 0, function* () {
-      return w(this.requestManager);
+    return n(this, void 0, void 0, function* () {
+      return S(this.requestManager);
     });
   }
   // TODO consider adding returnFormat parameter (to format address as bytes)
@@ -117,8 +117,8 @@ class b extends T {
    * ```
    */
   getCoinbase() {
-    return e(this, void 0, void 0, function* () {
-      return M(this.requestManager);
+    return n(this, void 0, void 0, function* () {
+      return F(this.requestManager);
     });
   }
   /**
@@ -132,8 +132,8 @@ class b extends T {
    * ```
    */
   isMining() {
-    return e(this, void 0, void 0, function* () {
-      return A(this.requestManager);
+    return n(this, void 0, void 0, function* () {
+      return M(this.requestManager);
     });
   }
   /**
@@ -151,7 +151,7 @@ class b extends T {
    * ```
    */
   getHashrate(t = r) {
-    return e(this, void 0, void 0, function* () {
+    return n(this, void 0, void 0, function* () {
       return this.getHashRate(t);
     });
   }
@@ -168,8 +168,8 @@ class b extends T {
    * ```
    */
   getHashRate(t = r) {
-    return e(this, void 0, void 0, function* () {
-      return H(this, t);
+    return n(this, void 0, void 0, function* () {
+      return N(this, t);
     });
   }
   /**
@@ -185,8 +185,70 @@ class b extends T {
    * ```
    */
   getGasPrice(t = r) {
-    return e(this, void 0, void 0, function* () {
-      return R(this, t);
+    return n(this, void 0, void 0, function* () {
+      return _(this, t);
+    });
+  }
+  /**
+   * @param returnFormat ({@link DataFormat} defaults to {@link DEFAULT_RETURN_FORMAT}) Specifies how the return data should be formatted.
+   * @returns the current maxPriorityFeePerGas per gas in wei.
+   *
+   * ```ts
+   * web3.eth.getMaxPriorityFeePerGas().then(console.log);
+   * > 20000000000n
+   *
+   * web3.eth.getMaxPriorityFeePerGas({ number: FMT_NUMBER.HEX , bytes: FMT_BYTES.HEX }).then(console.log);
+   * > "0x4a817c800"
+   * ```
+   */
+  getMaxPriorityFeePerGas(t = r) {
+    return n(this, void 0, void 0, function* () {
+      return H(this, t);
+    });
+  }
+  /**
+   * Calculates the current Fee Data.
+   * If the node supports EIP-1559, then the `maxFeePerGas` and `maxPriorityFeePerGas` will be calculated.
+   * If the node does not support EIP-1559, then the `gasPrice` will be returned and the rest are `null`s.
+   *
+   * @param baseFeePerGasFactor The factor to multiply the baseFeePerGas with, if the node supports EIP-1559.
+   * @param alternativeMaxPriorityFeePerGas The alternative maxPriorityFeePerGas to use, if the node supports EIP-1559, but does not support the method `eth_maxPriorityFeePerGas`.
+   * @returns The current fee data.
+   *
+   * ```ts
+   * web3.eth.calculateFeeData().then(console.log);
+   * > {
+   *     gasPrice: 20000000000n,
+   *     maxFeePerGas: 20000000000n,
+   *     maxPriorityFeePerGas: 20000000000n,
+   * 	   baseFeePerGas: 20000000000n
+   * }
+   *
+   * web3.eth.calculateFeeData(ethUnitMap.Gwei, 2n).then(console.log);
+   * > {
+   *     gasPrice: 20000000000n,
+   *     maxFeePerGas: 40000000000n,
+   *     maxPriorityFeePerGas: 20000000000n,
+   * 	   baseFeePerGas: 20000000000n
+   * }
+   * ```
+   */
+  calculateFeeData(t = BigInt(2), i = st.Gwei) {
+    var e;
+    return n(this, void 0, void 0, function* () {
+      const o = yield this.getBlock(void 0, !1), s = (e = o == null ? void 0 : o.baseFeePerGas) !== null && e !== void 0 ? e : void 0;
+      let u;
+      try {
+        u = yield this.getGasPrice();
+      } catch {
+      }
+      let c;
+      try {
+        c = yield this.getMaxPriorityFeePerGas();
+      } catch {
+      }
+      let h;
+      return s && (c = c ?? i, h = s * t + c), { gasPrice: u, maxFeePerGas: h, maxPriorityFeePerGas: c, baseFeePerGas: s };
     });
   }
   /**
@@ -199,8 +261,8 @@ class b extends T {
    */
   getAccounts() {
     var t;
-    return e(this, void 0, void 0, function* () {
-      return ((t = yield q(this.requestManager)) !== null && t !== void 0 ? t : []).map((n) => ot(n));
+    return n(this, void 0, void 0, function* () {
+      return ((t = yield w(this.requestManager)) !== null && t !== void 0 ? t : []).map((e) => ut(e));
     });
   }
   /**
@@ -216,8 +278,8 @@ class b extends T {
    * ```
    */
   getBlockNumber(t = r) {
-    return e(this, void 0, void 0, function* () {
-      return F(this, t);
+    return n(this, void 0, void 0, function* () {
+      return R(this, t);
     });
   }
   /**
@@ -236,9 +298,9 @@ class b extends T {
    * > "0xe8d4a51000"
    * ```
    */
-  getBalance(t, i = this.defaultBlock, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return L(this, t, i, n);
+  getBalance(t, i = this.defaultBlock, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return x(this, t, i, e);
     });
   }
   /**
@@ -268,9 +330,9 @@ class b extends T {
    *    ]
    * ```
    */
-  getStorageAt(t, i, n = this.defaultBlock, o = r) {
-    return e(this, void 0, void 0, function* () {
-      return U(this, t, i, n, o);
+  getStorageAt(t, i, e = this.defaultBlock, o = r) {
+    return n(this, void 0, void 0, function* () {
+      return L(this, t, i, e, o);
     });
   }
   /**
@@ -299,9 +361,9 @@ class b extends T {
    * ]
    * ```
    */
-  getCode(t, i = this.defaultBlock, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return I(this, t, i, n);
+  getCode(t, i = this.defaultBlock, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return U(this, t, i, e);
     });
   }
   /**
@@ -368,9 +430,9 @@ class b extends T {
    *  }
    * ```
    */
-  getBlock(t = this.defaultBlock, i = !1, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return W(this, t, i, n);
+  getBlock(t = this.defaultBlock, i = !1, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return D(this, t, i, e);
     });
   }
   /**
@@ -390,8 +452,8 @@ class b extends T {
    * ```
    */
   getBlockTransactionCount(t = this.defaultBlock, i = r) {
-    return e(this, void 0, void 0, function* () {
-      return G(this, t, i);
+    return n(this, void 0, void 0, function* () {
+      return I(this, t, i);
     });
   }
   /**
@@ -411,8 +473,8 @@ class b extends T {
    * ```
    */
   getBlockUncleCount(t = this.defaultBlock, i = r) {
-    return e(this, void 0, void 0, function* () {
-      return j(this, t, i);
+    return n(this, void 0, void 0, function* () {
+      return W(this, t, i);
     });
   }
   /**
@@ -478,9 +540,9 @@ class b extends T {
    *  }
    * ```
    */
-  getUncle(t = this.defaultBlock, i, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return D(this, t, i, n);
+  getUncle(t = this.defaultBlock, i, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return j(this, t, i, e);
     });
   }
   /**
@@ -532,11 +594,11 @@ class b extends T {
    * ```
    */
   getTransaction(t, i = r) {
-    return e(this, void 0, void 0, function* () {
-      const n = yield E(this, t, i);
-      if (!n)
-        throw new g();
-      return n;
+    return n(this, void 0, void 0, function* () {
+      const e = yield E(this, t, i);
+      if (!e)
+        throw new f();
+      return e;
     });
   }
   /**
@@ -622,8 +684,8 @@ class b extends T {
    * ```
    */
   getPendingTransactions(t = r) {
-    return e(this, void 0, void 0, function* () {
-      return x(this, t);
+    return n(this, void 0, void 0, function* () {
+      return V(this, t);
     });
   }
   /**
@@ -676,9 +738,9 @@ class b extends T {
    *  }
    * ```
    */
-  getTransactionFromBlock(t = this.defaultBlock, i, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return V(this, t, i, n);
+  getTransactionFromBlock(t = this.defaultBlock, i, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return z(this, t, i, e);
     });
   }
   /**
@@ -726,11 +788,11 @@ class b extends T {
    * ```
    */
   getTransactionReceipt(t, i = r) {
-    return e(this, void 0, void 0, function* () {
-      const n = yield z(this, t, i);
-      if (!n)
-        throw new g();
-      return n;
+    return n(this, void 0, void 0, function* () {
+      const e = yield J(this, t, i);
+      if (!e)
+        throw new f();
+      return e;
     });
   }
   /**
@@ -751,9 +813,9 @@ class b extends T {
    * > 1
    * ```
    */
-  getTransactionCount(t, i = this.defaultBlock, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return J(this, t, i, n);
+  getTransactionCount(t, i = this.defaultBlock, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return K(this, t, i, e);
     });
   }
   /**
@@ -862,8 +924,8 @@ class b extends T {
    * > <Some TransactionError>
    * ```
    */
-  sendTransaction(t, i = r, n) {
-    return K(this, t, i, n);
+  sendTransaction(t, i = r, e) {
+    return Q(this, t, i, e);
   }
   /**
    * @param transaction Signed transaction in one of the valid {@link Bytes} format.
@@ -949,8 +1011,8 @@ class b extends T {
    * > <Some TransactionError>
    * ```
    */
-  sendSignedTransaction(t, i = r, n) {
-    return Q(this, t, i, n);
+  sendSignedTransaction(t, i = r, e) {
+    return X(this, t, i, e);
   }
   /**
    * @param message Data to sign in one of the valid {@link Bytes} format.
@@ -979,9 +1041,9 @@ class b extends T {
    * web3.eth.sign("0x48656c6c6f20776f726c64", 0).then(console.log);
    * > "0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400"
    */
-  sign(t, i, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return X(this, t, i, n);
+  sign(t, i, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return Y(this, t, i, e);
     });
   }
   /**
@@ -1036,8 +1098,8 @@ class b extends T {
    * ```
    */
   signTransaction(t, i = r) {
-    return e(this, void 0, void 0, function* () {
-      return Y(this, t, i);
+    return n(this, void 0, void 0, function* () {
+      return Z(this, t, i);
     });
   }
   // TODO Decide what to do with transaction.to
@@ -1051,9 +1113,9 @@ class b extends T {
    * @param returnFormat ({@link DataFormat} defaults to {@link DEFAULT_RETURN_FORMAT}) - Specifies how the return data from the call should be formatted.
    * @returns The returned data of the call, e.g. a smart contract function's return value.
    */
-  call(t, i = this.defaultBlock, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return Z(this, t, i, n);
+  call(t, i = this.defaultBlock, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return $(this, t, i, e);
     });
   }
   /**
@@ -1082,9 +1144,9 @@ class b extends T {
    * > 21000
    * ```
    */
-  estimateGas(t, i = this.defaultBlock, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return $(this, t, i, n);
+  estimateGas(t, i = this.defaultBlock, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return O(this, t, i, e);
     });
   }
   /**
@@ -1132,8 +1194,8 @@ class b extends T {
    * ```
    */
   getPastLogs(t, i = r) {
-    return e(this, void 0, void 0, function* () {
-      return O(this, t, i);
+    return n(this, void 0, void 0, function* () {
+      return tt(this, t, i);
     });
   }
   /**
@@ -1155,8 +1217,8 @@ class b extends T {
    * ```
    */
   getWork() {
-    return e(this, void 0, void 0, function* () {
-      return C(this.requestManager);
+    return n(this, void 0, void 0, function* () {
+      return A(this.requestManager);
     });
   }
   /**
@@ -1176,9 +1238,9 @@ class b extends T {
    * > true
    * ```
    */
-  submitWork(t, i, n) {
-    return e(this, void 0, void 0, function* () {
-      return N(this.requestManager, t, i, n);
+  submitWork(t, i, e) {
+    return n(this, void 0, void 0, function* () {
+      return G(this.requestManager, t, i, e);
     });
   }
   // TODO - Format addresses
@@ -1196,8 +1258,8 @@ class b extends T {
    * ```
    */
   requestAccounts() {
-    return e(this, void 0, void 0, function* () {
-      return P(this.requestManager);
+    return n(this, void 0, void 0, function* () {
+      return q(this.requestManager);
     });
   }
   /**
@@ -1213,8 +1275,8 @@ class b extends T {
    * ```
    */
   getChainId(t = r) {
-    return e(this, void 0, void 0, function* () {
-      return tt(this, t);
+    return n(this, void 0, void 0, function* () {
+      return it(this, t);
     });
   }
   /**
@@ -1226,8 +1288,8 @@ class b extends T {
    * ```
    */
   getNodeInfo() {
-    return e(this, void 0, void 0, function* () {
-      return _(this.requestManager);
+    return n(this, void 0, void 0, function* () {
+      return C(this.requestManager);
     });
   }
   /**
@@ -1302,9 +1364,9 @@ class b extends T {
    * }
    * ```
    */
-  getProof(t, i, n = this.defaultBlock, o = r) {
-    return e(this, void 0, void 0, function* () {
-      return it(this, t, i, n, o);
+  getProof(t, i, e = this.defaultBlock, o = r) {
+    return n(this, void 0, void 0, function* () {
+      return et(this, t, i, e, o);
     });
   }
   // TODO Throwing an error with Geth, but not Infura
@@ -1368,9 +1430,9 @@ class b extends T {
    * }
    * ```
    */
-  getFeeHistory(t, i = this.defaultBlock, n, o = r) {
-    return e(this, void 0, void 0, function* () {
-      return nt(this, t, i, n, o);
+  getFeeHistory(t, i = this.defaultBlock, e, o = r) {
+    return n(this, void 0, void 0, function* () {
+      return nt(this, t, i, e, o);
     });
   }
   /**
@@ -1404,9 +1466,9 @@ class b extends T {
    * }
    * ```
    */
-  createAccessList(t, i = this.defaultBlock, n = r) {
-    return e(this, void 0, void 0, function* () {
-      return et(this, t, i, n);
+  createAccessList(t, i = this.defaultBlock, e = r) {
+    return n(this, void 0, void 0, function* () {
+      return rt(this, t, i, e);
     });
   }
   /**
@@ -1418,151 +1480,151 @@ class b extends T {
    * @param returnFormat ({@link DataFormat} defaults to {@link DEFAULT_RETURN_FORMAT}) - Specifies how the signed typed data should be formatted.
    * @returns The signed typed data.
    */
-  signTypedData(t, i, n = !1, o = r) {
-    return e(this, void 0, void 0, function* () {
-      return rt(this, t, i, n, o);
+  signTypedData(t, i, e = !1, o = r) {
+    return n(this, void 0, void 0, function* () {
+      return ot(this, t, i, e, o);
     });
   }
   /**
-  * Lets you subscribe to specific events in the blockchain.
-  *
-  * @param name - The subscription you want to subscribe to.
-  * @param args - Optional additional parameters, depending on the subscription type.
-  * @returns A subscription object of type {@link RegisteredSubscription}. The object contains:
-  *  - subscription.id: The subscription id, used to identify and unsubscribing the subscription.
-  *  - subscription.subscribe(): Can be used to re-subscribe with the same parameters.
-  *  - subscription.unsubscribe(): Unsubscribes the subscription and returns TRUE in the callback if successful.
-  *  - subscription.args: The subscription arguments, used when re-subscribing.
-  *
-  *
-  * You can use the subscription object to listen on:
-  *
-  * - on("data") - Fires on each incoming log with the log object as argument.
-  * - on("changed") - Fires on each log which was removed from the blockchain. The log will have the additional property "removed: true".
-  * - on("error") - Fires when an error in the subscription occurs.
-  * - on("connected") - Fires once after the subscription successfully connected. Returns the subscription id.
-  *
-  * @example **Subscribe to Smart Contract events**
-  * ```ts
-  * // Subscribe to `logs`
-  * const logSubscription = web3.eth.subscribe('logs', {
-  *     address: '0x1234567890123456789012345678901234567890',
-  *     topics: ['0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234']
-  * });
-  * logSubscription.on('data', (data: any) => console.log(data));
-  * logSubscription.on('error', (error: any) => console.log(error));
-  *
-  * ```
-  *
-  * @example **Subscribe to new block headers**
-  * ```ts
-  * // Subscribe to `newBlockHeaders`
-  * const newBlocksSubscription = await web3.eth.subscribe('newBlockHeaders');
-  *
-  * newBlocksSubscription.on('data', async blockhead => {
-  * 	console.log('New block header: ', blockhead);
-  *
-  * 	// You do not need the next line, if you like to keep notified for every new block
-  * 	await newBlocksSubscription.unsubscribe();
-  * 	console.log('Unsubscribed from new block headers.');
-  * });
-  * newBlocksSubscription.on('error', error =>
-  * 	console.log('Error when subscribing to New block header: ', error),
-  * );
-  * ```
-  *
-  * 	### subscribe('pendingTransactions')
-  *
-  * Subscribes to incoming pending transactions.
-  * You can subscribe to pending transactions by calling web3.eth.subscribe('pendingTransactions').
-  *
-  * ```ts
-  * (await web3.eth.subscribe('pendingTransactions')).on('data', console.log);
-  * ```
-  *
-  * ### subscribe('newHeads')
-  * ( same as subscribe('newBlockHeaders'))
-  * Subscribes to incoming block headers. This can be used as timer to check for changes on the blockchain.
-  *
-  * The structure of a returned block header is {@link BlockHeaderOutput}:
-  *
-  * ```ts
-  * (await web3.eth.subscribe('newHeads')).on( // 'newBlockHeaders' would work as well
-  *  'data',
-  * console.log
-  * );
-  * >{
-  * parentHash: '0x9e746a1d906b299def98c75b06f714d62dacadd567c7515d76eeaa8c8074c738',
-  * sha3Uncles: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347',
-  * miner: '0x0000000000000000000000000000000000000000',
-  * stateRoot: '0xe0f04b04861ecfa95e82a9310d6a7ef7aef8d7417f5209c182582bfb98a8e307',
-  * transactionsRoot: '0x31ab4ea571a9e10d3a19aaed07d190595b1dfa34e03960c04293fec565dea536',
-  * logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
-  * difficulty: 2n,
-  * number: 21n,
-  * gasLimit: 11738125n,
-  * gasUsed: 830006n,
-  * timestamp: 1678797237n,
-  * extraData: '0xd883010b02846765746888676f312e32302e31856c696e757800000000000000e0a6e93cf40e2e71a72e493272210c3f43738ccc7e7d7b14ffd51833797d896c09117e8dc4fbcbc969bd21b42e5af3e276a911524038c001b2109b63b8e0352601',
-  * nonce: 0n
-  * }
-  * ```
-  *
-  * ### subscribe('syncing')
-  * Subscribe to syncing events. This will return `true` when the node is syncing and when it’s finished syncing will return `false`, for the `changed` event.
-  *
-  * ```ts
-  * (await web3.eth.subscribe('syncing')).on('changed', console.log);
-  * > `true` // when syncing
-  *
-  * (await web3.eth.subscribe('syncing')).on('data', console.log);
-  * > {
-  *      startingBlock: 0,
-  *      currentBlock: 0,
-  *      highestBlock: 0,
-  *      pulledStates: 0,
-  *      knownStates: 0
-  *   }
-  * ```
-  *
-  * ### subscribe('logs', options)
-  * Subscribes to incoming logs, filtered by the given options. If a valid numerical fromBlock options property is set, web3.js will retrieve logs beginning from this point, backfilling the response as necessary.
-  *
-  * options: You can subscribe to logs matching a given filter object, which can take the following parameters:
-  * - `fromBlock`: (optional, default: 'latest') Integer block number, or `'latest'` for the last mined block or `'pending'`, `'earliest'` for not yet mined transactions.
-  * - `address`: (optional) Contract address or a list of addresses from which logs should originate.
-  * - `topics`: (optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with `or` options.
-  *
-  * ```ts
-  *  (await web3.eth.subscribe('logs', {
-  *    address: '0xdac17f958d2ee523a2206206994597c13d831ec7',
-  *   })).on('data', console.log);
-  *
-  * > {
-  * removed: false,
-  * logIndex: 119n,
-  * transactionIndex: 58n,
-  * transactionHash: '0x61533efa77937360215069d5d6cb0be09a22af9721e6dc3df59d957833ed8870',
-  * blockHash: '0xe32bb97084479d32247f66f8b46d00af2fbc3c2db2bc6e5843fe2e4d1ca9b099',
-  * blockNumber: 18771966n,
-  * address: '0xdac17f958d2ee523a2206206994597c13d831ec7',
-  * data: '0x00000000000000000000000000000000000000000000000000000000d88b2e40',
-  * topics: [
-  * '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
-  * '0x0000000000000000000000002fb2457f6ec1865dc0d4e7300c696b69c2a1b989',
-  * '0x00000000000000000000000027fd43babfbe83a81d14665b1a6fb8030a60c9b4'
-  * ]
-  * }
-  *```
-  */
-  subscribe(t, i, n = r) {
+   * Lets you subscribe to specific events in the blockchain.
+   *
+   * @param name - The subscription you want to subscribe to.
+   * @param args - Optional additional parameters, depending on the subscription type.
+   * @returns A subscription object of type {@link RegisteredSubscription}. The object contains:
+   *  - subscription.id: The subscription id, used to identify and unsubscribing the subscription.
+   *  - subscription.subscribe(): Can be used to re-subscribe with the same parameters.
+   *  - subscription.unsubscribe(): Unsubscribes the subscription and returns TRUE in the callback if successful.
+   *  - subscription.args: The subscription arguments, used when re-subscribing.
+   *
+   *
+   * You can use the subscription object to listen on:
+   *
+   * - on("data") - Fires on each incoming log with the log object as argument.
+   * - on("changed") - Fires on each log which was removed from the blockchain. The log will have the additional property "removed: true".
+   * - on("error") - Fires when an error in the subscription occurs.
+   * - on("connected") - Fires once after the subscription successfully connected. Returns the subscription id.
+   *
+   * @example **Subscribe to Smart Contract events**
+   * ```ts
+   * // Subscribe to `logs`
+   * const logSubscription = web3.eth.subscribe('logs', {
+   *     address: '0x1234567890123456789012345678901234567890',
+   *     topics: ['0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234']
+   * });
+   * logSubscription.on('data', (data: any) => console.log(data));
+   * logSubscription.on('error', (error: any) => console.log(error));
+   *
+   * ```
+   *
+   * @example **Subscribe to new block headers**
+   * ```ts
+   * // Subscribe to `newBlockHeaders`
+   * const newBlocksSubscription = await web3.eth.subscribe('newBlockHeaders');
+   *
+   * newBlocksSubscription.on('data', async blockhead => {
+   * 	console.log('New block header: ', blockhead);
+   *
+   * 	// You do not need the next line, if you like to keep notified for every new block
+   * 	await newBlocksSubscription.unsubscribe();
+   * 	console.log('Unsubscribed from new block headers.');
+   * });
+   * newBlocksSubscription.on('error', error =>
+   * 	console.log('Error when subscribing to New block header: ', error),
+   * );
+   * ```
+   *
+   * 	### subscribe('pendingTransactions')
+   *
+   * Subscribes to incoming pending transactions.
+   * You can subscribe to pending transactions by calling web3.eth.subscribe('pendingTransactions').
+   *
+   * ```ts
+   * (await web3.eth.subscribe('pendingTransactions')).on('data', console.log);
+   * ```
+   *
+   * ### subscribe('newHeads')
+   * ( same as subscribe('newBlockHeaders'))
+   * Subscribes to incoming block headers. This can be used as timer to check for changes on the blockchain.
+   *
+   * The structure of a returned block header is {@link BlockHeaderOutput}:
+   *
+   * ```ts
+   * (await web3.eth.subscribe('newHeads')).on( // 'newBlockHeaders' would work as well
+   *  'data',
+   * console.log
+   * );
+   * >{
+   * parentHash: '0x9e746a1d906b299def98c75b06f714d62dacadd567c7515d76eeaa8c8074c738',
+   * sha3Uncles: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347',
+   * miner: '0x0000000000000000000000000000000000000000',
+   * stateRoot: '0xe0f04b04861ecfa95e82a9310d6a7ef7aef8d7417f5209c182582bfb98a8e307',
+   * transactionsRoot: '0x31ab4ea571a9e10d3a19aaed07d190595b1dfa34e03960c04293fec565dea536',
+   * logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
+   * difficulty: 2n,
+   * number: 21n,
+   * gasLimit: 11738125n,
+   * gasUsed: 830006n,
+   * timestamp: 1678797237n,
+   * extraData: '0xd883010b02846765746888676f312e32302e31856c696e757800000000000000e0a6e93cf40e2e71a72e493272210c3f43738ccc7e7d7b14ffd51833797d896c09117e8dc4fbcbc969bd21b42e5af3e276a911524038c001b2109b63b8e0352601',
+   * nonce: 0n
+   * }
+   * ```
+   *
+   * ### subscribe('syncing')
+   * Subscribe to syncing events. This will return `true` when the node is syncing and when it’s finished syncing will return `false`, for the `changed` event.
+   *
+   * ```ts
+   * (await web3.eth.subscribe('syncing')).on('changed', console.log);
+   * > `true` // when syncing
+   *
+   * (await web3.eth.subscribe('syncing')).on('data', console.log);
+   * > {
+   *      startingBlock: 0,
+   *      currentBlock: 0,
+   *      highestBlock: 0,
+   *      pulledStates: 0,
+   *      knownStates: 0
+   *   }
+   * ```
+   *
+   * ### subscribe('logs', options)
+   * Subscribes to incoming logs, filtered by the given options. If a valid numerical fromBlock options property is set, web3.js will retrieve logs beginning from this point, backfilling the response as necessary.
+   *
+   * options: You can subscribe to logs matching a given filter object, which can take the following parameters:
+   * - `fromBlock`: (optional, default: 'latest') Integer block number, or `'latest'` for the last mined block or `'pending'`, `'earliest'` for not yet mined transactions.
+   * - `address`: (optional) Contract address or a list of addresses from which logs should originate.
+   * - `topics`: (optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with `or` options.
+   *
+   * ```ts
+   *  (await web3.eth.subscribe('logs', {
+   *    address: '0xdac17f958d2ee523a2206206994597c13d831ec7',
+   *   })).on('data', console.log);
+   *
+   * > {
+   * removed: false,
+   * logIndex: 119n,
+   * transactionIndex: 58n,
+   * transactionHash: '0x61533efa77937360215069d5d6cb0be09a22af9721e6dc3df59d957833ed8870',
+   * blockHash: '0xe32bb97084479d32247f66f8b46d00af2fbc3c2db2bc6e5843fe2e4d1ca9b099',
+   * blockNumber: 18771966n,
+   * address: '0xdac17f958d2ee523a2206206994597c13d831ec7',
+   * data: '0x00000000000000000000000000000000000000000000000000000000d88b2e40',
+   * topics: [
+   * '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
+   * '0x0000000000000000000000002fb2457f6ec1865dc0d4e7300c696b69c2a1b989',
+   * '0x00000000000000000000000027fd43babfbe83a81d14665b1a6fb8030a60c9b4'
+   * ]
+   * }
+   *```
+   */
+  subscribe(t, i, e = r) {
     var o;
-    return e(this, void 0, void 0, function* () {
-      const s = yield (o = this.subscriptionManager) === null || o === void 0 ? void 0 : o.subscribe(t, i, n);
-      return s instanceof p && t === "logs" && typeof i == "object" && !st(i.fromBlock) && Number.isFinite(Number(i.fromBlock)) && setImmediate(() => {
+    return n(this, void 0, void 0, function* () {
+      const s = yield (o = this.subscriptionManager) === null || o === void 0 ? void 0 : o.subscribe(t, i, e);
+      return s instanceof m && t === "logs" && typeof i == "object" && !ct(i.fromBlock) && Number.isFinite(Number(i.fromBlock)) && setImmediate(() => {
         this.getPastLogs(i).then((u) => {
-          for (const a of u)
-            s._processSubscriptionResult(a);
+          for (const c of u)
+            s._processSubscriptionResult(c);
         }).catch((u) => {
           s._processSubscriptionError(u);
         });
@@ -1570,7 +1632,7 @@ class b extends T {
     });
   }
   static shouldClearSubscription({ sub: t }) {
-    return !(t instanceof m);
+    return !(t instanceof b);
   }
   /**
    * Resets subscriptions.
@@ -1587,11 +1649,11 @@ class b extends T {
     var i;
     return (i = this.subscriptionManager) === null || i === void 0 ? void 0 : i.unsubscribe(
       // eslint-disable-next-line
-      t ? b.shouldClearSubscription : void 0
+      t ? k.shouldClearSubscription : void 0
     );
   }
 }
 export {
-  b as Web3Eth,
-  v as registeredSubscriptions
+  k as Web3Eth,
+  p as registeredSubscriptions
 };