hashgraph / hedera-services

Crypto, token, consensus, file, and smart contract services for the Hedera public ledger
Apache License 2.0
280 stars 124 forks source link

docs: (internal) design standard for APIs exposed via system contracts #14244

Open david-bakin-sl opened 1 month ago

david-bakin-sl commented 1 month ago

We've learned over time that there are impacts to how the methods in system contracts are declared - i.e., the signature. (And sometimes we don't learn the impact until much later, unfortunately.)

We should maintain an "API standards"/"API coding style" document - a checklist basically - of how (future) methods should look.

Suggestions initially for consideration:

This document should include other considerations for what needs to go into a HIP, besides methods (and their signatures). E.g.,

david-bakin-sl commented 1 month ago

@Nana-EC, @lukelee-sl - FYI