org.alephium.protocol.model.CliqueInfo.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alephium-protocol_2.13 Show documentation
alephium-protocol
There is a newer version: 3.8.8
Show newest version
// Copyright 2018 The Alephium Authors
// This file is part of the alephium project.
//
// The library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the library. If not, see .

package org.alephium.protocol.model

import java.net.InetSocketAddress

import org.alephium.protocol.{PrivateKey}
import org.alephium.protocol.config.{CliqueConfig, GroupConfig}
import org.alephium.util.AVector

// All the groups [0, ..., G-1] are assigned to different brokers based `% brokerNum`
// Assume the peers are ordered according to the groups they correspond to
final case class CliqueInfo private (
    id: CliqueId,
    externalAddresses: AVector[Option[InetSocketAddress]],
    internalAddresses: AVector[InetSocketAddress],
    groupNumPerBroker: Int,
    priKey: PrivateKey
) { self =>
  def brokerNum: Int = internalAddresses.length

  def cliqueConfig: CliqueConfig =
    new CliqueConfig {
      val brokerNum: Int = self.brokerNum
      val groups: Int    = self.brokerNum * self.groupNumPerBroker
    }

  def intraBrokers: AVector[BrokerInfo] = {
    internalAddresses.mapWithIndex { (internalAddress, index) =>
      BrokerInfo.unsafe(id, index, brokerNum, internalAddress)
    }
  }

  def coordinatorAddress: InetSocketAddress = internalAddresses.head

  def selfInterBrokerInfo(implicit brokerConfig: BrokerGroupInfo): InterBrokerInfo =
    InterBrokerInfo.unsafe(id, brokerConfig.brokerId, brokerNum)

  def selfBrokerInfo(implicit brokerConfig: BrokerGroupInfo): Option[BrokerInfo] = {
    val brokerId = brokerConfig.brokerId
    externalAddresses(brokerId) map { address =>
      BrokerInfo.unsafe(id, brokerId, brokerNum, address)
    }
  }

  @SuppressWarnings(Array("org.wartremover.warts.OptionPartial"))
  def interBrokers: Option[AVector[BrokerInfo]] = {
    Option.when(externalAddresses.forall(_.nonEmpty))(externalAddresses.mapWithIndex {
      case (addressOpt, brokerId) =>
        BrokerInfo.unsafe(id, brokerId, brokerNum, addressOpt.get)
    })
  }
}

object CliqueInfo {
  def validate(info: CliqueInfo)(implicit config: GroupConfig): Either[String, Unit] = {
    val cliqueGroups = info.brokerNum * info.groupNumPerBroker
    if (cliqueGroups != config.groups) {
      Left(s"Number of groups: got: $cliqueGroups expect: ${config.groups}")
    } else {
      Right(())
    }
  }

  def unsafe(
      id: CliqueId,
      externalAddresses: AVector[Option[InetSocketAddress]],
      internalAddresses: AVector[InetSocketAddress],
      groupNumPerBroker: Int,
      priKey: PrivateKey
  ): CliqueInfo = {
    new CliqueInfo(id, externalAddresses, internalAddresses, groupNumPerBroker, priKey)
  }
}