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.

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

Jump to bottom

fix: make web3.js tree shakable by optimizing compilers #25014

Closed
wants to merge 30 commits into from
Closed

fix: make web3.js tree shakable by optimizing compilers #25014

wants to merge 30 commits into from

Conversation

steveluscher
Copy link
Contributor

Problem

There are two main obstacles that an optimizing compiler faces when trying to tree-shake our JavaScript SDK.

  1. We perform a lot of work in our module factories – baking layouts before they're used – and an optimizing compiler can't know for sure that work is side-effect free. The target amount of work to do in module factories is zero.
  2. For all the work we do in module factories that a compiler sees as potentially side-effectful, the libraries that we pull in through npm do even more.

Summary of Changes

Will write an essay here when this PR is ready.

Test Plan

yarn build
npx agadoo lib/index.browser.esm.js

Fixes solana-labs/solana-web3.js#1122.

steveluscher added 30 commits May 3, 2022 11:34
@steveluscher
chore: add patch-package so that we can start modifying our dependencies
f906bbf
@steveluscher
fix: patch the buffer package, marking it as side-effect free
37e4d5e
@steveluscher
fix: patch the borsh package, marking it as side-effect free
5eb249c
@steveluscher
fix: patch the tweetnacl package, marking it as side-effect free
4842f3b
@steveluscher
fix: patch the bn.js package, marking it as side-effect free
d23c17d
@steveluscher
fix: patch the bs58 package, marking it as side-effect free
4b0413d
@steveluscher
fix: patch the @solana/buffer-layout package, marking it as side-effe…
f3a5b64 
…ct free
@steveluscher
fix: lazily initialize static members
db14289
@steveluscher
fix: lazily register the PublicKey schema
a899aff
@steveluscher
fix: lazily initialize constants for use in is_on_curve method
5e5056d
@steveluscher
fix: replace @ethersproject/sha2 with smaller, tree-shakeable asmcryp…
8c01892 
…to.js
@steveluscher
fix: mark creation of SOLANA_SCHEMA Map as side-effect-free
ca41cc1
@steveluscher
fix: mark creation of FeeCalculatorLayout as side-effect-free
9e946c3
@steveluscher
fix: mark creation of NonceAccountLayout as side-effect-free
167a3a9
@steveluscher
fix: mark eagerly instantiated public keys as side-effect free
4feb8e8
@steveluscher
fix: mark creation of VoteAccountLayout as side-effect free
5d44047
@steveluscher
fix: mark creation of SYSTEM_INSTRUCTION_LAYOUTS as side-effect free
64bfc0d
@steveluscher
fix: patch the jayson package, marking it as side-effect free
29c48d2
@steveluscher
fix: patch the rpc-websockets package, marking it as side-effect free
6681b04
@steveluscher
fix: don't use a fetch ponyfill in browser environments
ab0314a
@steveluscher
fix: mark creation of DEFAULT_SIGNATURE as side-effect free
b1b358c
@steveluscher
fix: lazily create the validator info struct to eliminate side-effect…
5c46c7b 
…s in `validator-info`
@steveluscher
fix: mark creation of SECP256K1_INSTRUCTION_LAYOUT as side-effect free
af5edc8
@steveluscher
fix: mark creation of COMPUTE_BUDGET_INSTRUCTION_LAYOUTS as side-ef…
ee3832b 
…fect free
@steveluscher
fix: lazily create RPC result schemas so as to make connection.ts s…
5f3f934 
…ide-effect free
@steveluscher
fix: patch the js-sha3 package, marking it as side-effect free
0242dfb
@steveluscher
fix: mark creation of vote-program statics as side-effect free
304db06
@steveluscher
fix: mark creation of stake-program statics as side-effect free
346dd0c
@steveluscher
fix: mark creation of loader statics as side-effect free
caf86b2
@steveluscher
fix: mark creation of ED25519_INSTRUCTION_LAYOUT as side-effect free
8bd397e
@steveluscher steveluscher added the javascript Pull requests that update Javascript code label May 5, 2022
@steveluscher steveluscher mentioned this pull request May 6, 2022
Closed
@steveluscher steveluscher mentioned this pull request May 24, 2022
Closed
@wentokay wentokay mentioned this pull request May 24, 2022
Open
@steveluscher steveluscher mentioned this pull request May 31, 2022
Closed
@stale
Copy link

stale bot commented Jun 12, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale [bot only] Added to stale content; results in auto-close after a week. label Jun 12, 2022
@stale
Copy link

stale bot commented Jul 10, 2022

This stale pull request has been automatically closed. Thank you for your contributions.

@stale stale bot closed this Jul 10, 2022
@steveluscher steveluscher mentioned this pull request Jul 28, 2022
Closed
@steveluscher steveluscher reopened this Aug 1, 2022
@steveluscher steveluscher mentioned this pull request Feb 1, 2023
Closed
5 tasks
@stale
Copy link

stale bot commented Aug 13, 2022

This stale pull request has been automatically closed. Thank you for your contributions.

@stale stale bot closed this Aug 13, 2022
@steveluscher
Copy link
Contributor Author

This is fine. I’m going to get this done in smaller chunks anyway.

@steveluscher steveluscher deleted the shake-my-tree branch December 7, 2022 19:17
@steveluscher steveluscher restored the shake-my-tree branch December 7, 2022 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
javascript Pull requests that update Javascript code stale [bot only] Added to stale content; results in auto-close after a week.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

web3.js: library is not tree-shakeable
1 participant
@steveluscher