Add wallet export guide #62
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -20,6 +20,7 @@ At a structural level, a Turnkey Organization is comprised of a few core resourc | |||
| - <b>Users:</b> Humans or machines with access to an Organization | |||
| - <b>Policies:</b> Rules defining which users can take which actions within an Organization | |||
| - <b>Private Keys:</b> Crypto private keys, used to derive addresses and sign transactions | |||
| - <b>Wallets:</b> A collection of crypto private keys that share a common seed | |||
There was a problem hiding this comment.
It might be confusing to define wallets as a collection of private keys. They're collection of addresses generated from a common seed, not a group of what we (Turnkey) call "Private Keys".
There was a problem hiding this comment.
FWIW, our docs use this language: Wallets are collections of cryptographic key pairs typically used for sending and receiving digital assets.
And our internal rust/wallet README has: A HD Wallet is a collection of cryptographic private/public keypairs that share a common seed.
There was a problem hiding this comment.
This definition is fine in the abstract / on its own, but I have a feeling that there might be confusion when we say this right below the definition of "private keys" 😬
I don't feel super strongly, we can merge as-is and refine later! Not a big deal at all.
There was a problem hiding this comment.
Yep I agree it's confusing. I think we do need to include it in the list of Resources, especially to avoid users looking for a "Private Keys" page. This definition is pulled from and shortened from A HD Wallet is a collection of cryptographic private/public key pairs that share a common seed. A Wallet is used to generate Accounts. in our Getting-Started > Wallets page.
Something that might make the wallet definition less confusing is to remove the private key definition right above it. I can see how it'd be confusing to users to mentally model Wallets + Private Keys + Accounts if they read the current definition as wallets = group(private_keys) and then they later see wallets = group(accounts)
| --- | ||
| # Export Wallet | ||
|
|
||
| Turnkey's export functionality allows your end users to backup or transer a [Wallet](../getting-started/Wallets.md) by securely viewing the wallet's [mnemonic phrase](https://learnmeabitcoin.com/technical/mnemonic). We engineered this feature to ensure that the user can export their mnemonic without exposing the mnemonic itsef to Turnkey or your application. |
There was a problem hiding this comment.
transfer (typo)
itself (typo)
|
|
||
| <img src="/img/wallet_export_mnemonic.png" /> | ||
|
|
||
| The exported wallet will remain stored within Turnkey’s infrastructure. In your dashboard, the exported user Wallet will be flagged as “Exported”. |
There was a problem hiding this comment.
"will" => "should"? We don't control the UI here :)
There was a problem hiding this comment.
i think Hannah meant the Turnkey dashboard. It does seem helpful to specify that e.g. "In your Turnkey dashboard, .."
| @@ -22,6 +22,7 @@ That said, we have built out several example services and applications to help i | |||
| | [`rebalancer`](https://github.com/tkhq/sdk/tree/main/examples/rebalancer/) | A demo application which showcases an example of how to use Turnkey for managing multiple types of keys & users | | |||
| | [`sweeper`](https://github.com/tkhq/sdk/tree/main/examples/sweeper/) | Sweep funds from one address to a different address | | |||
| | [`trading-runner`](https://github.com/tkhq/sdk/tree/main/examples/trading-runner/) | A sample application demonstrating a trading operation, using various private keys, users, and policies, powered by Uniswap | | |||
| | [`wallet-export`](https://github.com/tkhq/sdk/tree/main/examples/wallet-export/) | A NextJS app that demonstrates how to use `@turnkey/iframe-stamper` to export a wallet as a mnemonic | | |||
There was a problem hiding this comment.
⭐ ty! i realize this is pretty annoying to update manually, since we ultimately have to do it in two places: SDK readme (i'll include updates in this PR), and here. nice-to-have at some point would be a small script that automatically makes the two consistent
There was a problem hiding this comment.
💯 ! It's okay though, we've been adding quite a number of examples lately but it's a regular occurrence
This PR contains: