Refactor: types/interfaces

[carletex]

Tries to solve a couple of items from (+ general cleanup) #617

• Remove T prefix on types
• Change interface to types (when possible)
• Remove some export from types when they weren't used
• Some changes on useBurnerWallet: naming (signers => account, comments, typos, etc)

We can add more stuff in this PR (if it's in the same line).

Also, do you remember where was the discussion about viem's Address vs 0x${string}? We are still overriding in abi.d.ts, and would like to give it a second thought.

Thanks!

[technophile-04]

Also some stuff from #232 (comment):

• Removing @dev comments since they are not valid JSDoc comments

Also, do you remember where was the discussion about viem's Address vs 0x${string}

maybe are you talking about PR #515 ?

[carletex]

Removing @dev comments since they are not valid JSDoc comments

Oh yes!! Done in 07d1a04

I also tweaked some comments... and thought a bit about the JSDocs comments. Since we are using TS, I feel that some JSDocs annotations are redundant. I personally will only use them if:

• It's an exported function (it's a user facing hook / function)
• They add some extra/useful information (besides the function description). It's nice to see how IDEs show that info @param, @return, etc.

I removed some of them in the PR, but applying these rules we could probably remove a bunch more haha.

What do you all think?

maybe are you talking about PR #515 ?

Yesss thanks!!

---

[technophile-04]

I also tweaked some comments... and thought a bit about the JSDocs comments. Since we are using TS, I feel that some JSDocs annotations are redundant. I personally will only use them if:

• It's an exported function (it's a user facing hook / function)
• They add some extra/useful information (besides the function description). It's nice to see how IDEs show that info @param, @return, etc.

I removed some of them in the PR, but applying these rules we could probably remove a bunch more haha.

💯 agree with this!!! Lol I was planning to mention it in my previous comment to remove stuff like this :

scaffold-eth-2/packages/nextjs/hooks/scaffold-eth/useNativeCurrencyPrice.ts

Line 10 in b2a91b8

* @returns nativeCurrencyPrice: number

but saw we had lot clean up to do so thought maybe it would be out of scope for this PR and maybe we could have another PR with refactoring JSDoc comments.

[carletex]

but saw we had lot clean up to do so thought maybe it would be out of scope for this PR and maybe we could have another PR with refactoring JSDoc comments.

Yep, maybe another PR! Added it as a ToDo in #617

[rin-st]

👍

[technophile-04]

Merging this, Thanks Carlos 🙌