dethcrypto / dethcrypto/TypeChain

Feature request: Generate inline documents from `natspec` to `types

Open
#770 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
2.8k
Forks
376
PR merge metrics
No merged PRs in 30d

Description

For example, for the following solidity function, copy respective documents to the type file. It would be pretty useful for frontend devs and other integrators to understand more about how to use the function properly. Please let me know if it is already supported. Thanks!

```
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, uint256 amount) external returns (bool);
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.