✨ Add provider.getTransactionCount
#101
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -33,7 +33,8 @@ type RPCMethodName = | |||
| | 'eth_chainId' | |||
| | 'eth_gasPrice' | |||
| | 'eth_getBalance' | |||
| | 'eth_getTransactionByHash'; | |||
| | 'eth_getTransactionByHash' | |||
| | 'eth_getTransactionCount'; | |||
| const ethersProvider = new ethers.providers.StaticJsonRpcProvider(rpcUrl); | ||
| const web3Provider = new Web3(rpcUrl); | ||
| const [eeTC, ethersTC, web3TC] = await Promise.all([ | ||
| eeProvider.getTransactionCount(address, blockTag), |
There was a problem hiding this comment.
This is SUCH a good test since it covers web3 and ethers both 🙏
| @@ -300,6 +300,16 @@ export class JsonRpcProvider { | |||
| blockNumber.number - cleanedTransaction.blockNumber + 1; | |||
| return cleanedTransaction; | |||
| } | |||
|
|
|||
| public async getTransactionCount( | |||
There was a problem hiding this comment.
The only thing I can think of to add would be tsdoc comments above this function, which get auto-compiled into the live documentation via docusaurus.
I should add a contributing guideline, so this is not expected for you to know!
I'll take care of this from here and merge this @iadnanmalik 🙏
There was a problem hiding this comment.
Haha same brainwaves, thought I'd beat you to it! Resolving my comment
There was a problem hiding this comment.
Thank you so much for your kind words.
This was my first ever open source contribution ❤️
There was a problem hiding this comment.
Ignore this, as Dawson already mentioned
This is looking good, thank you! I'll give it a closer look later when I get a chance. Only thing that stood out immediately was needing some inline TypeDoc documentation. Here's a good example: https://github.com/Earnifi/essential-eth/blob/6f549292b931aaac96bfd1d05bd9b997d0a521e3/src/providers/JsonRpcProvider.ts#L30
Let me know if you have any questions!
src/providers/JsonRpcProvider.ts
Outdated
| const transactionCount = (await this.post( | ||
| buildRPCPostBody('eth_getTransactionCount', [address, blockTag]), | ||
| )) as string; | ||
| return tinyBig(hexToDecimal(transactionCount)).toNumber(); |
There was a problem hiding this comment.
I'm not sure tinyBig is needed here since we're always returning a decimal which is going to be within the JavaScript max range
| @@ -0,0 +1,27 @@ | |||
| import { debug } from 'console'; | |||
There was a problem hiding this comment.
I think this "debug" was left-over from testing. I'll remove this before merging too
| import { BlockTag } from '../../types/Block.types'; | ||
| import { rpcUrls } from './rpc-urls'; | ||
|
|
||
| const address = '0x0000000000000000000000000000000000000000'; |
There was a problem hiding this comment.
Turns out this address has 0 transactions in most blocks, so we want to use a much more active address for tests.
One example could be a hot-wallet for coinbase since that has a ton of traffic.
There was a problem hiding this comment.
Should we try something other than TinyBig?
With some different addresses?
| describe('provider.getBalance gno', () => { | ||
| const rpcUrl = rpcUrls.gno; | ||
| it('should get latest equal to ethers', async () => { | ||
| await testGetTC(rpcUrl, 'latest'); |
There was a problem hiding this comment.
These test-cases could cover more options.
One would be passing in a blockNumber as a decimal. Here is an example of a test which does not pass:
// on mainnet
it.only('should tx count up to block number equal to ethers and web3', async () => {
await testGetTC(rpcUrl, 14649390);
});
|
Wahoo, your first PR merged @iadnanmalik ! I did a few changes to it which I will try to summarize in a "contribution guidelines" soon :) Feel free to take on another issue if you'd like! Let me know and I will assign the issue for any you are interested in 🙏 |
dawsbot
changed the title
provider.getTransactionCount
Closes #94
The
getTransactionCountfunction takes in a string and a blockTag object and returns a number which is the count of the transactions. Format of the already written code has been followed.Any suggestions or changes are most welcome. :)