Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Additional types for JsonRPC endpoints #826

Merged
merged 20 commits into from
Feb 10, 2021
Merged

Conversation

bradlhart
Copy link
Contributor

Change Description

Several more types added for all JsonRPC functions. Additionally added return types for other functions that did not have them. A new test system was also added in order to make sure these JsonRPC endpoint types stay accurate to nodeos.

API Changes

  • API Changes

Documentation Additions

  • Documentation Additions

@bradlhart bradlhart changed the title Additional types endpoints Additional types for JsonRPC endpoints Feb 2, 2021
Copy link

@venu-block1 venu-block1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests ran successfully.

Are there going to be any backward compatibility issues for users using these new types?

@bradlhart
Copy link
Contributor Author

The types are meant to match with the latest release for eos. That might mean that there will be incompatibility with older versions of eos, but technically that would also be true for things like get_kv_table_rows not existing on anything other than 2.1. The release notes will likely have information about how to fix such incompatibility, such as overriding the type to any or a user-defined type. Despite that possibility, having these types for eosjs will inform the developers better and enhance the documentation.

The only part that is difficult about this process is that a single-node eos process might not produce as much information in the responses as a multi-node setup would so there might be some inaccuracies. If they are present, these should be solved quickly with a patch version.

@bradlhart bradlhart merged commit 8065061 into develop Feb 10, 2021
@bradlhart bradlhart deleted the additional_types_endpoints branch February 10, 2021 21:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants