zcash-grant-system/admin/src/util/statuses.ts

import {
  PROPOSAL_STATUS,
  CCR_STATUS,
  RFP_STATUS,
  CONTRIBUTION_STATUS,
  PROPOSAL_ARBITER_STATUS,
  MILESTONE_STAGE,
  PROPOSAL_STAGE,
} from 'src/types';

export interface StatusSoT<E> {
  id: E;
  tagDisplay: string;
  tagColor: string;
  hint: string;
  not?: boolean;
}

export const MILESTONE_STAGES: Array<StatusSoT<MILESTONE_STAGE>> = [
  {
    id: MILESTONE_STAGE.IDLE,
    tagDisplay: 'Idle',
    tagColor: '#e9c510',
    hint: 'Proposal has has an idle milestone.',
  },
  {
    id: MILESTONE_STAGE.REQUESTED,
    tagDisplay: 'Requested',
    tagColor: '#e9c510',
    hint: 'Proposal has has a milestone with a requested payout.',
  },
  {
    id: MILESTONE_STAGE.REJECTED,
    tagDisplay: 'Rejected',
    tagColor: '#e9c510',
    hint: 'Proposal has has a milestone with a rejected payout.',
  },
  {
    id: MILESTONE_STAGE.ACCEPTED,
    tagDisplay: 'Accepted',
    tagColor: '#e9c510',
    hint: 'Proposal has an accepted milestone, and awaits payment.',
  },
  {
    id: MILESTONE_STAGE.PAID,
    tagDisplay: 'Paid',
    tagColor: '#e9c510',
    hint: 'Proposal has a paid milestone.',
  },
];

export const CCR_STATUSES: Array<StatusSoT<CCR_STATUS>> = [
  {
    id: CCR_STATUS.APPROVED,
    tagDisplay: 'Approved',
    tagColor: '#afd500',
    hint: 'Request has been approved and is awaiting being published by user.',
  },
  {
    id: CCR_STATUS.DELETED,
    tagDisplay: 'Deleted',
    tagColor: '#bebebe',
    hint: 'Request has been deleted and is not visible on the platform.',
  },
  {
    id: CCR_STATUS.DRAFT,
    tagDisplay: 'Draft',
    tagColor: '#8d8d8d',
    hint: 'Request is being created by the user.',
  },
  {
    id: CCR_STATUS.LIVE,
    tagDisplay: 'Live',
    tagColor: '#108ee9',
    hint: 'Request is live on the platform.',
  },
  {
    id: CCR_STATUS.PENDING,
    tagDisplay: 'Awaiting Approval',
    tagColor: '#ffaa00',
    hint: 'User is waiting for admin to approve or request changes to this Request.',
  },
  {
    id: CCR_STATUS.REJECTED,
    tagDisplay: 'Changes Requested',
    tagColor: '#eb4118',
    hint:
      'Admin has requested changes for this Request. User may adjust it and resubmit for approval.',
  },
  {
    id: CCR_STATUS.REJECTED_PERMANENTLY,
    tagDisplay: 'Rejected Permanently',
    tagColor: '#eb4118',
    hint:
      'Admin has rejected this CCR permanently. It cannot be resubmitted for approval.',
  },
];

export const PROPOSAL_STATUSES: Array<StatusSoT<PROPOSAL_STATUS>> = [
  {
    id: PROPOSAL_STATUS.APPROVED,
    tagDisplay: 'Approved',
    tagColor: '#afd500',
    hint: 'Proposal has been approved and is awaiting being published by user.',
  },
  {
    id: PROPOSAL_STATUS.DISCUSSION,
    tagDisplay: 'Open for Public Review',
    tagColor: '#afd500',
    hint: 'Proposal has been opened for public discussion.',
  },
  {
    id: PROPOSAL_STATUS.LIVE_DRAFT,
    tagDisplay: 'Live Draft',
    tagColor: '#8d8d8d',
    hint: 'Proposal is an edit that will to be published to another proposal.',
  },
  {
    id: PROPOSAL_STATUS.DELETED,
    tagDisplay: 'Deleted',
    tagColor: '#bebebe',
    hint: 'Proposal has been deleted and is not visible on the platform.',
  },
  {
    id: PROPOSAL_STATUS.DRAFT,
    tagDisplay: 'Draft',
    tagColor: '#8d8d8d',
    hint: 'Proposal is being created by the user.',
  },
  {
    id: PROPOSAL_STATUS.LIVE,
    tagDisplay: 'Live',
    tagColor: '#108ee9',
    hint: 'Proposal is live on the platform.',
  },
  {
    id: PROPOSAL_STATUS.PENDING,
    tagDisplay: 'Awaiting Approval',
    tagColor: '#ffaa00',
    hint: 'User is waiting for admin to approve or request changes to this Proposal.',
  },
  {
    id: PROPOSAL_STATUS.REJECTED,
    tagDisplay: 'Changes Requested',
    tagColor: '#eb4118',
    hint:
      'Admin has requested changes for this proposal. User may adjust it and resubmit for approval.',
  },
  {
    id: PROPOSAL_STATUS.REJECTED_PERMANENTLY,
    tagDisplay: 'Rejected Permanently',
    tagColor: '#eb4118',
    hint:
      'Admin has rejected this proposal permanently. It cannot be resubmitted for approval.',
  },
  {
    id: PROPOSAL_STATUS.STAKING,
    tagDisplay: 'Staking',
    tagColor: '#722ed1',
    hint: 'This proposal is awaiting a staking contribution.',
  },
];

export const PROPOSAL_STAGES: Array<StatusSoT<PROPOSAL_STAGE>> = [
  {
    id: PROPOSAL_STAGE.PREVIEW,
    tagDisplay: 'Preview',
    tagColor: '#afd500',
    hint: 'Proposal is not yet published.',
  },
  {
    id: PROPOSAL_STAGE.FUNDING_REQUIRED,
    tagDisplay: 'Funding',
    tagColor: '#bebebe',
    hint: 'Proposal has been published but still needs funding.',
  },
  {
    id: PROPOSAL_STAGE.WIP,
    tagDisplay: 'WIP',
    tagColor: '#8d8d8d',
    hint: 'Proposal is fully funded and the work is being done.',
  },
  {
    id: PROPOSAL_STAGE.COMPLETED,
    tagDisplay: 'Completed',
    tagColor: '#108ee9',
    hint: 'Proposal was accepted, published, funded and all funds paid out.',
  },
  {
    id: PROPOSAL_STAGE.FAILED,
    tagDisplay: 'Failed',
    tagColor: '#eb4118',
    hint: 'Proposal failed to meet target and is currently refunding all contributors.',
  },
  {
    id: PROPOSAL_STAGE.CANCELED,
    tagDisplay: 'Canceled',
    tagColor: '#eb4118',
    hint:
      'Proposal was canceled by an admin and is currently refunding all contributors.',
  },
  {
    id: PROPOSAL_STAGE.NOT_CANCELED,
    tagDisplay: 'NOT Canceled',
    tagColor: '#eb4118',
    hint: 'Proposal has NOT been canceled.',
    not: true,
  },
];

export const PROPOSAL_ARBITER_STATUSES: Array<StatusSoT<PROPOSAL_ARBITER_STATUS>> = [
  {
    id: PROPOSAL_ARBITER_STATUS.MISSING,
    tagDisplay: 'Missing',
    tagColor: '#cf00d5',
    hint: 'Proposal does not have an arbiter.',
  },
  {
    id: PROPOSAL_ARBITER_STATUS.NOMINATED,
    tagDisplay: 'Nominated',
    tagColor: '#cf00d5',
    hint: 'An arbiter has been nominated for this proposal.',
  },
  {
    id: PROPOSAL_ARBITER_STATUS.ACCEPTED,
    tagDisplay: 'Accepted',
    tagColor: '#cf00d5',
    hint: 'Proposal has an arbiter.',
  },
];

export const RFP_STATUSES: Array<StatusSoT<RFP_STATUS>> = [
  {
    id: RFP_STATUS.DRAFT,
    tagDisplay: 'Draft',
    tagColor: '#ffaa00',
    hint: 'RFP is currently being edited by admins and isn’t visible to users.',
  },
  {
    id: RFP_STATUS.LIVE,
    tagDisplay: 'Live',
    tagColor: '#108ee9',
    hint: 'RFP is live and users can submit proposals for it.',
  },
  {
    id: RFP_STATUS.CLOSED,
    tagDisplay: 'Closed',
    tagColor: '#eb4118',
    hint:
      'RFP has been closed to new submissions and will no longer be listed, but can still be viewed, and associated proposals will remain open.',
  },
];

export const CONTRIBUTION_STATUSES: Array<StatusSoT<CONTRIBUTION_STATUS>> = [
  {
    id: CONTRIBUTION_STATUS.PENDING,
    tagDisplay: 'Pending',
    tagColor: '#ffaa00',
    hint: 'Contribution is currently waiting to be sent and confirmed on chain',
  },
  {
    id: CONTRIBUTION_STATUS.CONFIRMED,
    tagDisplay: 'Confirmed',
    tagColor: '#108ee9',
    hint: 'Contribution was confirmed on chain with multiple block confirmations',
  },
  {
    id: CONTRIBUTION_STATUS.DELETED,
    tagDisplay: 'Deleted',
    tagColor: '#eb4118',
    hint:
      'User deleted the contribution before it was sent, or after it didn’t confirm after 24 hours',
  },
];

export function getStatusById<E>(statuses: Array<StatusSoT<E>>, id: E) {
  const result = statuses.find(s => s.id === id);
  if (!result) {
    throw Error(`getStatusById: could not find status for '${id}'`);
  }
  return result;
}