diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 5378a16..60e22f8 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -112,4 +112,4 @@ community. This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at -https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. +https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. \ No newline at end of file diff --git a/README.md b/README.md index 0d7d708..8117cf0 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,7 @@ vero-audit-guard/ │ └── src/main.rs ├── anomaly-detector/ # TypeScript relayer monitor │ ├── Dockerfile +│ ├── README.md │ └── src/index.ts ├── atomic-rpc-relayer-bridge/ # Local RPC/metrics bridge │ ├── Dockerfile @@ -92,6 +93,7 @@ vero-audit-guard/ │ ├── policy-compliance.yml # OPA policy compliance checks │ └── anchor-on-merge.yml # Anchors audit trail on merge to main ├── BUILD_GUARD.sh # Local automation script +├── CODE_OF_CONDUCT.md # Contributor code of conduct ├── CONTRIBUTING.md # Contributor + compose workflow ├── POLICY_AS_CODE.md # Policy engine documentation ├── INCIDENT_RESPONSE.md # Emergency runbook @@ -204,8 +206,14 @@ See [ARCHITECTURE.md](ARCHITECTURE.md) for the container topology and integratio --- +## Code of Conduct + +Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) for details. + +--- + ## Security Contacts - **Bug reports:** See [`VULNERABILITY_DISCLOSURE.md`](VULNERABILITY_DISCLOSURE.md) - **Emergency:** security@vero.xyz -- **PGP:** https://vero.xyz/.well-known/security.txt +- **PGP:** https://vero.xyz/.well-known/security.txt \ No newline at end of file diff --git a/anomaly-detector/README.md b/anomaly-detector/README.md new file mode 100644 index 0000000..0083815 --- /dev/null +++ b/anomaly-detector/README.md @@ -0,0 +1,19 @@ +# Anomaly Detector + +Real-time anomaly detector for the relayer service. + +## Key Modules + +- `threat-feed-fetcher.ts`: Fetches threat feeds and incoming security signals. +- `rpc-failover-monitor.ts`: Monitors RPC endpoint health and handles failover tracking. + +## Local Development + +- **Development:** `npm run dev` +- **Test:** `npm run test` +- **Build:** `npm run build` + +## Inputs & Outputs + +- **Inputs:** `nonce-db.json` and relayer configurations. +- **Outputs:** Anomaly alerts and monitoring logs. \ No newline at end of file