Files
basicswap/tests/basicswap/extended/test_firo.py
2026-03-18 11:57:32 +02:00

676 lines
21 KiB
Python

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright (c) 2022-2023 tecnovert
# Copyright (c) 2024-2026 The Basicswap developers
# Distributed under the MIT software license, see the accompanying
# file LICENSE or http://www.opensource.org/licenses/mit-license.php.
import os
import random
import logging
import unittest
import basicswap.config as cfg
from basicswap.basicswap import (
Coins,
SwapTypes,
BidStates,
DebugTypes,
)
from basicswap.basicswap_util import (
TxLockTypes,
)
from basicswap.util import (
make_int,
format_amount,
)
from tests.basicswap.util import (
read_json_api,
)
from tests.basicswap.common import (
callrpc_cli,
stopDaemons,
wait_for_bid,
make_rpc_func,
TEST_HTTP_PORT,
wait_for_offer,
waitForRPC,
)
from basicswap.interface.contrib.firo_test_framework.mininode import (
FromHex,
CTransaction,
set_regtest,
)
from basicswap.bin.run import startDaemon
from basicswap.contrib.rpcauth import generate_salt, password_to_hmac
from tests.basicswap.test_xmr import BaseTest, test_delay_event, callnoderpc
logger = logging.getLogger()
FIRO_BINDIR = os.path.expanduser(
os.getenv("FIRO_BINDIR", os.path.join(cfg.DEFAULT_TEST_BINDIR, "firo"))
)
FIROD = os.getenv("FIROD", "firod" + cfg.bin_suffix)
FIRO_CLI = os.getenv("FIRO_CLI", "firo-cli" + cfg.bin_suffix)
FIRO_TX = os.getenv("FIRO_TX", "firo-tx" + cfg.bin_suffix)
FIRO_BASE_PORT = 34832
FIRO_BASE_RPC_PORT = 35832
FIRO_BASE_ZMQ_PORT = 36832
def firoCli(cmd, node_id=0):
return callrpc_cli(
FIRO_BINDIR,
os.path.join(cfg.TEST_DATADIRS, "firo_" + str(node_id)),
"regtest",
cmd,
FIRO_CLI,
)
def prepareDataDir(
datadir, node_id, conf_file, dir_prefix, base_p2p_port, base_rpc_port, num_nodes=3
):
node_dir = os.path.join(datadir, dir_prefix + str(node_id))
if not os.path.exists(node_dir):
os.makedirs(node_dir)
cfg_file_path = os.path.join(node_dir, conf_file)
if os.path.exists(cfg_file_path):
return
with open(cfg_file_path, "w+") as fp:
fp.write("regtest=1\n")
fp.write("port=" + str(base_p2p_port + node_id) + "\n")
fp.write("rpcport=" + str(base_rpc_port + node_id) + "\n")
salt = generate_salt(16)
fp.write(
"rpcauth={}:{}${}\n".format(
"test" + str(node_id),
salt,
password_to_hmac(salt, "test_pass" + str(node_id)),
)
)
fp.write("daemon=0\n")
fp.write("dandelion=0\n")
fp.write("printtoconsole=0\n")
fp.write("server=1\n")
fp.write("discover=0\n")
fp.write("listenonion=0\n")
fp.write("bind=127.0.0.1\n")
fp.write("findpeers=0\n")
fp.write("debug=1\n")
fp.write("debugexclude=libevent\n")
fp.write("fallbackfee=0.01\n")
fp.write("acceptnonstdtxn=0\n")
"""
# qa/rpc-tests/segwit.py
fp.write('prematurewitness=1\n')
fp.write('walletprematurewitness=1\n')
fp.write('blockversion=4\n')
fp.write('promiscuousmempoolflags=517\n')
"""
for i in range(0, num_nodes):
if node_id == i:
continue
fp.write("addnode=127.0.0.1:{}\n".format(base_p2p_port + i))
return node_dir
class Test(BaseTest):
__test__ = True
test_coin_from = Coins.FIRO
firo_daemons = []
firo_addr = None
start_ltc_nodes = False
start_xmr_nodes = False
test_atomic = True
test_xmr = False
# Particl node mnemonics are test_xmr.py, node 2 is set randomly
firo_seeds = [
"d90b7ed1be614e1c172653aee1f3b6230f43b7fa99cf07fa984a17966ad81de7",
"6c81d6d74ba33a0db9e41518c2b6789fbe938e98018a4597dac661cfc5f2dfc1",
"c5de2be44834e7e47ad7dc8e35c6b77c79f17c6bb40d5509a00fc3dff384a865",
]
@classmethod
def prepareExtraDataDir(cls, i):
extra_opts = []
if not cls.restore_instance:
seed_hex = cls.firo_seeds[i]
extra_opts.append(f"-hdseed={seed_hex}")
data_dir = prepareDataDir(
cfg.TEST_DATADIRS,
i,
"firo.conf",
"firo_",
base_p2p_port=FIRO_BASE_PORT,
base_rpc_port=FIRO_BASE_RPC_PORT,
)
if os.path.exists(os.path.join(FIRO_BINDIR, "firo-wallet")):
callrpc_cli(
FIRO_BINDIR,
data_dir,
"regtest",
"-wallet=wallet.dat create",
"firo-wallet",
)
cls.firo_daemons.append(
startDaemon(
os.path.join(cfg.TEST_DATADIRS, "firo_" + str(i)),
FIRO_BINDIR,
FIROD,
opts=extra_opts,
)
)
logging.info("Started %s %d", FIROD, cls.firo_daemons[-1].handle.pid)
waitForRPC(make_rpc_func(i, base_rpc_port=FIRO_BASE_RPC_PORT), test_delay_event)
@classmethod
def addPIDInfo(cls, sc, i):
sc.setDaemonPID(Coins.FIRO, cls.firo_daemons[i].handle.pid)
@classmethod
def prepareExtraCoins(cls):
# Raise MTP_SWITCH_TIME and PP_SWITCH_TIME in mininode.py
set_regtest()
if cls.restore_instance:
void_block_rewards_pubkey = cls.getRandomPubkey()
cls.firo_addr = (
cls.swap_clients[0]
.ci(Coins.FIRO)
.pubkey_to_address(void_block_rewards_pubkey)
)
else:
num_blocks = 400
cls.firo_addr = callnoderpc(
0, "getnewaddress", ["mining_addr"], base_rpc_port=FIRO_BASE_RPC_PORT
)
# cls.firo_addr = callnoderpc(0, 'addwitnessaddress', [cls.firo_addr], base_rpc_port=FIRO_BASE_RPC_PORT)
logging.info(f"Mining {num_blocks} Firo blocks to {cls.firo_addr}")
callnoderpc(
0,
"generatetoaddress",
[num_blocks, cls.firo_addr],
base_rpc_port=FIRO_BASE_RPC_PORT,
)
firo_addr1 = callnoderpc(
1, "getnewaddress", ["initial addr"], base_rpc_port=FIRO_BASE_RPC_PORT
)
# firo_addr1 = callnoderpc(1, 'addwitnessaddress', [firo_addr1], base_rpc_port=FIRO_BASE_RPC_PORT)
for i in range(5):
callnoderpc(
0,
"sendtoaddress",
[firo_addr1, 1000],
base_rpc_port=FIRO_BASE_RPC_PORT,
)
# Set future block rewards to nowhere (a random address), so wallet amounts stay constant
void_block_rewards_pubkey = cls.getRandomPubkey()
cls.firo_addr = (
cls.swap_clients[0]
.ci(Coins.FIRO)
.pubkey_to_address(void_block_rewards_pubkey)
)
chain_height = callnoderpc(
0, "getblockcount", base_rpc_port=FIRO_BASE_RPC_PORT
)
num_blocks = 1352 - chain_height # Activate CTLV (bip65)
logging.info(f"Mining {num_blocks} Firo blocks to {cls.firo_addr}")
callnoderpc(
0,
"generatetoaddress",
[num_blocks, cls.firo_addr],
base_rpc_port=FIRO_BASE_RPC_PORT,
)
@classmethod
def tearDownClass(cls):
logging.info("Finalising FIRO Test")
super(Test, cls).tearDownClass()
stopDaemons(cls.firo_daemons)
cls.firo_daemons.clear()
@classmethod
def addCoinSettings(cls, settings, datadir, node_id):
settings["chainclients"]["firo"] = {
"connection_type": "rpc",
"manage_daemon": False,
"rpcport": FIRO_BASE_RPC_PORT + node_id,
"rpcuser": "test" + str(node_id),
"rpcpassword": "test_pass" + str(node_id),
"datadir": os.path.join(datadir, "firo_" + str(node_id)),
"bindir": FIRO_BINDIR,
"use_csv": False,
"use_segwit": False,
}
@classmethod
def coins_loop(cls):
super(Test, cls).coins_loop()
callnoderpc(
0, "generatetoaddress", [1, cls.firo_addr], base_rpc_port=FIRO_BASE_RPC_PORT
)
def getBalance(self, js_wallets):
return float(js_wallets[self.test_coin_from.name]["balance"]) + float(
js_wallets[self.test_coin_from.name]["unconfirmed"]
)
def getXmrBalance(self, js_wallets):
return float(js_wallets[Coins.XMR.name]["unconfirmed"]) + float(
js_wallets[Coins.XMR.name]["balance"]
)
def callnoderpc(self, method, params=[], wallet=None, node_id=0):
return callnoderpc(
node_id, method, params, wallet, base_rpc_port=FIRO_BASE_RPC_PORT
)
def mineBlock(self, num_blocks: int = 1):
self.callnoderpc("generatetoaddress", [num_blocks, self.firo_addr])
def test_001_firo(self):
logging.info(f"---------- Test {self.test_coin_from.name} segwit")
"""
Segwit is not currently enabled:
https://github.com/firoorg/firo/blob/master/src/validation.cpp#L4425
Txns spending segwit utxos don't get mined.
"""
return
addr_plain = firoCli('getnewaddress "segwit test"')
addr_witness = firoCli(f"addwitnessaddress {addr_plain}")
addr_witness_info = firoCli(f"validateaddress {addr_witness}")
txid = firoCli(f"sendtoaddress {addr_witness} 1.0")
assert len(txid) == 64
self.callnoderpc("generatetoaddress", [1, self.firo_addr])
"""
TODO: Add back when segwit is active
ro = self.callnoderpc('scantxoutset', ['start', ['addr({})'.format(addr_witness)]])
assert (len(ro['unspents']) == 1)
assert (ro['unspents'][0]['txid'] == txid)
"""
tx_wallet = firoCli(f"gettransaction {txid}")
tx_hex = tx_wallet["hex"]
tx = firoCli(f"decoderawtransaction {tx_hex}")
prevout_n = -1
for txo in tx["vout"]:
if addr_witness in txo["scriptPubKey"]["addresses"]:
prevout_n = txo["n"]
break
assert prevout_n > -1
tx_funded = firoCli(
f'createrawtransaction [{{\\"txid\\":\\"{txid}\\",\\"vout\\":{prevout_n}}}] {{\\"{addr_plain}\\":0.99}}'
)
tx_signed = firoCli(f"signrawtransaction {tx_funded}")["hex"]
# Add scriptsig for txids to match
decoded_tx = CTransaction()
decoded_tx = FromHex(decoded_tx, tx_funded)
decoded_tx.vin[0].scriptSig = bytes.fromhex("16" + addr_witness_info["hex"])
decoded_tx.rehash()
txid_with_scriptsig = decoded_tx.hash
tx_funded_decoded = firoCli(f"decoderawtransaction {tx_funded}")
tx_signed_decoded = firoCli(f"decoderawtransaction {tx_signed}")
assert tx_funded_decoded["txid"] != tx_signed_decoded["txid"]
assert txid_with_scriptsig == tx_signed_decoded["txid"]
def test_007_hdwallet(self):
logging.info(f"---------- Test {self.test_coin_from.name} hdwallet")
swap_client = self.swap_clients[0]
# Run initialiseWallet to set 'main_wallet_seedid_'
swap_client.initialiseWallet(self.test_coin_from)
ci = swap_client.ci(self.test_coin_from)
assert "490ba1e2c3894d5534c467141ee3cdf77292c362" == ci.getWalletSeedID()
assert swap_client.checkWalletSeed(self.test_coin_from) is True
def test_008_gettxout(self):
logging.info(f"---------- Test {self.test_coin_from.name} gettxout")
swap_client = self.swap_clients[0]
# First address sometimes has a balance already
_ = self.callnoderpc(
"getnewaddress",
[
"gettxout test",
],
)
addr_plain = self.callnoderpc(
"getnewaddress",
[
"gettxout test 1",
],
)
txid = self.callnoderpc("sendtoaddress", [addr_plain, 1.0])
assert len(txid) == 64
self.mineBlock()
unspents = self.callnoderpc(
"listunspent",
[
0,
999999999,
[
addr_plain,
],
],
)
assert len(unspents) == 1
utxo = unspents[0]
txout = self.callnoderpc("gettxout", [utxo["txid"], utxo["vout"]])
assert addr_plain in txout["scriptPubKey"]["addresses"]
# Spend
addr_plain2 = self.callnoderpc(
"getnewaddress",
[
"gettxout test 2",
],
)
tx_funded = self.callnoderpc(
"createrawtransaction",
[[{"txid": utxo["txid"], "vout": utxo["vout"]}], {addr_plain2: 0.99}],
)
tx_signed = self.callnoderpc(
"signrawtransaction",
[
tx_funded,
],
)["hex"]
self.callnoderpc(
"sendrawtransaction",
[
tx_signed,
],
)
# utxo should be unavailable when spent in the mempool
txout = self.callnoderpc("gettxout", [utxo["txid"], utxo["vout"]])
assert txout is None
self.mineBlock()
ci = swap_client.ci(Coins.FIRO)
require_amount: int = ci.make_int(1)
funds_proof = ci.getProofOfFunds(require_amount, "test".encode("utf-8"))
amount_proved = ci.verifyProofOfFunds(
funds_proof[0], funds_proof[1], funds_proof[2], "test".encode("utf-8")
)
assert amount_proved >= require_amount
def test_08_wallet(self):
logging.info(f"---------- Test {self.test_coin_from.name} wallet")
logging.info("Test withdrawal")
addr = self.callnoderpc(
"getnewaddress",
[
"Withdrawal test",
],
)
wallets = read_json_api(TEST_HTTP_PORT + 0, "wallets")
assert float(wallets[self.test_coin_from.name]["balance"]) > 100
post_json = {
"value": 100,
"address": addr,
"subfee": False,
}
json_rv = read_json_api(
TEST_HTTP_PORT + 0,
f"wallets/{self.test_coin_from.name.lower()}/withdraw",
post_json,
)
assert len(json_rv["txid"]) == 64
logging.info("Test createutxo")
post_json = {
"value": 10,
}
json_rv = read_json_api(
TEST_HTTP_PORT + 0,
f"wallets/{self.test_coin_from.name.lower()}/createutxo",
post_json,
)
assert len(json_rv["txid"]) == 64
def test_11_xmrswap_to(self):
logging.info("---------- Test xmr swap protocol to")
swap_clients = self.swap_clients
coin_from = Coins.BTC
coin_to = Coins.FIRO
swap_type = SwapTypes.XMR_SWAP
ci_from = swap_clients[0].ci(coin_from)
ci_to = swap_clients[1].ci(coin_to)
id_bidder: int = 1
self.prepare_balance(
coin_to,
100.0,
1800 + id_bidder,
1801 if coin_to in (Coins.XMR,) else 1800,
)
swap_value = ci_from.make_int(random.uniform(0.2, 20.0), r=1)
rate_swap = ci_to.make_int(random.uniform(0.2, 20.0), r=1)
offer_id = swap_clients[0].postOffer(
coin_from, coin_to, swap_value, rate_swap, swap_value, swap_type
)
wait_for_offer(test_delay_event, swap_clients[1], offer_id)
offer = swap_clients[1].getOffer(offer_id)
bid_id = swap_clients[1].postBid(offer_id, offer.amount_from)
wait_for_bid(test_delay_event, swap_clients[0], bid_id, BidStates.BID_RECEIVED)
swap_clients[0].acceptBid(bid_id)
wait_for_bid(
test_delay_event,
swap_clients[0],
bid_id,
BidStates.SWAP_COMPLETED,
wait_for=120,
)
wait_for_bid(
test_delay_event,
swap_clients[1],
bid_id,
BidStates.SWAP_COMPLETED,
sent=True,
wait_for=120,
)
def test_12_xmrswap_to_recover_b_lock_tx(self):
coin_from = Coins.BTC
coin_to = Coins.FIRO
logging.info(
f"---------- Test {coin_from.name} to {coin_to.name} follower recovers coin b lock tx"
)
swap_clients = self.swap_clients
ci_from = swap_clients[0].ci(coin_from)
ci_to = swap_clients[1].ci(coin_to)
amt_swap = ci_from.make_int(random.uniform(0.1, 2.0), r=1)
rate_swap = ci_to.make_int(random.uniform(0.2, 20.0), r=1)
offer_id = swap_clients[0].postOffer(
coin_from,
coin_to,
amt_swap,
rate_swap,
amt_swap,
SwapTypes.XMR_SWAP,
lock_type=TxLockTypes.SEQUENCE_LOCK_BLOCKS,
lock_value=32,
)
wait_for_offer(test_delay_event, swap_clients[1], offer_id)
offer = swap_clients[1].getOffer(offer_id)
bid_id = swap_clients[1].postXmrBid(offer_id, offer.amount_from)
wait_for_bid(test_delay_event, swap_clients[0], bid_id, BidStates.BID_RECEIVED)
bid, xmr_swap = swap_clients[0].getXmrBid(bid_id)
swap_clients[1].setBidDebugInd(bid_id, DebugTypes.CREATE_INVALID_COIN_B_LOCK)
swap_clients[0].acceptXmrBid(bid_id)
wait_for_bid(
test_delay_event,
swap_clients[0],
bid_id,
BidStates.XMR_SWAP_FAILED_REFUNDED,
wait_for=180,
)
wait_for_bid(
test_delay_event,
swap_clients[1],
bid_id,
BidStates.XMR_SWAP_FAILED_REFUNDED,
sent=True,
)
def test_13_adsswap_reverse(self):
logging.info("---------- Test ads swap protocol reverse")
swap_clients = self.swap_clients
coin_from = Coins.FIRO
coin_to = Coins.BTC
swap_type = SwapTypes.XMR_SWAP
ci_from = swap_clients[0].ci(coin_from)
ci_to = swap_clients[1].ci(coin_to)
swap_value = ci_from.make_int(random.uniform(0.2, 20.0), r=1)
rate_swap = ci_to.make_int(random.uniform(0.2, 10.0), r=1)
offer_id = swap_clients[0].postOffer(
coin_from, coin_to, swap_value, rate_swap, swap_value, swap_type
)
id_bidder: int = 1
self.prepare_balance(
coin_to,
100.0,
1800 + id_bidder,
1801 if coin_to in (Coins.XMR,) else 1800,
)
wait_for_offer(test_delay_event, swap_clients[1], offer_id)
offer = swap_clients[1].getOffer(offer_id)
bid_id = swap_clients[1].postBid(offer_id, offer.amount_from)
wait_for_bid(test_delay_event, swap_clients[0], bid_id, BidStates.BID_RECEIVED)
swap_clients[0].acceptBid(bid_id)
wait_for_bid(
test_delay_event,
swap_clients[0],
bid_id,
BidStates.SWAP_COMPLETED,
wait_for=120,
)
wait_for_bid(
test_delay_event,
swap_clients[1],
bid_id,
BidStates.SWAP_COMPLETED,
sent=True,
wait_for=120,
)
def test_101_full_swap(self):
logging.info(f"---------- Test {self.test_coin_from.name} to XMR")
if not self.test_xmr:
logging.warning("Skipping test")
return
swap_clients = self.swap_clients
js_1 = read_json_api(1801, "wallets")
node1_from_before = self.getBalance(js_1)
js_1_xmr = read_json_api(1801, "wallets/xmr")
amt_swap = make_int(random.uniform(0.1, 2.0), scale=8, r=1)
rate_swap = make_int(random.uniform(0.2, 20.0), scale=12, r=1)
offer_id = swap_clients[0].postOffer(
self.test_coin_from,
Coins.XMR,
amt_swap,
rate_swap,
amt_swap,
SwapTypes.XMR_SWAP,
)
wait_for_offer(test_delay_event, swap_clients[1], offer_id)
offer = swap_clients[0].getOffer(offer_id)
bid_id = swap_clients[1].postXmrBid(offer_id, offer.amount_from)
wait_for_bid(test_delay_event, swap_clients[0], bid_id, BidStates.BID_RECEIVED)
swap_clients[0].acceptXmrBid(bid_id)
wait_for_bid(
test_delay_event,
swap_clients[0],
bid_id,
BidStates.SWAP_COMPLETED,
wait_for=180,
)
wait_for_bid(
test_delay_event,
swap_clients[1],
bid_id,
BidStates.SWAP_COMPLETED,
sent=True,
)
amount_from = float(format_amount(amt_swap, 8))
js_1 = read_json_api(1801, "wallets")
node1_from_after = self.getBalance(js_1)
assert node1_from_after > node1_from_before + (amount_from - 0.05)
# TODO: Discard block rewards
# js_0 = read_json_api(1800, 'wallets')
# node0_from_after = self.getBalance(js_0)
# assert (node0_from_after < node0_from_before - amount_from)
js_1_xmr_after = read_json_api(1801, "wallets/xmr")
scale_from = 8
amount_to = int((amt_swap * rate_swap) // (10**scale_from))
amount_to_float = float(format_amount(amount_to, 12))
node1_xmr_after = float(js_1_xmr_after["unconfirmed"]) + float(
js_1_xmr_after["balance"]
)
node1_xmr_before = float(js_1_xmr["unconfirmed"]) + float(js_1_xmr["balance"])
assert node1_xmr_after > node1_xmr_before + (amount_to_float - 0.02)
if __name__ == "__main__":
unittest.main()