NGUtech / bitcoin-interop

src/Entity/BitcoinTransaction.php

<?php declare(strict_types=1);
/**
 * This file is part of the ngutech/bitcoin-interop project.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace NGUtech\Bitcoin\Entity;

use Daikon\Entity\Attribute;
use Daikon\Entity\AttributeMap;
use Daikon\Entity\Entity;
use Daikon\Money\Entity\TransactionInterface;
use Daikon\ValueObject\BoolValue;
use Daikon\ValueObject\FloatValue;
use Daikon\ValueObject\Natural;
use Daikon\ValueObject\Text;
use NGUtech\Bitcoin\Service\BitcoinCurrencies;
use NGUtech\Bitcoin\Service\SatoshiCurrencies;
use NGUtech\Bitcoin\ValueObject\Bitcoin;
use NGUtech\Bitcoin\ValueObject\Hash;
use NGUtech\Bitcoin\ValueObject\OutputList;

final class BitcoinTransaction extends Entity implements TransactionInterface
{
    public const AMOUNT_MIN = '1'.SatoshiCurrencies::SAT;
    public const AMOUNT_MAX = '21000000'.BitcoinCurrencies::BTC;

    public static function getAttributeMap(): AttributeMap
    {
        return new AttributeMap([
            Attribute::define('id', Hash::class),
            Attribute::define('label', Text::class),
            Attribute::define('amount', Bitcoin::class),
            Attribute::define('outputs', OutputList::class),
            Attribute::define('feeRate', FloatValue::class),
            Attribute::define('feeEstimate', Bitcoin::class),
            Attribute::define('feeSettled', Bitcoin::class),
            Attribute::define('comment', Text::class),
            Attribute::define('confTarget', Natural::class),
            Attribute::define('confirmations', Natural::class),
            Attribute::define('rbf', BoolValue::class),
        ]);
    }

    public function getIdentity(): Hash
    {
        return $this->getId();
    }

    public function getId(): Hash
    {
        return $this->get('id') ?? Hash::makeEmpty();

The expression return $this->get('id') ?? NGUtech\Bitcoin\ValueObject\Hash::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return NGUtech\Bitcoin\ValueObject\Hash. Consider adding an additional type-check to rule them out.

    }

    public function getLabel(): Text
    {
        return $this->get('label') ?? Text::makeEmpty();

The expression return $this->get('label') ?? Daikon\ValueObject\Text::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return Daikon\ValueObject\Text. Consider adding an additional type-check to rule them out.

    }

    public function getAmount(): Bitcoin
    {
        return $this->get('amount') ?? Bitcoin::makeEmpty();

The expression return $this->get('amount') ?? NGUtech\Bitcoin\ValueObject\Bitcoin::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return NGUtech\Bitcoin\ValueObject\Bitcoin. Consider adding an additional type-check to rule them out.

    }

    public function getOutputs(): OutputList
    {
        return $this->get('outputs') ?? OutputList::makeEmpty();

The expression return $this->get('outputs') ?? NGUtech\Bitcoin\ValueObject\OutputList::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return NGUtech\Bitcoin\ValueObject\OutputList. Consider adding an additional type-check to rule them out.

    }

    public function getFeeRate(): FloatValue
    {
        return $this->get('feeRate') ?? FloatValue::makeEmpty();

The expression return $this->get('feeRate') ?? Daikon\ValueObject\FloatValue::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return Daikon\ValueObject\FloatValue. Consider adding an additional type-check to rule them out.

    }

    public function getFeeEstimate(): Bitcoin
    {
        return $this->get('feeEstimate') ?? Bitcoin::makeEmpty();

The expression return $this->get('feeEstimate') ?? NGUtech\Bitcoin\ValueObject\Bitcoin::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return NGUtech\Bitcoin\ValueObject\Bitcoin. Consider adding an additional type-check to rule them out.

    }

    public function getFeeSettled(): Bitcoin
    {
        return $this->get('feeSettled') ?? Bitcoin::makeEmpty();

The expression return $this->get('feeSettled') ?? NGUtech\Bitcoin\ValueObject\Bitcoin::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return NGUtech\Bitcoin\ValueObject\Bitcoin. Consider adding an additional type-check to rule them out.

    }

    public function getFeeRefund(): Bitcoin
    {
        return $this->getFeeEstimate()->subtract($this->getFeeSettled());
    }

    public function getComment(): Text
    {
        return $this->get('comment') ?? Text::makeEmpty();

The expression return $this->get('comment') ?? Daikon\ValueObject\Text::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return Daikon\ValueObject\Text. Consider adding an additional type-check to rule them out.

    }

    public function getConfTarget(): Natural
    {
        return $this->get('confTarget') ?? Natural::makeEmpty();

The expression return $this->get('confTarget') ?? Daikon\ValueObject\Natural::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return Daikon\ValueObject\Natural. Consider adding an additional type-check to rule them out.

    }

    public function getConfirmations(): Natural
    {
        return $this->get('confirmations') ?? Natural::makeEmpty();

The expression return $this->get('confirmations') ?? Daikon\ValueObject\Natural::makeEmpty() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return Daikon\ValueObject\Natural. Consider adding an additional type-check to rule them out.

    }

    public function getRbf(): BoolValue
    {
        return $this->get('rbf') ?? BoolValue::false();

The expression return $this->get('rbf') ?? Daikon\ValueObject\BoolValue::false() could return the type Daikon\ValueObject\ValueObjectInterface which includes types incompatible with the type-hinted return Daikon\ValueObject\BoolValue. Consider adding an additional type-check to rule them out.

    }
}