Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@mysten/wallet-standard

Package Overview
Dependencies
Maintainers
4
Versions
758
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mysten/wallet-standard

A suite of standard utilities for implementing wallets based on the Wallet Standard.

  • 0.0.0-experimental-20221026202654
  • npm
  • Socket score

Version published
Weekly downloads
24K
increased by11.33%
Maintainers
4
Weekly downloads
 
Created
Source

@mysten/wallet-standard

A suite of standard utilities for implementing wallets and libraries based on the Wallet Standard.

Implementing the Wallet Standard in an extension wallet

Creating a wallet interface

You need to create a class that represents your wallet. You can use the Wallet interface from @mysten/wallet-standard to help ensure your class adheres to the standard.

import { Wallet, SUI_DEVNET_CHAIN } from "@mysten/wallet-standard";

class YourWallet implements Wallet {
  get version() {
    // Return the version of the Wallet Standard this implements (in this case, 1.0.0).
    return "1.0.0";
  }
  get name() {
    return "Wallet Name";
  }
  get icon() {
    return "some-icon-data-url";
  }

  // Return the Sui chains that your wallet supports.
  get chains() {
    return [SUI_DEVNET_CHAIN];
  }
}

Implementing features

Features are standard methods consumers can use to interact with a wallet. To be listed in the Sui wallet adapter, you must implement the following features in your wallet:

  • standard:connect - Used to initiate a connection to the wallet.
  • standard:events - Used to listen for changes that happen within the wallet, such as accounts being added or removed.
  • sui:signAndExecuteTransaction - Used to prompt the user to sign a transaction, then submit it for execution to the blockchain.

You can implement these features in your wallet class under the features property:

import {
  ConnectFeature,
  ConnectMethod,
  EventsFeature,
  EventsOnMethod,
  SuiSignAndExecuteTransactionFeature,
  SuiSignAndExecuteTransactionMethod
} from "@mysten/wallet-standard";

class YourWallet implements Wallet {
  get features(): ConnectFeature & EventsFeature & SuiSignAndExecuteTransactionFeature {
    return {
      "standard:connect": {
        version: "1.0.0",
        connect: this.#connect,
      },
      "standard:events": {
        version: "1.0.0",
        on: this.#on,
      }
      "sui:signAndExecuteTransaction": {
        version: "1.0.0",
        signAndExecuteTransaction: this.#signAndExecuteTransaction,
      },
    };
  },

  #on: EventsOnMethod = () => {
    // Your wallet's events on implementation.
  };

	#connect: ConnectMethod = () => {
		// Your wallet's connect implementation
	};

	#signAndExecuteTransaction: SuiSignAndExecuteTransactionMethod = () => {
		// Your wallet's signAndExecuteTransaction implementation
	};
}

Exposing accounts

The last requirement of the wallet interface is to expose an acccounts interface. This should expose all of the accounts that a connected dapp has access to. It can be empty prior to initiating a connection through the standard:connect feature.

The accounts can use the ReadonlyWalletAccount class to easily construct an account matching the required interface.

import { ReadonlyWalletAccount } from "@mysten/wallet-standard";

class YourWallet implements Wallet {
  get accounts() {
    // Assuming we already have some internal representation of accounts:
    return someWalletAccounts.map(
      (walletAccount) =>
        // Return
        new ReadonlyWalletAccount({
          address: walletAccount.suiAddress,
          publicKey: walletAccount.pubkey,
          // The Sui chains that your wallet supports.
          chains: [SUI_DEVNET_CHAIN],
          // The features that this account supports. This can be a subset of the wallet's supported features.
          // These features must exist on the wallet as well.
          features: ["sui:signAndExecuteTransaction", "standard:signMessage"],
        })
    );
  }
}

Registering in the window

Once you have a compatible interface for your wallet, you can register it in the window under the window.navigator.wallets interface. Wallets self-register by pushing their standard wallet interface to this array-like interface.

// This makes TypeScript aware of the `window.navigator.wallets` interface.
declare const window: import("@mysten/wallet-standard").WalletsWindow;

(window.navigator.wallets || []).push(({ register }) => {
  register(new YourWallet());
});

Note that while this interface is array-like, it is not always an array, and the only method that should be called on it is push.

FAQs

Package last updated on 26 Oct 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc