Telemetry with Posthog

CHANGELOG.md

@@ -10,19 +10,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Each version will have a separate `Breaking Changes` section as well. To describe in how to upgrade from one version to another if needed
 
 ## [Unreleased]
+
 ### Added
+
+* feat: Added Telemetry with Posthog <https://github.com/Layr-Labs/eigensdk-rs/pull/147>. This is implemented in the sub-crate `eigen-telemetry`.
+  * To enable and use telemetry in your avs/code, you need to include the SDK crates with the feature telemetry enabled. In the main function the code must set the config of the telemetry with the given parameters:
+
+  ```rust
+  fn main() {
+    let _ = eigen_telemetry::telemetry::Telemetry::set_config("YOUR_TELEMETRY_KEY", "YOUR_USER_ID");
+    // ...
+  }
+  ```
+
 ### Changed
+
 * Changes in the way bindings are generated in [#245](https://github.com/Layr-Labs/eigensdk-rs/pull/243).
   * The `bindings` target now generates the bindings using Docker with Foundry v0.3.0.
   * The previous `bindings` target was renamed to `bindings_host`, as it runs without Docker. However the `bindings_host` target is for CI use only. To generate the bindings, please use the `bindings` target.
-
 
 ### Breaking changes
+
 ### Removed
 
 ## [0.1.3] - 2024-01-17
+
 ### Added 🎉
-* feat: add rewards-v2 related functionality by @supernovahs in https://github.com/Layr-Labs/eigensdk-rs/pull/221
+
+* feat: add rewards-v2 related functionality by @supernovahs in <https://github.com/Layr-Labs/eigensdk-rs/pull/221>
   * New methods in `ELChainReader`:
     * `get_operator_avs_split`
     * `get_operator_pi_split`
@@ -32,43 +47,52 @@ Each version will have a separate `Breaking Changes` section as well. To describ
   * Bindings updated for rewards-v2 core contracts release
 
 ### Breaking Changes 🛠
-* feat!: remove delegation manager from `ELChainWriter` by @supernovahs in https://github.com/Layr-Labs/eigensdk-rs/pull/214
+
+* feat!: remove delegation manager from `ELChainWriter` by @supernovahs in <https://github.com/Layr-Labs/eigensdk-rs/pull/214>
   * `ELChainWriter::new` no longer receives the delegation manager address as first parameter.
-* feat!: change way bindings are generated by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/204
+* feat!: change way bindings are generated by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/204>
   * `eigen_utils::core` contains bindings related to core contracts
   * `eigen_utils::middleware` contains bindings related to middleware contracts
   * `eigen_utils::sdk` contains bindings related to the SDK (should only be used for testing)
 
 ### Documentation 📚
-* docs: add CHANGELOG.md by @lferrigno in https://github.com/Layr-Labs/eigensdk-rs/pull/220
+
+* docs: add CHANGELOG.md by @lferrigno in <https://github.com/Layr-Labs/eigensdk-rs/pull/220>
+
 ### Other Changes
-* ci: change docker setup action for official one by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/219
-* docs: add error message for `cargo test` on darwin by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/215
-* test: fix `test_register_and_update_operator` by @ricomateo in https://github.com/Layr-Labs/eigensdk-rs/pull/223
-* chore: update way anvil state dump is generated by @ricomateo in https://github.com/Layr-Labs/eigensdk-rs/pull/222
-* fix: disable doctests on `eigen-utils` by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/227
-* chore: bump version by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/228
-* docs: add GitHub release changelog configuration by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/229
+
+* ci: change docker setup action for official one by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/219>
+* docs: add error message for `cargo test` on darwin by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/215>
+* test: fix `test_register_and_update_operator` by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/223>
+* chore: update way anvil state dump is generated by @ricomateo in <https://github.com/Layr-Labs/eigensdk-rs/pull/222>
+* fix: disable doctests on `eigen-utils` by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/227>
+* chore: bump version by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/228>
+* docs: add GitHub release changelog configuration by @MegaRedHand in <https://github.com/Layr-Labs/eigensdk-rs/pull/229>
 
 ## [0.1.2] - 2025-01-09
+
 ### Added
+
 * Added retries with exponential backoff to send transactions in [#158](https://github.com/Layr-Labs/eigensdk-rs/pull/158)
 * Added `query_registration_detail` method in [#162](https://github.com/Layr-Labs/eigensdk-rs/pull/162)
 * Added clippy lints in `Cargo.toml` in [#159](https://github.com/Layr-Labs/eigensdk-rs/pull/159)
 * Added BLS aggregation logger in [#154](https://github.com/Layr-Labs/eigensdk-rs/pull/154)
 * Added `common` crate to `eigensdk` crate in [#213](https://github.com/Layr-Labs/eigensdk-rs/pull/213)
 
 ### Changed
+
 * Updated `eigenlayer-middleware` to v0.4.3 (rewards release) in [#177](https://github.com/Layr-Labs/eigensdk-rs/pull/177)
 * Fixed Holesky RPC provider URL in [#184](https://github.com/Layr-Labs/eigensdk-rs/pull/184)
 * Fixed BLS signature logic in [#174](https://github.com/Layr-Labs/eigensdk-rs/pull/174)
 
 ### Removed
+
 * Deleted `TxManager` in [#151](https://github.com/Layr-Labs/eigensdk-rs/pull/151)
 * Removed `TxManager` crate import in [#211](https://github.com/Layr-Labs/eigensdk-rs/pull/211)
 * Removed logs in `operatorsinfo` test in [#185](https://github.com/Layr-Labs/eigensdk-rs/pull/185)
 
 ### Documentation
+
 * Added notes for running tests in [#194](https://github.com/Layr-Labs/eigensdk-rs/pull/194)
 * Added "Contract Bindings" section to the README in [#178](https://github.com/Layr-Labs/eigensdk-rs/pull/178)
 * Added "Branches" section to the README in [#200](https://github.com/Layr-Labs/eigensdk-rs/pull/200)

Cargo.toml

@@ -56,6 +56,7 @@ clippy.question_mark = "warn"
 clippy.implicit_return = "allow"
 
 [workspace.dependencies]
+#misc
 eigen-client-avsregistry = { path = "crates/chainio/clients/avsregistry" }
 ark-bn254 = "0.5.0"
 ark-ec = "0.5.0"
@@ -81,6 +82,7 @@ eigen-services-blsaggregation = { path = "crates/services/bls_aggregation" }
 eigen-services-operatorsinfo = { path = "crates/services/operatorsinfo" }
 eigen-signer = { path = "crates/signer/" }
 eigen-testing-utils = { path = "testing/testing-utils" }
+eigen-telemetry = { path = "crates/telemetry/" }
 eigen-types = { path = "crates/types/" }
 eigen-utils = { path = "crates/utils/" }
 eigen-nodeapi = { path = "crates/nodeapi/" }
@@ -116,13 +118,8 @@ tokio = { version = "1.41", features = ["test-util", "full", "sync"] }
 tracing = "0.1"
 tracing-subscriber = { version = "0.3", features = ["json"] }
 url = "2.5"
-
-#misc
 rust-bls-bn254 = { version = "0.2.1", features = ["std"] }
 uuid = { version = "1.11", features = ["v4"] }
-
-
-#misc
 parking_lot = "0.12"
 
 
@@ -140,3 +137,5 @@ alloy = { version = "0.9", features = [
 
 avsregistry-read = { path = "examples/avsregistry-read" }
 avsregistry-write = { path = "examples/avsregistry-write" }
+
+posthog-rs = "0.2.0"

crates/chainio/clients/avsregistry/Cargo.toml

@@ -10,16 +10,18 @@ license-file.workspace = true
 
 [dependencies]
 alloy.workspace = true
+ark-ff.workspace = true
 async-trait.workspace = true
-num-bigint = "0.4.4"
 eigen-types.workspace = true
 eigen-crypto-bls.workspace = true
-ark-ff.workspace = true
+eigen-telemetry = { workspace = true, optional = true }
 eigen-client-elcontracts.workspace = true
 eigen-common.workspace = true
 eigen-utils.workspace = true
 eigen-logging.workspace = true
+num-bigint = "0.4.4"
 thiserror.workspace = true
+tokio = { workspace = true, optional = true }
 tracing.workspace = true
 
 [lints]
@@ -30,3 +32,6 @@ eigen-testing-utils.workspace = true
 hex = "0.4.3"
 once_cell.workspace = true
 tokio = { version = "1.37.0", features = ["test-util", "full", "sync"] }
+
+[features]
+telemetry = ["dep:eigen-telemetry", "dep:tokio"]

crates/chainio/clients/avsregistry/src/error.rs

@@ -157,9 +157,14 @@ pub enum AvsRegistryError {
     /// Invalid Signature
     #[error("Invalid signature")]
     InvalidSignature,
+
     /// Parse BigInt
     #[error("big int error")]
     ParseBigIntError,
+
+    /// Telemetry error
+    #[error("Telemetry error")]
+    TelemetryError(String),
 }
 
 impl From<ElContractsError> for AvsRegistryError {