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

refactor: custom names for generic result types in Candid interface #105

Merged
merged 6 commits into from
Dec 21, 2023

Conversation

rvanasa
Copy link
Collaborator

@rvanasa rvanasa commented Dec 20, 2023

Resolves #76.

CC @gregorydemay.

Copy link
Member

@gregorydemay gregorydemay left a comment

Choose a reason for hiding this comment

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

Thanks @rvanasa for the changes in the Candid file! This seems much cleaner to me!

Comment on lines +224 to +225
request : (JsonRpcSource, text, nat64) -> (RequestResult);
requestCost : (JsonRpcSource, text, nat64) -> (RequestCostResult) query;
Copy link
Member

Choose a reason for hiding this comment

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

understanding questions: what are those 2 methods request and requestCost?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

request() is the generic JSON-RPC endpoint (to cover everything outside of the 6 Candid-RPC methods), and requestCost() calculates the number of cycles required for a given request. This is explained in more detail in the design document.

@rvanasa rvanasa merged commit 0ac3adf into main Dec 21, 2023
@rvanasa rvanasa deleted the custom-candid-interface branch December 21, 2023 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change type names in Candid interface
2 participants