useSignTransaction

Hook to sign a Solana transaction using the connected wallet from Embedded Wallets.

Import

import { useSignTransaction } from '@web3auth/modal/react/solana'

Usage

import { useSignTransaction } from '@web3auth/modal/react/solana'
import type { Transaction } from '@solana/kit'

function SignTransactionButton({ transaction }: { transaction: Transaction }) {
  const { signTransaction, loading, error, data } = useSignTransaction()

  const handleSign = async () => {
    try {
      const signedTx = await signTransaction(transaction)
      // Do something with signedTx
    } catch (e) {
      // Handle error
    }
  }

  return (
    <div>
      <button onClick={handleSign} disabled={loading}>
        {loading ? 'Signing...' : 'Sign Transaction'}
      </button>
      {error && <div>Error: {error.message}</div>}
      {data && <div>Signed Transaction: {data}</div>}
    </div>
  )
}

Return type

export type IUseSignTransaction = {
  loading: boolean
  error: Web3AuthError | null
  data: string | null
  signTransaction: (transaction: TransactionOrVersionedTransaction) => Promise<string>
}

loading

boolean

Indicates if the transaction signing is in progress.

error

Web3AuthError | null

Error object if signing fails, otherwise null.

data

string | null

The signed transaction as a string, or null if not signed yet.

signTransaction

(transaction: TransactionOrVersionedTransaction) => Promise<string>

Function to sign a Solana transaction. Returns the signed transaction as a string.

Example

signTransaction.tsx

import { FormEvent } from 'react'
import {
  address,
  appendTransactionMessageInstruction,
  compileTransaction,
  createNoopSigner,
  createTransactionMessage,
  lamports,
  pipe,
  setTransactionMessageFeePayerSigner,
  setTransactionMessageLifetimeUsingBlockhash,
} from '@solana/kit'
import { getTransferSolInstruction } from '@solana-program/system'
import { useSolanaWallet, useSignTransaction } from '@web3auth/modal/react/solana'

export function SignTransaction() {
  const { signTransaction, loading, error, data } = useSignTransaction()
  const { accounts, rpc } = useSolanaWallet()

  async function submit(e: FormEvent<HTMLFormElement>) {
    e.preventDefault()
    const formData = new FormData(e.target as HTMLFormElement)
    const to = formData.get('address') as string
    const value = formData.get('value') as string

    if (!rpc || !accounts?.length) return

    const { value: latestBlockhash } = await rpc.getLatestBlockhash().send()
    const feePayer = createNoopSigner(address(accounts[0]))
    const message = pipe(
      createTransactionMessage({ version: 0 }),
      m => setTransactionMessageFeePayerSigner(feePayer, m),
      m => setTransactionMessageLifetimeUsingBlockhash(latestBlockhash, m),
      m =>
        appendTransactionMessageInstruction(
          getTransferSolInstruction({
            source: feePayer,
            destination: address(to),
            amount: lamports(BigInt(Math.floor(Number(value) * 1e9))),
          }),
          m
        )
    )

    signTransaction(compileTransaction(message))
  }

  return (
    <form onSubmit={submit}>
      <input name="address" placeholder="Address" required />
      <input name="value" placeholder="Amount (SOL)" type="number" step="0.01" required />
      <button disabled={loading} type="submit">
        {loading ? 'Signing...' : 'Sign transaction'}
      </button>
      {data && <p>Signed transaction: {String(data)}</p>}
      {error && <p>Error: {error.message}</p>}
    </form>
  )
}