Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions THIRD-PARTY-NOTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,14 +243,14 @@ Total distributed third-party packages: 234
- [github.com/prometheus/client_golang/internal/github.com/golang/gddo/httputil](https://github.com/prometheus/client_golang/blob/v1.24.1/internal/github.com/golang/gddo/LICENSE)
- [github.com/spaolacci/murmur3](https://github.com/spaolacci/murmur3/blob/v1.1.0/LICENSE)
- [github.com/wlynxg/anet](https://github.com/wlynxg/anet/blob/v0.0.5/LICENSE)
- [golang.org/x/crypto](https://cs.opensource.google/go/x/crypto/+/v0.54.0:LICENSE)
- [golang.org/x/crypto](https://cs.opensource.google/go/x/crypto/+/v0.55.0:LICENSE)
- [golang.org/x/exp](https://cs.opensource.google/go/x/exp/+/74f9aab9:LICENSE)
- [golang.org/x/net](https://cs.opensource.google/go/x/net/+/v0.57.0:LICENSE)
- [golang.org/x/oauth2](https://cs.opensource.google/go/x/oauth2/+/v0.36.0:LICENSE)
- [golang.org/x/sync/errgroup](https://cs.opensource.google/go/x/sync/+/v0.22.0:LICENSE)
- [golang.org/x/sys](https://cs.opensource.google/go/x/sys/+/v0.47.0:LICENSE)
- [golang.org/x/term](https://cs.opensource.google/go/x/term/+/v0.45.0:LICENSE)
- [golang.org/x/text](https://cs.opensource.google/go/x/text/+/v0.40.0:LICENSE)
- [golang.org/x/text](https://cs.opensource.google/go/x/text/+/v0.41.0:LICENSE)
- [golang.org/x/time/rate](https://cs.opensource.google/go/x/time/+/v0.15.0:LICENSE)
- [gonum.org/v1/gonum/mathext](https://github.com/gonum/gonum/blob/v0.17.0/LICENSE)
- [google.golang.org/api](https://github.com/googleapis/google-api-go-client/blob/v0.272.0/LICENSE)
Expand Down
48 changes: 24 additions & 24 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,29 @@
# Optimum Gateway - Version History & Changelog

**Latest Release:** [v1.1.1](./versions/v1.1.1/release_notes.md)
**Latest Docs:** [v1.1.1 Documentation](./versions/v1.1.1/index.md)
**Latest Release:** [v1.2.0](./versions/v1.2.0/release_notes.md)
**Latest Docs:** [v1.2.0 Documentation](./versions/v1.2.0/index.md)

## Supported Versions

| Version | Status | Docker Image |
| ------- | --------------------- | --------------------------- |
| v1.1.1 | CURRENT — recommended | `getoptimum/gateway:v1.1.1` |
| v1.0.2 | Previous — supported | `getoptimum/gateway:v1.0.2` |
| v1.2.0 | CURRENT — recommended | `getoptimum/gateway:v1.2.0` |
| v1.1.1 | Previous — supported | `getoptimum/gateway:v1.1.1` |

## v1.1.1 (Current)
## v1.2.0 (Current)

**Docker Image:** `getoptimum/gateway:v1.2.0`

Recommended upgrade for everyone on v1.1.1. Networking and CL peering are unchanged — same ports and firewall rules.

### Highlights

* **Consumer block stream.** Opt-in WebSocket + gRPC feed of decoded beacon blocks (`stream_enable: true`). Consumers use `osc_` keys from the [Partner Console](https://console.getoptimum.io/) (Hoodi and Mainnet). See [Consumer Block Stream](./versions/v1.2.0/06_block_stream.md).
* **Stream metrics.** `mump2p_stream_*` series on the telemetry port when the stream is enabled. See [Metrics](./versions/v1.2.0/metrics.md#consumer-block-stream).

[Full release notes](./versions/v1.2.0/release_notes.md) · [Documentation](./versions/v1.2.0/index.md)

## v1.1.1

**Docker Image:** `getoptimum/gateway:v1.1.1`

Expand All @@ -25,30 +38,17 @@ Recommended upgrade for everyone on v1.0.2. Networking and CL peering are unchan

[Full release notes](./versions/v1.1.1/release_notes.md) · [Documentation](./versions/v1.1.1/index.md)

## v1.0.2

**Docker Image:** `getoptimum/gateway:v1.0.2`

Required upgrade that replaces all earlier releases.

### Highlights

* **API-key authentication.** Each gateway authenticates with an `ogw_live_...` key set via the `OPT_API_KEY` environment variable; the key drives `gateway_id`, `chain`, and validator scope (no per-network YAML).
* **More consensus clients.** Adds Nimbus and Lodestar alongside Prysm, Lighthouse, and Teku.
* **Lighthouse / PeerDAS compatibility.** Advertises a custody group count of 8 in libp2p metadata so PeerDAS-aware clients keep the gateway as a peer.
* **Health endpoints.** Structured `GET /health` (200/503 with `cl_peers`, `mump2p_peers`, `subscribed_topics`, `last_block_age_sec`, `cl_health`, `mump2p_health`) plus a lightweight `GET /` liveness probe.
* **Attestation subnet carry + metrics.** Subscribes to all 64 subnets and forwards partner-validator attestations over mump2p, with inclusion and propagation metrics.
* **Metric namespace.** Gateway metrics are now prefixed `mump2p_gateway_` (previously `optp2p_gateway_optimum_gateway_`) — update saved Prometheus/Grafana queries.
* **Simpler config + security hardening.** Removed `enable_aggregation`, the baked-in topic list, the sidecar port, and separate push credentials; bounded JWT lifetime and more frequent JWKS refresh.
## v1.0.2 (Deprecated)

[Full release notes](./versions/v1.0.2/release_notes.md) · [Documentation](./versions/v1.0.2/index.md)
**v1.0.2 is deprecated.** Docs for this release have been removed. Partners still on v1.0.2 should upgrade to **[v1.2.0](./versions/v1.2.0/release_notes.md)** (`getoptimum/gateway:v1.2.0`). v1.1.1 remains supported as a previous release.

## Important: Deprecated Versions

**The following versions are deprecated and no longer supported. Upgrade to v1.1.1.**
**The following versions are deprecated and no longer supported. Upgrade to v1.2.0.**

| Version | Status |
| ----------- | ---------- |
| v1.0.2 | DEPRECATED |
| v0.0.1-rc1 | DEPRECATED |
| v0.0.1-rc2 | DEPRECATED |
| v0.0.1-rc3 | DEPRECATED |
Expand All @@ -69,7 +69,7 @@ recreate the container:

```bash
export OPT_API_KEY=ogw_live_xxx
docker pull getoptimum/gateway:v1.1.1
docker pull getoptimum/gateway:v1.2.0
docker rm -f optimum-gateway
docker run --name optimum-gateway --rm \
-p 33212:33212/tcp \
Expand All @@ -78,7 +78,7 @@ docker run --name optimum-gateway --rm \
-v $(pwd)/config:/app/config \
-v $(pwd)/data/libp2p:/tmp/libp2p \
-v $(pwd)/data/mump2p:/tmp/mump2p \
getoptimum/gateway:v1.1.1 \
getoptimum/gateway:v1.2.0 \
-config=/app/config/app_conf.yml
```

Expand Down
Binary file removed docs/public/block_stream.png
Binary file not shown.
Loading
Loading