Skip to content

Latest commit

 

History

History
194 lines (148 loc) · 5.82 KB

README.md

File metadata and controls

194 lines (148 loc) · 5.82 KB
Raw

Suiet Wallet Adapter

⚠️ Deprecation Announcement: This package will not be maintained, please switch to our wallet-kit instead. Because Sui team has come up with a wallet-standard which introduces a standard way to integrate with wallets on Sui.

👋 If you want to know how to install/use suiet, please visit our offical website suiet.app or docs

Integrate your DApp with Suiet Wallet from now on 🥳

We've presented an adapter that implemented the interface of SUI Wallet Adapter for you✨ With this adapter, your DApp can easily connect with the Suiet Wallet Extension, which enables DApp to retrieve basic info of user's wallet and launch manipulation requests such as transaction signing.

1️⃣ First-choice integration guide

Try our @suiet/wallet-kit for easy integration with this adapter🥳

@suiet/wallet-kit is an all-in-one wallet connection kit with nice UI components for dapps , which connects your dapp with wallets on SUI and empowers your dapp with awesome wallet abilities🪄

2️⃣ Manual integration guide

For React DApps, the Sui team has provided React context provider and React hook in the npm package @mysten/wallet-adapter-react . Therefore we can simply register the Suiet Adapter into the official provider and then make use of them.

⚠️ Usage with React ONLY: We only support React DApp right now.

🚀 Get Started

Easy Integration with Suiet wallet kit

🔗 Quick start in minutes: https://kit.suiet.app/docs/QuickStart

Maunal Integration with SUI official kit

⚙️ Prerequisites

  1. A React project
  2. Install required npm packages
npm install @mysten/wallet-adapter-react @suiet/wallet-adapter

🚢 Use Sui wallet provider & Register Suiet adapter

// main.js
import {WalletProvider} from "@mysten/wallet-adapter-react";
import {SuietWalletAdapter} from "@suiet/wallet-adapter";

const supportedWallets = [
  {adapter: new SuietWalletAdapter()},
];

ReactDOM.createRoot(document.getElementById("root")).render(
  <React.StrictMode>
    <WalletProvider supportedWallets={supportedWallets}>
      <App/>
    </WalletProvider>
  </React.StrictMode>
);

✅ Retrieve data and launch manipulations

// App.jsx
import {useEffect} from "react";
import {useWallet} from "@mysten/wallet-adapter-react";

function App() {
  const {
    select,
    wallet,
    connected,
    connecting,
    disconnect,
    getAccounts,
    executeMoveCall,
  } = useWallet();

  useEffect(() => {
    if (!connected || !wallet) return;
    (async function () {
      console.log(wallet.adapter.name);
      const accounts = await getAccounts();
      console.log(accounts);
    })();
  }, [connected, wallet]);

  async function handleExecuteMoveCall() {
    await executeMoveCall({
      packageObjectId: "0x2",
      module: "devnet_nft",
      function: "mint",
      typeArguments: [],
      arguments: [
        "name",
        "capy",
        "https://cdn.britannica.com/94/194294-138-B2CF7780/overview-capybara.jpg?w=800&h=450&c=crop",
      ],
      gasBudget: 10000,
    });
  }

  return (
    <div className={'app'}>
      <h1>Current wallet: {wallet ? wallet.adapter.name : 'null'}</h1>
      <button
        onClick={() => {
          if (!connected) {
            select('Suiet');
          } else {
            disconnect();
          }
        }}
      >
        {connecting ? "connecting" : connected ? "Disconnect" : "connect"}
      </button>
    </div>
  )
}

There you go ✅ Go connect with our wallet with custom UI selector!

✨ Features

Sign Message

⚠️ Sui official react kit doesn't support this feature right now. You can try our @suiet/wallet-kit which fully support it and also many handful features

signMessage: (input: { message: Uint8Array }) => Promise<{
  signature: Uint8Array;
  signedMessage: Uint8Array;
}>

If you are using @suiet/wallet-kit, you can use signMessage function from hooks.

If you are using SUI official kit which has not supported this feature, you can try the below hack (when connected to Suiet Wallet):

Suiet Wallet version should >= 0.1.25

import {SuietWalletAdapter} from "@suiet/wallet-adapter";
import * as tweetnacl from 'tweetnacl'  // crypto lib for verify signature

const suietAdapter = new SuietWalletAdapter();

async function signMessage() {
  const result = await suietAdapter.signMessage({
    message: new TextEncoder().encode('Hello world')
  })

  const textDecoder = new TextDecoder()
  console.log('signMessage success', result)
  console.log('signMessage signature', result.signature)  // output -> Uint8Array
  console.log('signMessage signedMessage', textDecoder.decode(result.signedMessage).toString()) // Uint8Array of your raw message

  // verify signMessage with 
  const publicKey = await suietAdapter.getPublicKey()
  console.log('publicKey', publicKey)  // output -> Uint8Array(32)
  const isValidSignature = tweetnacl.sign.detached.verify(
    result.signedMessage,
    result.signature,
    publicKey,
  )
  console.log('verify signature with publicKey: ', isValidSignature)
}

💡 Demo playground

We also prepared a demo for developers, feel free to check it out:

🔗 Website: https://wallet-adapter-example.suiet.app/

🔗 Github Repo: https://github.com/suiet/wallet-adapter/tree/main/examples/sui-kit-integration