types.ts

export type PublicKey = string;
export type Value = string;

export interface ScpSlices {
  threshold: number;
  validators: PublicKey[];
  innerSets?: ScpSlices[];
}

export interface ScpNominate {
  voted: Value[];
  accepted: Value[];
}

export interface ScpBallot {
  value: Value[];
  counter: number;
}

export interface ScpPrepare {
  ballot: ScpBallot; // current & highest prepare vote
  prepared: ScpBallot | null; // highest accepted prepared ballot
  aCounter: number; // lowest non-aborted ballot counter or 0
  hCounter: number; // h.counter or 0 if h == NULL
  cCounter: number; // c.counter or 0 if !c || !hCounter
}

export interface ScpCommit {
  ballot: ScpBallot;
  preparedCounter: number;
  hCounter: number;
  cCounter: number;
}

export interface ScpExternalize {
  commit: ScpBallot;
  hCounter: number;
}

export interface BaseMessageEnvelope {
  message: ScpNominate | ScpPrepare | ScpCommit | ScpExternalize;
  type: 'ScpNominate' | 'ScpPrepare' | 'ScpCommit' | 'ScpExternalize';
  sender: PublicKey;
  slices: ScpSlices;
  timestamp: number;
  slot: number;
}

export interface ScpNominateEnvelope extends BaseMessageEnvelope {
  type: 'ScpNominate';
  message: ScpNominate;
}

export interface ScpPrepareEnvelope extends BaseMessageEnvelope {
  type: 'ScpPrepare';
  message: ScpPrepare;
}

export interface ScpCommitEnvelope extends BaseMessageEnvelope {
  type: 'ScpCommit';
  message: ScpCommit;
}

export interface ScpExternalizeEnvelope extends BaseMessageEnvelope {
  type: 'ScpExternalize';
  message: ScpExternalize;
}

export type MessageEnvelope = ScpNominateEnvelope | ScpPrepareEnvelope | ScpCommitEnvelope | ScpExternalizeEnvelope;

export type TransactionHash = string;
export type BroadcastFunction = (envelope: MessageEnvelope, sendAnyways?: boolean) => void;
export type ValidationFunction = (transactionHash: TransactionHash) => Promise<boolean>;
export type InputFunction = () => Promise<TransactionHash[]>;

export interface ProtocolOptions {
  self: PublicKey;
  slices: ScpSlices;
  slot: number;
  logDebug: boolean;
  logMessages: boolean;
  logLevel?: 'debug' | 'info' | 'error' | 'warn' | 'verbose' | 'debug';
}

export interface ProtocolFunctions {
  broadcast: BroadcastFunction;
  validate: ValidationFunction;
  getInput: InputFunction;
}