Wallet Adapter Plugin for Browser Extension Wallet Builders
A wallet adapter plugin allows dapps to use your wallet. With the AIP-62 Wallet standard, dapps can simply update their version of aptos-wallet-adapter
to connect to newly added Wallet plugins.
Implementing a wallet plugin for a browser extension wallet has two main steps:
- Implement a wallet adapter plugin for your browser extension.
- Update the
aptos-wallet-adapter
package to let dapps know about your wallet.
1. Implement the Wallet Adapter Plugin.
Section titled “1. Implement the Wallet Adapter Plugin.”You can use the wallet-standard
repo’s example to implement an AIP-62 compatible wallet adapter plugin that dapps can automatically recognize.
-
Copy the into your browser extension codebase.
-
Follow the instructions in that example to make it use your wallet to execute the AIP-62 functions.
-
Add a call to registerWallet with your plugin implementation so that it gets called on page load.
This is what will notify dapps that your wallet is available.
// Put this function with your "MyWallet" implementation so it gets called on page load.(function () {if (typeof window === "undefined") return;const myWallet = new MyWallet();registerWallet(myWallet);})(); -
Test your changes by going to the and trying to connect your wallet.
- After your extension calls
registerWallet
, you should be able to click “Connect a Wallet” and see your wallet as an option.- You can then use the demo dapp features to verify your other wallet features work as expected.
- This simulates how a real dapp will interact with your browser extension.
- You can also test your implementations by updating
standardWallet.ts
fromMyWallet
to your wallet’s implementation, then running the Wallet Adapter Demo dapp locally.
- After your extension calls
-
Publish the new version of your browser extension.
2. Update wallet-adapter-core
to know about your extension.
Section titled “2. Update wallet-adapter-core to know about your extension.”In order for dapp users who are not already using your wallet to get the option to create an account with your wallet, you need to update wallet-adapter-core
with your browser extension’s download link.
-
Fork the monorepo. ()
-
Open your fork in a local editor such as VSCode.
-
Create a new branch for your changes.
Terminal window git checkout -b your-wallet -
Navigate to .
-
Add your wallet’s details to by following the AptosStandardSupportedWallet interface.
export interface AptosStandardSupportedWallet<Name extends string = string> {// The name of your wallet cast to WalletName (Ex. "Petra" as WalletName<"Petra">)name: WalletName<Name>;// The link to your chrome extension or main website where new users can create an account with your wallet.url: string;// An icon for your wallet. Can be one of 4 data types. Be sure to follow the below format exactly (including the "," after base64).icon: `data:image/${"svg+xml" | "webp" | "png" | "gif"};base64,${string}`;// Copy this exactlyreadyState: WalletReadyState.NotDetected;// Copy this exactlyisAIP62Standard: true;}For example:
{name: "Petra" as WalletName<"Petra">,url: "https://chromewebstore.google.com/detail/petra-aptos-wallet/ejjladinnckdgjemekebdpeokbikhfci?hl=en",icon: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAWbSURBVHgB7Z09c9NYFIaPlFSpUqQNK6rQhbSkWJghLZP9BesxfwAqytg1xe7+AY+3go5ACzObBkpwSqrVQkuRCiqkva8UZW1je22wpHPveZ8ZRU6wwwznueee+6FLJCuSdzrb7nZTNjaOJc9/ctdNiaJESPPkeeq+phLH5/L162k0HJ7JikTLvtEFPnFBf+D+0l/dt9tCNJK6xnjmZOg7GdJlPvC/AhQtPo5P3MsHQvwhiobLiLBQABf82y74z4Qt3ldSybKHToLTeW+I5/1B3u2euOD/JQy+zyRowEUs5zAzA1x+oCckJHrRYNCf/uE3AjD4QfONBBMC5PfvY2j3TEi4ZNmd8eHilQDFMK/s8xMhIXPhJLjuJLjAN/8VgRsbPWHwLbAtm5tXRWGRAS5b/99C7FBmgbTMAGXrJ5aIomJir8wA3S5afyLEEkUtEBezfQy+RYpFvdilgmMhNnGxRw2wL8QqScy1fMNE0T4yQCLEKkksxDQUwDj2BNjbK69pdndn/zxwNsUCCOyNGyJ374psbYkMBiLv30++59o1kW5X5NMnkdFI5OXL8nXghCsAAn10NL/Fz2NnpxQFFyR5/bq8BypDWAIg6AcHIoeH60nn4/K8e1deECIgwhAAQULQEXxIUAf43bju3ZvMDJ7jrwDT/XpToIvABeECqBf8EuB7+/W6CKBe0C/Auvv1uvC0XtArQBP9el14VC/oEqCtfr0uPKgX2hdAW79eF0rrhfYFQPCRKi1RyY4ZyZYF4GKQcSiAcSiAcSiAcSiAcSiAcSiAcSiAcSiAcSiAcSiAcSiAcSiAcShAm3z+LG1DAdqEAhjn40dpGwrQFtgIwgxgGAWtH1CAtsC2cQVQgLZQsk2cArSBoqeHKEAbKHpiiAI0DVq+kv4fUICmQetXMPyroABNgtb/5o1oggI0icJzBChAUyDwr16JNihAUzx+LBqhAE3w5InaU0MoQN08f64y9VdQgDrBkO/FC9EMBagLBB/P/yvHxlGxTYPh3tOn4gMUYN2g4FPc509DAdYFqvxZh1ArhwKsg6rSVzTHvywU4EeoqnyPTxKnAKuCVo4iD4s6ARwhTwGWoTrk8e3bIE4IH4cCVCDI1U6dL1/K73Eh4B727ctCASoQ6MBa9zJwJtA4FMA4FMA4FMA4FMA4FMA4FMA4FMA47Qtg4P/n1Uz7AgQ8zeoD7Qug5KQMq+joApgFWkNHEWhwEUYLFMA4OgRQdGCCNXQIUG28II2jZyKIWaAV9Aig7OgUK+gRAMH36ImaUNC1FoDt1swCjaJLAAQfT9mQxtC3GohugCOCxtC5HIyHLNkVNIJOATAv4Mnz9b6jd0MIhoWsB2pH944gPHmLkQGpDf1bwtAVUILa8GNPICRgd1AL/mwKRXfA0cHa8WtXMArDfp8bSdeIf9vCEfxHj8psQBF+GH/PB0A2wIzhrVsih4ciOztCVsfvAyKQAVAbYPr44EDk6Ehkd1fI8oRxQggKQ2QEXMgEe3ulELhvbQmZT3hHxFRn+1Tn/UAAZAWIUXUTHz4IKQn/jCBkB6Pn/ywDHw41DgUwDgRIhVgljSWKzoXYJM+dAFmWCrHKeewsOBViExd71AAjd10IsUYaDYdnsfty4Uz4U4g1zvClHAbm+e9CbJFlfdwKAVwWSJ0EfwixwrCIuYxPBOV5T1gLWCCtWj+4EqCoBbLsFyFhk2UPq9YPJqaCURW6W19IqPRdjCeG/dGsd+Xdbs/dToSERD8aDHrTP4zmvZsSBMXM4INo0afyTudY4vg39zIR4iNFXXfZtc9k4XJw0V9k2R1OFHkIhvVZdn1R8MHCDDDx+zqdxK0c9tz1szAjaKWc1XUTe+OV/iKWFmAcJ8NtJ8Kxe7kvkCGKEiHN45Zz3b/9yN3/uVzUGxXD+RX4F56985hsqA6SAAAAAElFTkSuQmCC",readyState: WalletReadyState.NotDetected,isAIP62Standard: true,} -
In type.ts, update the type AvailableWallets to include your wallet’s name.
export type AvailableWallets = "Nightly" | "Petra" | "T wallet" | "Your Wallet's Name"; -
Update the at the top-level of the aptos-wallet-adapter to include your wallet in the list of AIP-62 compatible wallets.
-
Commit and push your changes to your fork.
-
Follow to open a pull request for the repo.
Resources
Section titled “Resources”- Wallet Adapter Demo App
- Live site
- Source code
- See
standardWallet.ts
for an example implementation of an AIP-62 compatible wallet-adapter plugin.
wallet-standard
source code.wallet-adapter-core
source code.- AIP-62 standard.