def test_marginal_utility():
"""Test the marginal utility."""
currency_holdings = {"FET": 100}
utility_params = {"good_id": 20.0}
exchange_params = {"FET": 10.0}
good_holdings = {"good_id": 2}
tx_fee = 9
preferences = Preferences()
preferences.set(
utility_params_by_good_id=utility_params,
exchange_params_by_currency_id=exchange_params,
tx_fee=tx_fee,
)
delta_good_holdings = {"good_id": 1}
delta_currency_holdings = {"FET": -5}
ownership_state = OwnershipState()
ownership_state.set(
amount_by_currency_id=currency_holdings,
quantities_by_good_id=good_holdings,
)
marginal_utility = preferences.marginal_utility(
ownership_state=ownership_state,
delta_quantities_by_good_id=delta_good_holdings,
delta_amount_by_currency_id=delta_currency_holdings,
)
assert marginal_utility is not None, "Marginal utility must not be none."
def test_linear_utility():
"""Calculate the linear_utility and checks that it is not none."""
currency_holdings = {"FET": 100}
utility_params = {"good_id": 20.0}
exchange_params = {"FET": 10.0}
preferences = Preferences()
preferences.set(
utility_params_by_good_id=utility_params,
exchange_params_by_currency_id=exchange_params,
)
linear_utility = preferences.linear_utility(amount_by_currency_id=currency_holdings)
assert linear_utility is not None, "Linear utility must not be none."
def test_logarithmic_utility():
"""Calculate the logarithmic utility and checks that it is not none.."""
utility_params = {"good_id": 20.0}
exchange_params = {"FET": 10.0}
good_holdings = {"good_id": 2}
preferences = Preferences()
preferences.set(
utility_params_by_good_id=utility_params,
exchange_params_by_currency_id=exchange_params,
)
log_utility = preferences.logarithmic_utility(quantities_by_good_id=good_holdings)
assert log_utility is not None, "Log_utility must not be none."
def test_preferences_properties():
"""Test the properties of the preferences class."""
preferences = Preferences()
with pytest.raises(AssertionError):
preferences.exchange_params_by_currency_id
with pytest.raises(AssertionError):
preferences.utility_params_by_good_id
def test_is_utility_enhancing_uninitialized():
"""Test is_utility_enhancing when the states are uninitialized."""
ownership_state = OwnershipState()
preferences = Preferences()
terms = Terms(
ledger_id="ethereum",
sender_address="agent_1",
counterparty_address="pk",
amount_by_currency_id={"FET": -20},
is_sender_payable_tx_fee=True,
quantities_by_good_id={"good_id": 10},
nonce="transaction nonce",
)
assert preferences.is_utility_enhancing(
ownership_state=ownership_state,
terms=terms), "Should enhance utility."
def test_preferences_init():
"""Test the preferences init()."""
utility_params = {"good_id": 20.0}
exchange_params = {"FET": 10.0}
tx_fee = 9
preferences = Preferences()
preferences.set(
exchange_params_by_currency_id=exchange_params,
utility_params_by_good_id=utility_params,
tx_fee=tx_fee,
)
assert preferences.utility_params_by_good_id is not None
assert preferences.exchange_params_by_currency_id is not None
assert preferences.seller_transaction_fee == 4
assert preferences.buyer_transaction_fee == 5
assert preferences.is_initialized
def test_preferences_init():
"""Test the preferences init()."""
utility_params = {"good_id": 20.0}
exchange_params = {"FET": 10.0}
preferences = Preferences()
preferences.set(
exchange_params_by_currency_id=exchange_params,
utility_params_by_good_id=utility_params,
)
assert preferences.utility_params_by_good_id is not None
assert preferences.exchange_params_by_currency_id is not None
assert preferences.is_initialized
copied_preferences = copy.copy(preferences)
assert (preferences.exchange_params_by_currency_id ==
copied_preferences.exchange_params_by_currency_id)
assert (preferences.utility_params_by_good_id ==
copied_preferences.utility_params_by_good_id)
def test_score_diff_from_transaction():
"""Test the difference between the scores."""
good_holdings = {"good_id": 2}
currency_holdings = {"FET": 100}
utility_params = {"good_id": 20.0}
exchange_params = {"FET": 10.0}
ownership_state = OwnershipState()
ownership_state.set(
amount_by_currency_id=currency_holdings, quantities_by_good_id=good_holdings
)
preferences = Preferences()
preferences.set(
utility_params_by_good_id=utility_params,
exchange_params_by_currency_id=exchange_params,
)
terms = Terms(
ledger_id=ETHEREUM,
sender_address="agent_1",
counterparty_address="pk",
amount_by_currency_id={"FET": -20},
is_sender_payable_tx_fee=True,
quantities_by_good_id={"good_id": 10},
nonce="transaction nonce",
)
cur_score = preferences.utility(
quantities_by_good_id=good_holdings, amount_by_currency_id=currency_holdings
)
new_state = ownership_state.apply_transactions([terms])
new_score = preferences.utility(
quantities_by_good_id=new_state.quantities_by_good_id,
amount_by_currency_id=new_state.amount_by_currency_id,
)
diff_scores = new_score - cur_score
score_difference = preferences.utility_diff_from_transaction(
ownership_state=ownership_state, terms=terms
)
assert (
score_difference == diff_scores
), "The calculated difference must be equal to the return difference from the function."
assert not preferences.is_utility_enhancing(
ownership_state=ownership_state, terms=terms
), "Should not enhance utility."
def test_score_diff_from_transaction():
"""Test the difference between the scores."""
good_holdings = {"good_id": 2}
currency_holdings = {"FET": 100}
utility_params = {"good_id": 20.0}
exchange_params = {"FET": 10.0}
tx_fee = 3
ownership_state = OwnershipState()
ownership_state.set(amount_by_currency_id=currency_holdings,
quantities_by_good_id=good_holdings)
preferences = Preferences()
preferences.set(
utility_params_by_good_id=utility_params,
exchange_params_by_currency_id=exchange_params,
tx_fee=tx_fee,
)
tx_message = TransactionMessage(
performative=TransactionMessage.Performative.PROPOSE_FOR_SETTLEMENT,
skill_callback_ids=[PublicId(AUTHOR, "a_skill", "0.1.0")],
tx_id="transaction0",
tx_sender_addr="agent_1",
tx_counterparty_addr="pk",
tx_amount_by_currency_id={"FET": -20},
tx_sender_fee=preferences.seller_transaction_fee,
tx_counterparty_fee=preferences.buyer_transaction_fee,
tx_quantities_by_good_id={"good_id": 10},
info={"some_info_key": "some_info_value"},
ledger_id="fetchai",
tx_nonce="transaction nonce",
)
cur_score = preferences.utility(quantities_by_good_id=good_holdings,
amount_by_currency_id=currency_holdings)
new_state = ownership_state.apply_transactions([tx_message])
new_score = preferences.utility(
quantities_by_good_id=new_state.quantities_by_good_id,
amount_by_currency_id=new_state.amount_by_currency_id,
)
dif_scores = new_score - cur_score
score_difference = preferences.utility_diff_from_transaction(
ownership_state=ownership_state, tx_message=tx_message)
assert (
score_difference == dif_scores
), "The calculated difference must be equal to the return difference from the function."
def test_utility():
"""Calculate the score."""
utility_params = {"good_id": 20.0}
exchange_params = {"FET": 10.0}
currency_holdings = {"FET": 100}
good_holdings = {"good_id": 2}
preferences = Preferences()
preferences.set(
utility_params_by_good_id=utility_params,
exchange_params_by_currency_id=exchange_params,
)
score = preferences.utility(
quantities_by_good_id=good_holdings, amount_by_currency_id=currency_holdings,
)
linear_utility = preferences.linear_utility(amount_by_currency_id=currency_holdings)
log_utility = preferences.logarithmic_utility(quantities_by_good_id=good_holdings)
assert (
score == log_utility + linear_utility
), "The score must be equal to the sum of log_utility and linear_utility."
def setup_class(cls):
"""Initialise the decision maker."""
cls._patch_logger()
cls.multiplexer = Multiplexer([_make_dummy_connection()])
private_key_pem_path = os.path.join(CUR_PATH, "data",
"fet_private_key.txt")
eth_private_key_pem_path = os.path.join(CUR_PATH, "data",
"fet_private_key.txt")
cls.wallet = Wallet({
FetchAICrypto.identifier:
private_key_pem_path,
EthereumCrypto.identifier:
eth_private_key_pem_path,
})
cls.ledger_apis = LedgerApis(
{FetchAICrypto.identifier: DEFAULT_FETCHAI_CONFIG},
FetchAICrypto.identifier)
cls.agent_name = "test"
cls.identity = Identity(
cls.agent_name,
addresses=cls.wallet.addresses,
default_address_key=FetchAICrypto.identifier,
)
cls.ownership_state = OwnershipState()
cls.preferences = Preferences()
cls.decision_maker_handler = DecisionMakerHandler(
identity=cls.identity,
wallet=cls.wallet,
ledger_apis=cls.ledger_apis,
)
cls.decision_maker = DecisionMaker(cls.decision_maker_handler)
cls.multiplexer.connect()
cls.tx_id = "transaction0"
cls.tx_sender_addr = "agent_1"
cls.tx_counterparty_addr = "pk"
cls.info = {"some_info_key": "some_info_value"}
cls.ledger_id = "fetchai"
cls.decision_maker.start()