voting-module-adapter.ts

import { ComponentType } from 'react'

import { ActionCategoryMaker } from './actions'
import { DaoInfoCard, StakingMode } from './components'
import { DaoTabWithComponent } from './dao'
import { GenericToken } from './token'

export interface BaseProfileCardMemberInfoProps {
  maxGovernanceTokenDeposit: string | undefined
  // True if wallet cannot vote on a proposal being shown.
  cantVoteOnProposal?: boolean
}

export interface BaseStakingModalProps {
  visible: boolean
  onClose: () => void
  initialMode?: StakingMode
  maxDeposit?: string
}

export type VotingModuleRelevantAddress = {
  label: string
  address: string
}

export interface IVotingModuleAdapter {
  // Hooks
  hooks: {
    useMainDaoInfoCards: () => DaoInfoCard[]
    useVotingModuleRelevantAddresses: () => VotingModuleRelevantAddress[]
    useCommonGovernanceTokenInfo?: () => GenericToken
  }

  // Components
  components: {
    extraTabs?: (Omit<DaoTabWithComponent, 'label'> & {
      labelI18nKey: string
    })[]
    ProfileCardMemberInfo: ComponentType<BaseProfileCardMemberInfoProps>
    MainDaoInfoCardsLoader: ComponentType<any>
    StakingModal?: ComponentType<BaseStakingModalProps>
  }

  // Fields
  fields: {
    actionCategoryMakers: ActionCategoryMaker[]
  }
}

export type VotingModuleAdapter = {
  id: string
  contractNames: string[]

  load: (options: IVotingModuleAdapterOptions) => IVotingModuleAdapter
}

export interface IVotingModuleAdapterOptions {
  chainId: string
  coreAddress: string
  votingModuleAddress: string
}

export interface IVotingModuleAdapterContext {
  id: string
  options: IVotingModuleAdapterOptions
  adapter: IVotingModuleAdapter
}