feat: initial oas generators support; algod http clients with tests covering transaction endpoints; refinements in python ffi package #63
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
…uto generate valid baseline tests
…dify - Instead setting up a structure for custom mustache files implementing manually written tests given that each end point (total around 55) often requires complex state setup - For the time being the only test established is the test for sending raw transactions
Refines the algokit-transact Python package to improve compatibility with Poetry and Python 3.13. Updates dependencies and build configurations for a smoother development experience.
aorumbayev
requested review from
CiottiGiorgio,
joe-p,
lempira,
neilcampbell and
PatrickDinh
aorumbayev
force-pushed
the
spike/oas_clients
branch
4 times, most recently
from
f858c9a to
97af59d
Compare
aorumbayev
force-pushed
the
spike/oas_clients
branch
from
97af59d to
49cf4e5
Compare
|
Haven't reviewed in-depth yet, but would it be possible make the Python changes in a separate PR? We have merge conflicts anyways after #61 and having that work in a separate PR will make it a bit easier to review and iterate. |
aorumbayev
force-pushed
the
spike/oas_clients
branch
3 times, most recently
from
b79287d to
8e6f806
Compare
aorumbayev
force-pushed
the
spike/oas_clients
branch
from
8e6f806 to
6b060a0
Compare
PatrickDinh
approved these changes
May 2, 2025
|
Could we add extension to the moustache template files to make them a bit easier to digest? For example, instead of |
PatrickDinh
reviewed
May 5, 2025
| ], | ||
| "scripts": { | ||
| "test": "vitest", | ||
| "build": "npm run clean && npm run build:esm && npm run build:cjs", |
There was a problem hiding this comment.
hey @aorumbayev, sorry I missed this in my first round of review. Do you think that we should change this to bun instead of npm to align with the rest of the code base?
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.
Proposed changes
This PR introduces the infrastructure for generating Algorand API clients using the OpenAPI Generator tool. This approach automates the creation of clients in various languages (initially focusing on Python and TypeScript for
algokit-utils) from a single OpenAPI specification, ensuring consistency and reducing maintenance overhead.Motivation:
As outlined in
docs/research/openapi-generators.md, manually maintaining API clients across multiple languages is time-consuming and error-prone. Using OpenAPI generators allows us to:Changes:
/apito support the generation process:api/specs/: Contains the OpenAPI specifications (v2 and v3).api/api_clients/: Will hold the generated client code.api/oas_templates/: Stores custom Mustache templates for tailoring generated code.api/scripts/: Includes utility scripts (generate-api-clients.ts) for managing the generation process.openapitools.json,package.json,tsconfig.json,openapi-config.yaml) to configure the generator and manage dependencies (likebunfor running the generation script).AvmValueschema for Python).scripts/generate-api-clients.ts(run viabun run) to orchestrate the client generation, including handling.openapi-generator-ignorefiles to protect custom code.get pending txns,get tx params,post raw txn) needed foralgokit-utilsintegration.docs/research/openapi-generators.mddetailing the approach, structure, rationale, and future work.poetry.lockandpyproject.tomlinpackages/python/algokit_transactreflecting changes potentially related to CFFI or other dependencies needed for the generated clients or testing infrastructure. (Specific updates includecffi,maturin,packaging,pluggy,pytest,tomli, and adjustments to dev dependencies).This PR lays the baseline for a more scalable and maintainable approach to managing Algorand API clients across different languages within the monorepo project.