@intellax/ix-ethereum-connector

ix-ethereum-connector

wagmi configuration wrapper

• Ethereum Library wagmi: https://wagmi.sh/
• Ethereum client viem: https://viem.sh/

INSTALL

npm install @web3modal/wagmi wagmi viem @tanstack/react-query @intellax/ix-ethereum-connector

CONFIG

/**
 * https://wagmi.sh/react/getting-started
 */
type Options = {
  /**
   * Get projectId at https://cloud.walletconnect.com
   */
  projectId: string;
  /**
   * @description WalletConnectMetadata
   * @link https://wagmi.sh/core/api/connectors/walletConnect#metadata
   */
  walletConnectMetadata: {
    name: string;
    description: string;
    url: string;
    icons: string[];
  };

  /**
   * set Default Chains
   * testnet: true [polygonAmoy, spolia]
   * testnet: false [polygon, mainnet]
   */
  testnet: boolean;

  /**
   * @link https://docs.walletconnect.com/web3modal/v2/javascript/wagmi/options
   */
  web3ModalOptions?: Omit<
    Web3ModalOptions<ReturnType<typeof defaultWagmiConfig>>,
    "projectId" | "wagmiConfig"
  >;

  /**
   * @description CreateConfigParameters
   * @link https://wagmi.sh/core/api/createConfig
   */
  createConfigParameters?: Omit<
    CreateConfigParameters,
    "transports" | "chains" | "connectors" | "chains" | "client"
  >;
  /**
   * Override Connectors
   * @description Connectors
   * @link https://wagmi.sh/core/api/connectors
   */
  connectors?: CreateConnectorFn[];
  /**
   * Override Chains
   * @link https://wagmi.sh/core/api/chains
   */
  chains?: [Chain, ...Chain[]];

  debug?: boolean;
  /**
   * try Connect to IX Wallet Provider
   * default: true
   */
  tryIxInjected?: boolean;
};