Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate interfaces for algod responses #344

Open
jdtzmn opened this issue Apr 20, 2021 · 0 comments
Open

Generate interfaces for algod responses #344

jdtzmn opened this issue Apr 20, 2021 · 0 comments

Comments

@jdtzmn
Copy link
Contributor

jdtzmn commented Apr 20, 2021

Summary

Currently, generated algod types are classes that extend the BaseModel, so using them for most of the JSON requests would introduce incorrect types, such as the BaseModel's _get_obj_for_encoding method. Before the next major release, it would be nice to generate interfaces that can be used to refine the current JSON request types and, unlike the current classes, do not introduce "breaking" types.

Scope

Create a code generation template that will generate algod API interfaces with comment documentation and include the generated interfaces in existing JSON requests where applicable.

Urgency

Not urgent, but would be a great enhancement to the current types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants
@jdtzmn @algoanne and others