refactor(experimental): a function to compute program derived addresses #1453

steveluscher · 2023-07-28T00:53:31Z

refactor(experimental): a function to compute program derived addresses

Summary

Given a program address and a series of string or bytearray seeds, this function will compute the off-chain program derived address (PDA) corresponding to both.

Test Plan

cd packages/addresses
pnpm test:unit:browser
pnpm test:unit:node

Implements #1446.

2501babe · 2023-07-28T04:50:09Z

packages/addresses/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Solana Labs, Inc


2501babe · 2023-07-28T04:51:07Z

packages/addresses/README.md

+### `getBase58EncodedAddressFromPublicKey()`
+
+Given a public `CryptoKey`, this method will return its associated `Base58EncodedAddress`.


not sure how this will feel in practice but in theory i like the distinction between pubkeys and addresses

i wonder if the method name could be shorter tho, since it will be used a lot. getAddressFromPublicKey? or maybe have a toAddress() on the CryptoKey?

I'm into it. If we can agree that the commonly used thing (the base58 string) is what we mean when we say ‘address’ then we can rename all the methods for the common case, and reserve the more wordy function names for the more uncommon cases (getAddressBytesFromFoo() etc).

I'll still keep the TypeScript types the way they are though.

2501babe · 2023-07-28T04:56:04Z

packages/addresses/src/__tests__/curve-test.ts

not necessary for this pr but when in "finishing touches" mode this is the kind of thing i personally would have a set of tests like "generate a few thousand random base addresses and seed strings and assert the old and new libraries produce the same result"

2501babe · 2023-07-28T04:58:55Z

packages/addresses/src/__tests__/program-derived-address-test.ts

+        ]);
+        expect(pdaButterfly).toStrictEqual(pdaButterFly);
+    });
+    // https://solana.stackexchange.com/questions/7253/what-combination-of-program-address-and-seeds-would-cause-findprogramaddress-t


hahaha i love the completionism

2501babe · 2023-07-28T05:30:45Z

packages/addresses/src/vendor/noble/ed25519.ts

noting for posterity that obvi i cant review this but clearly its third party code anyway

oic you're not familiar with my stacked PR workflow and you probably reviewed every commit in here. Each PR in this stack is only ‘about’ the top commit. The other commits before the last one are just there, because GitHub.

In other words, wow thanks for reviewing the whole stack! :)

2501babe · 2023-07-28T05:33:26Z

thank you for your service, ill try using this soon

2501babe · 2023-07-28T05:36:58Z

incidentally are we going back to not having a synchronous version of this... i know its probably something like "blah blah web workers 0.0001s speedup" but its just convenient not having pda generation infect the entire codebase with async/await, because its used so much in simple utility functions very far away on the code graph from real network calls

mcintyre94

Nice!

mcintyre94 · 2023-07-28T11:10:41Z

packages/addresses/README.md

+    programAddress: 'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL' as Base58EncodedAddress,
+    seeds: [
+        // Owner
+        serialize('9fYLFVoVqwH37C3dyPi6cpeobfbQ2jtLpN5HgAYDDdkm' as Base58EncodedAddress),


Does this return the same bytes as new PublicKey('9fYLFVoVqwH37C3dyPi6cpeobfbQ2jtLpN5HgAYDDdkm').toBuffer() in the old lib?

It does!

> new PublicKey('9fYLFVoVqwH37C3dyPi6cpeobfbQ2jtLpN5HgAYDDdkm').toBuffer() <Buffer 80 bc fe 45 2a 9a 00 99 12 7e 5e de 0f 4f 69 98 01 18 0f a0 75 af c9 f5 df 28 ec 9b 28 c0 5d ba>

> Buffer.from(getBase58EncodedAddressCodec().serialize('9fYLFVoVqwH37C3dyPi6cpeobfbQ2jtLpN5HgAYDDdkm')) <Buffer 80 bc fe 45 2a 9a 00 99 12 7e 5e de 0f 4f 69 98 01 18 0f a0 75 af c9 f5 df 28 ec 9b 28 c0 5d ba>

mcintyre94 · 2023-07-28T11:14:23Z

packages/addresses/src/__tests__/program-derived-address-test.ts

+            bumpSeed: 251,
+            pda: '46v3JvPtEPeQmH3euXydEbxYD6yfxeZjWSzkkYvvM5Pp',
+        });
+    });


Just out of interest did you use some trick to generate these examples? Mainly asking because they all have bumpSeed 251

Generating a few addresses for the tests until exactly that is the case.

mcintyre94 · 2023-07-28T11:25:15Z

packages/addresses/src/program-derived-address.ts

+    programAddress: Base58EncodedAddress;
+    seeds: Seed[];
+}>;
+type Seed = string | Uint8Array;


Not suggesting we should keep the existing interface, but do you know how you'd convert from a Buffer in the old code to this?

I remember that when I used Buffer.from([posX, posY]) (posX and posY are 0-255, u8 in rust) as a seed, I couldn't switch it to a Uint8Array and get the same result in the old code

I'm not sure if the different implementation here means that new Uint8Array([posX, posY]) would be equivalent?

It definitely is.

> Buffer.from([64, 216]) <Buffer 40 d8> > new Uint8Array([64, 216]) Uint8Array(2) [ 64, 216 ] > 0x40 === 64 true > 0xd8 === 216 true

Buffer has always been a pain in the ass because it's a Node-only primitive that has required a polyfill in browser, for almost no gain: #1100

I remember that when I used Buffer.from([posX, posY]) (posX and posY are 0-255, u8 in rust) as a seed, I couldn't switch it to a Uint8Array and get the same result in the old code

Very sus! We should try to repro that and figure out why.

steveluscher · 2023-07-29T00:07:29Z

are we going back to not having a synchronous version of this...

I'm pretty sure that if I did enough digging through GitHub issues I'd find a bunch of folks who were really mad about the move to sync versions of our key manipulation functions because their apps were key-heavy and sync versions kneecapped their performance severely.
We absolutely have no choice. Native Ed25519 primitives are coming to every JavaScript engine, and every single bit of those APIs is async.

cc/ @2501babe

# Summary Given a program address and a series of string or bytearray seeds, this function will compute the off-chain program derived address (PDA) corresponding to both. # Test Plan ``` cd packages/addresses pnpm test:unit:browser pnpm test:unit:node ```

github-actions · 2023-07-31T16:24:05Z

🎉 This PR is included in version 1.78.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2023-08-15T08: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 force-pushed the pr1453 branch from c4ee8ef to d592240 Compare July 28, 2023 00:59

2501babe reviewed Jul 28, 2023

View reviewed changes

mcintyre94 approved these changes Jul 28, 2023

View reviewed changes

steveluscher force-pushed the pr1453 branch 3 times, most recently from fc9ccd0 to 6afc39b Compare July 29, 2023 00:00

steveluscher force-pushed the pr1453 branch 2 times, most recently from ec013a2 to 45abc41 Compare July 29, 2023 00:27

steveluscher force-pushed the pr1453 branch from 45abc41 to 9255181 Compare July 29, 2023 03:02

steveluscher merged commit 083193b into master Jul 29, 2023

steveluscher deleted the pr1453 branch July 29, 2023 03:02

steveluscher mentioned this pull request Jul 29, 2023

Make getting PDAs a little easier #1446

Closed

github-actions bot added the released label Jul 31, 2023

steveluscher added this to the web3.js Roadmap - July 2023 milestone Jul 31, 2023

github-actions bot locked as resolved and limited conversation to collaborators Aug 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(experimental): a function to compute program derived addresses #1453

refactor(experimental): a function to compute program derived addresses #1453

steveluscher commented Jul 28, 2023 •

edited

Loading

2501babe Jul 28, 2023

steveluscher Jul 29, 2023

2501babe Jul 28, 2023

2501babe Jul 28, 2023

steveluscher Jul 29, 2023

2501babe Jul 28, 2023

2501babe Jul 28, 2023

2501babe Jul 28, 2023

steveluscher Jul 29, 2023 •

edited

Loading

steveluscher Jul 29, 2023

2501babe commented Jul 28, 2023

2501babe commented Jul 28, 2023 •

edited

Loading

mcintyre94 left a comment

mcintyre94 Jul 28, 2023

steveluscher Jul 29, 2023

mcintyre94 Jul 28, 2023

steveluscher Jul 29, 2023

mcintyre94 Jul 28, 2023 •

edited

Loading

steveluscher Jul 29, 2023 •

edited

Loading

steveluscher Jul 29, 2023

steveluscher commented Jul 29, 2023 •

edited

Loading

github-actions bot commented Jul 31, 2023

github-actions bot commented Aug 15, 2023

		### `getBase58EncodedAddressFromPublicKey()`

		Given a public `CryptoKey`, this method will return its associated `Base58EncodedAddress`.

refactor(experimental): a function to compute program derived addresses #1453

refactor(experimental): a function to compute program derived addresses #1453

Conversation

steveluscher commented Jul 28, 2023 • edited Loading

Summary

Test Plan

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

steveluscher Jul 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

2501babe commented Jul 28, 2023

2501babe commented Jul 28, 2023 • edited Loading

mcintyre94 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

mcintyre94 Jul 28, 2023 • edited Loading

Choose a reason for hiding this comment

steveluscher Jul 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steveluscher commented Jul 29, 2023 • edited Loading

github-actions bot commented Jul 31, 2023

github-actions bot commented Aug 15, 2023

steveluscher commented Jul 28, 2023 •

edited

Loading

steveluscher Jul 29, 2023 •

edited

Loading

2501babe commented Jul 28, 2023 •

edited

Loading

mcintyre94 Jul 28, 2023 •

edited

Loading

steveluscher Jul 29, 2023 •

edited

Loading

steveluscher commented Jul 29, 2023 •

edited

Loading