Skip to content

Add nonce tracker to transactions controller #1147

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.

Sign up for GitHub

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

Merged
adonesky1 merged 8 commits into from
Apr 11, 2023
Merged

Add nonce tracker to transactions controller #1147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5679f2b
add nonceTracker to TransactionsController
adonesky1 Mar 28, 2023
4abd631
cleanup
adonesky1 Apr 6, 2023
2138d65
address feedback
adonesky1 Apr 6, 2023
c73cf69
update comment
adonesky1 Apr 6, 2023
9f2662e
modify mocking strategy
adonesky1 Apr 10, 2023
96c406d
cleanup
adonesky1 Apr 10, 2023
c2961a4
address feedback
adonesky1 Apr 11, 2023
943b0b1
Merge branch 'main' into add-nonce-tracker-to-transactions-controller
adonesky1 Apr 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/network-controller/src/NetworkController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export type ProviderProxy = SwappableProxy<Provider>;

type BlockTracker = any;

type BlockTrackerProxy = SwappableProxy<BlockTracker>;
export type BlockTrackerProxy = SwappableProxy<BlockTracker>;
Copy link
Copy Markdown
Contributor

@legobeat legobeat Apr 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this is now an exported type, doesn't it warrant constraining BlockTracker to something more specific than any?

Copy link
Copy Markdown
Contributor Author

@adonesky1 adonesky1 Apr 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps! But I don't believe that's appropriately scoped to this PR. As you can see directly above this we are doing the same with Provider:

type Provider = any;

export type ProviderProxy = SwappableProxy<Provider>;

Copy link
Copy Markdown
Contributor

@legobeat legobeat Apr 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does the type of Provider reduce the scope of this PR?

The impacts of the type being any is different for public and private interfaces. A type which is acceptable as any internally may require constraining before being appropriate for exposure.

Copy link
Copy Markdown
Contributor Author

@adonesky1 adonesky1 Apr 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does the type of Provider reduce the scope of this PR?

On that point I was just noting that we're already exporting the ProviderProxy object with a Provider type parameter that is also typed as any.

Copy link
Copy Markdown
Contributor Author

@adonesky1 adonesky1 Apr 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the BlockTracker is set here, where it is a property on the Provider. I believe there is an intention to follow back here and improve typing soon. cc @Gudahtt @mcmire

If we think it makes sense to add the types for both Provider and BlockTracker in this PR I'm open to that.

Copy link
Copy Markdown
Contributor

@mcmire mcmire Apr 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's right. We're using any at the moment because web3-provider-engine doesn't provide types at all, and we're about to replace it anyway (see #1116). Once the replacement is complete, then we can just use the correct types from @metamask/eth-json-rpc-provider and eth-block-tracker.


export type NetworkControllerStateChangeEvent = {
type: `NetworkController:stateChange`;
Expand Down
1 change: 1 addition & 0 deletions packages/transaction-controller/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"eth-query": "^2.1.2",
"eth-rpc-errors": "^4.0.0",
"ethereumjs-util": "^7.0.10",
"nonce-tracker": "^1.1.0",
"uuid": "^8.3.2"
},
"devDependencies": {
Expand Down
Loading