robosats/tests/test_trade_pipeline.py

417 lines
16 KiB
Python
Raw Normal View History

2023-11-06 14:01:56 +00:00
import json
2023-11-06 19:33:40 +00:00
from datetime import datetime
from decimal import Decimal
2023-11-06 23:13:23 +00:00
from unittest.mock import patch
2023-11-06 14:01:56 +00:00
from decouple import config
from django.contrib.auth.models import User
from django.urls import reverse
2023-11-06 14:01:56 +00:00
2023-11-09 10:33:53 +00:00
from api.management.commands.follow_invoices import Command as FollowInvoices
2023-11-06 19:33:40 +00:00
from api.models import Currency, Order
from api.tasks import cache_market
2023-11-09 10:33:53 +00:00
from tests.mocks.cln import MockHoldStub # , MockNodeStub
from tests.mocks.lnd import ( # MockRouterStub,; MockSignerStub,; MockVersionerStub,
2023-11-06 23:13:23 +00:00
MockInvoicesStub,
MockLightningStub,
)
from tests.test_api import BaseAPITestCase
2023-11-06 19:33:40 +00:00
2023-11-06 14:01:56 +00:00
def read_file(file_path):
"""
Read a file and return its content.
"""
with open(file_path, "r") as file:
return file.read()
class TradeTest(BaseAPITestCase):
2023-11-06 14:01:56 +00:00
su_pass = "12345678"
su_name = config("ESCROW_USERNAME", cast=str, default="admin")
maker_form_with_range = {
"type": Order.Types.BUY,
"currency": 1,
"has_range": True,
"min_amount": 21,
"max_amount": 101.7,
"payment_method": "Advcash Cash F2F",
"is_explicit": False,
"premium": 3.34,
"public_duration": 69360,
"escrow_duration": 8700,
"bond_size": 3.5,
"latitude": 34.7455,
"longitude": 135.503,
}
@classmethod
def setUpTestData(cls):
2023-11-06 19:33:40 +00:00
"""
Set up initial data for the test case.
2023-11-06 19:33:40 +00:00
"""
# Create super user
User.objects.create_superuser(cls.su_name, "super@user.com", cls.su_pass)
# Fetch currency prices from external APIs
cache_market()
2023-11-06 14:01:56 +00:00
def test_login_superuser(self):
2023-11-06 23:13:23 +00:00
"""
Test the login functionality for the superuser.
2023-11-06 23:13:23 +00:00
"""
path = reverse("admin:login")
2023-11-06 14:01:56 +00:00
data = {"username": self.su_name, "password": self.su_pass}
response = self.client.post(path, data)
self.assertEqual(response.status_code, 302)
self.assertResponse(response)
def test_cache_market(self):
"""
Test if the cache_market() call during test setup worked
"""
usd = Currency.objects.get(id=1)
self.assertIsInstance(
usd.exchange_rate,
Decimal,
f"Exchange rate is not a Decimal. Got {type(usd.exchange_rate)}",
)
self.assertGreater(
usd.exchange_rate, 0, "Exchange rate is not higher than zero"
)
self.assertIsInstance(
usd.timestamp, datetime, "External price timestamp is not a datetime"
)
2023-11-06 14:01:56 +00:00
2023-11-09 10:33:53 +00:00
def get_robot_auth(self, robot_index, first_encounter=False):
2023-11-06 19:33:40 +00:00
"""
2023-11-06 23:13:23 +00:00
Create an AUTH header that embeds token, pub_key, and enc_priv_key into a single string
as requested by the robosats token middleware.
2023-11-06 19:33:40 +00:00
"""
b91_token = read_file(f"tests/robots/{robot_index}/b91_token")
pub_key = read_file(f"tests/robots/{robot_index}/pub_key")
enc_priv_key = read_file(f"tests/robots/{robot_index}/enc_priv_key")
2023-11-06 14:01:56 +00:00
2023-11-09 10:33:53 +00:00
# First time a robot authenticated, it is registered by the backend, so pub_key and enc_priv_key is needed
if first_encounter:
headers = {
"HTTP_AUTHORIZATION": f"Token {b91_token} | Public {pub_key} | Private {enc_priv_key}"
}
else:
headers = {"HTTP_AUTHORIZATION": f"Token {b91_token}"}
2023-11-06 14:01:56 +00:00
return headers, pub_key, enc_priv_key
def assert_robot(self, response, pub_key, enc_priv_key, robot_index):
"""
Assert that the robot is created correctly.
"""
nickname = read_file(f"tests/robots/{robot_index}/nickname")
2023-11-06 14:01:56 +00:00
data = json.loads(response.content.decode())
self.assertEqual(response.status_code, 200)
self.assertResponse(response)
2023-11-06 14:01:56 +00:00
self.assertEqual(
data["nickname"],
nickname,
f"Robot created nickname is not {nickname}",
2023-11-06 14:01:56 +00:00
)
self.assertEqual(
data["public_key"], pub_key, "Returned public Kky does not match"
)
self.assertEqual(
data["encrypted_private_key"],
enc_priv_key,
"Returned encrypted private key does not match",
)
self.assertEqual(
len(data["tg_token"]), 15, "String is not exactly 15 characters long"
)
self.assertEqual(
data["tg_bot_name"],
config(
"TELEGRAM_BOT_NAME", cast=str, default="RoboCoordinatorNotificationBot"
),
"Telegram bot name is not correct",
)
self.assertFalse(
data["tg_enabled"], "The new robot's telegram seems to be enabled"
)
self.assertEqual(data["earned_rewards"], 0, "The new robot's rewards are not 0")
2023-11-06 23:13:23 +00:00
def create_robot(self, robot_index):
"""
Creates the robots in /tests/robots/{robot_index}
"""
path = reverse("robot")
2023-11-09 10:33:53 +00:00
headers, pub_key, enc_priv_key = self.get_robot_auth(robot_index, True)
2023-11-06 23:13:23 +00:00
response = self.client.get(path, **headers)
self.assert_robot(response, pub_key, enc_priv_key, robot_index)
2023-11-06 23:13:23 +00:00
2023-11-06 14:01:56 +00:00
def test_create_robots(self):
"""
Test the creation of two robots to be used in the trade tests
2023-11-06 14:01:56 +00:00
"""
2023-11-06 19:33:40 +00:00
self.create_robot(robot_index=1)
self.create_robot(robot_index=2)
def make_order(self, maker_form, robot_index=1):
"""
Create an order for the test.
"""
path = reverse("make")
2023-11-06 19:33:40 +00:00
# Get valid robot auth headers
2023-11-09 10:33:53 +00:00
headers, _, _ = self.get_robot_auth(robot_index, True)
response = self.client.post(path, maker_form, **headers)
return response
2023-11-06 19:33:40 +00:00
def test_make_order(self):
"""
Test the creation of an order.
"""
maker_form = self.maker_form_with_range
response = self.make_order(maker_form, robot_index=1)
2023-11-06 19:33:40 +00:00
data = json.loads(response.content.decode())
# Checks
2023-11-06 23:13:23 +00:00
self.assertIsInstance(data["id"], int, "Order ID is not an integer")
2023-11-06 19:33:40 +00:00
self.assertEqual(
data["status"],
Order.Status.WFB,
"Newly created order status is not 'Waiting for maker bond'",
)
2023-11-06 23:13:23 +00:00
self.assertIsInstance(
datetime.fromisoformat(data["created_at"]),
datetime,
2023-11-06 19:33:40 +00:00
"Order creation timestamp is not datetime",
)
2023-11-06 23:13:23 +00:00
self.assertIsInstance(
datetime.fromisoformat(data["expires_at"]),
datetime,
2023-11-06 19:33:40 +00:00
"Order expiry time is not datetime",
)
self.assertEqual(
data["type"], Order.Types.BUY, "Buy order is not of type value BUY"
)
self.assertEqual(data["currency"], 1, "Order for USD is not of currency USD")
self.assertIsNone(
2023-11-06 23:13:23 +00:00
data["amount"], "Order with range has a non-null simple amount"
2023-11-06 19:33:40 +00:00
)
self.assertTrue(data["has_range"], "Order with range has a False has_range")
2023-11-06 23:13:23 +00:00
self.assertAlmostEqual(
2023-11-09 10:33:53 +00:00
float(data["min_amount"]),
maker_form["min_amount"],
"Order min amount does not match",
2023-11-06 19:33:40 +00:00
)
2023-11-06 23:13:23 +00:00
self.assertAlmostEqual(
2023-11-09 10:33:53 +00:00
float(data["max_amount"]),
maker_form["max_amount"],
"Order max amount does not match",
2023-11-06 19:33:40 +00:00
)
self.assertEqual(
data["payment_method"],
2023-11-09 10:33:53 +00:00
maker_form["payment_method"],
2023-11-06 19:33:40 +00:00
"Order payment method does not match",
)
self.assertEqual(
data["escrow_duration"],
2023-11-09 10:33:53 +00:00
maker_form["escrow_duration"],
2023-11-06 19:33:40 +00:00
"Order escrow duration does not match",
)
2023-11-06 23:13:23 +00:00
self.assertAlmostEqual(
2023-11-09 10:33:53 +00:00
float(data["bond_size"]),
maker_form["bond_size"],
"Order bond size does not match",
2023-11-06 19:33:40 +00:00
)
2023-11-06 23:13:23 +00:00
self.assertAlmostEqual(
2023-11-09 10:33:53 +00:00
float(data["latitude"]),
maker_form["latitude"],
"Order latitude does not match",
2023-11-06 19:33:40 +00:00
)
2023-11-06 23:13:23 +00:00
self.assertAlmostEqual(
2023-11-09 10:33:53 +00:00
float(data["longitude"]),
maker_form["longitude"],
"Order longitude does not match",
2023-11-06 19:33:40 +00:00
)
2023-11-06 23:13:23 +00:00
self.assertAlmostEqual(
2023-11-09 10:33:53 +00:00
float(data["premium"]),
maker_form["premium"],
"Order premium does not match",
2023-11-06 19:33:40 +00:00
)
self.assertFalse(
data["is_explicit"], "Relative pricing order has True is_explicit"
)
self.assertIsNone(
2023-11-06 23:13:23 +00:00
data["satoshis"], "Relative pricing order has non-null Satoshis"
2023-11-06 19:33:40 +00:00
)
self.assertIsNone(data["taker"], "New order's taker is not null")
2023-11-09 10:33:53 +00:00
return data
@patch("api.lightning.cln.hold_pb2_grpc.HoldStub", MockHoldStub)
@patch("api.lightning.lnd.lightning_pb2_grpc.LightningStub", MockLightningStub)
@patch("api.lightning.lnd.invoices_pb2_grpc.InvoicesStub", MockInvoicesStub)
2023-11-09 10:33:53 +00:00
def get_order(self, order_id, robot_index=1, first_encounter=False):
path = reverse("order")
2023-11-09 10:33:53 +00:00
params = f"?order_id={order_id}"
headers, _, _ = self.get_robot_auth(robot_index, first_encounter)
response = self.client.get(path + params, **headers)
return response
def test_get_order_created(self):
# Make an order
maker_form = self.maker_form_with_range
robot_index = 1
order_made_response = self.make_order(maker_form, robot_index)
2023-11-09 10:33:53 +00:00
order_made_data = json.loads(order_made_response.content.decode())
# Maker's first order fetch. Should trigger maker bond hold invoice generation.
response = self.get_order(order_made_data["id"])
data = json.loads(response.content.decode())
self.assertEqual(response.status_code, 200)
self.assertEqual(data["id"], order_made_data["id"])
self.assertTrue(
isinstance(datetime.fromisoformat(data["created_at"]), datetime)
2023-11-06 19:33:40 +00:00
)
2023-11-09 10:33:53 +00:00
self.assertTrue(
isinstance(datetime.fromisoformat(data["expires_at"]), datetime)
)
self.assertTrue(data["is_maker"])
self.assertTrue(data["is_participant"])
self.assertTrue(data["is_buyer"])
self.assertFalse(data["is_seller"])
self.assertEqual(data["maker_status"], "Active")
self.assertEqual(data["status_message"], Order.Status(Order.Status.WFB).label)
self.assertFalse(data["is_fiat_sent"])
self.assertFalse(data["is_disputed"])
self.assertEqual(
data["ur_nick"], read_file(f"tests/robots/{robot_index}/nickname")
)
2023-11-09 10:33:53 +00:00
self.assertTrue(isinstance(data["satoshis_now"], int))
self.assertFalse(data["maker_locked"])
self.assertFalse(data["taker_locked"])
self.assertFalse(data["escrow_locked"])
self.assertEqual(
data["bond_invoice"],
"lntb17310n1pj552mdpp50p2utzh7mpsf3uq7u7cws4a96tj3kyq54hchdkpw8zecamx9klrqd2j2pshjmt9de6zqun9vejhyetwvdjn5gphxs6nsvfe893z6wphvfsj6dryvymj6wp5xvuz6wp5xcukvdec8yukgcf49cs9g6rfwvs8qcted4jkuapq2ay5cnpqgefy2326g5syjn3qt984253q2aq5cnz92skzqcmgv43kkgr0dcs9ymmzdafkzarnyp5kvgr5dpjjqmr0vd4jqampwvs8xatrvdjhxumxw4kzugzfwss8w6tvdssxyefqw4hxcmmrddjkggpgveskjmpfyp6kumr9wdejq7t0w5sxx6r9v96zqmmjyp3kzmnrv4kzqatwd9kxzar9wfskcmre9ccqz52xqzwzsp5hkzegrhn6kegr33z8qfxtcudaklugygdrakgyy7va0wt2qs7drfq9qyyssqc6rztchzl4m7mlulrhlcajszcl9fan8908k9n5x7gmz8g8d6ht5pj4l8r0dushq6j5s8x7yv9a5klz0kfxwy8v6ze6adyrrp4wu0q0sq3t604x",
)
self.assertTrue(isinstance(data["bond_satoshis"], int))
@patch("api.lightning.lnd.invoices_pb2_grpc.InvoicesStub", MockInvoicesStub)
def check_for_locked_bonds(self):
# A background thread checks every 5 second the status of invoices. We invoke directly during test.
# It will ask LND via gRPC. In our test, the request/response from LND is mocked, and it will return fake invoice status "ACCEPTED"
follow_invoices = FollowInvoices()
follow_invoices.follow_hold_invoices()
def make_and_publish_order(self, maker_form, robot_index=1):
2023-11-09 10:33:53 +00:00
# Make an order
order_made_response = self.make_order(maker_form, robot_index)
2023-11-09 10:33:53 +00:00
order_made_data = json.loads(order_made_response.content.decode())
# Maker's first order fetch. Should trigger maker bond hold invoice generation.
self.get_order(order_made_data["id"])
# Check for invoice locked (the mocked LND will return ACCEPTED)
self.check_for_locked_bonds()
# Get order
response = self.get_order(order_made_data["id"])
return response
def test_publish_order(self):
maker_form = self.maker_form_with_range
2023-11-09 10:33:53 +00:00
# Get order
response = self.make_and_publish_order(maker_form)
2023-11-09 10:33:53 +00:00
data = json.loads(response.content.decode())
self.assertEqual(response.status_code, 200)
self.assertEqual(data["id"], data["id"])
self.assertEqual(data["status_message"], Order.Status(Order.Status.PUB).label)
self.assertTrue(data["maker_locked"])
self.assertFalse(data["taker_locked"])
self.assertFalse(data["escrow_locked"])
# Test what we can see with newly created robot 2 (only for public status)
public_response = self.get_order(
data["id"], robot_index=2, first_encounter=True
)
public_data = json.loads(public_response.content.decode())
self.assertFalse(public_data["is_participant"])
self.assertTrue(isinstance(public_data["price_now"], float))
self.assertTrue(isinstance(data["satoshis_now"], int))
@patch("api.lightning.cln.hold_pb2_grpc.HoldStub", MockHoldStub)
@patch("api.lightning.lnd.lightning_pb2_grpc.LightningStub", MockLightningStub)
@patch("api.lightning.lnd.invoices_pb2_grpc.InvoicesStub", MockInvoicesStub)
def take_order(self, order_id, amount, robot_index=2):
path = reverse("order")
params = f"?order_id={order_id}"
headers, _, _ = self.get_robot_auth(robot_index, first_encounter=True)
body = {"action": "take", "amount": amount}
response = self.client.post(path + params, body, **headers)
return response
def make_and_take_order(
self, maker_form, take_amount=80, maker_index=1, taker_index=2
):
response_published = self.make_and_publish_order(maker_form, maker_index)
data_publised = json.loads(response_published.content.decode())
response = self.take_order(data_publised["id"], take_amount, taker_index)
return response
# def test_make_and_take_order(self):
# maker_index = 1
# taker_index = 2
# maker_form = self.maker_form_with_range
# self.create_robot(taker_index) #### WEEEE SHOULD NOT BE NEEDED >??? WHY ROBOT HAS NO LOGIN TIME??
# response = self.make_and_take_order(maker_form, 80, maker_index, taker_index)
# data = json.loads(response.content.decode())
# print(data)
# self.assertEqual(
# data["ur_nick"], read_file(f"tests/robots/{taker_index}/nickname")
# )
# self.assertEqual(
# data["taker_nick"], read_file(f"tests/robots/{taker_index}/nickname")
# )
# self.assertEqual(
# data["maker_nick"], read_file(f"tests/robots/{maker_index}/nickname")
# )
# self.assertFalse(data["is_maker"])
# self.assertTrue(data["is_taker"])
# self.assertTrue(data["is_participant"])
# a = {
# "maker_status": "Active",
# "taker_status": "Active",
# "price_now": 38205.0,
# "premium_now": 3.34,
# "satoshis_now": 266196,
# "is_buyer": False,
# "is_seller": True,
# "taker_nick": "EquivalentWool707",
# "status_message": "Waiting for taker bond",
# "is_fiat_sent": False,
# "is_disputed": False,
# "ur_nick": "EquivalentWool707",
# "maker_locked": True,
# "taker_locked": False,
# "escrow_locked": False,
# "bond_invoice": "lntb73280n1pj5uypwpp5vklcx3s3c66ltz5v7kglppke5n3u6sa6h8m6whe278lza7rwfc7qd2j2pshjmt9de6zqun9vejhyetwvdjn5gp3vgcxgvfkv43z6e3cvyez6dpkxejj6cnxvsmj6c3exsuxxden89skzv3j9cs9g6rfwvs8qcted4jkuapq2ay5cnpqgefy2326g5syjn3qt984253q2aq5cnz92skzqcmgv43kkgr0dcs9ymmzdafkzarnyp5kvgr5dpjjqmr0vd4jqampwvs8xatrvdjhxumxw4kzugzfwss8w6tvdssxyefqw4hxcmmrddjkggpgveskjmpfyp6kumr9wdejq7t0w5sxx6r9v96zqmmjyp3kzmnrv4kzqatwd9kxzar9wfskcmre9ccqz2sxqzfvsp5hkz0dnvja244hc8jwmpeveaxtjd4ddzuqlpqc5zxa6tckr8py50s9qyyssqdcl6w2rhma7k3v904q4tuz68z82d6x47dgflk6m8jdtgt9dg3n9304axv8qvd66dq39sx7yu20sv5pyguv9dnjw3385y8utadxxsqtsqpf7p3w",
# "bond_satoshis": 7328,
# }