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 docs/guides/01-getting-started-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ If you prefer manual installation:
**Output:**

```bash
Version: v0.0.1-rc4
Commit: fdbee67
Version: v0.0.1-rc5
Commit: d5b774a
```

You can visit [mump2p-cli release page](https://github.com/getoptimum/mump2p-cli/releases) for the latest version.
Expand Down
8 changes: 6 additions & 2 deletions docs/guides/02-getting-started-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,9 @@ Rate limits are enforced based on client configuration. Exceeding limits results

For a complete working proxy client with both REST subscription and gRPC streaming, see the full implementation:

**[Complete Proxy Client Example](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_proxy_client/proxy_client.go)**
**[Complete Proxy Client Example](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#grpc-proxy-client-implementation)**

**[Complete Code](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_proxy_client/proxy_client.go)**

The proxy client provides:

Expand Down Expand Up @@ -562,7 +564,9 @@ curl -s http://localhost:9092/api/v1/health

For a complete working P2P client that connects directly to nodes, see the full implementation with trace handling:

**[Complete P2P Client Example](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_p2p_client/p2p_client.go)**
**[Complete P2P Client Example](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#using-p2p-nodes-directly-optional--no-proxy)**

**[Complete Code](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_p2p_client/p2p_client.go)**

The client includes:

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/04-experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@ You can run them using:

For comprehensive metrics collection during experiments, use the gRPC P2P client with trace handling:

**[P2P Client with Metrics Collection](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_p2p_client/p2p_client.go)**
**[P2P Client with Metrics Collection](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#collecting-trace-data-for-experiments)**

**[Complete Code](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_p2p_client/p2p_client.go)**

The client automatically captures and displays:

Expand Down
24 changes: 15 additions & 9 deletions docs/guides/05-faq-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,29 +57,35 @@ This generates `p2p.key` and exports `BOOTSTRAP_PEER_ID` automatically.

1. **Containers are running**: `docker ps` to verify proxy and p2pnode containers are up
2. **Correct ports**: Proxy gRPC on `localhost:50051`, P2P sidecar on `localhost:33221`
3. **Use latest client examples**: Reference [`optimum-dev-setup-guide/grpc_proxy_client/proxy_client.go`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_proxy_client/proxy_client.go)
3. **Use latest client examples**: Reference [`optimum-dev-setup-guide/docs/guide.md#grpc-proxy-client-implementation`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#grpc-proxy-client-implementation)

**[Complete Code](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_proxy_client/proxy_client.go)**

### Q: Getting "method not found" or protobuf errors

**A:** Use the correct protobuf definitions from [`optimum-dev-setup-guide`](https://github.com/getoptimum/optimum-dev-setup-guide):
**A:** Use the correct protobuf definitions from [`optimum-dev-setup-guide/docs/guide.md`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#api-reference):

* [`grpc_proxy_client/proto/gateway_stream.proto`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_proxy_client/proto/gateway_stream.proto)
* [`grpc_p2p_client/proto/p2p_stream.proto`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_p2p_client/proto/p2p_stream.proto)
* See the [API Reference section](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#api-reference) for complete protobuf definitions
* All proto files are available in the repository's `grpc_*_client/proto/` directories:
* [`grpc_proxy_client/proto/gateway_stream.proto`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_proxy_client/proto/gateway_stream.proto)
* [`grpc_p2p_client/proto/p2p_stream.proto`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_p2p_client/proto/p2p_stream.proto)



## Development Issues

### Q: Go client code compilation errors

**A:** Use the exact Go versions and dependencies from [`optimum-dev-setup-guide`](https://github.com/getoptimum/optimum-dev-setup-guide):
**A:** Use the exact Go versions and dependencies from [`optimum-dev-setup-guide/docs/guide.md`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#client-tools):

* [`grpc_proxy_client/go.mod`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_proxy_client/go.mod)
* [`grpc_p2p_client/go.mod`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_p2p_client/go.mod)
* See the [Client Tools section](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#client-tools) for complete examples
* All go.mod files and dependencies are available in the repository's `grpc_*_client/` directories:
* [`grpc_proxy_client/go.mod`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_proxy_client/go.mod)
* [`grpc_p2p_client/go.mod`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/grpc_p2p_client/go.mod)

### Q: Code examples don't work as expected

**A:** All examples are tested against [`optimum-dev-setup-guide`](https://github.com/getoptimum/optimum-dev-setup-guide). Check:
**A:** All examples are tested against [`optimum-dev-setup-guide/docs/guide.md`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md). Check:

1. Environment variables are set correctly
2. Docker containers are running
Expand All @@ -100,5 +106,5 @@ When something doesn't work:
### Getting Help

* **CLI Issues**: [mump2p-cli FAQ](https://github.com/getoptimum/mump2p-cli#faq---common-issues--troubleshooting)
* **Setup Issues**: Check [`optimum-dev-setup-guide`](https://github.com/getoptimum/optimum-dev-setup-guide)
* **Setup Issues**: Check [`optimum-dev-setup-guide/docs/guide.md`](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md)
* **Protocol Questions**: See [OptimumP2P Documentation](./p2p.md)
2 changes: 1 addition & 1 deletion docs/learn/overview/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ A **flexnode** is an operator-run node that participates in Optimum's coded goss

* **Try OptimumP2P (≤5 min):** [Using mump2p-cli](../../guides/01-getting-started-cli.md)
* **Run locally:** [Local Setup with Docker](../../guides/02-getting-started-docker.md)
* **Integrate:** [Publish/Subscribe via Optimum Proxy endpoints](https://github.com/getoptimum/optimum-dev-setup-guide)
* **Integrate:** [Publish/Subscribe via Optimum Proxy endpoints](https://github.com/getoptimum/optimum-dev-setup-guide/blob/main/docs/guide.md#proxy-api)

### Intended users

Expand Down