org.plasmalabs.sdk.syntax.TransactionSyntax.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plasma-sdk_2.13 Show documentation

plasma-sdk

The newest version!

package org.plasmalabs.sdk.syntax

import org.plasmalabs.sdk.common.ContainsEvidence
import org.plasmalabs.sdk.common.ContainsImmutable
import org.plasmalabs.sdk.common.ContainsSignable
import org.plasmalabs.sdk.common.ContainsSignable.instances.ioTransactionSignable
import org.plasmalabs.sdk.models.TransactionId
import org.plasmalabs.sdk.models.common.ImmutableBytes
import org.plasmalabs.sdk.models.transaction.IoTransaction

import scala.language.implicitConversions

trait TransactionSyntax {

  implicit def ioTransactionAsTransactionSyntaxOps(transaction: IoTransaction): TransactionSyntaxOps =
    new TransactionSyntaxOps(transaction)
}

class TransactionSyntaxOps(val transaction: IoTransaction) extends AnyVal {

  /**
   * The ID of this transaction.  If an ID was pre-computed and saved in the Transaction, it is restored.
   * Otherwise, a new ID is computed (but not saved in the Transaction).
   */
  def id: TransactionId =
    transaction.transactionId.getOrElse(computeId)

  /**
   * Computes what the ID _should_ be for this Transaction.
   */
  def computeId: TransactionId = {
    import TransactionSyntaxOps._
    val signableBytes = ContainsSignable[IoTransaction].signableBytes(transaction)
    val immutable = ImmutableBytes(signableBytes.value)
    val evidence = ContainsEvidence[ImmutableBytes].sizedEvidence(immutable)
    TransactionId(evidence.digest.value)
  }

  /**
   * Compute a new ID and return a copy of this Transaction with the new ID embedded.
   * Any previous value will be overwritten in the new copy.
   */
  def embedId: IoTransaction =
    transaction.copy(transactionId = Some(computeId))

  /**
   * Returns true if this Transaction contains a valid embedded ID.
   */
  def containsValidId: Boolean =
    transaction.transactionId.contains(computeId)
}

object TransactionSyntaxOps {
  implicit private val immutableContainsImmutable: ContainsImmutable[ImmutableBytes] = identity
}