polkadot-js/apps

View on GitHub
packages/page-treasury/src/Overview/Council.tsx

Summary

Maintainability
A
2 hrs
Test Coverage
// Copyright 2017-2024 @polkadot/app-treasury authors & contributors
// SPDX-License-Identifier: Apache-2.0

import type { SubmittableExtrinsic } from '@polkadot/api/types';
import type { ProposalIndex } from '@polkadot/types/interfaces';

import React, { useEffect, useRef, useState } from 'react';

import { getTreasuryProposalThreshold } from '@polkadot/apps-config';
import { Button, Dropdown, InputAddress, Modal, TxButton } from '@polkadot/react-components';
import { useApi, useCollectiveInstance, useToggle } from '@polkadot/react-hooks';

import { useTranslation } from '../translate.js';

interface Props {
  id: ProposalIndex;
  isDisabled: boolean;
  members: string[];
}

interface ProposalState {
  proposal?: SubmittableExtrinsic<'promise'> | null;
  proposalLength: number;
}

function Council ({ id, isDisabled, members }: Props): React.ReactElement<Props> | null {
  const { t } = useTranslation();
  const { api } = useApi();
  const [isOpen, toggleOpen] = useToggle();
  const [accountId, setAccountId] = useState<string | null>(null);
  const [proposalType, setProposalType] = useState('accept');
  const [{ proposal, proposalLength }, setProposal] = useState<ProposalState>(() => ({ proposalLength: 0 }));
  const modCouncil = useCollectiveInstance('council');

  const threshold = Math.ceil((members?.length || 0) * getTreasuryProposalThreshold(api));

  const councilTypeOptRef = useRef([
    { text: t('Acceptance proposal to council'), value: 'accept' },
    { text: t('Rejection proposal to council'), value: 'reject' }
  ]);

  useEffect((): void => {
    const proposal = proposalType === 'reject'
      ? api.tx.treasury.rejectProposal(id)
      : api.tx.treasury.approveProposal(id);

    setProposal({ proposal, proposalLength: proposal.length });
  }, [api, id, proposalType]);

  if (!modCouncil) {
    return null;
  }

  return (
    <>
      {isOpen && (
        <Modal
          header={t('Send to council')}
          onClose={toggleOpen}
          size='large'
        >
          <Modal.Content>
            <Modal.Columns hint={t('The council member that is proposing this, submission equates to an "aye" vote.')}>
              <InputAddress
                filter={members}
                label={t('submit with council account')}
                onChange={setAccountId}
                type='account'
                withLabel
              />
            </Modal.Columns>
            <Modal.Columns hint={t('Proposal can either be to approve or reject this spend. Once approved, the change is applied by either removing the proposal or scheduling payout.')}>
              <Dropdown
                label={t('council proposal type')}
                onChange={setProposalType}
                options={councilTypeOptRef.current}
                value={proposalType}
              />
            </Modal.Columns>
          </Modal.Content>
          <Modal.Actions>
            <TxButton
              accountId={accountId}
              icon='check'
              isDisabled={!accountId || !threshold}
              label={t('Send to council')}
              onStart={toggleOpen}
              params={
                api.tx[modCouncil].propose.meta.args.length === 3
                  ? [threshold, proposal, proposalLength]
                  : [threshold, proposal]
              }
              tx={api.tx[modCouncil].propose}
            />
          </Modal.Actions>
        </Modal>
      )}
      <Button
        icon='step-forward'
        isDisabled={isDisabled}
        label={t('To council')}
        onClick={toggleOpen}
      />
    </>
  );
}

export default React.memo(Council);