docs: update create-type md for clearer instructions #455
Conversation
TarikGul
changed the title
docs/api/start/types.create.md
Outdated
| You may want to construct a `Call` type given a specific tx. This can be done via `api.createType('Call', foo)`. It can be useful if you intend on only needing the call hex. | ||
|
|
||
| ```js | ||
| const tx = await api.tx.balances.transfer(BOB, 12345); | ||
| const call = api.createType('Call', { | ||
| callIndex: tx.callIndex, | ||
| args: tx.args, | ||
| }); | ||
|
|
||
| console.log('Call Hex: ', call.toHex()); | ||
| ``` |
There was a problem hiding this comment.
The recommended approach here is -
console.log(
'hex = ',
api.tx.balances.transfer(BOB, 123).method.toHex()
);There was a problem hiding this comment.
Really good to know, I actually thought wrong about how to create a call for a while then! Thanks for letting me know and I will have it corrected above!
There was a problem hiding this comment.
Thanks for the suggestion, i just applied the fix. I went with the direction of advising using api.tx.balances.transfer(BOB, 123).method.toHex() instead of a createType('Call', foo). If you would like as well I can also remove that whole section all together. It might be useful though since even I didnt realize you can grab the method from the tx itself.
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This PR focuses on bringing some clarity based on this comment. We thought it would be beneficial to be a bit more explicit in the docs about not using createType for calls such as
api.tx...,api.query...etc.I also added an example where createType can be used to create a
Call.