Documentation
    Preparing search index...

    Main wallet client class that provides unified access to blockchain operations

    This class integrates various modules (swap, lending, balance, etc.) and provides a consistent interface for interacting with the Sui blockchain. It handles transaction signing, module management, and event emission.

    Index

    Constructors

    Properties

    client: SuiClient

    The Sui client instance

    events: Emitter<ModuleEvents> = ...

    Event emitter for module events

    signer: Signer

    The signer instance for transaction signing

    Accessors

    • get address(): string

      Gets the wallet address from the signer's public key

      Returns string

      The wallet address as a string

    • get balance(): BalanceModule

      Returns BalanceModule

    • get haedal(): HaedalModule

      Returns HaedalModule

    • get lending(): LendingModule

      Returns LendingModule

    • get swap(): SwapModule

      Returns SwapModule

    • get volo(): VoloModule

      Returns VoloModule

    Methods

    • Gets the configuration for a specific module

      Type Parameters

      • TName extends "balance" | "lending" | "volo" | "swap" | "haedal"

      Parameters

      • name: TName

        The name of the module

      Returns ExtractModuleConfig<
          {
              balance: BalanceModule;
              haedal: HaedalModule;
              lending: LendingModule;
              swap: SwapModule;
              volo: VoloModule;
          }[TName],
      >

      The merged configuration (default + user config)

    • Checks if a module is available

      Parameters

      • name: "balance" | "lending" | "volo" | "swap" | "haedal"

        The name of the module to check

      Returns boolean

      True if the module exists, false otherwise

    • Gets a specific module by name

      Type Parameters

      • TName extends "balance" | "lending" | "volo" | "swap" | "haedal"

      Parameters

      • name: TName

        The name of the module to retrieve

      Returns {
          balance: BalanceModule;
          haedal: HaedalModule;
          lending: LendingModule;
          swap: SwapModule;
          volo: VoloModule;
      }[TName]

      The requested module instance

    • Signs and executes a transaction block

      Parameters

      • options: { transaction: Uint8Array<ArrayBufferLike> | Transaction } & Omit<
            ExecuteTransactionBlockParams,
            "transactionBlock"
            | "signature",
        > & Partial<DryRunOptions>

        Transaction execution options including dry run support

      Returns Promise<DryRunTransactionBlockResponse | SuiTransactionBlockResponse>

      Promise with transaction execution result