Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error in the documentation with TransactionRequest. maxPiorityFeePerGas -> should be TransactionRequest. maxPriorityFeePerGas - missing r #1777

Closed
GiraeffleAeffle opened this issue Jul 16, 2021 · 2 comments
Labels
documentation Documentation related issue. fixed/complete This Bug is fixed or Enhancement is complete and published.

Comments

@GiraeffleAeffle
Copy link

GiraeffleAeffle commented Jul 16, 2021

In the documentation https://docs.ethers.io/v5/api/providers/types/#providers-TransactionRequest

there is an error

transactionRequest.maxPiorityFeePerGas ⇒ BigNumber | Promise< BigNumber >
The price (in wei) per unit of gas this transaction will pay for the EIP-1559 priority fee. This is included in the maxFeePerGass, so this will not affect the total maximum cost set with maxFeePerGas.

Most developers should leave this unspecified and use the default value that ethers determines from the network.

This may not be specified for transactions with type set to 0 or if gasPrice is specified.

This is wrong. There is a r mission in Priority-> maxPiorityFeePerGas

It should be -> maxPriorityFeePerGas

I couldn't find it in here

Otherwise I would have made a PR

@GiraeffleAeffle GiraeffleAeffle added the documentation Documentation related issue. label Jul 16, 2021
@GiraeffleAeffle GiraeffleAeffle changed the title Error in the ducumentation with TransactionRequest. maxPiorityFeePerGas -> should be TransactionRequest. maxPriorityFeePerGas - missing r Error in the documentation with TransactionRequest. maxPiorityFeePerGas -> should be TransactionRequest. maxPriorityFeePerGas - missing r Jul 16, 2021
@ricmoo
Copy link
Member

ricmoo commented Aug 9, 2021

I have a few un-committed changes to the docs (which have been uploaded). I'll fix this and push those changes.

Thanks! :)

@ricmoo ricmoo added the on-deck This Enhancement or Bug is currently being worked on. label Aug 9, 2021
ricmoo added a commit that referenced this issue Aug 9, 2021
@ricmoo
Copy link
Member

ricmoo commented Aug 9, 2021

Fixed and published.

Thanks! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related issue. fixed/complete This Bug is fixed or Enhancement is complete and published.
Projects
None yet
Development

No branches or pull requests

2 participants