org.alephium.protocol.vm.MutBalanceState.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.vm

import org.alephium.protocol.model.TokenId
import org.alephium.util.U256

/*
 * For each stateful frame, users could put a set of assets.
 * Contracts could move funds, generate outputs by using vm's instructions.
 * `remaining` is the current usable balances
 * `approved` is the balances that function call potentially can use
 */
final case class MutBalanceState(remaining: MutBalances, approved: MutBalances) {
  def approveALPH(lockupScript: LockupScript, amount: U256): Option[Unit] = {
    for {
      _ <- remaining.subAlph(lockupScript, amount)
      _ <- approved.addAlph(lockupScript, amount)
    } yield ()
  }

  def approveToken(lockupScript: LockupScript, tokenId: TokenId, amount: U256): Option[Unit] = {
    for {
      _ <- remaining.subToken(lockupScript, tokenId, amount)
      _ <- approved.addToken(lockupScript, tokenId, amount)
    } yield ()
  }

  def alphRemaining(lockupScript: LockupScript): Option[U256] = {
    remaining.getBalances(lockupScript).map(_.attoAlphAmount)
  }

  def alphRemainingUnsafe(lockupScript: LockupScript): U256 = {
    alphRemaining(lockupScript).getOrElse(U256.Zero)
  }

  def tokenRemaining(lockupScript: LockupScript, tokenId: TokenId): Option[U256] = {
    remaining.getTokenAmount(lockupScript, tokenId)
  }

  def tokenRemainingUnsafe(lockupScript: LockupScript, tokenId: TokenId): U256 = {
    tokenRemaining(lockupScript, tokenId).getOrElse(U256.Zero)
  }

  def isPaying(lockupScript: LockupScript): Boolean = {
    remaining.all.exists(_._1 == lockupScript)
  }

  def useApproved(): MutBalanceState = {
    val toUse = approved.use()
    MutBalanceState(toUse, MutBalances.empty)
  }

  def useAll(lockupScript: LockupScript): Option[MutBalancesPerLockup] = {
    remaining.useAll(lockupScript)
  }

  def useAllApproved(lockupScript: LockupScript): Option[MutBalancesPerLockup] = {
    approved.useAll(lockupScript)
  }

  def useAlph(lockupScript: LockupScript, amount: U256): Option[Unit] = {
    remaining.subAlph(lockupScript, amount)
  }

  def useToken(lockupScript: LockupScript, tokenId: TokenId, amount: U256): Option[Unit] = {
    remaining.subToken(lockupScript, tokenId, amount)
  }
}

object MutBalanceState {
  def empty: MutBalanceState = MutBalanceState(MutBalances.empty, MutBalances.empty)
  def from(balances: MutBalances): MutBalanceState = MutBalanceState(balances, MutBalances.empty)
}