Skip to content
New issue

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

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

Already on GitHub? # to your account

Inappropriate paragraph on entities/realms in FileCreateTransactionBody page #834

Open
david-bakin-sl opened this issue Nov 25, 2024 · 0 comments

Comments

@david-bakin-sl
Copy link

The FileCreateTransactionBody page seems to have an inappropriate paragraph - that is, I'm sure the information is correct, but I don't know why it is on this page.

An entity (account, file, or smart contract instance) must be created in a particular realm. If the realmID is left null, then a new realm will be created with the given admin key. If a new realm has a null adminKey, then anyone can create/modify/delete entities in that realm. But if an admin key is given, then any transaction to create/modify/delete an entity in that realm must be signed by that key, though anyone can still call functions on smart contract instances that exist in that realm. A realm ceases to exist when everything within it has expired and no longer exists. The current API ignores shardID, realmID, and newRealmAdminKey, and creates everything in shard 0 and realm 0, with a null key. Future versions of the API will support multiple realms and multiple shards.

Yes, the FileCreateTransactionBody has a property newRealmAdminKey but that doesn't seem to justify this paragraph in its full glory. Especially since we don't yet support non-zero realms. Or shards, for that matter.

The two other HAPI transactions with a newRealmAdminKey field (CryptoCreate, ContractCreate) don't have that paragraph at all - in fact, their description of newRealmAdminKey might be considered too skimpy or at least misleading given that we don't support creating new realms.

Suggestion: Find a common way to describe what the newRealmAdminKey property really does and use it in all three places?

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant