Export EIP-6963 Types #7270

danforbes · 2024-09-18T19:15:52Z

Export EIP-6963 types

github-actions · 2024-09-18T19:18:13Z

Bundle Stats

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
10	640.73 kB → 640.83 kB (+108 B)	+0.02%

Changeset

File	Δ	Size
`../web3-eth/lib/commonjs/web3_subscriptions.js`	📈 +54 B (+0.87%)	6.08 kB → 6.13 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
../lib/commonjs/abi.d.ts	999 B → 1.06 kB (+90 B)	+9.01%
../lib/commonjs/index.d.ts	8.69 kB → 8.72 kB (+35 B)	+0.39%
web3.min.js	621.32 kB → 621.34 kB (+20 B)	+0.00%

Smaller

Asset	File Size	% Changed
../lib/commonjs/providers.exports.d.ts	183 B → 148 B (-35 B)	-19.13%
../lib/commonjs/types.d.ts	2.67 kB → 2.67 kB (-2 B)	-0.07%

Unchanged

Asset	File Size	% Changed
../lib/commonjs/accounts.d.ts	3.89 kB	0%
../lib/commonjs/web3.d.ts	1.38 kB	0%
../lib/commonjs/web3_eip6963.d.ts	1.28 kB	0%
../lib/commonjs/eth.exports.d.ts	280 B	0%
../lib/commonjs/version.d.ts	60 B	0%

github-actions

Benchmark

Benchmark suite	Current: `416db8f`	Previous: `facc2e6`	Ratio
`processingTx`	`22147` ops/sec (`±6.10%`)	`22984` ops/sec (`±5.69%`)	`1.04`
`processingContractDeploy`	`38334` ops/sec (`±8.19%`)	`38640` ops/sec (`±12.90%`)	`1.01`
`processingContractMethodSend`	`15502` ops/sec (`±7.72%`)	`16387` ops/sec (`±6.56%`)	`1.06`
`processingContractMethodCall`	`25953` ops/sec (`±9.11%`)	`28396` ops/sec (`±6.55%`)	`1.09`
`abiEncode`	`43174` ops/sec (`±7.06%`)	`44603` ops/sec (`±6.87%`)	`1.03`
`abiDecode`	`29655` ops/sec (`±7.46%`)	`32125` ops/sec (`±5.97%`)	`1.08`
`sign`	`1514` ops/sec (`±0.88%`)	`1562` ops/sec (`±3.66%`)	`1.03`
`verify`	`363` ops/sec (`±0.50%`)	`369` ops/sec (`±0.44%`)	`1.02`

This comment was automatically generated by workflow using github-action-benchmark.

codecov · 2024-09-18T19:29:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.44%. Comparing base (cc99825) to head (416db8f).
Report is 8 commits behind head on 4.x.

Additional details and impacted files

@@           Coverage Diff           @@
##              4.x    #7270   +/-   ##
=======================================
  Coverage   94.44%   94.44%           
=======================================
  Files         216      216           
  Lines        8463     8463           
  Branches     2339     2340    +1     
=======================================
  Hits         7993     7993           
  Misses        470      470

Flag	Coverage Δ
UnitTests	`94.44% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

jdevcs · 2024-09-19T11:40:18Z

packages/web3-types/src/eip6963_types.ts

+export interface EIP6963ProviderInfo {
+	uuid: string;
+	name: string;
+	icon: string;
+	rdns: string;
+}
+
+export interface EIP6963ProviderDetail<API = Web3APISpec> {
+	info: EIP6963ProviderInfo;
+	provider: EIP1193Provider<API>;
+}
+
+export type EIP6963ProviderResponse = Map<string, EIP6963ProviderDetail>;
+
+export interface EIP6963ProvidersMapUpdateEvent extends CustomEvent {


why these types are moved from web3 to types package?

Because I think they should be exported and it seemed like the best way to go about it. I can modify the PR export them directly from the web3 package, but this seemed like a better approach to me.

usually we move types in web3-types package if these are used by 1+ package / are common types.
As web3-types package is a dependency of almost all other packages so we try to keep it light for usecase of other individual packages usage.

( same for utils package , for future changes)

I believe since we created web3-types, it should encompass all the neccesary types to use the package. I think as well remain consistent, as we have EIP1193Provider types EIP6693 provider types should be included. This will allow these types to be exported through the main package which would make alot of since for most users, as I believe not very many users would know that EIP6693 types would be exported through providers namespace. We had a discussion on this a while back on this issue about doing this change #6952

as I believe not very many users would know that EIP6693 types would be exported through providers namespace.

I agree on this, that these types should be directly exported from web3 package, instead of via namspace.

But regarding first point : only shared types shouldbe in web3-types package, and eip6963 types are used in web3 main package only? Same applies to other packages non-shared types like https://github.com/web3/web3.js/blob/4.x/packages/web3-eth-contract/src/types.ts

@luu-alex

I see what you are getting at, I think id still prefer it being within web3-types package as it feels intuitive for an eip type to be there, but it should be fine as long as this is documented and users are able to bring these types in properly

jdevcs

also EIP-6963 types are exported under provider namespace:

web3.js/packages/web3/src/providers.exports.ts

Line 22 in 6f9a485

export * from './web3_eip6963.js';

web3.js/packages/web3/src/index.ts

Line 353 in 6f9a485

export * as providers from './providers.exports.js';

but I think we may also export directly

danforbes · 2024-09-20T13:37:50Z

Thank you for the clarification, @jdevcs - I had gotten confused. I need to revert #7271 as well.

danforbes · 2024-10-01T14:29:47Z

Closes #6952

github-actions bot reviewed Sep 18, 2024

View reviewed changes

danforbes marked this pull request as ready for review September 18, 2024 19:21

danforbes requested review from avkos, jdevcs, luu-alex and Muhammad-Altabba as code owners September 18, 2024 19:21

github-actions bot deployed to web3-js-docs (Preview) September 18, 2024 19:23 View deployment

github-actions bot deployed to web3-js-docs (Preview) September 18, 2024 19:28 View deployment

jdevcs reviewed Sep 19, 2024

View reviewed changes

jdevcs reviewed Sep 20, 2024

View reviewed changes

danforbes closed this Sep 20, 2024

danforbes deleted the fix/eip6963/export branch September 20, 2024 13:37

danforbes mentioned this pull request Sep 20, 2024

Revert CHANGELOG Changes from #7271 #7274

Merged

danforbes restored the fix/eip6963/export branch October 1, 2024 14:29

danforbes reopened this Oct 1, 2024

danforbes linked an issue Oct 1, 2024 that may be closed by this pull request

export eip6963 types #6952

Closed

danforbes added 2 commits October 1, 2024 07:40

Export EIP-6963 Types

7f21618

CHANGELOG

6a88b18

danforbes force-pushed the fix/eip6963/export branch from 93cbb36 to 6a88b18 Compare October 1, 2024 14:42

github-actions bot deployed to web3-js-docs (Preview) October 1, 2024 14:50 View deployment

danforbes requested a review from jdevcs October 7, 2024 15:27

Comments from Review

416db8f

github-actions bot deployed to web3-js-docs (Preview) October 8, 2024 15:38 View deployment

jdevcs approved these changes Oct 9, 2024

View reviewed changes

danforbes merged commit f701406 into 4.x Oct 9, 2024
53 of 54 checks passed

danforbes deleted the fix/eip6963/export branch October 9, 2024 13:24

luu-alex mentioned this pull request Oct 16, 2024

v4.14.0 #7333

Merged

17 tasks

danforbes mentioned this pull request Oct 22, 2024

Update Intermediate dApp Guide #7349

Merged

swirlds-automation mentioned this pull request Nov 12, 2024

build(dep): [Snyk] Upgrade web3 from 4.13.0 to 4.14.0 hashgraph/hedera-json-rpc-relay#3248

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Export EIP-6963 Types #7270

Export EIP-6963 Types #7270

danforbes commented Sep 18, 2024

github-actions bot commented Sep 18, 2024 •

edited

Loading

github-actions bot left a comment •

edited

Loading

codecov bot commented Sep 18, 2024 •

edited

Loading

jdevcs Sep 19, 2024

danforbes Sep 19, 2024

jdevcs Sep 20, 2024

luu-alex Sep 25, 2024

jdevcs Oct 8, 2024

luu-alex Oct 8, 2024 •

edited

Loading

jdevcs left a comment •

edited

Loading

danforbes commented Sep 20, 2024

danforbes commented Oct 1, 2024

Export EIP-6963 Types #7270

Export EIP-6963 Types #7270

Conversation

danforbes commented Sep 18, 2024

github-actions bot commented Sep 18, 2024 • edited Loading

Bundle Stats

github-actions bot left a comment • edited Loading

Choose a reason for hiding this comment

Benchmark

codecov bot commented Sep 18, 2024 • edited Loading

Codecov Report

jdevcs Sep 19, 2024

Choose a reason for hiding this comment

danforbes Sep 19, 2024

Choose a reason for hiding this comment

jdevcs Sep 20, 2024

Choose a reason for hiding this comment

luu-alex Sep 25, 2024

Choose a reason for hiding this comment

jdevcs Oct 8, 2024

Choose a reason for hiding this comment

luu-alex Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

jdevcs left a comment • edited Loading

Choose a reason for hiding this comment

danforbes commented Sep 20, 2024

danforbes commented Oct 1, 2024

github-actions bot commented Sep 18, 2024 •

edited

Loading

github-actions bot left a comment •

edited

Loading

codecov bot commented Sep 18, 2024 •

edited

Loading

luu-alex Oct 8, 2024 •

edited

Loading

jdevcs left a comment •

edited

Loading