search

w3f / polkadot-wiki

The source of truth for Polkadot.
GNU General Public License v3.0
373 stars 2.3k forks source link

[Feature Request] Metadata Explorer Runtime Casing #4517

Open gilescope opened 1 year ago

gilescope commented 1 year ago

image

At the moment if someone tries to call a runtime method with the above using State call they will find that they need to have the method in snake case rather than in camel case. It would be helpful if we displayed it in the metadata explorer in snake case to give them this visual cue. E.g. AccountNonce should be account_nonce (This is only for the runtime calls)

gilescope commented 1 year ago

Maybe we should add an attribute like State.call method: AccountNonceApi_account_nonce and State.call method: BlockBuilderApi_check_inherents? I don't know if there's a better way to publicise this format but it's not something that someone would guess at so it's important that we make it clear to people.

alfarok commented 1 year ago

Hey @gilescope, thanks for checking out the new tool and providing feedback! The current camel casing is reflective of the runtime calls in polkadotjs. I see what you are saying though regarding the difference in casing in the runtime spec.

One solution could be to explicitly state that the calls are for the PolkadotJS api, such as:

PolkadotJS API Endpoint: api.call.accountNonceApi.accountNonce

Then also add another row showing the original runtime formatting, such as:

Runtime Method: AccountNonceApi_account_nonce

Let me know if I am understanding the issue correctly and if you have any additional thoughts on the solution above. Thanks again!

gilescope commented 1 year ago

Yeah that would be helpful. I like the idea of showing the js call too.

On Mon, 27 Feb 2023 at 17:20, Keith Alfaro @.***> wrote:

Hey @gilescope https://github.com/gilescope, thanks for checking out the new tool and providing feedback! The current camel casing is reflective of the runtime calls in polkadotjs. I see what you are saying though regarding the difference in casing in the runtime spec.

One solution could be to explicitly state that the calls are for the PolkadotJS api, such as:

PolkadotJS API Endpoint: api.call.accountNonceApi.accountNonce

Then also add another row showing the original runtime formatting, such as:

Runtime Method: AccountNonceApi_account_nonce

Let me know if I am understanding the issue correctly and if you have any additional thoughts on the solution above. Thanks again!

— Reply to this email directly, view it on GitHub https://github.com/w3f/polkadot-wiki/issues/4517#issuecomment-1446731877, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGEJCFQTNWY6GY3EFXRVLTWZTO5DANCNFSM6AAAAAAVJS2BQY . You are receiving this because you were mentioned.Message ID: @.***>