useCheckWaasFeeOptions

​

Import

import { useCheckWaasFeeOptions } from '@0xsequence/connect'

​

Usage

import { useCheckWaasFeeOptions } from '@0xsequence/connect'

function App() {
  const checkFeeOptions = useCheckWaasFeeOptions()
  
  const handleTransaction = async () => {
    // Example transaction
    const transaction = {
      to: '0x...',
      value: '1000000000000000000', // 1 ETH
      data: '0x...'
    }
    
    const { isSponsored, feeOptions, feeQuote } = await checkFeeOptions({
      transactions: [transaction],
      chainId: 1 // Ethereum Mainnet
    })
    
    if (isSponsored) {
      console.log('Transaction is sponsored!')
    } else if (feeOptions) {
      console.log('Available fee options:', feeOptions)
      console.log('Fee quote:', feeQuote)
      // Handle fee payment selection
    }
  }
  
  return (
    <div>
      <button onClick={handleTransaction}>
        Check Transaction Fees
      </button>
    </div>
  )
}

​

Return Type

The hook returns a function with the following signature:

(params: {
  transactions: Transaction[]
  chainId: number
}) => Promise<{
  feeQuote: string | undefined
  feeOptions: FeeOption[] | undefined
  isSponsored: boolean
}>

​

Parameters

​

transactions

Transaction[]

Array of transactions to check fee options for.

interface Transaction {
  to: string
  value?: string
  data?: string
  // ... other transaction properties
}

​

chainId

number

The ID of the blockchain network where the transaction will be executed.

​

Return Object Properties

​

isSponsored

boolean

Indicates whether the transaction will be sponsored (true) or requires fee payment (false).

​

feeOptions

FeeOption[] | undefined

Available fee payment options if the transaction is not sponsored.

interface FeeOption {
  token: {
    symbol: string
    decimals: number
    address: string
  }
  // ... other fee option properties
}

​

feeQuote

string | undefined

The fee quote for the transaction if available.

​

Notes

This hook is specifically designed for use with Sequence WaaS (Wallet as a Service) and provides functionality to:

• Check if a transaction will be sponsored
• Get available fee options for unsponsored transactions
• Retrieve fee quotes for transactions

Key features:

• Automatically detects WaaS provider availability
• Returns sponsored status for transactions
• Provides fee options and quotes when sponsorship is not available
• Works seamlessly with the WaaS transaction flow

Common use cases:

• Transaction fee estimation
• Fee payment option selection
• Sponsored transaction detection
• Integration with transaction confirmation flows

This hook is commonly used in conjunction with useWaasFeeOptions to handle fee payments for unsponsored transactions. It’s particularly useful in wallet interfaces and transaction confirmation flows where you need to determine if a transaction will be sponsored or requires fee payment.