| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292 |
- <!doctype html>
- <html class="default no-js">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>@solana/wallet-adapter</title>
- <meta name="description" content="Documentation for @solana/wallet-adapter">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <link rel="stylesheet" href="assets/css/main.css">
- <script async src="assets/js/search.js" id="search-script"></script>
- </head>
- <body>
- <header>
- <div class="tsd-page-toolbar">
- <div class="container">
- <div class="table-wrap">
- <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
- <div class="field">
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
- </div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
- <a href="index.html" class="title">@solana/wallet-adapter</a>
- </div>
- <div class="table-cell" id="tsd-widgets">
- <div id="tsd-filter">
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
- <div class="tsd-filter-group">
- <div class="tsd-select" id="tsd-filter-visibility">
- <span class="tsd-select-label">All</span>
- <ul class="tsd-select-list">
- <li data-value="public">Public</li>
- <li data-value="protected">Public/Protected</li>
- <li data-value="private" class="selected">All</li>
- </ul>
- </div>
- <input type="checkbox" id="tsd-filter-inherited" checked />
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
- <input type="checkbox" id="tsd-filter-externals" checked />
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
- </div>
- </div>
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
- </div>
- </div>
- </div>
- </div>
- <div class="tsd-page-title">
- <div class="container">
- <h1>@solana/wallet-adapter</h1>
- </div>
- </div>
- </header>
- <div class="container container-main">
- <div class="row">
- <div class="col-8 col-content">
- <div class="tsd-panel tsd-typography">
- <a href="#solanawallet-adapter" id="solanawallet-adapter" style="color: inherit; text-decoration: none;">
- <h1><code>@solana/wallet-adapter</code></h1>
- </a>
- <p>Modular TypeScript wallet adapters and components for Solana applications.</p>
- <!-- @TODO -->
- <a href="#quick-links" id="quick-links" style="color: inherit; text-decoration: none;">
- <h2>Quick Links</h2>
- </a>
- <ul>
- <li><a href="https://solana-labs.github.io/wallet-adapter/">Docs</a></li>
- <li><a href="https://solana-labs.github.io/wallet-adapter/example/">Example</a></li>
- </ul>
- <a href="#packages" id="packages" style="color: inherit; text-decoration: none;">
- <h2>Packages</h2>
- </a>
- <table>
- <thead>
- <tr>
- <th>package</th>
- <th>description</th>
- <th>npm</th>
- <th>version</th>
- </tr>
- </thead>
- <tbody><tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/wallets">wallets</a></td>
- <td>All wallets with icons</td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-wallets"><code>@solana/wallet-adapter-wallets</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/react">react</a></td>
- <td>React hooks and context for dApps</td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-react"><code>@solana/wallet-adapter-react</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/base">base</a></td>
- <td>Adapter interface, errors, and utilities</td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-base"><code>@solana/wallet-adapter-base</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/phantom">phantom</a></td>
- <td>Adapter for <a href="https://www.phantom.app">Phantom</a></td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-phantom"><code>@solana/wallet-adapter-phantom</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/torus">torus</a></td>
- <td>Adapter for <a href="https://tor.us">Torus</a></td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-torus"><code>@solana/wallet-adapter-torus</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/ledger">ledger</a></td>
- <td>Adapter for <a href="https://www.ledger.com">Ledger</a></td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-ledger"><code>@solana/wallet-adapter-ledger</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/solong">solong</a></td>
- <td>Adapter for <a href="https://solongwallet.com">Solong</a></td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-solong"><code>@solana/wallet-adapter-solong</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/mathwallet">mathwallet</a></td>
- <td>Adapter for <a href="https://mathwallet.org">MathWallet</a></td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-mathwallet"><code>@solana/wallet-adapter-mathwallet</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/sollet">sollet</a></td>
- <td>Adapter for <a href="https://www.sollet.io">Sollet</a></td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-sollet"><code>@solana/wallet-adapter-sollet</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/material-ui">material-ui</a></td>
- <td>Components for <a href="https://material-ui.com">Material UI</a></td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-material-ui"><code>@solana/wallet-adapter-material-ui</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/material-ui-starter">material-ui-starter</a></td>
- <td><a href="https://create-react-app.dev/">Create React App</a> project using Material UI</td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-material-ui-starter"><code>@solana/wallet-adapter-material-ui-starter</code></a></td>
- <td><code>0.1.0</code></td>
- </tr>
- <tr>
- <td><a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/example">example</a></td>
- <td>Demo of components</td>
- <td><a href="https://www.npmjs.com/package/@solana/wallet-adapter-example"><code>@solana/wallet-adapter-example</code></a></td>
- <td><code>0.4.0</code></td>
- </tr>
- </tbody></table>
- <a href="#quick-setup-using-react-with-material-ui" id="quick-setup-using-react-with-material-ui" style="color: inherit; text-decoration: none;">
- <h2>Quick Setup (using React with Material UI)</h2>
- </a>
- <p>See the <a href="https://github.com/solana-labs/wallet-adapter/tree/master/packages/material-ui-starter">material-ui-starter</a> package for a more complete example.</p>
- <a href="#install" id="install" style="color: inherit; text-decoration: none;">
- <h3>Install</h3>
- </a>
- <p>Install these peer dependencies (or skip this if you have them already):</p>
- <pre><code class="language-shell"><span style="color: #000000">yarn add @material-ui/core \</span>
- <span style="color: #000000"> @material-ui/icons \</span>
- <span style="color: #000000"> @solana/web3.js \</span>
- <span style="color: #000000"> react</span>
- </code></pre>
- <p>Install these dependencies:</p>
- <pre><code class="language-shell"><span style="color: #000000">yarn add @solana/wallet-adapter-wallets \</span>
- <span style="color: #000000"> @solana/wallet-adapter-react \</span>
- <span style="color: #000000"> @solana/wallet-adapter-material-ui \</span>
- <span style="color: #000000"> @solana/wallet-adapter-base</span>
- </code></pre>
- <a href="#code" id="code" style="color: inherit; text-decoration: none;">
- <h3>Code</h3>
- </a>
- <pre><code class="language-tsx"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">React</span><span style="color: #000000">, { </span><span style="color: #001080">FC</span><span style="color: #000000">, </span><span style="color: #001080">useMemo</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'react'</span><span style="color: #000000">;</span>
- <span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">WalletProvider</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@solana/wallet-adapter-react'</span><span style="color: #000000">;</span>
- <span style="color: #AF00DB">import</span><span style="color: #000000"> {</span>
- <span style="color: #000000"> </span><span style="color: #001080">getLedgerWallet</span><span style="color: #000000">,</span>
- <span style="color: #000000"> </span><span style="color: #001080">getMathWallet</span><span style="color: #000000">,</span>
- <span style="color: #000000"> </span><span style="color: #001080">getPhantomWallet</span><span style="color: #000000">,</span>
- <span style="color: #000000"> </span><span style="color: #001080">getSolletWallet</span><span style="color: #000000">,</span>
- <span style="color: #000000"> </span><span style="color: #001080">getSolongWallet</span><span style="color: #000000">,</span>
- <span style="color: #000000"> </span><span style="color: #001080">getTorusWallet</span><span style="color: #000000">,</span>
- <span style="color: #000000">} </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@solana/wallet-adapter-wallets'</span><span style="color: #000000">;</span>
- <span style="color: #AF00DB">import</span><span style="color: #000000"> {</span>
- <span style="color: #000000"> </span><span style="color: #001080">WalletDialogProvider</span><span style="color: #000000">,</span>
- <span style="color: #000000"> </span><span style="color: #001080">WalletDisconnectButton</span><span style="color: #000000">,</span>
- <span style="color: #000000"> </span><span style="color: #001080">WalletMultiButton</span><span style="color: #000000">,</span>
- <span style="color: #000000">} </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@solana/wallet-adapter-material-ui'</span><span style="color: #000000">;</span>
- <span style="color: #AF00DB">export</span><span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #795E26">Wallet</span><span style="color: #000000">: </span><span style="color: #267F99">FC</span><span style="color: #000000"> = () </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
- <span style="color: #000000"> </span><span style="color: #008000">// @solana/wallet-adapter-wallets imports all the adapters but supports tree shaking --</span>
- <span style="color: #000000"> </span><span style="color: #008000">// Only the wallets you want to support will be compiled into your application</span>
- <span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">wallets</span><span style="color: #000000"> = </span><span style="color: #795E26">useMemo</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> [</span>
- <span style="color: #000000"> </span><span style="color: #795E26">getPhantomWallet</span><span style="color: #000000">(),</span>
- <span style="color: #000000"> </span><span style="color: #795E26">getTorusWallet</span><span style="color: #000000">({ </span><span style="color: #001080">clientId:</span><span style="color: #000000"> </span><span style="color: #A31515">'Go to https://developer.tor.us and create a client ID'</span><span style="color: #000000"> }),</span>
- <span style="color: #000000"> </span><span style="color: #795E26">getLedgerWallet</span><span style="color: #000000">(),</span>
- <span style="color: #000000"> </span><span style="color: #795E26">getSolongWallet</span><span style="color: #000000">(),</span>
- <span style="color: #000000"> </span><span style="color: #795E26">getMathWallet</span><span style="color: #000000">(),</span>
- <span style="color: #000000"> </span><span style="color: #795E26">getSolletWallet</span><span style="color: #000000">(),</span>
- <span style="color: #000000"> ], []);</span>
- <span style="color: #000000"> </span><span style="color: #AF00DB">return</span><span style="color: #000000"> (</span>
- <span style="color: #000000"> </span><span style="color: #800000"><</span><span style="color: #267F99">WalletProvider</span><span style="color: #000000"> </span><span style="color: #FF0000">wallets</span><span style="color: #000000">=</span><span style="color: #0000FF">{</span><span style="color: #001080">wallets</span><span style="color: #0000FF">}</span><span style="color: #000000"> </span><span style="color: #FF0000">autoConnect</span><span style="color: #800000">></span>
- <span style="color: #000000"> </span><span style="color: #800000"><</span><span style="color: #267F99">WalletDialogProvider</span><span style="color: #800000">></span>
- <span style="color: #000000"> </span><span style="color: #800000"><</span><span style="color: #267F99">WalletMultiButton</span><span style="color: #800000">/></span>
- <span style="color: #000000"> </span><span style="color: #800000"><</span><span style="color: #267F99">WalletDisconnectButton</span><span style="color: #800000">/></span>
- <span style="color: #000000"> </span><span style="color: #800000"></</span><span style="color: #267F99">WalletDialogProvider</span><span style="color: #800000">></span>
- <span style="color: #000000"> </span><span style="color: #800000"></</span><span style="color: #267F99">WalletProvider</span><span style="color: #800000">></span>
- <span style="color: #000000"> );</span>
- <span style="color: #000000">};</span>
- </code></pre>
- </div>
- </div>
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
- <nav class="tsd-navigation primary">
- <ul>
- <li class=" ">
- <a href="modules.html">Modules</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_base.html">@solana/wallet-<wbr>adapter-<wbr>base</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_ledger.html">@solana/wallet-<wbr>adapter-<wbr>ledger</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_material_ui.html">@solana/wallet-<wbr>adapter-<wbr>material-<wbr>ui</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_mathwallet.html">@solana/wallet-<wbr>adapter-<wbr>mathwallet</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_phantom.html">@solana/wallet-<wbr>adapter-<wbr>phantom</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_react.html">@solana/wallet-<wbr>adapter-<wbr>react</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_sollet.html">@solana/wallet-<wbr>adapter-<wbr>sollet</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_solong.html">@solana/wallet-<wbr>adapter-<wbr>solong</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_torus.html">@solana/wallet-<wbr>adapter-<wbr>torus</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="modules/_solana_wallet_adapter_wallets.html">@solana/wallet-<wbr>adapter-<wbr>wallets</a>
- </li>
- </ul>
- </nav>
- <nav class="tsd-navigation secondary menu-sticky">
- <ul class="before-current">
- </ul>
- </nav>
- </div>
- </div>
- </div>
- <footer class="with-border-bottom">
- <div class="container">
- <h2>Legend</h2>
- <div class="tsd-legend-group">
- <ul class="tsd-legend">
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
- </ul>
- </div>
- </div>
- </footer>
- <div class="container tsd-generator">
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
- </div>
- <div class="overlay"></div>
- <script src="assets/js/main.js"></script>
- </body>
- </html>
|