Add signers example

[lorisleiva]

This PR adds an example to the examples folder that show-cases how to create and use various signers. It offers 4 different signer options:

1. Signing using a generated key pair.
2. Signing using a key pair loaded from a local JSON file.
3. Signing using a key pair derived from a seed. (Note that this currently requires a helper method getPublicKeyFromPrivateKey that should soon be available in @solana/keys).
4. Signing using a no-op signer.

Each of these options go through the same 3 signing methods that:

• Sign a message using the signer.
• Sign a transaction using the signer.
• Sign a transaction by automatically extracting the signers in the transaction message.

Here is an example of the logs we see when running pnpm start on that example.

INFO (Signers): [option 1] Using a generated key pair signer
    address: "EkYtTyNcw9USEjKcQX23puoUUgiEbbiqi32uiSjyTZgs"
INFO (Signers): >>  Signing the message "Hello, World!"
    signature: "5hbhCAsFvV1HcQQ3YVDzQJeAbNDJpjwKo1YxR8TvpXTJCA2vAmeGeyVXRCqtyCGuV4vHKpXzoTgn5QxpJ5HjMyq7"
INFO (Signers): >>  Signing a transfer SOL transaction
    signature: "ztaVZHbN39DGh52XjXa6xrVL1ect53Qa9pmHsvUbNWEX96oApqMzEJFAxNSGoi2fEg1sY3iAFs8S45xXqddpsuV"
INFO (Signers): >>  Signing a transfer SOL transaction using its registered signers
    signature: "ztaVZHbN39DGh52XjXa6xrVL1ect53Qa9pmHsvUbNWEX96oApqMzEJFAxNSGoi2fEg1sY3iAFs8S45xXqddpsuV"

INFO (Signers): [option 2] Using a key pair signer from a JSON file
    address: "BoK4mWeYVU6LdgNfo8QF7zxmTRiHw7VKMhodToZgrRup"
INFO (Signers): >>  Signing the message "Hello, World!"
    signature: "5tZ5zqXGcjrt6QHpUbNsdff59CTyQqfY8UYRpB5baxJXvokmwKEau1UknvURjmMTyZvhbYfaXC6A9iuWzU6rsCdS"
INFO (Signers): >>  Signing a transfer SOL transaction
    signature: "Jnnos7xeUJnv2BSVqjYb4Vs6AviHdMcFRCbYYRVrsXGsHnZTBBoh3b7BV1APTniWeP2mNG2DvXW4U4G8L8K8Dso"
INFO (Signers): >>  Signing a transfer SOL transaction using its registered signers
    signature: "Jnnos7xeUJnv2BSVqjYb4Vs6AviHdMcFRCbYYRVrsXGsHnZTBBoh3b7BV1APTniWeP2mNG2DvXW4U4G8L8K8Dso"

INFO (Signers): [option 3] Using a key pair signer from a seed
    address: "A4fhR7TUeaj8qNS7PnBHdU4BnyZzuegK27AvHbSx5bhB"
INFO (Signers): >>  Signing the message "Hello, World!"
    signature: "wL5M1pSx1eyzKhqzSwP4jyTwTQNihFsAGEx52C9PeqNrQpjEQNoyvYkFcPLZWCSJi4bbwgNHR14awse5GrWn9Cu"
INFO (Signers): >>  Signing a transfer SOL transaction
    signature: "3EYnSrL7136Rca3YGbSYfHP3w52AZEv8nMBLofhu25r6XNfmduMWhj3vLemZkRNSu9QAzbAV5tCZXWAidZ4oPfis"
INFO (Signers): >>  Signing a transfer SOL transaction using its registered signers
    signature: "3EYnSrL7136Rca3YGbSYfHP3w52AZEv8nMBLofhu25r6XNfmduMWhj3vLemZkRNSu9QAzbAV5tCZXWAidZ4oPfis"

INFO (Signers): [option 4] Using a no-op signer
    address: "HpgzmkFMyHxKAZ8ym6prLdxQ8H3GmQaSBcyimW31dQoe"
INFO (Signers): >>  Signing the message "Hello, World!"
    signature: null
INFO (Signers): >>  Signing a transfer SOL transaction
    signature: null
INFO (Signers): >>  Signing a transfer SOL transaction using its registered signers
    signature: null

[changeset-bot]

⚠️ No Changeset found

Latest commit: df4c052

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[lorisleiva]

• Add signers example #3048 👈
• Add createKeyPairSignerFromPrivateKeyBytes helper #3051
• Add createKeyPairFromPrivateKeyBytes helper #3050
• Add getPublicKeyFromPrivateKey helper #3049
• Add support for importing JWK keys in crypto polyfill #3064
• Add support for exporting keys as JWK in crypto polyfill #3063
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @lorisleiva and the rest of your teammates on Graphite

[steveluscher]

Would this example land harder if the imported signers had the same public key address? I feel like the string -> seed -> keypair example might be confusing to some (most people probably just think ‘my private key exists, it has a seed, and it's these exact 256 bits’) and is sort of orthogonal to just trying to demonstrate the signers API.

[steveluscher]

I opted not to do this in the examples, since they just run in Node where Ed25519 is always supported.

[lorisleiva]

I'm not too sure why but I'm getting No key generation implementation could be found if I don't import the polyfill. Weird as I'm using node v18.19.0. Any idea how that could be?

[steveluscher]

That doesn't seem right. Says it was implemented in v18.4.0. Let's investigate this.

[steveluscher]

K, so in Node 18, crypto is not injected into the global scope by default. You have to add --experimental-global-webcrypto after tsx.

You can do this (to all the examples) or not, but I think we're saying that the new web3.js supports Node LTS and up, which at this point is >20.16.0.

[steveluscher]

Either way I'd prefer not to have the polyfill in the example, lest people copy and paste it blindly.

[lorisleiva]

Thank you for looking into this. I thought we were still supporting Node 18 which is why I was using this version but I've bumped it to 20+ and everything works without the polyfill now so I've removed it. Good to know it still works with 18 with an experimental flag though.

[lorisleiva]

@steveluscher

I feel like the string -> seed -> keypair example might be confusing to some [...] and is sort of orthogonal to just trying to demonstrate the signers API.

Yeah that's a fair point. I've changed this logic to simply use the first 32 bytes of the example-keypair.json file. Which brings us to the next point.

Would this example land harder if the imported signers had the same public key address?

By making the change mentioned above, we know have option 2 and 3 which uses the same signer. I've also changed the no-op signer to use the same address so now option 2, 3 and 4 are the same signer. I believe option 1 cannot be included in this though since we're trying to showcase generated signers.

[steveluscher]

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher

🚮 Removed packages: npm/whatwg-fetch@3.6.20

View full report↗︎

[lorisleiva]

Merge activity

• Aug 7, 4:34 AM EDT: @lorisleiva started a stack merge that includes this pull request via Graphite.
• Aug 7, 4:48 AM EDT: Graphite rebased this pull request as part of a merge.
• Aug 7, 4:50 AM EDT: Graphite rebased this pull request as part of a merge.
• Aug 7, 4:50 AM EDT: @lorisleiva merged this pull request with Graphite.

[github-actions]

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.