Generate missing protobuf files for HIP 1337

[exploreriii]

HIP 1337 needs additional fields that are not yet present

We need to update generate_protobuf.py

BLOCKED - until protobufs get updated

[github-actions]

@coderabbitai plan

[coderabbitai]

Coding Plan

Summary

• Wait for upstream protobuf repositories to publish HIP 1337 proto definitions in a tagged release
• Update the VERSION constant in generate_proto.py to pull the release containing HIP 1337
• Add module directory entries only if HIP 1337 protos are in a new top-level path (subdirectories under services/ are auto-included)
• Add import path patches to REPLACEMENTS if the new protos have broken cross-module imports

Design Choices

Design Choice 1: HIP 1337 Proto Location

Options Considered:

1. Protos will be added under services/auxiliary/hip_1337/ (following tss/hints/history pattern)
2. Protos will be added as new fields/messages in existing services/*.proto files
3. Protos will be added in an entirely new top-level module directory

Chosen Option: 1

Rationale: Option 1 or 2 are most likely based on existing patterns; if Option 3 occurs, the modules tuple in SOURCES will need updating. Plan covers all scenarios.

Design Choice 2: Version Availability

Options Considered:

1. Protos will be in a new stable release tag (e.g., v0.73.0 or later)
2. Protos will require pulling from a specific branch or pre-release tag

Chosen Option: 1

Rationale: Option 1 assumed; the VERSION constant should be updated to the first stable release containing HIP 1337 protos.

💡 User Tips

Regenerate the plan with different choices with @coderabbitai <feedback>.

Implementation Steps

Phase 1: Prerequisite Verification

Verify that HIP 1337 protobuf definitions are available in upstream repositories before proceeding with implementation.

Check Upstream Repositories for HIP 1337 Protos

Confirm the availability and location of HIP 1337 proto files in the upstream sources.

• Check hiero-ledger/hiero-consensus-node releases/tags for a version containing HIP 1337 proto definitions
• Check hashgraph/hedera-protobufs releases/tags if the protos originate from that source
• Identify the exact directory path where HIP 1337 protos are located (e.g., services/auxiliary/hip_1337/, services/hip1337/, or new fields in existing protos)
• Note the minimum version tag that includes the required proto files
• Document any new import dependencies the HIP 1337 protos have on other proto files

🤖 Prompt for AI agents

This phase is a prerequisite verification step — no code changes are made. The
goal is to confirm that HIP 1337 proto definitions are available in upstream
repositories before any implementation begins.

- Check `hiero-ledger/hiero-consensus-node` releases/tags for a version
containing HIP 1337 proto definitions
- Check `hashgraph/hedera-protobufs` releases/tags if the protos originate from
that source
- Identify the exact directory path where HIP 1337 protos are located (e.g.,
`services/auxiliary/hip_1337/`, `services/hip1337/`, or new fields in existing
protos)
- Note the minimum version tag that includes the required proto files
- Document any new import dependencies the HIP 1337 protos have on other proto
files

Phase 2: Update Proto Generation Script

Modify generate_proto.py to fetch and compile the HIP 1337 protobuf files.

Task 1: Update Version Constant

Bump the VERSION constant to include the release containing HIP 1337 protos.

• Update VERSION constant in generate_proto.py (line 33) to the identified version tag
• Verify both source repositories have compatible releases at the new version

Task 2: Add Module Directory (If Required)

Add any new top-level module directories to the SOURCES configuration if HIP 1337 protos are not under an existing module prefix.

• If protos are under services/auxiliary/*: No changes needed (prefix matching handles this automatically)
• If protos are in a new top-level directory: Add the directory name to the appropriate modules tuple in SOURCES (lines 34-49 of generate_proto.py)
• For hiero-consensus-node source: Update line 47
• For hedera-protobufs source: Update line 41

Task 3: Add Import Patches (If Required)

Add entries to the REPLACEMENTS dict if HIP 1337 protos contain broken import paths that need fixing.

• Review the new proto files for bare import statements (e.g., import "some_type.proto" without path prefix)
• Add corresponding entries to REPLACEMENTS dict (lines 55-65 of generate_proto.py) mapping broken imports to fully-qualified paths
• If platform-specific import patterns exist, add regex rules similar to the existing platform/event/ handling

Task 4: Verify Proto Generation

Run the updated script and verify HIP 1337 protos are correctly generated.

• Execute uv run python generate_proto.py locally
• Verify new *_pb2.py, *_pb2_grpc.py, and *_pb2.pyi files are generated in src/hiero_sdk_python/hapi/
• Confirm import statements in generated files are correctly rewritten to relative imports
• Check that existing proto generation still works (no regressions)

🤖 Prompt for AI agents

This phase modifies `generate_proto.py` to fetch and compile HIP 1337 protobuf
files. Apply the following changes based on the findings from Phase 1.

**Task 2.1 — Update VERSION constant:**
- In `generate_proto.py` (line 33), update the `VERSION` constant to the
identified version tag containing HIP 1337 protos
- Ensure both `hiero-ledger/hiero-consensus-node` and
`hashgraph/hedera-protobufs` have compatible releases at the new version

**Task 2.2 — Add Module Directory (if required):**
- If HIP 1337 protos are under `services/auxiliary/*`, no changes are needed —
prefix matching handles this automatically
- If protos are in a new top-level directory, add the directory name to the
appropriate `modules` tuple in `SOURCES` (lines 34-49):
  - For `hiero-consensus-node` source: update line 47
  - For `hedera-protobufs` source: update line 41

**Task 2.3 — Add Import Patches (if required):**
- Review the new HIP 1337 proto files for bare import statements (e.g., `import
"some_type.proto"` without a path prefix)
- Add corresponding entries to the `REPLACEMENTS` dict (lines 55-65) mapping
broken imports to fully-qualified paths
- If platform-specific import patterns exist, add regex rules similar to the
existing `platform/event/` handling

**Task 2.4 — Verify Proto Generation:**
- Execute `uv run python generate_proto.py` locally
- Verify new `*_pb2.py`, `*_pb2_grpc.py`, and `*_pb2.pyi` files are generated in
`src/hiero_sdk_python/hapi/`
- Confirm import statements in generated files are correctly rewritten to
relative imports
- Check that existing proto generation still works (no regressions)

Research

The SDK uses generate_proto.py to fetch, patch, and compile protobuf files from two upstream sources: hashgraph/hedera-protobufs (mirror protos) and hiero-ledger/hiero-consensus-node (services, platform, fee, sdk, block, streams, blocks). The script downloads versioned tarballs (currently pinned to v0.72.0-rc.2), extracts modules by prefix-matching, patches broken import paths via a REPLACEMENTS dict, compiles with grpcio-tools.protoc, and fixes Python imports to relative paths. Generated output lands in src/hiero_sdk_python/hapi/ (gitignored). Subdirectories under existing modules (e.g., services/auxiliary/*) are automatically included without explicit configuration.

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

This phase is a prerequisite verification step — no code changes are made. The
goal is to confirm that HIP 1337 proto definitions are available in upstream
repositories before any implementation begins.

- Check `hiero-ledger/hiero-consensus-node` releases/tags for a version
containing HIP 1337 proto definitions
- Check `hashgraph/hedera-protobufs` releases/tags if the protos originate from
that source
- Identify the exact directory path where HIP 1337 protos are located (e.g.,
`services/auxiliary/hip_1337/`, `services/hip1337/`, or new fields in existing
protos)
- Note the minimum version tag that includes the required proto files
- Document any new import dependencies the HIP 1337 protos have on other proto
files
===============================================================================

Task: 2

This phase modifies `generate_proto.py` to fetch and compile HIP 1337 protobuf
files. Apply the following changes based on the findings from Phase 1.

**Task 2.1 — Update VERSION constant:**
- In `generate_proto.py` (line 33), update the `VERSION` constant to the
identified version tag containing HIP 1337 protos
- Ensure both `hiero-ledger/hiero-consensus-node` and
`hashgraph/hedera-protobufs` have compatible releases at the new version

**Task 2.2 — Add Module Directory (if required):**
- If HIP 1337 protos are under `services/auxiliary/*`, no changes are needed —
prefix matching handles this automatically
- If protos are in a new top-level directory, add the directory name to the
appropriate `modules` tuple in `SOURCES` (lines 34-49):
  - For `hiero-consensus-node` source: update line 47
  - For `hedera-protobufs` source: update line 41

**Task 2.3 — Add Import Patches (if required):**
- Review the new HIP 1337 proto files for bare import statements (e.g., `import
"some_type.proto"` without a path prefix)
- Add corresponding entries to the `REPLACEMENTS` dict (lines 55-65) mapping
broken imports to fully-qualified paths
- If platform-specific import patterns exist, add regex rules similar to the
existing `platform/event/` handling

**Task 2.4 — Verify Proto Generation:**
- Execute `uv run python generate_proto.py` locally
- Verify new `*_pb2.py`, `*_pb2_grpc.py`, and `*_pb2.pyi` files are generated in
`src/hiero_sdk_python/hapi/`
- Confirm import statements in generated files are correctly rewritten to
relative imports
- Check that existing proto generation still works (no regressions)

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[danielmarv]

/assign

[github-actions]

Hi @danielmarv 👋

This issue has been assigned but no pull request has been created yet.
Are you still planning on working on it?
If you are, please create a draft PR linked to this issue or comment /working to let us know.
If you’re no longer able to work on this issue, you can comment /unassign to release it.

From the Python SDK Team