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

FallbackProvider picks broadcastTransaction results incorrectly #4297

Closed
staltz opened this issue Aug 7, 2023 · 1 comment
Closed

FallbackProvider picks broadcastTransaction results incorrectly #4297

staltz opened this issue Aug 7, 2023 · 1 comment
Assignees
Labels
enhancement New feature or improvement. fixed/complete This Bug is fixed or Enhancement is complete and published. v6 Issues regarding v6

Comments

@staltz
Copy link

staltz commented Aug 7, 2023

Ethers Version

6.6.2

Search Terms

FallbackProvider

Describe the Problem

We use FallbackProvider to submit a "broadcastTransaction" request to many providers. Some of them fail, some of them succeed. They all have the same "weight" value, which can cause one of the failures to be picked as the main result.

When FallbackProvider (src.ts/providers/provider-fallback.ts) performs a broadcastTransaction request, it uses a try-catch and converts network errors to "normalized result" objects. Then, it uses getAnyResult to pick the main result. getAnyResult in turn uses checkQuorum to get the first (or heaviest weight) result that passes the quorum value.

Expected: if there is one success with weight 2 (quorum 2) and one error with weight 2 (quorum 2), then the success should always be chosen by checkQuorum.

Actual: if there is one success with weight 2 (quorum 2) and one error with weight 2 (quorum 2), then depending on the order of the results in the array, the first one will be picked, which may be the error result.

Code Snippet

No response

Contract ABI

No response

Errors

No response

Environment

Ethereum (mainnet/ropsten/rinkeby/goerli), node.js (v12 or newer), Browser (Chrome, Safari, etc), React Native/Expo/JavaScriptCore

Environment (Other)

No response

@staltz staltz added investigate Under investigation and may be a bug. v6 Issues regarding v6 labels Aug 7, 2023
@ricmoo ricmoo added enhancement New feature or improvement. on-deck This Enhancement or Bug is currently being worked on. next-patch Issues scheduled for the next arch release. and removed investigate Under investigation and may be a bug. labels Aug 8, 2023
@ricmoo ricmoo added the minor-bump Planned for the next minor version bump. label Nov 11, 2023
@ricmoo
Copy link
Member

ricmoo commented Nov 27, 2023

Fixed in 6.9.0.

Let me know if there are any other weirdnesses; I've added a test suite to help ensure any nuances of the FallbackProvider can be reliably tested.

Thanks! :)

@ricmoo ricmoo closed this as completed Nov 27, 2023
@ricmoo ricmoo added fixed/complete This Bug is fixed or Enhancement is complete and published. and removed on-deck This Enhancement or Bug is currently being worked on. minor-bump Planned for the next minor version bump. next-patch Issues scheduled for the next arch release. labels Nov 27, 2023
rrw-zilliqa added a commit to Zilliqa/ethers.js that referenced this issue Apr 29, 2024
* docs: fixed typo in jsdocs for Wallet.createRandom (ethers-io#4461)

* admin: added diff scripts for build page

* admin: updated dist files

* Added safe and finalized provider events (ethers-io#3921).

* tests: bumped Node versions for testing (ethers-io#4451)

* admin: style fix (ethers-io#4356)

* More robust FallbackProvider broadcast (ethers-io#4186, ethers-io#4297, ethers-io#4442).

* Account for provider config weight when kicking off a request in FallbackProvider (ethers-io#4298).

* Fixed ParamType formatting causing bad tuple full and minimal ABI output (ethers-io#4329, ethers-io#4479).

* Added Base network to AlchemyProvider (ethers-io#4384).

* Add auto-detected static network support to providers and allow customizing socket provider options (ethers-io#4199, ethers-io#4418, ethers-io#4441).

* Use provider-specified suggested priority fee when available, otherwise fallback onto existing logic of 1 gwei (ethers-io#4463).

* admin: updated dist files

* admin: update changelog after build-clean

* docs: Fixed some grammar in getting-started (ethers-io#4486, ethers-io#4487, ethers-io#4488)

* Fix uncatchable issue when sending transactions over JSON-RPC and provide some retry-recovery for missing v (ethers-io#4513).

* admin: update dist files

* Fix Base58 padding for string representation of binary data (ethers-io#4527).

* admin: updated dist files

* Limit decoded result imflation ratio from ABI-encoded data (ethers-io#4537).

* admin: updated dist files

* Better debugging output on fetch errors.

* docs: added StaticJsonRpcProvider to migration docs

* Fixed typo in Error string (ethers-io#4539).

* Fix EIP-712 type aliases for uint and int (ethers-io#4541).

* Added additional sepolia testnets.

* Updated third-party provider network URLs (ethers-io#4542).

* admin: updated dist files

* Fixed normalization and abstracted EIP-712 Array parsing (ethers-io#4541).

* admin: updated dist files

* tests: added testing for correct thrid-party URLs

* Updated thrid-part provider URLs for QuickNode.

* tests: rename test suite to follow naming convention

* admin: updated dist files

* Normalize EIP-712 types before computing the payload (ethers-io#4541).

* tests: add tests for EIP-712 payload aliases

* admin: updated dist files

---------

Co-authored-by: Richard Moore <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improvement. fixed/complete This Bug is fixed or Enhancement is complete and published. v6 Issues regarding v6
Projects
None yet
Development

No branches or pull requests

2 participants