Qtum delegation #1096

Milerius · 2021-10-05T17:32:23Z

WIP:

add_delegation ✅
remove_delegation ✅
rpc add_delegation ✅
rpc remove_delegation ✅
rpc get_staking_infos ✅
unit test transaction generation add_delegation ✅
unit test transaction generation remove_delegation ✅
unit test transaction generation proof of delegation ✅
unit test RPC's ✅

Some info before reviewing from QTUM developers:

ROI and Fees:

The ROI for staking is available at https://qtum.info/misc/toolbox/stake-calculator. "Expected time" to a block reward is a probability term, there is much variation, but this value is an excellent long-term average.

A default super staker fee is 10%; some go lower.

Staking amount:

You can't choose the amount to delegate, only the address to delegate, and then all the UTXOs over 100.0 QTUM in that address will be staked by the super staker.

Non-custodial

The delegation is non-custodial, so you still have complete control of the funds. You can add or remove funds, and the delectation will remain. If you want to move to another super staker, then undelegate first. A UTXO that has just been staked (by the super staker) may have to wait for 2,000 confirmations before sending.

The last point is charming. This means that no modification is required regarding balance spendable or not; as far the delectation is still active, that means for every UTXO's > 100 QTUM, you will be staking.

Please read https://docs.qtum.site/en/OfflineStakingDelegation/ before reviewing.

remove_delegation example: https://testnet.qtum.info/tx/421a628e8465783a7e1ba28803b7b882e3069d1fe070fb84ae9efb5512eb2032

add_delegation example: https://testnet.qtum.info/tx/48921789c7dc3d6362421940a38b612354615351090e21095d636bb4b031782b

Milerius · 2021-10-05T17:37:38Z

mm2src/coins/qrc20.rs

+        amount: BigDecimal,
+        to_addr: Address,
+        fee: u64,
+    ) -> Result<GenerateQrc20TxResult, MmError<GenerateTxError>> {
+        let staker_address_hex = qtum::contract_addr_from_utxo_addr(to_addr.clone());


The amount cannot be < 100, otherwise, we need to return an error.

Milerius · 2021-10-05T17:38:09Z

mm2src/coins/qrc20.rs

+            Token::Bytes(signature.into()),
+        ])?;
+
+        let contract_address = ethabi::Address::from_str("0000000000000000000000000000000000000086").unwrap();


Should I turn it into a constant? It's the smart contract address of the delegation for QTUM.

Milerius · 2021-10-05T17:38:19Z

mm2src/coins/qrc20.rs

+        println!("res: {}", hex::encode(params));
+        println!("script_pubkey: {}", hex::encode(script_pubkey.clone()));


…into qtum_delegation

…ure confirmations field

…into qtum_delegation

artemii235

Next review iteration 🙂

mm2src/coins/utxo.rs

mm2src/coins/utxo/qtum.rs

mm2src/mm2_tests.rs

mm2src/coins/utxo/qtum.rs

artemii235

One more review iteration.

mm2src/coins/lp_coins.rs

mm2src/coins/utxo/qtum.rs

mm2src/coins/utxo/qtum_delegation.rs

artemii235 · 2021-10-20T08:31:28Z

mm2src/mm2_tests/structs.rs

@@ -4,6 +4,7 @@
 /// backwards compatibility
 /// Use `#[serde(deny_unknown_fields)]` for all structs for tests to fail in case of adding new fields to the response
 use bigdecimal::BigDecimal;
+use coins::TransactionType;


Please declare the TransactionType separately here. If we occasionally make an incompatible change, we won't catch it because we import the updated struct.

mm2src/coins/utxo/qtum_delegation.rs

- Return an Error in add and remove delegation functions - get_staking_infos could also be used to see if your address format support delegation.

artemii235

Few minor nitpicks 🙂

mm2src/coins/qrc20/rpc_clients.rs

mm2src/coins/utxo/qtum.rs

artemii235

🔥

sergeyboyko0791

Everything is almost perfect. Could you please fix the last few comments?

sergeyboyko0791 · 2021-10-27T10:24:17Z

mm2src/coins/lp_coins.rs

@@ -442,6 +472,41 @@ impl WithdrawRequest {
    }
 }

+/// Please note that no type should have the same structure as another type,
+/// because this enum has the `untagged` deserialization.


There is the comment yet :D

because this enum has the untagged deserialization.

sergeyboyko0791 · 2021-10-27T10:58:30Z

mm2src/coins/utxo/qtum_delegation.rs

+            .map_to_mm(|e| StakingInfosError::Transport(e.to_string()))?;
+        let am_i_staking = add_delegation_history.len() > remove_delegation_history.len();
+        if am_i_staking {
+            let last_tx_add = &add_delegation_history[add_delegation_history.len() - 1];


It shouldn't crush since add_delegation_history.len() > remove_delegation_history.len() is true if add_delegation_history is not empty. But could you please add an explicit check for the length of add_delegation_history, or use

let last_tx_add = match add_delegation_history.last() { Some(last_tx_add) => last_tx_add, None => return Ok(None), };

I ask you to do it because someone, including me, can change the if condition and forget to check the length.

sergeyboyko0791 · 2021-10-27T10:59:47Z

mm2src/coins/utxo/qtum_delegation.rs

+            // topic[0] -> a23803f3b2b56e71f2921c22b23c32ef596a439dbe03f7250e6b58a30eb910b5
+            // topic[1] -> 000000000000000000000000d4ea77298fdac12c657a18b222adc8b307e18127 -> staker_address
+            // topic[2] -> 0000000000000000000000006d9d2b554d768232320587df75c4338ecc8bf37d
+            let raw = res[0].log[0].topics[1].trim_start_matches('0');


AddDelegation contract call can be not only the first output of a transaction, but also second and third, and so on. Please look at the example. You can check which output emitted QTUM_ADD_DELEGATION_TOPIC something like this:

let receipt = res.into_iter().find(|receipt| receipt.log.iter().any(it_qtum_add_delegation)).expect("TODO using match");

Now it looks perfect, thanks!

…ss hex

…ng element

sergeyboyko0791

Approve!!!

artemii235

@Milerius Please fix Clippy and make sure you run this check locally before pushing, especially to the almost finished PR.

artemii235

Reapproving

Milerius added 2 commits October 5, 2021 09:55

feat(qtum_delegation): first part of qtum delegation

08d0816

feat(qtum): finish add_delegation impl function

603e7fe

Milerius commented Oct 5, 2021

View reviewed changes

Milerius added 23 commits October 5, 2021 19:45

feat(qtum): throw error if the amount is < 100 + remove useless logs

5ad4136

feat(qtum): amount is not disposable for qtum delegation

e28f6b9

Merge branch 'dev' of https://github.com/KomodoPlatform/atomicDEX-API …

0ee44ad

…into qtum_delegation

feat(qtum): add delegation to qtum coin instead of qrc20

299a64a

feat(qtum): add pod signature compact

326699e

feat(qtum): fix pod and signature

aa773ce

feat(qtum): simplify the signature

4533644

feat(qtum): add test for add delegation

78d9638

feat(qtum): sync with dev

b24238f

feat(qtum): change script output to my address

0cedec8

feat(qtum): change_script is already included by generate qrc tx

a3521c8

feat(tx): add transaction type

3c4d1d2

feat(qtum): add remove delegation.

10726a7

feat(z_coin): add missing tx type

d3544a8

feat(add_delegation): add_delegation rpc

86a902f

feat(add_delegation): finalize add_delegation rpc

3714487

feat(dispatcher): add remove_delegation

d74afa3

feat(qtum): use cipig qtum electrum for unit tests

39e7168

feat(qtum): better check for qtum mature unspents

d806bf2

feat(qtum): mock unspent for add and remove delegation

5c5d4d0

feat(tests): add delegation and remove delegation for mm2_tests.rs

3a7fae8

feat(tests): don't mock for add and remove delegation

092f9c1

feat(mature_confs): For QTUM tests that generate a tx, reduce the mat…

5c6e368

…ure confirmations field

Milerius marked this pull request as ready for review October 11, 2021 10:01

Milerius requested review from artemii235, sergeyboyko0791 and shamardy October 11, 2021 10:01

Milerius added 4 commits October 18, 2021 12:10

Merge branch 'dev' of https://github.com/KomodoPlatform/atomicDEX-API …

5761004

…into qtum_delegation

feat(sync): sync with dev

fe7d5ba

feat(dispatcher): fix compilation

2cdd286

feat(qtum): remove check for balance in add_delegation

fba4d8e

artemii235 requested changes Oct 19, 2021

View reviewed changes

mm2src/coins/utxo.rs Outdated Show resolved Hide resolved

mm2src/coins/utxo/qtum.rs Outdated Show resolved Hide resolved

mm2src/mm2_tests.rs Outdated Show resolved Hide resolved

mm2src/coins/utxo/qtum.rs Outdated Show resolved Hide resolved

Milerius added 3 commits October 19, 2021 11:08

feat(qtum): implement delegation ops

80e7d2b

feat(qtum): finalize delegation ops

7b10a70

feat(sync): sync with dev

102f250

artemii235 requested changes Oct 20, 2021

View reviewed changes

Milerius added 5 commits October 20, 2021 14:25

feat(qtum): fix review qtum delegation

ab59c06

feat(qtum): new logic for the amount calculation

4628aa0

feat(qtum): add delegation error for non-legacy

e3ef90e

- Return an Error in add and remove delegation functions - get_staking_infos could also be used to see if your address format support delegation.

feat(qtum): rename delegation error to make it more generic

664262a

feat(qtum_delegation): use only one traits for delegation ops.

5a08eae

artemii235 requested changes Oct 22, 2021

View reviewed changes

mm2src/coins/qrc20/rpc_clients.rs Outdated Show resolved Hide resolved

mm2src/coins/qrc20/rpc_clients.rs Outdated Show resolved Hide resolved

mm2src/coins/utxo/qtum.rs Show resolved Hide resolved

feat(review): fix review comments

f683f85

artemii235 previously approved these changes Oct 27, 2021

View reviewed changes

sergeyboyko0791 suggested changes Oct 27, 2021

View reviewed changes

feat(qtum_delegation): fix review comment

4c40a7d

Milerius dismissed artemii235’s stale review via 4c40a7d October 27, 2021 17:00

Milerius added 3 commits October 27, 2021 19:05

feat(qtum_delegation): better comment explanation

343169d

feat(qtum_delegation): use get for retrieving the padded staker addre…

8615585

…ss hex

feat(qtum_delegation): verify that topics is not empty before accessi…

25398e7

…ng element

sergeyboyko0791 previously approved these changes Oct 29, 2021

View reviewed changes

artemii235 requested changes Oct 29, 2021

View reviewed changes

fix(review): cargo clippy

d5f9ff1

Milerius dismissed sergeyboyko0791’s stale review via d5f9ff1 October 31, 2021 05:20

artemii235 approved these changes Nov 1, 2021

View reviewed changes

artemii235 merged commit dea71de into dev Nov 1, 2021

artemii235 deleted the qtum_delegation branch November 1, 2021 08:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Qtum delegation #1096

Qtum delegation #1096

Milerius commented Oct 5, 2021 •

edited

Milerius Oct 5, 2021

Milerius Oct 5, 2021

Milerius Oct 5, 2021

artemii235 left a comment

artemii235 left a comment

artemii235 Oct 20, 2021

artemii235 left a comment

artemii235 left a comment

sergeyboyko0791 left a comment

sergeyboyko0791 Oct 27, 2021

sergeyboyko0791 Oct 27, 2021

sergeyboyko0791 Oct 27, 2021

sergeyboyko0791 Oct 29, 2021

sergeyboyko0791 left a comment

artemii235 left a comment •

edited

artemii235 left a comment

		println!("res: {}", hex::encode(params));
		println!("script_pubkey: {}", hex::encode(script_pubkey.clone()));

Qtum delegation #1096

Qtum delegation #1096

Conversation

Milerius commented Oct 5, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

artemii235 left a comment

Choose a reason for hiding this comment

artemii235 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

artemii235 left a comment

Choose a reason for hiding this comment

artemii235 left a comment

Choose a reason for hiding this comment

sergeyboyko0791 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergeyboyko0791 left a comment

Choose a reason for hiding this comment

artemii235 left a comment • edited

Choose a reason for hiding this comment

artemii235 left a comment

Choose a reason for hiding this comment

Milerius commented Oct 5, 2021 •

edited

artemii235 left a comment •

edited