feat: indexer api client and minor jinja generator fixes #228
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aorumbayev
force-pushed
the
feat/indexer-client
branch
from
b1dd4b8 to
65c9974
Compare
Updates the OAS parser to represent top-level array schemas as type aliases (e.g., Vec) instead of structs. This simplifies the generated Rust code and avoids creating unnecessary empty structs for array types. Also it renames and refactors the 'StateDelta' and 'TealKeyValueStore' to be type aliases rather than structs.
Adds the Indexer client to algokit-utils, enabling interaction with the Algorand Indexer service. This includes: - Integration of the `indexer_client` crate. - Updates to `AlgorandClient` to support Indexer configuration. - Addition of methods in `ClientManager` to manage Indexer client instances. - Adds pre-commit hooks for formatting, linting, and testing the API OAS generator code. - Adds integration tests for the Indexer client.
…ns; refine ci Introduces a composite action to set up Rust, Bun, and Python dependencies. Implements CI workflows for linting, testing, generating, and verifying the API client code. This includes output stability checks and compilation tests. Adds a scheduled workflow to convert OpenAPI specifications and identify any necessary updates. Fixes typos in the OpenAPI specification and generated code.
This change introduces a set of helper functions to facilitate testing involving the Algorand Indexer. It provides functionality to wait for the indexer to catch up with transactions or applications, with configurable retry logic and error handling. This ensures tests can reliably verify the state of the indexer after submitting transactions. This commit also removes the previous implementation of indexer waiting logic, and replaces it with the new helpers.
aorumbayev
force-pushed
the
feat/indexer-client
branch
from
65c9974 to
2616b0c
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds initial support for the indexer client along with minor tweaks to the API generator tooling. The main purpose is to introduce a new HTTP client library for interacting with Algorand's indexer API alongside the existing algod client.
- Adds new indexer API client with complete endpoint coverage and type-safe request/response handling
- Expands API generation tooling to support both algod and indexer client generation
- Updates documentation to include the new indexer client alongside the existing algod client
Reviewed Changes
Copilot reviewed 159 out of 161 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| tools/api_tools/src/main.rs | Adds new CLI commands for indexer client generation, formatting, and OpenAPI conversion |
| docs/book/api_index.md | Documents the new algod_client and indexer_client HTTP libraries |
| crates/indexer_client/ | Contains the complete generated indexer client with models, APIs, and type definitions |
crates/indexer_client/src/models/transaction_signature_multisig_subsignature.rs
Show resolved
Hide resolved
Adds functionality to parse string enums from the OAS specification and generate corresponding Rust enums. This includes adding a new `enum_values` field to the `Schema` dataclass and a macro for generating Rust enums from string values. The changes also refactor the `OASParser` class to improve readability and maintainability by extracting several methods for handling vendor extensions, array schemas, and properties. This makes the code easier to understand and modify in the future.
neilcampbell
approved these changes
Aug 12, 2025
api/oas_generator/rust_oas_generator/templates/apis/client.rs.j2
Outdated
Show resolved
Hide resolved
api/oas_generator/rust_oas_generator/templates/apis/endpoint.rs.j2
Outdated
Show resolved
Hide resolved
Contributor
|
🎉 This PR is included in version 1.0.0-alpha.52 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Contributor
|
🎉 This PR is included in version 1.0.0-alpha.44 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds minor tweaks to api generator along with initial support for indexer client.