refactor(experimental): create a sham for `PublicKey` #1861

steveluscher · 2023-11-17T19:44:32Z

Preamble

Imagine that you depend on a module that itself depends on the legacy @solana/web3.js. This makes it difficult for you to remove the legacy library from your project.

The chances are, though, that module only needs a fraction of what web3.js provides.

The goal of the sham – of which this PR is the first – is to provide drop-in replacements for just the things that a set list of known dependencies require. You should be able to hot-swap the sham in via npm overrides or yarn resolutions and thereby drop the legacy web3.js from your bundle.

Summary

This PR introduces an interface compatible(-ish) PublicKey that you can use as a drop-in replacement for the one in @solana/web3.js@1

Test Plan

cd packages/library-legacy-sham/
pnpm test:unit:browser
pnpm test:unit:node

See later diffs for a functional test plan where we actually drop the sham in to an actual application and see the results.

Addresses #1825.

steveluscher · 2023-11-17T19:44:42Z

Current dependencies on/for this PR:

master
- PR refactor(experimental): create a sham for PublicKey #1861 👈
  - PR refactor(experimental): add constants to web3.js sham #1862
    - PR refactor(experimental): create a sham for Keypair #1863
      - PR refactor(experimental): export every type from the sham #1864

This stack of pull requests is managed by Graphite.

lorisleiva

Love it! ❤️

lorisleiva · 2023-11-18T08:20:14Z

packages/library-legacy-sham/README.md

+
+This package is a drop-in replacement for a _subset_ of the version `1.x` `@solana/web3.js` interfaces. Its goal is to satisfy the legacy interfaces with as little code as possible.
+
+If you depend on on web3.js _directly_ then you should not use this. Instead, migrate to version `>=2` of `@solana/web3.js`.


Suggested change

If you depend on on web3.js _directly_ then you should not use this. Instead, migrate to version `>=2` of `@solana/web3.js`.

If you depend on web3.js _directly_ then you should not use this. Instead, migrate to version `>=2` of `@solana/web3.js`.

lorisleiva · 2023-11-18T08:23:47Z

packages/library-legacy-sham/src/__tests__/public-key-test.ts

+        'findProgramAddress',
+        'findProgramAddressSync',


I expect people are likely gonna complain about these not being shamed.

🙅🏼 shame!

People won't use the sham. Libraries will use the sham (eg. @metaplex/mpl-token-metadata). So long as we support everything the libraries need, we're done.

lorisleiva · 2023-11-18T08:24:30Z

packages/library-legacy-sham/src/__tests__/public-key-test.ts

+            it('returns `true` given two public keys with the same address', () => {
+                expect(publicKey.equals(publicKey)).toBe(true);
+            });
+            it('returns `false` given two public keys with the same address', () => {


Suggested change

it('returns `false` given two public keys with the same address', () => {

it('returns `false` given two public keys with different addresses', () => {

lorisleiva · 2023-11-18T08:26:48Z

packages/library-legacy-sham/src/__tests__/public-key-test.ts

+        });
+        describe('the `toJSON()` method', () => {
+            it('returns the `Address` related to the public key as a string', () => {
+                expect(publicKey.toJSON()).toBe(VALID_ADDRESS);


I may be wrong here but shouldn't toJson() return a JSON string instead of just a string? I.e. "I'm valid JSON" instead of I'm not.

Suggested change

expect(publicKey.toJSON()).toBe(VALID_ADDRESS);

expect(publicKey.toJSON()).toBe(`"${VALID_ADDRESS}"`);

This confused me too in something else where I was using JSON.stringify(..) but it seems like JavaScript ignores the quotes.

Oh I see, toJSON doesn't return you a JSON string? Just the JSON-compatible JavaScript object?

The more I think about it the less sure I am, but I'm imagining it's a JSON string until you pass it into a JavaScript function, then they are clipped? 😅

I'm just matching the behaviour of the existing library without trying to use my brain. I might hurt myself otherwise.

mcintyre94

This looks like a neat approach! Are there any particular libraries you're using to figure out what is/isn't required in the sham?

buffalojoec

Are we really naming it legacy-sham? 🤭

Also PSA to all README'ers: Don't use instanceof or you're toast.

buffalojoec · 2023-11-20T14:05:14Z

packages/library-legacy-sham/src/__tests__/public-key-test.ts

+        describe('the `toBuffer()` method', () => {
+            if (__NODEJS__) {
+                it('returns a buffer representing the public key bytes', () => {
+                    expect(publicKey.toBuffer()).toEqual(Buffer.from(VALID_ADDRESS_BYTES));


steveluscher · 2023-11-20T21:52:45Z

Merge activity

Nov 20, 1:52 PM: @steveluscher started a stack merge that includes this pull request via Graphite.
Nov 20, 1:52 PM: @steveluscher merged this pull request with Graphite.

steveluscher · 2023-11-21T06:26:42Z

Are there any particular libraries you're using to figure out what is/isn't required in the sham?

Yeah; starting with @solana/wallet-adapter and then I'll move on to @orca-so/*-sdk then to @coral-xyz/anchor then @metaplex-foundation/mpl-token-metadata then then then until some apps actually start working.

github-actions · 2023-12-05T08:01:55Z

Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up.

steveluscher mentioned this pull request Nov 17, 2023

refactor(experimental): delete Buffer in non-Node tests #1860

Closed

This was referenced Nov 17, 2023

refactor(experimental): add constants to web3.js sham #1862

Merged

refactor(experimental): create a sham for Keypair #1863

Merged

refactor(experimental): export every type from the sham #1864

Merged

steveluscher force-pushed the 11-15-refactor_experimental_delete_Buffer_in_non-Node_tests branch from aa45e91 to e3abdd2 Compare November 17, 2023 19:45

steveluscher force-pushed the 11-15-refactor_experimental_create_a_sham_for_PublicKey_ branch from 8036a03 to f9982dd Compare November 17, 2023 19:45

lorisleiva approved these changes Nov 18, 2023

View reviewed changes

mcintyre94 approved these changes Nov 20, 2023

View reviewed changes

buffalojoec approved these changes Nov 20, 2023

View reviewed changes

refactor(experimental): create a sham for PublicKey

516772f

steveluscher changed the base branch from 11-15-refactor_experimental_delete_Buffer_in_non-Node_tests to master November 20, 2023 21:46

steveluscher force-pushed the 11-15-refactor_experimental_create_a_sham_for_PublicKey_ branch from f9982dd to 516772f Compare November 20, 2023 21:46

steveluscher merged commit 0983bae into master Nov 20, 2023
7 checks passed

steveluscher deleted the 11-15-refactor_experimental_create_a_sham_for_PublicKey_ branch November 20, 2023 21:52

github-actions bot locked as resolved and limited conversation to collaborators Dec 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(experimental): create a sham for `PublicKey` #1861

refactor(experimental): create a sham for `PublicKey` #1861

steveluscher commented Nov 17, 2023 •

edited

Loading

steveluscher commented Nov 17, 2023 •

edited

Loading

lorisleiva left a comment

lorisleiva Nov 18, 2023

lorisleiva Nov 18, 2023

buffalojoec Nov 20, 2023

steveluscher Nov 20, 2023

lorisleiva Nov 18, 2023

lorisleiva Nov 18, 2023

buffalojoec Nov 20, 2023

lorisleiva Nov 20, 2023

buffalojoec Nov 20, 2023 •

edited

Loading

steveluscher Nov 20, 2023

mcintyre94 left a comment

buffalojoec left a comment

buffalojoec Nov 20, 2023

steveluscher commented Nov 20, 2023 •

edited

Loading

steveluscher commented Nov 21, 2023

github-actions bot commented Dec 5, 2023


		This package is a drop-in replacement for a _subset_ of the version `1.x` `@solana/web3.js` interfaces. Its goal is to satisfy the legacy interfaces with as little code as possible.

		If you depend on on web3.js _directly_ then you should not use this. Instead, migrate to version `>=2` of `@solana/web3.js`.

	If you depend on on web3.js _directly_ then you should not use this. Instead, migrate to version `>=2` of `@solana/web3.js`.
	If you depend on web3.js _directly_ then you should not use this. Instead, migrate to version `>=2` of `@solana/web3.js`.

	it('returns `false` given two public keys with the same address', () => {
	it('returns `false` given two public keys with different addresses', () => {

	expect(publicKey.toJSON()).toBe(VALID_ADDRESS);
	expect(publicKey.toJSON()).toBe(`"${VALID_ADDRESS}"`);

refactor(experimental): create a sham for PublicKey #1861

refactor(experimental): create a sham for PublicKey #1861

Conversation

steveluscher commented Nov 17, 2023 • edited Loading

Preamble

Summary

Test Plan

steveluscher commented Nov 17, 2023 • edited Loading

lorisleiva left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

buffalojoec Nov 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcintyre94 left a comment

Choose a reason for hiding this comment

buffalojoec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steveluscher commented Nov 20, 2023 • edited Loading

Merge activity

steveluscher commented Nov 21, 2023

github-actions bot commented Dec 5, 2023

refactor(experimental): create a sham for `PublicKey` #1861

refactor(experimental): create a sham for `PublicKey` #1861

steveluscher commented Nov 17, 2023 •

edited

Loading

steveluscher commented Nov 17, 2023 •

edited

Loading

buffalojoec Nov 20, 2023 •

edited

Loading

steveluscher commented Nov 20, 2023 •

edited

Loading