-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19 from phantom/brian/docs1
Update SDK readme
- Loading branch information
Showing
2 changed files
with
102 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,107 @@ | ||
| # @phantom/wallet-sdk | ||
| # Phantom Embedded Wallet SDK | ||
|
|
||
| ### Integrating the Embedded Wallet: Getting Started | ||
| Phantom Embedded enables you to seamlessly onboard users to your application, without requiring them to have previously installed a wallet. With Phantom Embedded, users can create a self custodial wallet with just their Google account and a 4-digit pin. Once created, this wallet will automatically sync with [Phantom](https://phantom.app)'s mobile and extension apps without the user needing to know their seed phrase or manage any private keys. | ||
|
|
||
| 1. Install the Phantom SDK (https://github.com/phantom/wallet-sdk) | ||
| In addition to powering wallet creation, Phantom Embedded also comes with a built-in UI for users to view and manage their holdings. This UI serves as a trusted interface for users to sign messages and transactions on your app. | ||
|
|
||
| ## Features | ||
|
|
||
| - Create self custodial wallets without leaving your application | ||
| - Onboard users via Sign in with Google and a 4-digit pin (no seed phrases) | ||
| - Sync embedded wallets with Phantom's mobile and extension apps | ||
| - Sign transactions and message on Solana (more chains coming soon) | ||
| - View, send, and receive tokens on Solana, Ethereum, Bitcoin, Base, and Polygon | ||
| - Pricing: **FREE** | ||
|
|
||
| ## Quickstart | ||
|
|
||
| 1. Install the Phantom Embedded SDK | ||
|
|
||
| ```bash | ||
| yarn | npm | pnpm add @phantom/wallet-sdk | ||
| ``` | ||
|
|
||
| 1. Load the embedded wallet and the launcher | ||
| 2. Load the Phantom Embedded wallet in your web application | ||
|
|
||
| ```tsx | ||
| import { createPhantom } from "@phantom/wallet-sdk" | ||
|
|
||
| const opts: CreatePhantomConfig = { | ||
| zIndex: 10_000, | ||
| hideLauncherBeforeOnboarded: true, | ||
| zIndex: 10_000, | ||
| hideLauncherBeforeOnboarded: true, | ||
| } | ||
|
|
||
| const App = () => { | ||
| useEffect(() => { | ||
| createPhantom(opts); | ||
| createPhantom(opts); | ||
| }, []); | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| ### Options | ||
| 3. [Integrate Phantom](https://docs.phantom.app/solana/integrating-phantom) as you would normally. Whenever a user interacts with Phantom (e.g. `window.phantom.solana.connect()`), the Phantom Embedded wallet will automatically initialize if the user does not have Phantom already installed. | ||
|
|
||
| ## Configuration | ||
|
|
||
| The following optional parameters can be passed as `createPhantom({options...})` to customize the Phantom Embedded wallet experience. | ||
|
|
||
| | Parameter | Type | Description | | ||
| | ----------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------- | | ||
| | `hideLauncherBeforeOnboarded` | boolean | If `true`, the Phantom Embedded UI will be hidden until the user engages with Phantom. Defaults to `false`. | | ||
| | `colorScheme` | string | The background color of the Phantom Embedded iframe, which should be configured to match your site's theme. Can be `"light"`, `"dark"`, or `"normal"`. Defaults to `"normal"`. | | ||
| | `zIndex` | number | The z-index of the Phantom Embedded UI. Defaults to `10_000`. | | ||
| | `paddingBottom` | number | The number of pixels between the Phantom Embedded UI and the right edge of the web. Defaults to `0`. | | ||
| | `paddingRight` | number | The number of pixels between the Phantom Embedded UI and the bottom edge of the web. Defaults to `0`. | | ||
|
|
||
| ## See It In Action | ||
|
|
||
| Try out Phantom Embedded via our demo app: https://sandbox.phantom.dev/sol-embedded-sandbox | ||
|
|
||
| > Note: Phantom Embedded will not initialize if it detects that the user already has the Phantom extension installed, or if the user is accessing the page from within the Phantom mobile app. | ||
| ## Give Feedback | ||
|
|
||
| Phantom Embedded is in active development and will be prioritizing features requested by early adopters. If you are interested in working with us, please email us at `[email protected]` or message `@brianfriel` on Telegram. | ||
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| <details> | ||
| <summary>How does the embedded wallet work with the Phantom extension?</summary> | ||
|
|
||
| If the Phantom extension is detected, we will not inject the embedded wallet. Phantom users can continue using their extension like normal. | ||
|
|
||
| </details> | ||
| <details> | ||
| <summary>What does `createPhantom()` do?</summary> | ||
|
|
||
| The Phantom embedded wallet lives inside an iframe. The `createPhantom` function loads and attaches the iframe to your website. | ||
|
|
||
| </details> | ||
| <details> | ||
| <summary>How do I interact with the embedded wallet?</summary> | ||
|
|
||
| Once `createPhantom` has been called, `window.phantom.solana` and a compliant wallet-standard provider will also be available in the global scope of your website. This means that most of your existing code for interacting with Solana wallets should work out of the box. | ||
|
|
||
| Once a user has onboarded to the embedded wallet, they should be able to click your “connect wallet” button, which gives your website access to their Solana address. After that, signing messages and transactions should just work as normal. | ||
|
|
||
| </details> | ||
| <details> | ||
| <summary>I can't see the embedded wallet on my website. What's wrong?</summary> | ||
|
|
||
| The most common cause is that you are using a browser with the Phantom extension installed. If the Phantom extension is detected, we will not inject the embedded wallet. | ||
|
|
||
| You can temporarily disable the Phantom extension by going to `chrome://extensions` and toggling Phantom off. | ||
|
|
||
| </details> | ||
| <details> | ||
| <summary>How much does this cost?</summary> | ||
|
|
||
| It's free! | ||
|
|
||
| </details> | ||
|
|
||
| ## Disclaimers | ||
|
|
||
| We are providing early access to beta software for testing purposes only. Embedded wallet should be used in a non-production environment only. Phantom will not be liable for any losses or damages suffered by you or your end users if you push the early access version of embedded wallets to a production environment. | ||
|
|
||
| - hideLauncherBeforeOnboarded: Set to true to avoid showing the launcher button until a user has onboarded to the Phantom Wallet. | ||
| - zIndex: Pass a custom zIndex to the Phantom Wallet iframe | ||
| - colorScheme: If the Phantom Wallet iframe has an opaque background on your site. You should set this color scheme to match the color scheme of your site. | ||
| All suggestions, enhancement requests, recommendations or other feedback provided by you relating to the embedded wallet will be the sole and exclusive property of Phantom and by using the early access version of embedded wallets and providing feedback to Phantom you agree to assign any rights in that feedback to Phantom. |