alert-contract 0.0.1

package/README.md

@@ -0,0 +1,63 @@
+# EVM Observability SDK
+
+Lightweight, zero-dependency **on-chain observability SDK** for EVM smart contracts.
+
+This SDK provides a simple and gas-efficient way to emit **structured telemetry events**
+from smart contracts, enabling off-chain analytics, tracing, monitoring, and product metrics
+— without changing business logic.
+
+---
+
+## 🚀 Installation
+
+Install via npm:
+
+```bash
+npm install @smart-alert/evm-observability
+```
+
+---
+
+## ✨ Key Features
+
+- 📡 Function call tracing (who, what, where)
+- 📊 Business metrics emitted directly from contracts
+- 🧩 Zero runtime dependencies
+- ⚡ No external calls, no shared state
+- 🛠 Works with any EVM-compatible chain
+- 🧠 Contract-agnostic off-chain analytics
+
+---
+
+## 📦 What This SDK Is (and Is Not)
+
+### ✅ This SDK **IS**
+- A **Solidity compile-time SDK**
+- A set of **standardized events**
+- A reusable **abstract contract**
+- A stable **on-chain telemetry schema**
+
+### ❌ This SDK is **NOT**
+- A deployed central contract
+- A runtime dependency
+- A protocol with shared state
+- A replacement for business events like `Transfer`
+
+---
+
+## 🏗 Architecture Overview
+
+Smart Contract Architecture
+===========================
+
+```mermaid
+flowchart TD
+    A["Your Smart Contract (Vault, AMM, etc)"]
+    B["Observability.sol (SDK) - ObsCall, ObsMetric"]
+    C["Blockchain Logs"]
+    D["Off-chain SDK / Indexer / Analytics"]
+
+    A --> B
+    B --> C
+    C --> D
+```

package/contracts/main/AlertContractV1.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.20;
+
+abstract contract Observability {
+    event ObsCall(
+        address indexed contractAddress,
+        bytes4 indexed selector,
+        address indexed caller,
+        uint256 gasLeft
+    );
+
+    event ObsMetric(
+        address indexed contractAddress,
+        bytes32 indexed name,
+        uint256 value
+    );
+
+    event ObsError(
+        address indexed contractAddress,
+        bytes4 indexed selector,
+        bytes reason
+    );
+
+    modifier observe() {
+        emit ObsCall(
+            address(this),
+            msg.sig,
+            msg.sender,
+            gasleft()
+        );
+        _;
+    }
+
+    function _metric(bytes32 name, uint256 value) internal {
+        emit ObsMetric(address(this), name, value);
+    }
+
+    function _error(bytes memory reason) internal {
+        emit ObsError(address(this), msg.sig, reason);
+    }
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "alert-contract",
+  "version": "0.0.1",
+  "description": "EVM on-chain observability SDK for Solidity",
+  "main": "contracts/main/AlertContractV1.sol",
+  "scripts": {
+    "compile": "npx hardhat compile --show-stack-traces",
+    "test": "npx hardhat test"
+  },
+  "keywords": ["solidity", "sdk", "evm", "observability", "metrics", "smart-alert"],
+  "author": "alkesproject@gmail.com",
+  "license": "MIT",
+  "files": [
+    "contracts/main"
+  ],
+  "devDependencies": {
+    "@nomicfoundation/hardhat-network-helpers": "^1.0.12",
+    "@nomicfoundation/hardhat-toolbox": "^4.0.0",
+    "@openzeppelin/contracts": "^4.9.3",
+    "@openzeppelin/hardhat-upgrades": "^3.0.5",
+    "@types/luxon": "^3.3.1",
+    "hardhat": "^2.19.4",
+    "hardhat-gas-reporter": "^1.0.9"
+  },
+  "dependencies": {
+    "@nomicfoundation/hardhat-verify": "^2.1.0",
+    "dotenv": "^16.3.1",
+    "luxon": "^3.3.0"
+  }
+}