feat: watch pending txs for success #3537

iamacook · 2022-02-17T17:41:21Z

What it solves

Resolves #3531

How this PR fixes it

Pending transactions that exist in the store on mount are watched for their success on the chain. If they succeed or alternatively timeout, their pending status is removed. This depends on if the transaction was (un-)successfully mined within 50 blocks since the session loaded.

How to test it

Create a transaction and execute it with a low gas amount.
Cancel the transaction with a high gas amount.
Refresh the page and observe the pending status persisting.
Within a period of 50 blocks it will either switch to successful if it was mined, or cleared with a notification.

Screenshots

github-actions · 2022-02-17T17:41:35Z

CLA Assistant Lite All Contributors have signed the CLA.

github-actions · 2022-02-17T17:44:15Z

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type	Occurrences	Fixable
Errors	0	0
Warnings	2	0
Ignored	0	N/A

Result: ✅ success
Annotations: 2 total

[warning] @typescript-eslint/explicit-module-boundary-types

Require explicit return and argument types on exported functions' and classes' public class methods

src/logic/safe/hooks/useWatchPendingTxs.tsx Line 9 - Missing return type on function.

[warning] react-hooks/exhaustive-deps

verifies the list of dependencies for Hooks like useEffect and similar

src/logic/safe/hooks/useWatchPendingTxs.tsx Line 58 - React Hook useEffect has missing dependencies: 'pendingTxsOnChain' and 'web3.eth'. Either include them or remove the dependency array.

^{Report generated by eslint-plus-action}

github-actions · 2022-02-17T17:49:25Z

Deployment links

🟠 Rinkeby	⚪ Mainnet	🟣 Polygon	🟡 BSC	⚫ Arbitrum	🟢 Gnosis Chain

github-actions · 2022-02-17T17:56:44Z

E2E Tests Failed
Check the results here: https://github.com/gnosis/safe-react-e2e-tests/actions/runs/1946897963

Failed tests:

❌ Add an existing safe Add an existing safe
❌ Read-only transaction creation and review Read-only transaction creation and review
❌ Safe Apps List Safe Apps List

github-actions · 2022-03-01T10:47:15Z

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type	Occurrences	Fixable
Errors	0	0
Warnings	0	0
Ignored	1	N/A

Result: ✅ success
Annotations: 0 total

^{Report generated by eslint-plus-action}

coveralls · 2022-03-01T10:50:06Z

Pull Request Test Coverage Report for Build 1946860930

25 of 31 (80.65%) changed or added relevant lines in 4 files are covered.
243 unchanged lines in 23 files lost coverage.
Overall coverage remained the same at 35.015%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/logic/safe/store/actions/createTransaction.ts	0	1	0.0%
src/logic/safe/store/middleware/pendingTransactionsMiddleware.ts	2	4	50.0%
src/logic/safe/store/reducer/pendingTransactions.ts	0	3	0.0%

Files with Coverage Reduction	New Missed Lines	%
src/components/AppLayout/Footer/index.tsx	1	90.91%
src/logic/cookies/store/selectors/index.ts	1	0%
src/logic/hooks/useEstimateSafeCreationGas.tsx	1	88.0%
src/logic/safe/store/reducer/pendingTransactions.ts	1	23.81%
src/routes/safe/components/CurrencyDropdown/index.tsx	1	91.43%
src/logic/cookies/store/reducer/cookies.ts	2	60.0%
src/routes/CreateSafePage/steps/OwnersAndConfirmationsNewSafeStep.tsx	2	85.06%
src/routes/safe/components/Balances/SendModal/screens/SendCollectible/CollectibleSelectField/index.tsx	2	0%
src/routes/safe/components/Balances/SendModal/screens/SendCollectible/style.ts	2	0%
src/routes/safe/components/Balances/SendModal/screens/SendCollectible/TokenSelectField/index.tsx	3	0%

Totals
Change from base Build 1910896212:	0%
Covered Lines:	3390
Relevant Lines:	8751

💛 - Coveralls

src/logic/safe/store/middleware/pendingTransactionsMiddleware.ts

katspaugh

I would refactor the watcher in the following way:

Make a function that iterates over pending txns, launches a monitor for them
The monitor itself should be a function that takes a single tx
Write unit tests for both functions

src/logic/safe/store/middleware/pendingTransactionsMiddleware.ts

src/logic/notifications/notificationTypes.ts

src/logic/safe/transactions/pendingTxMonitor.ts

katspaugh

Code looks great!

src/logic/safe/store/reducer/pendingTransactions.ts

DiogoSoaress

Looks good! And easy to follow 👍

DiogoSoaress · 2022-03-09T10:35:17Z

src/logic/safe/store/actions/createTransaction.ts

          )
          .encodeABI()
-      : txHash && safeInstance.methods.approveHash(txHash).encodeABI()
+      : this.txHash && safeInstance.methods.approveHash(this.txHash).encodeABI()


Why this change? I see that before we were destructuring txHash from this

txHash wasn't updating when destructured

usame-algan

Great feature! 👍

francovenica · 2022-03-09T12:55:25Z

Looks goods

So I tried a couple of times to create a tx, setting the gas price in low and then cancelling it right away, refresh the page and see that the tx is shown in pending until it "realizes" after a few minutes that the tx was not mined.

iamacook added 4 commits February 16, 2022 14:47

fix: throw when tx isn't mined

c388c76

fix: remove unnecessary throw

2f79e3e

fix: propose once txHash + store with pending

22c160a

wip: watch loaded pending txs

f4fcfda

iamacook linked an issue Feb 17, 2022 that may be closed by this pull request

Pending statuses persist for cancelled transactions loaded from sessionStorage #3531

Closed

iamacook marked this pull request as draft February 17, 2022 17:41

Base automatically changed from pending-txs to dev February 21, 2022 12:34

Merge branch 'dev' into pending-watcher

e3ff1c6

fix: move watcher to middleware + add notification

75d6c36

iamacook marked this pull request as ready for review March 1, 2022 16:15

iamacook requested review from DiogoSoaress, katspaugh and usame-algan March 1, 2022 16:15

katspaugh reviewed Mar 1, 2022

View reviewed changes

src/logic/safe/store/middleware/pendingTransactionsMiddleware.ts Outdated Show resolved Hide resolved

katspaugh suggested changes Mar 1, 2022

View reviewed changes

katspaugh reviewed Mar 1, 2022

View reviewed changes

src/logic/safe/store/middleware/pendingTransactionsMiddleware.ts Outdated Show resolved Hide resolved

iamacook marked this pull request as draft March 1, 2022 16:39

fix: abstract monitor + add tests

c3526d3

iamacook temporarily deployed to Manual March 2, 2022 08:11 Inactive

fix: migrate to wallet connection + tweak monitor

0667c52

iamacook temporarily deployed to Manual March 2, 2022 09:43 Inactive

fix: remove chains with no pending txs

0145293

iamacook temporarily deployed to Manual March 2, 2022 09:54 Inactive

katspaugh reviewed Mar 2, 2022

View reviewed changes

src/logic/notifications/notificationTypes.ts Show resolved Hide resolved

katspaugh reviewed Mar 2, 2022

View reviewed changes

fix: extract back off consts + attempt loops

23a2b40

iamacook temporarily deployed to Manual March 2, 2022 10:57 Inactive

katspaugh reviewed Mar 2, 2022

View reviewed changes

src/logic/safe/transactions/pendingTxMonitor.ts Outdated Show resolved Hide resolved

katspaugh reviewed Mar 2, 2022

View reviewed changes

src/logic/safe/transactions/pendingTxMonitor.ts Outdated Show resolved Hide resolved

fix: split monitor + pass backOff options as param

148bb3b

iamacook temporarily deployed to Manual March 2, 2022 13:24 Inactive

fix: tests

e5a70ec

iamacook temporarily deployed to Manual March 2, 2022 15:47 Inactive

fix: tests

74fe1cb

iamacook temporarily deployed to Manual March 2, 2022 16:25 Inactive

iamacook marked this pull request as ready for review March 2, 2022 16:27

iamacook requested a review from katspaugh March 2, 2022 16:27

katspaugh approved these changes Mar 3, 2022

View reviewed changes

iamacook added 4 commits March 7, 2022 13:42

fix: check blockHash of receipt

5553c66

fix: test

a144665

fix: only remove pending in catch

e239a22

fix: test

64dcdd6

usame-algan reviewed Mar 9, 2022

View reviewed changes

src/logic/safe/store/reducer/pendingTransactions.ts Show resolved Hide resolved

DiogoSoaress approved these changes Mar 9, 2022

View reviewed changes

usame-algan approved these changes Mar 9, 2022

View reviewed changes

iamacook merged commit 0ff3119 into dev Mar 9, 2022

iamacook deleted the pending-watcher branch March 9, 2022 16:36

github-actions bot locked and limited conversation to collaborators Mar 9, 2022

feat: watch pending txs for success #3537

feat: watch pending txs for success #3537

Uh oh!

Conversation

iamacook commented Feb 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What it solves

How this PR fixes it

How to test it

Screenshots

Uh oh!

github-actions bot commented Feb 17, 2022

Uh oh!

github-actions bot commented Feb 17, 2022

ESLint Summary View Full Report

[warning] @typescript-eslint/explicit-module-boundary-types

[warning] react-hooks/exhaustive-deps

Uh oh!

github-actions bot commented Feb 17, 2022

Deployment links

Uh oh!

github-actions bot commented Feb 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ESLint Summary View Full Report

Uh oh!

coveralls commented Mar 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 1946860930

💛 - Coveralls

Uh oh!

Uh oh!

katspaugh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

katspaugh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DiogoSoaress left a comment

Choose a reason for hiding this comment

Uh oh!

DiogoSoaress Mar 9, 2022

Choose a reason for hiding this comment

Uh oh!

iamacook Mar 9, 2022

Choose a reason for hiding this comment

Uh oh!

usame-algan left a comment

Choose a reason for hiding this comment

Uh oh!

francovenica commented Mar 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

iamacook commented Feb 17, 2022 •

edited

Loading

github-actions bot commented Feb 17, 2022 •

edited

Loading

github-actions bot commented Mar 1, 2022 •

edited

Loading

coveralls commented Mar 1, 2022 •

edited

Loading