def test_addr_deregistration_fees(
self,
cluster: clusterlib.ClusterLib,
pool_users: List[clusterlib.PoolUser],
addr_fee: Tuple[int, int],
):
"""Test stake address deregistration fees."""
no_of_addr, expected_fee = addr_fee
temp_template = f"{helpers.get_func_name()}_{no_of_addr}"
src_address = pool_users[0].payment.address
selected_users = pool_users[:no_of_addr]
stake_addr_dereg_certs = [
cluster.gen_stake_addr_deregistration_cert(
addr_name=f"{temp_template}_addr{i}",
stake_vkey_file=p.stake.vkey_file)
for i, p in enumerate(selected_users)
]
# create TX data
tx_files = clusterlib.TxFiles(
certificate_files=[*stake_addr_dereg_certs],
signing_key_files=[
*[p.payment.skey_file for p in selected_users],
*[p.stake.skey_file for p in selected_users],
],
)
# calculate TX fee
tx_fee = cluster.calculate_tx_fee(src_address=src_address,
tx_name=temp_template,
tx_files=tx_files)
assert helpers.is_in_interval(
tx_fee, expected_fee), "Expected fee doesn't match the actual fee"
def _from_to_transactions(
self,
cluster_obj: clusterlib.ClusterLib,
tx_name: str,
pool_users: List[clusterlib.PoolUser],
from_num: int,
to_num: int,
amount_expected: Tuple[int, int],
):
"""Check fees for 1 tx from `from_num` payment addresses to `to_num` payment addresses."""
amount, expected_fee = amount_expected
src_address = pool_users[0].payment.address
# addr1..addr<from_num+1>
from_addr_recs = [p.payment for p in pool_users[1 : from_num + 1]]
# addr<from_num+1>..addr<from_num+to_num+1>
dst_addresses = [
pool_users[i].payment.address for i in range(from_num + 1, from_num + to_num + 1)
]
# create TX data
_txins = [cluster_obj.get_utxo(address=r.address) for r in from_addr_recs]
# flatten the list of lists that is _txins
txins = list(itertools.chain.from_iterable(_txins))
txouts = [clusterlib.TxOut(address=addr, amount=amount) for addr in dst_addresses]
tx_files = clusterlib.TxFiles(signing_key_files=[r.skey_file for r in from_addr_recs])
# calculate TX fee
tx_fee = cluster_obj.calculate_tx_fee(
src_address=src_address, tx_name=tx_name, txins=txins, txouts=txouts, tx_files=tx_files
)
assert helpers.is_in_interval(
tx_fee, expected_fee
), "Expected fee doesn't match the actual fee"
def mint_or_burn_sign(
cluster_obj: clusterlib.ClusterLib,
new_tokens: List[TokenRecord],
temp_template: str,
) -> clusterlib.TxRawOutput:
"""Mint or burn tokens, depending on the `amount` value. Sign using skeys.
Positive `amount` value means minting, negative means burning.
"""
_issuers_addrs = [n.issuers_addrs for n in new_tokens]
issuers_addrs = list(itertools.chain.from_iterable(_issuers_addrs))
issuers_skey_files = [p.skey_file for p in issuers_addrs]
token_mint_addr_skey_files = [
t.token_mint_addr.skey_file for t in new_tokens
]
src_address = new_tokens[0].token_mint_addr.address
tx_files = clusterlib.TxFiles(
signing_key_files=[*issuers_skey_files, *token_mint_addr_skey_files])
# build and sign a transaction
ttl = cluster_obj.calculate_tx_ttl()
fee = cluster_obj.calculate_tx_fee(
src_address=src_address,
tx_name=temp_template,
tx_files=tx_files,
ttl=ttl,
# TODO: workaround for https://github.com/input-output-hk/cardano-node/issues/1892
witness_count_add=len(issuers_skey_files) * 2,
)
tx_raw_output = cluster_obj.build_raw_tx(
src_address=src_address,
tx_name=temp_template,
tx_files=tx_files,
fee=fee,
ttl=ttl,
mint=[
clusterlib.TxOut(address=n.token_mint_addr.address,
amount=n.amount,
coin=n.token) for n in new_tokens
],
)
out_file_signed = cluster_obj.sign_tx(
tx_body_file=tx_raw_output.out_file,
signing_key_files=tx_files.signing_key_files,
tx_name=temp_template,
script_files=[n.script for n in new_tokens],
)
# submit signed transaction
cluster_obj.submit_tx(out_file_signed)
cluster_obj.wait_for_new_block(new_blocks=2)
return tx_raw_output
def test_pool_registration_fees(
self,
cluster: clusterlib.ClusterLib,
temp_dir: Path,
pool_users: List[clusterlib.PoolUser],
addr_fee: Tuple[int, int],
):
"""Test pool registration fees."""
no_of_addr, expected_fee = addr_fee
rand_str = clusterlib.get_rand_str(4)
temp_template = f"{helpers.get_func_name()}_{rand_str}_{no_of_addr}"
pool_name = f"pool_{rand_str}"
pool_metadata = {
"name": pool_name,
"description": "Shelley QA E2E test Test",
"ticker": "QA1",
"homepage": "www.test1.com",
}
pool_metadata_file = helpers.write_json(
temp_dir / f"{pool_name}_registration_metadata.json",
pool_metadata)
pool_data = clusterlib.PoolData(
pool_name=pool_name,
pool_pledge=1000,
pool_cost=15,
pool_margin=0.2,
pool_metadata_url="https://www.where_metadata_file_is_located.com",
pool_metadata_hash=cluster.gen_pool_metadata_hash(
pool_metadata_file),
)
# create pool owners
selected_owners = pool_users[:no_of_addr]
# create certificates
src_address, tx_files = self._create_pool_certificates(
cluster_obj=cluster,
pool_owners=selected_owners,
temp_template=temp_template,
pool_data=pool_data,
)
# calculate TX fee
tx_fee = cluster.calculate_tx_fee(src_address=src_address,
tx_name=temp_template,
tx_files=tx_files)
assert helpers.is_in_interval(
tx_fee, expected_fee), "Expected fee doesn't match the actual fee"
def test_expected_or_higher_fee(
self,
cluster: clusterlib.ClusterLib,
payment_addrs: List[clusterlib.AddressRecord],
fee_add: int,
):
"""Send a transaction with fee that is same or higher than expected."""
temp_template = f"{common.get_test_id(cluster)}_{fee_add}"
amount = 2_000_000
src_address = payment_addrs[0].address
dst_address = payment_addrs[1].address
src_init_balance = cluster.get_address_balance(src_address)
dst_init_balance = cluster.get_address_balance(dst_address)
destinations = [clusterlib.TxOut(address=dst_address, amount=amount)]
tx_files = clusterlib.TxFiles(signing_key_files=[payment_addrs[0].skey_file])
fee = (
cluster.calculate_tx_fee(
src_address=src_address,
tx_name=temp_template,
txouts=destinations,
tx_files=tx_files,
)
+ fee_add
)
tx_raw_output = cluster.send_funds(
src_address=src_address,
destinations=destinations,
tx_name=temp_template,
tx_files=tx_files,
fee=fee,
)
assert tx_raw_output.fee == fee, "The actual fee doesn't match the specified fee"
assert (
cluster.get_address_balance(src_address)
== src_init_balance - tx_raw_output.fee - len(destinations) * amount
), f"Incorrect balance for source address `{src_address}`"
assert (
cluster.get_address_balance(dst_address) == dst_init_balance + amount
), f"Incorrect balance for destination address `{dst_address}`"
def test_shelley_cddl(self, cluster: clusterlib.ClusterLib,
payment_addrs: List[clusterlib.AddressRecord]):
"""Check expected failure when Shelley Tx is used with CDDL format."""
temp_template = common.get_test_id(cluster)
src_address = payment_addrs[0].address
dst_address = payment_addrs[1].address
# amount value -1 means all available funds
destinations = [clusterlib.TxOut(address=dst_address, amount=-1)]
tx_files = clusterlib.TxFiles(
signing_key_files=[payment_addrs[1].skey_file])
fee = cluster.calculate_tx_fee(
src_address=src_address,
tx_name=temp_template,
txouts=destinations,
tx_files=tx_files,
)
orig_cddl_value = cluster.use_cddl
try:
cluster.use_cddl = True
tx_raw_output = cluster.build_raw_tx(
src_address=src_address,
tx_name=temp_template,
txouts=destinations,
tx_files=tx_files,
fee=fee,
)
finally:
cluster.use_cddl = orig_cddl_value
with pytest.raises(clusterlib.CLIError) as excinfo:
cluster.sign_tx(
tx_body_file=tx_raw_output.out_file,
signing_key_files=tx_files.signing_key_files,
tx_name=temp_template,
)
if "TextEnvelope error" in str(excinfo.value):
pytest.xfail("TextEnvelope error")
else:
pytest.fail(f"Unexpected error:\n{excinfo.value}")
def test_smaller_fee(
self,
cluster: clusterlib.ClusterLib,
payment_addrs: List[clusterlib.AddressRecord],
fee_change: float,
):
"""Try to send a transaction with smaller-than-expected fee.
Expect failure.
"""
temp_template = f"{common.get_test_id(cluster)}_{fee_change}"
src_address = payment_addrs[0].address
dst_address = payment_addrs[1].address
destinations = [clusterlib.TxOut(address=dst_address, amount=10)]
tx_files = clusterlib.TxFiles(signing_key_files=[payment_addrs[0].skey_file])
fee = 0.0
if fee_change:
fee = (
cluster.calculate_tx_fee(
src_address=src_address,
tx_name=temp_template,
txouts=destinations,
tx_files=tx_files,
)
/ fee_change
)
with pytest.raises(clusterlib.CLIError) as excinfo:
cluster.send_funds(
src_address=src_address,
destinations=destinations,
tx_name=temp_template,
tx_files=tx_files,
fee=int(fee),
)
assert "FeeTooSmallUTxO" in str(excinfo.value)
def mint_or_burn_witness(
cluster_obj: clusterlib.ClusterLib,
new_tokens: List[TokenRecord],
temp_template: str,
invalid_hereafter: Optional[int] = None,
invalid_before: Optional[int] = None,
) -> clusterlib.TxRawOutput:
"""Mint or burn tokens, depending on the `amount` value. Sign using witnesses.
Positive `amount` value means minting, negative means burning.
"""
_issuers_addrs = [t.issuers_addrs for t in new_tokens]
issuers_addrs = set(itertools.chain.from_iterable(_issuers_addrs))
issuers_skey_files = {p.skey_file for p in issuers_addrs}
src_address = new_tokens[0].token_mint_addr.address
# create TX body
tx_files = clusterlib.TxFiles(
script_files=clusterlib.ScriptFiles(minting_scripts=[t.script for t in new_tokens]),
)
mint = [
clusterlib.TxOut(address=t.token_mint_addr.address, amount=t.amount, coin=t.token)
for t in new_tokens
]
fee = cluster_obj.calculate_tx_fee(
src_address=src_address,
tx_name=temp_template,
tx_files=tx_files,
mint=mint,
# TODO: workaround for https://github.com/input-output-hk/cardano-node/issues/1892
witness_count_add=len(issuers_skey_files),
)
tx_raw_output = cluster_obj.build_raw_tx(
src_address=src_address,
tx_name=temp_template,
tx_files=tx_files,
fee=fee,
invalid_hereafter=invalid_hereafter,
invalid_before=invalid_before,
mint=mint,
)
# create witness file for each required key
witness_files = [
cluster_obj.witness_tx(
tx_body_file=tx_raw_output.out_file,
witness_name=f"{temp_template}_skey{idx}",
signing_key_files=[skey],
)
for idx, skey in enumerate(issuers_skey_files)
]
# sign TX using witness files
tx_witnessed_file = cluster_obj.assemble_tx(
tx_body_file=tx_raw_output.out_file,
witness_files=witness_files,
tx_name=temp_template,
)
# submit signed TX
cluster_obj.submit_tx(tx_file=tx_witnessed_file, txins=tx_raw_output.txins)
return tx_raw_output
def test_pool_deregistration_fees(
self,
cluster: clusterlib.ClusterLib,
temp_dir: Path,
pool_users: List[clusterlib.PoolUser],
addr_fee: Tuple[int, int],
):
"""Test pool deregistration fees."""
no_of_addr, expected_fee = addr_fee
rand_str = clusterlib.get_rand_str(4)
temp_template = f"{helpers.get_func_name()}_{rand_str}_{no_of_addr}"
src_address = pool_users[0].payment.address
pool_name = f"pool_{rand_str}"
pool_metadata = {
"name": pool_name,
"description": "Shelley QA E2E test Test",
"ticker": "QA1",
"homepage": "www.test1.com",
}
pool_metadata_file = helpers.write_json(
temp_dir / f"{pool_name}_registration_metadata.json",
pool_metadata)
pool_data = clusterlib.PoolData(
pool_name=pool_name,
pool_pledge=222,
pool_cost=123,
pool_margin=0.512,
pool_metadata_url="https://www.where_metadata_file_is_located.com",
pool_metadata_hash=cluster.gen_pool_metadata_hash(
pool_metadata_file),
)
# create pool owners
selected_owners = pool_users[:no_of_addr]
# create node cold key pair and counter
node_cold = cluster.gen_cold_key_pair_and_counter(
node_name=pool_data.pool_name)
# create deregistration certificate
pool_dereg_cert_file = cluster.gen_pool_deregistration_cert(
pool_name=pool_data.pool_name,
cold_vkey_file=node_cold.vkey_file,
epoch=cluster.get_epoch() + 1,
)
tx_files = clusterlib.TxFiles(
certificate_files=[pool_dereg_cert_file],
signing_key_files=[
*[p.payment.skey_file for p in selected_owners],
*[p.stake.skey_file for p in selected_owners],
node_cold.skey_file,
],
)
# calculate TX fee
tx_fee = cluster.calculate_tx_fee(src_address=src_address,
tx_name=temp_template,
tx_files=tx_files)
assert helpers.is_in_interval(
tx_fee, expected_fee), "Expected fee doesn't match the actual fee"
def mint_or_burn_sign(
cluster_obj: clusterlib.ClusterLib,
new_tokens: List[TokenRecord],
temp_template: str,
sign_incrementally: bool = False,
) -> clusterlib.TxRawOutput:
"""Mint or burn tokens, depending on the `amount` value. Sign using skeys.
Positive `amount` value means minting, negative means burning.
"""
_issuers_addrs = [t.issuers_addrs for t in new_tokens]
issuers_addrs = set(itertools.chain.from_iterable(_issuers_addrs))
issuers_skey_files = {p.skey_file for p in issuers_addrs}
token_mint_addr = new_tokens[0].token_mint_addr
signing_key_files = list({*issuers_skey_files, token_mint_addr.skey_file})
# build and sign a transaction
tx_files = clusterlib.TxFiles(signing_key_files=signing_key_files)
mint = [
clusterlib.Mint(
txouts=[
clusterlib.TxOut(address=t.token_mint_addr.address,
amount=t.amount,
coin=t.token)
],
script_file=t.script,
) for t in new_tokens
]
fee = cluster_obj.calculate_tx_fee(
src_address=token_mint_addr.address,
tx_name=temp_template,
mint=mint,
tx_files=tx_files,
# TODO: workaround for https://github.com/input-output-hk/cardano-node/issues/1892
witness_count_add=len(issuers_skey_files),
)
tx_raw_output = cluster_obj.build_raw_tx(
src_address=token_mint_addr.address,
tx_name=temp_template,
mint=mint,
tx_files=tx_files,
fee=fee,
)
# sign incrementally (just to check that it works)
if sign_incrementally and len(signing_key_files) >= 1:
out_file_signed = cluster_obj.sign_tx(
tx_body_file=tx_raw_output.out_file,
signing_key_files=signing_key_files[:1],
tx_name=f"{temp_template}_sign0",
)
# incrementally sign the already signed Tx with rest of required skeys
for idx, skey in enumerate(signing_key_files[1:], start=1):
out_file_signed = cluster_obj.sign_tx(
tx_file=out_file_signed,
signing_key_files=[skey],
tx_name=f"{temp_template}_sign{idx}",
)
else:
out_file_signed = cluster_obj.sign_tx(
tx_body_file=tx_raw_output.out_file,
signing_key_files=tx_files.signing_key_files,
tx_name=temp_template,
)
# submit signed transaction
cluster_obj.submit_tx(tx_file=out_file_signed, txins=tx_raw_output.txins)
return tx_raw_output
def mint_or_burn_witness(
cluster_obj: clusterlib.ClusterLib,
new_tokens: List[TokenRecord],
temp_template: str,
invalid_hereafter: Optional[int] = None,
invalid_before: Optional[int] = None,
use_build_cmd: bool = False,
sign_incrementally: bool = False,
) -> clusterlib.TxRawOutput:
"""Mint or burn tokens, depending on the `amount` value. Sign using witnesses.
Positive `amount` value means minting, negative means burning.
"""
_issuers_addrs = [t.issuers_addrs for t in new_tokens]
issuers_addrs = set(itertools.chain.from_iterable(_issuers_addrs))
issuers_skey_files = {p.skey_file for p in issuers_addrs}
token_mint_addr = new_tokens[0].token_mint_addr
signing_key_files = list({*issuers_skey_files, token_mint_addr.skey_file})
# create TX body
mint = [
clusterlib.Mint(
txouts=[
clusterlib.TxOut(address=t.token_mint_addr.address,
amount=t.amount,
coin=t.token)
],
script_file=t.script,
) for t in new_tokens
]
if use_build_cmd:
mint_txouts = [
clusterlib.TxOut(address=t.token_mint_addr.address,
amount=t.amount,
coin=t.token) for t in new_tokens
]
txouts = [
# meet the minimum required UTxO value
clusterlib.TxOut(address=new_tokens[0].token_mint_addr.address,
amount=2000_000),
# leave out token burning records
*[t for t in mint_txouts if t.amount > 0],
]
tx_raw_output = cluster_obj.build_tx(
src_address=token_mint_addr.address,
tx_name=temp_template,
txouts=txouts,
fee_buffer=2000_000,
mint=mint,
invalid_hereafter=invalid_hereafter,
invalid_before=invalid_before,
witness_override=len(signing_key_files),
)
else:
fee = cluster_obj.calculate_tx_fee(
src_address=token_mint_addr.address,
tx_name=temp_template,
mint=mint,
# TODO: workaround for https://github.com/input-output-hk/cardano-node/issues/1892
witness_count_add=len(signing_key_files),
)
tx_raw_output = cluster_obj.build_raw_tx(
src_address=token_mint_addr.address,
tx_name=temp_template,
mint=mint,
fee=fee,
invalid_hereafter=invalid_hereafter,
invalid_before=invalid_before,
)
# sign incrementally (just to check that it works)
if sign_incrementally and len(signing_key_files) >= 1:
# create witness file for first required key
witness_file = cluster_obj.witness_tx(
tx_body_file=tx_raw_output.out_file,
witness_name=f"{temp_template}_skey0",
signing_key_files=signing_key_files[:1],
)
# sign Tx using witness file
tx_witnessed_file = cluster_obj.assemble_tx(
tx_body_file=tx_raw_output.out_file,
witness_files=[witness_file],
tx_name=f"{temp_template}_sign0",
)
# incrementally sign the already signed Tx with rest of required skeys
for idx, skey in enumerate(signing_key_files[1:], start=1):
tx_witnessed_file = cluster_obj.sign_tx(
tx_file=tx_witnessed_file,
signing_key_files=[skey],
tx_name=f"{temp_template}_sign{idx}",
)
else:
# create witness file for each required key
witness_files = [
cluster_obj.witness_tx(
tx_body_file=tx_raw_output.out_file,
witness_name=f"{temp_template}_skey{idx}",
signing_key_files=[skey],
) for idx, skey in enumerate(signing_key_files)
]
# sign Tx using witness files
tx_witnessed_file = cluster_obj.assemble_tx(
tx_body_file=tx_raw_output.out_file,
witness_files=witness_files,
tx_name=temp_template,
)
# submit signed TX
cluster_obj.submit_tx(tx_file=tx_witnessed_file, txins=tx_raw_output.txins)
return tx_raw_output
def multisig_tx(
cluster_obj: clusterlib.ClusterLib,
temp_template: str,
src_address: str,
dst_address: str,
amount: int,
multisig_script: Path,
payment_skey_files: List[Path],
invalid_hereafter: Optional[int] = None,
invalid_before: Optional[int] = None,
script_is_src=False,
):
"""Build and submit multisig transaction."""
# record initial balances
src_init_balance = cluster_obj.get_address_balance(src_address)
dst_init_balance = cluster_obj.get_address_balance(dst_address)
# create TX body
destinations = [clusterlib.TxOut(address=dst_address, amount=amount)]
witness_count_add = len(payment_skey_files)
if script_is_src:
# TODO: workaround for https://github.com/input-output-hk/cardano-node/issues/1892
witness_count_add += 5
ttl = cluster_obj.calculate_tx_ttl()
fee = cluster_obj.calculate_tx_fee(
src_address=src_address,
tx_name=temp_template,
txouts=destinations,
ttl=ttl,
witness_count_add=witness_count_add,
)
tx_raw_output = cluster_obj.build_raw_tx(
src_address=src_address,
tx_name=temp_template,
txouts=destinations,
fee=fee,
ttl=ttl,
invalid_hereafter=invalid_hereafter,
invalid_before=invalid_before,
)
# create witness file for each key
witness_files = [
cluster_obj.witness_tx(
tx_body_file=tx_raw_output.out_file,
witness_name=f"{temp_template}_skey{idx}",
signing_key_files=[skey],
) for idx, skey in enumerate(payment_skey_files)
]
if script_is_src:
witness_files.append(
cluster_obj.witness_tx(
tx_body_file=tx_raw_output.out_file,
witness_name=f"{temp_template}_script",
script_file=multisig_script,
))
# sign TX using witness files
tx_witnessed_file = cluster_obj.assemble_tx(
tx_body_file=tx_raw_output.out_file,
witness_files=witness_files,
tx_name=temp_template,
)
# submit signed TX
cluster_obj.submit_tx(tx_witnessed_file)
cluster_obj.wait_for_new_block(new_blocks=2)
# check final balances
assert (cluster_obj.get_address_balance(src_address) == src_init_balance -
tx_raw_output.fee -
amount), f"Incorrect balance for source address `{src_address}`"
assert (cluster_obj.get_address_balance(dst_address) == dst_init_balance +
amount), f"Incorrect balance for script address `{dst_address}`"