feat: rust algod client #179
Open
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
Had to work around this bug in maturin: PyO3/maturin#2459 This fix is relatively simple but requires you to modify the packages post-installation. A fix (more like feature) can be added to maturin and I think it should be fairly straightforward
There is something weird going on with the env package though. For now you need to bun rm env, run the build script, and then bun i env before running the tests
Mutex works in WASM and only adds a few nanos of overhead, so just easier to use Mutex for both uniffi and wasm
It works, but there seems to be some closure that isn't getting cleaned up properly in the async call
Bun prefers main over module for some reason at runtime. See oven-sh/bun#13430 (comment)
…g for new rust client gen
aorumbayev
force-pushed
the
feat/rust-client
branch
2 times, most recently
from
81aad13 to
10f4f80
Compare
aorumbayev
force-pushed
the
feat/rust-client
branch
from
10f4f80 to
f20b6f5
Compare
aorumbayev
force-pushed
the
feat/rust-client
branch
from
f20b6f5 to
9f0b579
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR replaces the autogenerated Python/TypeScript Algod clients with a custom Jinja2-based Rust client generator, consolidating all endpoints into a new algod_client crate and removing the old algod_api crate.
- Introduced a unified Rust client in
crates/algod_clientwith full endpoint coverage and message-pack support - Removed Python/TypeScript clients and legacy
crates/algod_api - Updated workspace to use
algokit_http_clientand streamlined client instantiation
Reviewed Changes
Copilot reviewed 174 out of 604 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| crates/algod_client/src/apis/mod.rs | Added consolidated API modules and error mapping |
| crates/algod_client/src/apis/*.rs | Implemented each endpoint with JSON/MsgPack support |
| crates/algod_client/src/apis/client.rs | Exposed ergonomic AlgodClient interface |
| crates/algod_client/README.md | Updated crate README for Rust client usage |
| crates/algod_client/Cargo.toml | Defined algod_client package and dependencies |
| crates/algod_api/src/lib.rs & Cargo.toml | Removed legacy Python/TS client code |
Comments suppressed due to low confidence (2)
crates/algod_client/src/apis/health_check.rs:25
- The variant
Statusdefaultdoes not follow Rust’s PascalCase convention. Consider renaming it toStatusDefaultfor consistency.
Statusdefault(),
crates/algod_client/README.md:22
- The usage example references
configurationanddefault_api, which no longer exist. Update this snippet to show instantiation ofAlgodClient(e.g.,let client = AlgodClient::testnet();).
use algod_client::apis::{configuration, default_api};
| Self::new(http_client) | ||
| } | ||
|
|
||
| /// Create a new AlgodClient for a local localnet environment. |
There was a problem hiding this comment.
[nitpick] The phrase "local localnet" is redundant. Consider simplifying to "Create a new AlgodClient for a localnet environment."
Suggested change
| /// Create a new AlgodClient for a local localnet environment. | |
| /// Create a new AlgodClient for a localnet environment. |
Copilot uses AI. Check for mistakes.
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.
PR Description
This PR migrates from OpenAPI code generation to a custom Jinja2-based Rust client generator, removing Python/TypeScript clients for a unified Rust ecosystem.
Key Changes
Custom Rust OAS Generator
api/oas_generator/x-algokit-signed-txnfor transaction endpointsNew Rust Client Architecture
algod_apicrate with generatedalgod_clientcratereqwestto customalgokit_http_clientfor better abstractionCleanup & Consolidation
packages/directory containing Python/TypeScript clientsEnhanced Documentation
Client Interface Improvements
Breaking Changes
algod_apicrate replaced withalgod_clientNext steps
Exposing AlgodClient via ffi is out of scope of this pr given # number of changes it introduces. Initial integration with changes from #166 are in place though